export type ClientOptions = { baseUrl: "http://localhost:33333" | "https://api.yourdomain.com" | (string & {}); }; export type WorkspaceSettingsInputCreateType = { ai?: { /** * The 'Mentor' Agent (System/Specialty) providing domain context */ base_agent_id?: string | unknown; /** * Agent that classifies documents before extraction (runs at triage) */ classifier_agent_id?: string | unknown; /** * If true, chat interactions automatically update the Custom Agent */ continuous_learning?: boolean | unknown; /** * The 'Student' Agent (Custom) learning specific rules */ custom_agent_id?: string | unknown; /** * Explicitly enabled AI features for this workspace */ enabled_capabilities?: Array | unknown; /** * Maps diarization speaker IDs to role labels for transcript formatting. * E.g.: %{"SPEAKER_00" => "RD", "SPEAKER_01" => "Client"} * ISV-configured. The platform normalizes transcripts to these labels before passing to agents. * */ speaker_role_map?: { [key: string]: unknown; } | unknown; /** * Agent that validates extracted data post-extraction */ validator_agent_id?: string | unknown; /** * Whether validator runs synchronously (:sync) or asynchronously via Oban (:async) */ validator_mode?: "sync" | "async" | unknown; } | null; billing?: { allow_overdraft?: boolean | unknown; /** * Maximum overdraft credits allowed per period */ overdraft_limit?: number | unknown; /** * Period for overdraft limit reset (daily, weekly, monthly) */ overdraft_period?: "daily" | "weekly" | "monthly" | unknown; /** * When the current overdraft period began */ overdraft_period_started_at?: unknown; /** * Credits used from overdraft in current period */ overdraft_used?: number | unknown; } | null; review_train?: { confidence_threshold?: number | unknown; /** * Default ReviewQueue UUID for workspace-scoped reviews when no Case is attached. */ default_review_queue_id?: string | unknown; } | null; storage?: unknown | { errors?: { copy_to_local?: boolean | unknown; local_path?: string | unknown; } | unknown; input?: { local_path?: string | unknown; source?: "local" | "cloud" | unknown; } | unknown; output?: { copy_to_local?: boolean | unknown; local_path?: string | unknown; } | unknown; } | { errors?: unknown; input?: unknown; output?: unknown; }; watcher?: unknown | { claim_expiry_minutes?: number | unknown; /** * Configuration for cloud input sources */ cloud_config?: { /** * Override bucket (defaults to tenant processing bucket) */ bucket?: string | unknown; /** * Delete source file instead of moving to processed */ delete_after_processing?: boolean | unknown; /** * Override error prefix (defaults to workspaces/{id}/errors/) */ error_prefix?: string | unknown; /** * Override input prefix (defaults to workspaces/{id}/input/) */ input_prefix?: string | unknown; poll_interval_seconds?: number | unknown; /** * Override processed prefix (defaults to workspaces/{id}/processed/) */ processed_prefix?: string | unknown; provider?: "s3" | "minio" | "gcs" | unknown; } | unknown; duplicate_action?: "skip" | "move_to_processed" | "move_to_skipped" | unknown; enabled?: boolean | unknown; log_retention_days?: number | unknown; max_retries?: number | unknown; retry_delay_ms?: number | unknown; source_type?: "local" | "cloud" | unknown; } | { claim_expiry_minutes?: number | unknown; /** * Configuration for cloud input sources */ cloud_config?: unknown; duplicate_action?: "skip" | "move_to_processed" | "move_to_skipped" | unknown; enabled?: boolean | unknown; log_retention_days?: number | unknown; max_retries?: number | unknown; retry_delay_ms?: number | unknown; source_type?: "local" | "cloud" | unknown; }; }; /** * A "Resource object" representing a ephi-asset */ export type EphiAsset = { /** * An attributes object for a ephi-asset */ attributes?: { /** * Field included by default. */ application_id: string; /** * Field included by default. */ asset_type: "database" | "application" | "api_service" | "storage" | "network" | "endpoint_device" | "backup_system"; /** * Field included by default. */ baa_status: "in_place" | "needed" | "not_applicable"; /** * Field included by default. */ classification: "ephi_primary" | "ephi_secondary" | "ephi_transit" | "non_ephi"; /** * Categories of PHI this asset handles. Field included by default. */ data_categories: Array; /** * Field included by default. */ encryption_at_rest: boolean; /** * Field included by default. */ encryption_in_transit: boolean; /** * Field included by default. */ last_assessed_at?: string | null; /** * Field included by default. */ location: "cloud" | "on_premise" | "hybrid"; /** * Field included by default. */ name: string; /** * Field included by default. */ next_assessment_due?: string | null; /** * Responsible person or team. Field included by default. */ owner?: string | null; /** * Infrastructure provider (e.g., Google Cloud, AWS). Field included by default. */ provider?: string | null; /** * Field included by default. */ status: "active" | "decommissioning" | "decommissioned"; }; id: string; /** * A relationships object for a ephi-asset */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a portal-change-request */ export type PortalChangeRequest = { /** * An attributes object for a portal-change-request */ attributes?: { /** * Field included by default. */ field_name: string; /** * Field included by default. */ new_value: string; /** * Field included by default. */ old_value?: string | null; /** * Field included by default. */ reviewed_at?: unknown; /** * Field included by default. */ status: "pending" | "approved" | "rejected"; }; id: string; /** * A relationships object for a portal-change-request */ relationships?: { [key: string]: never; }; type: string; }; export type SchedulingCalendarSyncBaaAttestationInputCreateType = { attestation_text: string; attested_at: unknown; attested_by_user_id: string; platform_acknowledgment: string; type: "google_workspace_baa" | "microsoft_baa" | "other"; }; /** * A "Resource object" representing a agent-execution */ export type AgentExecution = { /** * An attributes object for a agent-execution */ attributes?: { /** * Field included by default. */ input: { [key: string]: unknown; }; /** * Field included by default. */ execution_mode: "extraction" | "agentic" | "dry_run" | "thread_message"; /** * Field included by default. */ agent_version_id: string; /** * Field included by default. */ result?: { [key: string]: unknown; } | null; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ max_cost_credits?: string | null; /** * Field included by default. */ current_iteration: number; /** * IDs of child executions this execution is waiting for. Field included by default. */ awaiting_children_ids?: Array | null; /** * Output tokens consumed across all LLM calls in this execution. Field included by default. */ total_output_tokens: number; /** * Explicit model override for this execution only. Highest priority in resolution chain. Field included by default. */ requested_model_id?: string | null; /** * Field included by default. */ triggered_by_user_id?: string | null; /** * Number of direct child executions spawned. Field included by default. */ child_execution_count?: number | null; /** * Caller-provided idempotency key, unique per workspace. Field included by default. */ idempotency_key?: string | null; /** * Field included by default. */ parent_execution_id?: string | null; /** * List of storage file references for multimodal input. Each entry: %{storage_file_id: uuid, label: string | nil}. Field included by default. */ file_inputs: Array<{ [key: string]: unknown; }>; /** * Sum of credits charged by all child executions. Field included by default. */ child_credits_total?: string | null; /** * Field included by default. */ status: "pending" | "running" | "awaiting_approval" | "paused" | "completed" | "failed" | "timed_out" | "cancelled"; /** * Field included by default. */ updated_at: unknown; /** * Field included by default. */ total_tokens_used: number; /** * Field included by default. */ total_tool_calls: number; /** * Input tokens consumed across all LLM calls in this execution. Field included by default. */ total_input_tokens: number; /** * Field included by default. */ max_iterations: number; /** * Denormalized for tenant-scoped concurrent execution limits. Field included by default. */ tenant_id: string; /** * Field included by default. */ estimated_max_cost?: string | null; /** * Field included by default. */ error?: { [key: string]: unknown; } | null; /** * Depth in execution tree (0 = root). Field included by default. */ depth: number; /** * Tool call awaiting human decision. Nil if not paused. Field included by default. */ pending_approval?: { [key: string]: unknown; } | null; /** * Field included by default. */ model_used?: string | null; /** * Field included by default. */ workspace_id: string; /** * Field included by default. */ completed_at?: unknown; /** * How this execution was delegated from its parent. Field included by default. */ delegation_mode?: "synchronous" | "fire_and_forget" | "parallel"; /** * Field included by default. */ agent_id: string; /** * Caller-provided metadata (e.g., trigger source, correlation IDs). Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ total_credits_charged?: string | null; /** * Field included by default. */ started_at?: unknown; /** * Credits charged by this execution's direct operations. Field included by default. */ own_credits_charged?: string | null; /** * Field included by default. */ max_tool_calls: number; }; id: string; /** * A relationships object for a agent-execution */ relationships?: { agent?: { /** * An identifier for agent */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; agent_version?: { /** * An identifier for agent_version */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; parent_execution?: { /** * An identifier for parent_execution */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; triggered_by_user?: { /** * An identifier for triggered_by_user */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; workspace?: { /** * An identifier for workspace */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a user-profile */ export type UserProfile = { /** * An attributes object for a user-profile */ attributes?: { /** * Field included by default. */ avatar_url?: string | null; /** * Field included by default. */ bio?: string | null; /** * Field included by default. */ first_name?: string | null; full_name?: string | null; /** * Field included by default. */ last_name?: string | null; /** * Field included by default. */ preferences?: { [key: string]: unknown; } | null; /** * Field included by default. */ social_links?: { [key: string]: unknown; } | null; /** * Current system messages (ToS, Welcome, Announcement) with user acknowledgment status */ system_messages?: { [key: string]: unknown; } | null; /** * Field included by default. */ user_id: string; }; id: string; /** * A relationships object for a user-profile */ relationships?: { user?: { /** * An identifier for user */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a chat-conversation */ export type ChatConversation = { /** * An attributes object for a chat-conversation */ attributes?: { /** * Structured data providing context for this conversation (e.g., failed prediction results). Field included by default. */ context_data?: { [key: string]: unknown; } | null; /** * Field included by default. */ title?: string | null; /** * Field included by default. */ workspace_id?: string | null; }; id: string; /** * A relationships object for a chat-conversation */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a trending-watch */ export type TrendingWatch = { /** * An attributes object for a trending-watch */ attributes?: { /** * Field included by default. */ conditions: { [key: string]: unknown; }; /** * Field included by default. */ enabled: boolean; /** * Field included by default. */ last_triggered_at?: unknown; /** * Field included by default. */ name: string; /** * Field included by default. */ notification_config: { [key: string]: unknown; }; /** * Field included by default. */ query?: string | null; /** * Field included by default. */ sources: Array<"twitter" | "reddit" | "linkedin" | "facebook" | "instagram" | "newsapi" | "gnews" | "bing_news">; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a trending-watch */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a workspace-agent-config */ export type WorkspaceAgentConfig = { /** * An attributes object for a workspace-agent-config */ attributes?: { /** * Field included by default. */ agent_deployment_id: string; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ overrides: { [key: string]: unknown; }; /** * Field included by default. */ schema_overrides?: { [key: string]: unknown; } | null; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a workspace-agent-config */ relationships?: { agent_deployment?: { /** * An identifier for agent_deployment */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; workspace?: { /** * An identifier for workspace */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a post-metric */ export type PostMetric = { /** * An attributes object for a post-metric */ attributes?: { /** * Field included by default. */ clicks: number; /** * Field included by default. */ collected_at: unknown; /** * Field included by default. */ collection_window: "1h" | "24h" | "7d" | "30d" | "90d"; /** * Field included by default. */ comments: number; /** * Field included by default. */ engagements: number; /** * Field included by default. */ impressions: number; /** * Field included by default. */ likes: number; /** * Field included by default. */ platform: "facebook" | "instagram" | "threads" | "twitter" | "linkedin" | "reddit" | "bluesky"; /** * Field included by default. */ reach: number; /** * Field included by default. */ saves?: number | null; /** * Field included by default. */ shares: number; /** * Field included by default. */ social_post_id: string; /** * Field included by default. */ video_views?: number | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a post-metric */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-goal-template */ export type ClinicalGoalTemplate = { /** * An attributes object for a clinical-goal-template */ attributes?: { /** * Field included by default. */ action_steps: Array; /** * Field included by default. */ age_groups: Array; /** * Field included by default. */ applicable_conditions: Array; /** * Field included by default. */ category?: string | null; /** * Field included by default. */ created_by_id?: string | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ difficulty?: "beginner" | "intermediate" | "advanced"; /** * Field included by default. */ evidence_base?: string | null; /** * Field included by default. */ frequency?: "daily" | "weekly"; /** * Field included by default. */ goal_type: string; /** * Field included by default. */ instructions?: string | null; /** * Field included by default. */ is_active: boolean; is_archived?: boolean | null; is_catalog?: boolean | null; /** * Field included by default. */ linked_metric_type?: string | null; /** * Field included by default. */ metadata: { [key: string]: unknown; }; /** * Field included by default. */ priority?: "high" | "medium" | "low"; /** * Field included by default. */ source_catalog_id?: string | null; /** * Field included by default. */ source_reference?: string | null; /** * Field included by default. */ source_template_id?: string | null; /** * Field included by default. */ suggested_duration_days?: number | null; /** * Field included by default. */ tags: Array; /** * Field included by default. */ target_value?: string | null; /** * Field included by default. */ timeframe?: string | null; /** * Field included by default. */ title: string; /** * Field included by default. */ tool_ids: Array; /** * Field included by default. */ unit?: string | null; }; id: string; /** * A relationships object for a clinical-goal-template */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a email-marketing-recipient */ export type EmailMarketingRecipient = { /** * An attributes object for a email-marketing-recipient */ attributes?: { /** * Field included by default. */ crm_contact_id?: string | null; /** * Field included by default. */ email: string; /** * Field included by default. */ raw_data?: { [key: string]: unknown; } | null; }; id: string; /** * A relationships object for a email-marketing-recipient */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a extraction-result */ export type ExtractionResult = { /** * An attributes object for a extraction-result */ attributes?: { /** * Average confidence across all extracted fields. Field included by default. */ avg_confidence?: number | null; /** * Character count of extracted text */ char_count?: number | null; /** * Classification confidence score. Field included by default. */ classification_confidence?: number | null; /** * Field included by default. */ credits_used?: string | null; /** * Specific document type classification. Field included by default. */ document_type?: string | null; /** * Document domain classification. Field included by default. */ domain?: string | null; /** * Error message if extraction failed or had issues. Field included by default. */ error_message?: string | null; /** * Field included by default. */ extracted_fields?: { [key: string]: unknown; } | null; /** * Time spent on field mapping (string + semantic matching). Field included by default. */ field_mapping_time_ms?: number | null; /** * Per-field extraction status. Keys are dot-notation field paths. Values: extracted, failed, inferred, pending, retried */ field_status?: { [key: string]: unknown; } | null; /** * Image height in pixels (for image documents) */ image_height?: number | null; /** * Image width in pixels (for image documents) */ image_width?: number | null; /** * Line count of extracted text */ line_count?: number | null; /** * Time spent on LLM field extraction. Field included by default. */ llm_extraction_time_ms?: number | null; /** * Municipality extracted from document. Field included by default. */ municipality?: string | null; ocr_blocks?: Array<{ [key: string]: unknown; }> | null; /** * Time spent on OCR/text extraction (DocTriage or LlamaParse). Field included by default. */ ocr_extraction_time_ms?: number | null; /** * Field included by default. */ processing_time_ms?: number | null; /** * Tabular row data for CSV/spreadsheet extractions. Each element is a JSON object keyed by column name. */ rows?: Array<{ [key: string]: unknown; }> | null; schema_id?: string | null; /** * Schema revision number used for this extraction. Field included by default. */ schema_revision?: number | null; /** * The version of the schema/agent used for this extraction. Field included by default. */ schema_version?: string | null; /** * State/province code. Field included by default. */ state?: string | null; /** * Field included by default. */ status: "pending" | "completed" | "failed"; /** * Field included by default. */ summary?: { [key: string]: unknown; } | null; /** * Field included by default. */ used_training_example_ids?: Array | null; /** * Word count of extracted text */ word_count?: number | null; }; id: string; /** * A relationships object for a extraction-result */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a voice-transcription-result */ export type VoiceTranscriptionResult = { /** * An attributes object for a voice-transcription-result */ attributes?: { /** * Extraction document if from audio file upload. Field included by default. */ document_id?: string | null; /** * Field included by default. */ duration_seconds?: number | null; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ language_detected?: string | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ processing_seconds?: number | null; /** * Field included by default. */ recording_id?: string | null; /** * Timestamped segments with confidence. Field included by default. */ segments?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ session_id?: string | null; /** * candle or whisper-rs. Field included by default. */ stt_engine?: string | null; /** * large-v3, medium, base. Field included by default. */ stt_model?: string | null; /** * Full transcript text. Field included by default. */ text: string; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a voice-transcription-result */ relationships?: { recording?: { /** * An identifier for recording */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; session?: { /** * An identifier for session */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a webhook-delivery */ export type WebhookDelivery = { /** * An attributes object for a webhook-delivery */ attributes?: { /** * Field included by default. */ attempt_count?: number | null; /** * Field included by default. */ event_type?: string | null; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ next_retry_at?: unknown; /** * Field included by default. */ payload: { [key: string]: unknown; }; /** * Field included by default. */ request_headers?: { [key: string]: unknown; } | null; /** * Field included by default. */ response_body?: string | null; /** * Field included by default. */ response_status?: number | null; /** * Field included by default. */ status?: "pending" | "success" | "failed" | "retrying"; /** * Field included by default. */ updated_at: unknown; /** * Field included by default. */ url: string; /** * Field included by default. */ webhook_config_id: string; }; id: string; /** * A relationships object for a webhook-delivery */ relationships?: { webhook_config?: { /** * An identifier for webhook_config */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a clinical-goal-template-category */ export type ClinicalGoalTemplateCategory = { /** * An attributes object for a clinical-goal-template-category */ attributes?: { /** * Field included by default. */ template_count: number; }; id: string; /** * A relationships object for a clinical-goal-template-category */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a platform-tone */ export type PlatformTone = { /** * An attributes object for a platform-tone */ attributes?: { /** * Field included by default. */ brand_identity_id: string; /** * Field included by default. */ call_to_action?: string | null; /** * Field included by default. */ custom_instructions?: string | null; /** * Field included by default. */ emoji_policy: "none" | "minimal" | "moderate" | "heavy"; /** * Field included by default. */ hashtag_count: number; /** * Field included by default. */ max_length?: number | null; /** * Field included by default. */ platform: "facebook" | "instagram" | "threads" | "twitter" | "linkedin" | "reddit" | "bluesky"; /** * Field included by default. */ tone: "casual" | "professional" | "humorous" | "inspirational" | "educational" | "promotional"; }; id: string; /** * A relationships object for a platform-tone */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a support-queue-member */ export type SupportQueueMember = { /** * An attributes object for a support-queue-member */ attributes?: { /** * Field included by default. */ is_available: boolean; /** * Field included by default. */ max_concurrent_tickets: number; /** * Field included by default. */ role: "agent" | "lead" | "supervisor"; /** * Field included by default. */ user_id: string; }; id: string; /** * A relationships object for a support-queue-member */ relationships?: { [key: string]: never; }; type: string; }; export type ExtractionWorkflowStepsInputCreateType = { /** * Static agent UUID for classify/extract/validate steps */ agent_id?: string | null; /** * How to resolve the agent. :from_classifier uses classifier output's recommended_agent_id */ agent_source?: "static" | "from_classifier" | "from_previous"; /** * Step-type-specific configuration: * route: %{"conditions" => [%{"field" => "step.key", "op" => "gte"|"lt"|"eq", "value" => term, "goto" => "step_name"}], "default" => "step_name"} * human_review: %{"fields" => [string], "timeout_hours" => integer, "fallback" => "step_name"} * validate: %{"on_failure" => "flag_for_review"|"goto", "goto_step" => "step_name", "max_retries" => integer} * enrich: %{"tools" => [string], "fields" => [string]} * transform: %{"transforms" => [%{"field" => string, "format" => string}]} * webhook: %{"url" => string, "timeout_ms" => integer, "headers" => map} * group_into_case: %{"case_type_slug" => string, "on_no_match" => "create_new"|"flag_for_review"|"skip"} * */ config?: { [key: string]: unknown; } | null; /** * Unique name for this step within the workflow, used for routing references */ name: string; /** * Execution order within the workflow (ascending) */ order?: number | null; /** * Named outputs this step produces, referenceable by later steps via 'step_name.output_key' */ outputs?: Array | null; /** * Execution type — determines which WorkflowRunner handler is invoked */ type: "classify" | "route" | "extract" | "validate" | "enrich" | "human_review" | "transform" | "webhook" | "group_into_case"; }; /** * A "Resource object" representing a wallet */ export type Wallet = { /** * An attributes object for a wallet */ attributes?: { /** * Field included by default. */ accounts?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ addons?: Array<{ [key: string]: unknown; }> | null; /** * Optional application context - wallets belong to tenants, not applications. Field included by default. */ application_id?: string | null; /** * Amount in credits. Field included by default. */ auto_top_up_amount?: number | null; /** * Field included by default. */ auto_top_up_enabled: boolean; /** * Threshold in credits. Field included by default. */ auto_top_up_threshold?: number | null; /** * Whether this tenant uses credit-based or seat-based billing. Field included by default. */ billing_mode: "credits" | "seats"; /** * Field included by default. */ credits: number; /** * Field included by default. */ credits_free?: number | null; /** * Field included by default. */ credits_paid?: number | null; /** * Total promotional credits ever allocated to this tenant. Field included by default. */ credits_promotional_allocated?: number | null; /** * Total purchased credits ever allocated to this tenant. Field included by default. */ credits_purchased_allocated?: number | null; /** * Field included by default. */ credits_subscription?: number | null; /** * Total subscription credits ever allocated to this tenant. Field included by default. */ credits_subscription_allocated?: number | null; /** * Field included by default. */ payment_methods?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ pinned_at?: string | null; /** * Field included by default. */ plan_id?: string | null; /** * Field included by default. */ plan_revision_id?: string | null; /** * Field included by default. */ plan_slug?: string | null; /** * Field included by default. */ plan_snapshot?: { [key: string]: unknown; } | null; /** * Seats included in the plan bundle (nil for credit-based). Field included by default. */ seats_included?: number | null; /** * Extra seats beyond the plan bundle. Field included by default. */ seats_overage?: number | null; /** * Current overage cost (overage_seats * overage_seat_price). Field included by default. */ seats_overage_cost?: { amount: string; currency: string; } | null | unknown; /** * Current seat usage (members + pending invitations). Field included by default. */ seats_used?: number | null; /** * Field included by default. */ storage_quota_bytes: number; /** * Field included by default. */ storage_used_bytes: number; /** * Daily usage history entries. Field included by default. */ usage_history?: Array<{ [key: string]: unknown; }> | null; /** * Storage breakdown by workspace (Top 3 + Others). Field included by default. */ workspace_storage?: Array<{ [key: string]: unknown; }> | null; /** * Usage breakdown by workspace (Top 3 + Others). Field included by default. */ workspace_usage?: Array<{ [key: string]: unknown; }> | null; }; id: string; /** * A relationships object for a wallet */ relationships?: { plan?: { /** * An identifier for plan */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a clinical-document */ export type ClinicalDocument = { /** * An attributes object for a clinical-document */ attributes?: { /** * Field included by default. */ contact_id?: string | null; /** * Field included by default. */ document_type: string; /** * Field included by default. */ expires_at?: unknown; /** * Field included by default. */ extracted_entity_ids: Array; /** * Field included by default. */ extraction_status: "pending" | "processing" | "completed" | "failed" | "skipped"; /** * Field included by default. */ import_id?: string | null; /** * Field included by default. */ patient_id: string; /** * Field included by default. */ source_date?: string | null; /** * Field included by default. */ source_platform: string; /** * Field included by default. */ storage_file_id: string; /** * Field included by default. */ title: string; }; id: string; /** * A relationships object for a clinical-document */ relationships?: { patient?: { /** * An identifier for patient */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; export type InvoicesInvoiceBillingAddressInputUpdateType = { city?: string | null; /** * ISO 3166-1 alpha-2 country code */ country?: string | null; line1?: string | null; line2?: string | null; postal_code?: string | null; state?: string | null; }; /** * A "Resource object" representing a email-marketing-sender-profile */ export type EmailMarketingSenderProfile = { /** * An attributes object for a email-marketing-sender-profile */ attributes?: { /** * Field included by default. */ address?: string | null; /** * Field included by default. */ company?: string | null; /** * Field included by default. */ dkim_selector?: string | null; /** * Field included by default. */ dkim_valid?: boolean | null; /** * Field included by default. */ dmarc_valid?: boolean | null; /** * Field included by default. */ dns_validated?: boolean | null; /** * Field included by default. */ dns_validated_at?: unknown; /** * Field included by default. */ email: string; /** * Field included by default. */ is_default?: boolean | null; /** * Field included by default. */ name: string; /** * Field included by default. */ phone?: string | null; /** * Field included by default. */ signature?: string | null; /** * Field included by default. */ spf_valid?: boolean | null; }; id: string; /** * A relationships object for a email-marketing-sender-profile */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a system-message */ export type SystemMessage = { /** * An attributes object for a system-message */ attributes?: { /** * Markdown content. Field included by default. */ content: string; /** * Field included by default. */ is_active: boolean; /** * Field included by default. */ published_at?: unknown; /** * For ToS: forces users to re-accept even if they accepted a previous version. Field included by default. */ requires_acceptance: boolean; /** * Field included by default. */ title: string; /** * Field included by default. */ type: "tos" | "privacy_policy" | "welcome" | "announcement"; /** * Field included by default. */ version: string; }; id: string; /** * A relationships object for a system-message */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a data-protection-impact-assessment */ export type DataProtectionImpactAssessment = { /** * An attributes object for a data-protection-impact-assessment */ attributes?: { /** * Field included by default. */ approved_at?: unknown; /** * Field included by default. */ approved_by?: string | null; /** * Email or name of the person conducting the assessment. Field included by default. */ assessor?: string | null; /** * Field included by default. */ description: string; /** * Field included by default. */ findings?: string | null; /** * Field included by default. */ mitigations?: string | null; /** * Optional link to ProcessingActivity record. Field included by default. */ processing_activity_id?: string | null; /** * Field included by default. */ risk_level: "low" | "medium" | "high" | "critical"; /** * Field included by default. */ status: "draft" | "in_review" | "approved" | "rejected"; /** * Field included by default. */ title: string; }; id: string; /** * A relationships object for a data-protection-impact-assessment */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a credit-package */ export type CreditPackage = { /** * An attributes object for a credit-package */ attributes?: { /** * Field included by default. */ application_id: string; /** * Field included by default. */ credits: number; /** * Field included by default. */ name: string; /** * Field included by default. */ price: { amount: string; currency: string; }; /** * Field included by default. */ slug: string; }; id: string; /** * A relationships object for a credit-package */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a notification-log */ export type NotificationLog = { /** * An attributes object for a notification-log */ attributes?: { /** * Field included by default. */ application_id?: string | null; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ recipient: string; /** * Field included by default. */ status?: "sent" | "failed" | "delivered" | "bounced"; /** * Field included by default. */ subject?: string | null; /** * Field included by default. */ type: string; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a notification-log */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a recipes-shopping-list */ export type RecipesShoppingList = { /** * An attributes object for a recipes-shopping-list */ attributes?: { /** * Field included by default. */ contact_id?: string | null; /** * Field included by default. */ meal_schedule_id?: string | null; /** * Field included by default. */ name: string; /** * Field included by default. */ status: "draft" | "active" | "completed"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a recipes-shopping-list */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a catalog-taxonomy-node */ export type CatalogTaxonomyNode = { /** * An attributes object for a catalog-taxonomy-node */ attributes?: { /** * Field included by default. */ description?: string | null; /** * Field included by default. */ name: string; /** * Field included by default. */ path?: string | null; /** * Field included by default. */ position?: number | null; /** * Field included by default. */ slug: string; }; id: string; /** * A relationships object for a catalog-taxonomy-node */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a support-queue */ export type SupportQueue = { /** * An attributes object for a support-queue */ attributes?: { /** * Field included by default. */ ai_agent_id?: string | null; /** * Field included by default. */ ai_mode: "ai_first" | "human_first" | "ai_only"; /** * Field included by default. */ business_hours?: { [key: string]: unknown; } | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ is_default: boolean; /** * Field included by default. */ name: string; /** * Field included by default. */ priority_boost: number; /** * Field included by default. */ type: "external" | "internal" | "mixed"; }; id: string; /** * A relationships object for a support-queue */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a content-generation */ export type ContentGeneration = { /** * An attributes object for a content-generation */ attributes?: { [key: string]: never; }; id: string; /** * A relationships object for a content-generation */ relationships?: { [key: string]: never; }; type: string; }; export type SchedulingAvailabilityRuleDateOverridesInputUpdateType = { date?: string | null; windows?: Array | null; }; export type ApplicationOauthInputCreateType = { /** * Allowed OAuth callback URLs for this application */ callback_urls?: Array | null; /** * Default callback URL if not specified in request */ default_callback_url?: string | null; /** * Which OAuth providers are enabled for this app */ enabled_providers?: Array<"google" | "github" | "salesforce" | "microsoft"> | null; /** * Custom GitHub OAuth client ID (optional) */ github_client_id?: string | null; /** * Custom GitHub OAuth client secret (optional) */ github_client_secret?: string | null; /** * Custom Google OAuth client ID (optional) */ google_client_id?: string | null; /** * Custom Google OAuth client secret (optional) */ google_client_secret?: string | null; /** * Custom Microsoft OAuth client ID (optional) */ microsoft_client_id?: string | null; /** * Custom Microsoft OAuth client secret (optional) */ microsoft_client_secret?: string | null; }; export type ExtractionWorkflowStepsInputUpdateType = { /** * Static agent UUID for classify/extract/validate steps */ agent_id?: string | null; /** * How to resolve the agent. :from_classifier uses classifier output's recommended_agent_id */ agent_source?: "static" | "from_classifier" | "from_previous"; /** * Step-type-specific configuration: * route: %{"conditions" => [%{"field" => "step.key", "op" => "gte"|"lt"|"eq", "value" => term, "goto" => "step_name"}], "default" => "step_name"} * human_review: %{"fields" => [string], "timeout_hours" => integer, "fallback" => "step_name"} * validate: %{"on_failure" => "flag_for_review"|"goto", "goto_step" => "step_name", "max_retries" => integer} * enrich: %{"tools" => [string], "fields" => [string]} * transform: %{"transforms" => [%{"field" => string, "format" => string}]} * webhook: %{"url" => string, "timeout_ms" => integer, "headers" => map} * group_into_case: %{"case_type_slug" => string, "on_no_match" => "create_new"|"flag_for_review"|"skip"} * */ config?: { [key: string]: unknown; } | null; /** * Unique name for this step within the workflow, used for routing references */ name?: string | null; /** * Execution order within the workflow (ascending) */ order?: number | null; /** * Named outputs this step produces, referenceable by later steps via 'step_name.output_key' */ outputs?: Array | null; /** * Execution type — determines which WorkflowRunner handler is invoked */ type?: "classify" | "route" | "extract" | "validate" | "enrich" | "human_review" | "transform" | "webhook" | "group_into_case"; }; /** * A "Resource object" representing a recipes-shopping-list-item */ export type RecipesShoppingListItem = { /** * An attributes object for a recipes-shopping-list-item */ attributes?: { /** * Field included by default. */ checked?: boolean | null; /** * Field included by default. */ food_group?: string | null; /** * Field included by default. */ name: string; /** * Field included by default. */ shopping_list_id: string; /** * Field included by default. */ total_quantity?: number | null; /** * Field included by default. */ unit?: string | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a recipes-shopping-list-item */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a form-publication */ export type FormPublication = { /** * An attributes object for a form-publication */ attributes?: { /** * Field included by default. */ abandonment_threshold_days: number; /** * Field included by default. */ access_mode: "public" | "token_gated" | "authenticated" | "signed_embed"; /** * Field included by default. */ allowed_origins: Array; /** * When true, submissions auto-enqueue into the workspace's Reviews queue and require human approval before downstream effects fire. Requires :forms_approval_workflow capability. Field included by default. */ approval_required: boolean; /** * Field included by default. */ captcha_provider: "none" | "turnstile"; /** * Field included by default. */ compliance_mode: "standard" | "hipaa"; /** * When true, ISVs can drive Submission filling through `PublicRuntime.start_fill_session/3` + `send_fill_message/4`. Requires :forms_conversational_fill capability. Field included by default. */ conversational_fill_enabled: boolean; /** * Field included by default. */ data_retention_days: number; /** * Field included by default. */ detect_pii: boolean; /** * When false, suppresses engine trace and routing value from runtime HTTP responses for confidential screeners. Field included by default. */ disclose_logic_trace: boolean; /** * Field included by default. */ expires_at?: unknown; /** * Idle threshold (seconds) after which `Forms.Workers.FillSessionPurgeWorker` closes a session. Default 1800s = 30 min. Field included by default. */ fill_session_idle_timeout_seconds: number; /** * Maximum turn pairs per FillSession. Hitting cap closes session with reason :turn_cap_reached. Default 50. Field included by default. */ fill_session_max_turns: number; /** * Field included by default. */ form_id: string; /** * Field included by default. */ form_version_id?: string | null; /** * Field included by default. */ honeypot_enabled: boolean; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ max_file_size_bytes: number; /** * Field included by default. */ max_file_uploads: number; /** * Field included by default. */ max_submission_bytes: number; /** * Minimum elapsed milliseconds between draft creation and submit. Bot-defense timestamp check; 0 disables. Field included by default. */ min_submit_delay_ms: number; /** * Capability gate for PCI payment_ref fields. Defaults to false; only flipped true after platform SAQ-D certification per publication. Field included by default. */ payment_enabled: boolean; /** * Field included by default. */ public_key_jwk?: { [key: string]: unknown; } | null; /** * Field included by default. */ rate_limit_autosaves_per_ip_per_hour: number; /** * Field included by default. */ rate_limit_per_ip_per_hour: number; /** * Field included by default. */ rate_limit_submissions_per_publication_per_hour: number; /** * Optional per-publication Reviews queue override. When nil, the workspace's default review queue is used. Field included by default. */ review_queue_id?: string | null; /** * Field included by default. */ revoked_at?: unknown; /** * When true, completed submissions are vectorized into the shared embeddings store and Forms.semantic_search_submissions/3 returns ranked results. Requires :forms_semantic_search capability. Field included by default. */ semantic_search_enabled: boolean; /** * Field included by default. */ slug: string; /** * Field included by default. */ updated_at: unknown; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a form-publication */ relationships?: { form?: { /** * An identifier for form */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; form_version?: { /** * An identifier for form_version */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; workspace?: { /** * An identifier for workspace */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a form-version */ export type FormVersion = { /** * An attributes object for a form-version */ attributes?: { /** * Field included by default. */ assistant_agent_version_id?: string | null; /** * Field included by default. */ assistant_id?: string | null; /** * Field included by default. */ changes_summary?: string | null; /** * Field included by default. */ compliance_mode: "standard" | "hipaa"; /** * Field included by default. */ consent_required: boolean; /** * Field included by default. */ created_at: unknown; /** * Field included by default. */ custom_css?: string | null; /** * Field included by default. */ form_id: string; /** * Field included by default. */ is_active: boolean; /** * Field included by default. */ layout_tree: { [key: string]: unknown; }; /** * Field included by default. */ logic_rules: { [key: string]: unknown; }; /** * Field included by default. */ output_schema: { [key: string]: unknown; }; /** * Field included by default. */ published_at?: unknown; /** * Field included by default. */ published_by_id?: string | null; /** * Field included by default. */ revision: number; /** * Field included by default. */ theme_id?: string | null; /** * Field included by default. */ theme_overrides: { [key: string]: unknown; }; /** * Field included by default. */ theme_version_pinned?: number | null; /** * Field included by default. */ tokens_snapshot: { [key: string]: unknown; }; /** * Field included by default. */ updated_at: unknown; /** * Field included by default. */ version_number: number; }; id: string; /** * A relationships object for a form-version */ relationships?: { form?: { /** * An identifier for form */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; theme?: { /** * An identifier for theme */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a recipes-recipe-nutrition */ export type RecipesRecipeNutrition = { /** * An attributes object for a recipes-recipe-nutrition */ attributes?: { /** * Field included by default. */ calories?: number | null; /** * Field included by default. */ carbs_g?: number | null; /** * Field included by default. */ fat_g?: number | null; /** * Field included by default. */ fiber_g?: number | null; /** * Field included by default. */ full_nutrients?: { [key: string]: unknown; } | null; /** * Field included by default. */ protein_g?: number | null; /** * Field included by default. */ recipe_id: string; /** * Field included by default. */ sodium_mg?: number | null; /** * Field included by default. */ source: "computed" | "external" | "manual"; /** * Field included by default. */ sugar_g?: number | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a recipes-recipe-nutrition */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a data-store-record */ export type DataStoreRecord = { /** * An attributes object for a data-store-record */ attributes?: { /** * Field included by default. */ content_type?: string | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ namespace: string; /** * Field included by default. */ record_key: string; /** * Time-to-live in seconds for automatic expiration. Field included by default. */ ttl_seconds?: number | null; /** * Field included by default. */ value?: { [key: string]: unknown; } | null; /** * Field included by default. */ version?: number | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a data-store-record */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a email-unsubscriber */ export type EmailUnsubscriber = { /** * An attributes object for a email-unsubscriber */ attributes?: { /** * Field included by default. */ campaign_ref_id?: string | null; /** * Field included by default. */ email: string; /** * Field included by default. */ scope?: "campaign" | "global"; /** * Field included by default. */ source?: "campaign" | "complaint" | "direct" | "link" | "manual"; }; id: string; /** * A relationships object for a email-unsubscriber */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a contract */ export type Contract = { /** * An attributes object for a contract */ attributes?: { /** * Field included by default. */ auto_renewal: boolean; /** * Plain-text contract body (used by ClauseExtractor). Field included by default. */ body_text?: string | null; /** * Field included by default. */ clauses_extracted_at?: unknown; /** * Field included by default. */ counterparty_name?: string | null; /** * Field included by default. */ custom_fields: { [key: string]: unknown; }; /** * Field included by default. */ end_date?: string | null; /** * Field included by default. */ external_url?: string | null; /** * Field included by default. */ last_synced_at?: unknown; /** * Field included by default. */ renewal_date?: string | null; /** * Field included by default. */ renewal_notice_days?: number | null; /** * Field included by default. */ source_id: string; /** * Field included by default. */ source_system: "salesforce" | "hubspot" | "manual"; /** * Field included by default. */ start_date?: string | null; /** * Field included by default. */ status: "draft" | "active" | "expired" | "terminated" | "renewed"; /** * Field included by default. */ title: string; /** * Field included by default. */ total_value_amount?: string | null; /** * Field included by default. */ total_value_currency?: string | null; }; id: string; /** * A relationships object for a contract */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a tenant-stats */ export type TenantStats = { /** * An attributes object for a tenant-stats */ attributes?: { /** * Field included by default. */ credits: { [key: string]: unknown; }; /** * Field included by default. */ documents: { [key: string]: unknown; }; /** * Field included by default. */ failed: { [key: string]: unknown; }; /** * Field included by default. */ files: { [key: string]: unknown; }; /** * Field included by default. */ success: { [key: string]: unknown; }; /** * Field included by default. */ tenant_id: string; }; id: string; /** * A relationships object for a tenant-stats */ relationships?: { tenant?: { /** * An identifier for tenant */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a support-ticket-attachment */ export type SupportTicketAttachment = { /** * An attributes object for a support-ticket-attachment */ attributes?: { /** * Field included by default. */ content_type?: string | null; /** * Field included by default. */ filename: string; /** * Field included by default. */ size_bytes?: number | null; /** * Field included by default. */ storage_path: string; }; id: string; /** * A relationships object for a support-ticket-attachment */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a invoices-payment */ export type InvoicesPayment = { /** * An attributes object for a invoices-payment */ attributes?: { /** * Field included by default. */ amount: string; /** * Field included by default. */ currency: string; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ method?: "bank_transfer" | "card" | "check" | "cash" | "crypto" | "other"; /** * Field included by default. */ notes?: string | null; /** * Field included by default. */ paid_at: unknown; /** * Field included by default. */ provider?: "qorpay" | "stripe" | "manual"; /** * Field included by default. */ provider_transaction_id?: string | null; /** * Field included by default. */ reference?: string | null; }; id: string; /** * A relationships object for a invoices-payment */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a portal-invitation */ export type PortalInvitation = { /** * An attributes object for a portal-invitation */ attributes?: { /** * Field included by default. */ accepted_at?: unknown; /** * Field included by default. */ email: string; /** * Field included by default. */ expires_at: unknown; }; id: string; /** * A relationships object for a portal-invitation */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a cde-scope-report */ export type CdeScopeReport = { /** * An attributes object for a cde-scope-report */ attributes?: { /** * Field included by default. */ assessor_notes?: string | null; /** * Field included by default. */ data_flow_map: { [key: string]: unknown; }; /** * Field included by default. */ generated_at: unknown; /** * Field included by default. */ scope_boundary: "in_scope" | "out_of_scope" | "connected"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a cde-scope-report */ relationships?: { [key: string]: never; }; type: string; }; export type CaseTypeRoutingRulesInputUpdateType = { default_queue_id?: string | null; overrides?: unknown | Array<{ queue_id: string; when?: { [key: string]: unknown; } | unknown; }> | Array<{ queue_id?: string | unknown; when?: { [key: string]: unknown; } | unknown; }>; }; /** * A "Resource object" representing a workspace-preference */ export type WorkspacePreference = { /** * An attributes object for a workspace-preference */ attributes?: { /** * Field included by default. */ context_key: string; /** * Field included by default. */ preferences: { [key: string]: unknown; }; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a workspace-preference */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a email-outbound-email */ export type EmailOutboundEmail = { /** * An attributes object for a email-outbound-email */ attributes?: { /** * Field included by default. */ ai_generated?: boolean | null; /** * Field included by default. */ attachments?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ body_html?: string | null; /** * Field included by default. */ body_text?: string | null; /** * Field included by default. */ contact_ref_id?: string | null; /** * Field included by default. */ context_ref_id?: string | null; /** * Field included by default. */ context_ref_type?: "custom" | "deal" | "session" | "ticket"; /** * Field included by default. */ error_message?: string | null; /** * Field included by default. */ include_unsubscribe_link?: boolean | null; /** * Field included by default. */ scheduled_for?: unknown; /** * Field included by default. */ sent_at?: unknown; /** * Field included by default. */ sent_via?: "gmail" | "outlook" | "smtp"; /** * Field included by default. */ source?: "agent" | "campaign" | "direct"; /** * Field included by default. */ status: "draft" | "failed" | "ready" | "scheduled" | "sent"; /** * Field included by default. */ subject: string; }; id: string; /** * A relationships object for a email-outbound-email */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a crawler-site-config */ export type CrawlerSiteConfig = { /** * An attributes object for a crawler-site-config */ attributes?: { [key: string]: never; }; id: string; /** * A relationships object for a crawler-site-config */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a social-campaign */ export type SocialCampaign = { /** * An attributes object for a social-campaign */ attributes?: { /** * Field included by default. */ brand_identity_id?: string | null; /** * Field included by default. */ content_brief?: string | null; /** * Field included by default. */ master_copy?: string | null; /** * Field included by default. */ media_urls?: Array | null; /** * Field included by default. */ name: string; /** * Field included by default. */ published_at?: unknown; /** * Field included by default. */ scheduled_at?: unknown; /** * Field included by default. */ seo_enhanced_at?: unknown; /** * Field included by default. */ seo_keywords?: Array | null; /** * Field included by default. */ status?: "draft" | "generating" | "review" | "scheduled" | "publishing" | "completed" | "cancelled"; /** * Field included by default. */ target_platforms?: Array | null; }; id: string; /** * A relationships object for a social-campaign */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a tenant-document-stats */ export type TenantDocumentStats = { /** * An attributes object for a tenant-document-stats */ attributes?: { /** * Field included by default. */ completed?: number | null; /** * Field included by default. */ failed?: number | null; /** * Field included by default. */ processing?: number | null; /** * Field included by default. */ queued?: number | null; /** * Field included by default. */ tenant_id: string; /** * Field included by default. */ total?: number | null; }; id: string; /** * A relationships object for a tenant-document-stats */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a chat-message */ export type ChatMessage = { /** * An attributes object for a chat-message */ attributes?: { /** * Field included by default. */ content: string; /** * Field included by default. */ created_at: unknown; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ role: "user" | "assistant" | "system" | "tool"; /** * Field included by default. */ thread_id: string; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a chat-message */ relationships?: { message_feedback?: { /** * Relationship data for message_feedback */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; thread?: { /** * An identifier for thread */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a ledger */ export type Ledger = { /** * An attributes object for a ledger */ attributes?: { /** * Amount of credits changed (positive integer). Field included by default. */ amount: number; /** * Field included by default. */ application_id?: string | null; /** * Field included by default. */ balance_after: number; /** * Field included by default. */ balance_before: number; /** * Field included by default. */ description?: string | null; /** * Optional metadata including api_key_id for tracking source. Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ operation: "topup" | "subscription" | "usage" | "expiry" | "refund" | "adjustment" | "storage" | "overdraft" | "promotional" | "wholesale_royalty" | "general" | "conversational" | "rag" | "training" | "field_mapping" | "extraction" | "ephemeral_extraction_base" | "analysis" | "communication" | "social" | "voice_transcription" | "voice_synthesis" | "invoicing" | "connector_tool_execution" | "email_inbound" | "agent_execution_step" | "agent_tool_call" | "agent_delegation" | "crm_data_export" | "knowledge_file_ingest" | "knowledge_chunk_embed" | "forms_generation" | "crawler" | "platform_metering"; /** * Field included by default. */ type: "credit" | "debit"; }; id: string; /** * A relationships object for a ledger */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a transaction-history */ export type TransactionHistory = { /** * An attributes object for a transaction-history */ attributes?: { /** * Transaction amount in cents or credits. Field included by default. */ amount: number; /** * Field included by default. */ created_at: unknown; /** * Field included by default. */ currency?: string | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ service_id?: string | null; /** * Field included by default. */ status: "pending" | "success" | "failed" | "refunded" | "voided"; /** * Field included by default. */ type?: "sale" | "auth" | "refund" | "void"; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a transaction-history */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a ephi-data-flow */ export type EphiDataFlow = { /** * An attributes object for a ephi-data-flow */ attributes?: { /** * Field included by default. */ application_id: string; /** * Categories of PHI flowing between assets. Field included by default. */ data_categories: Array; /** * Field included by default. */ description?: string | null; /** * Soft ref to destination EphiAsset — NOT a DB FK. Field included by default. */ destination_asset_id: string; /** * Field included by default. */ encryption: "encrypted" | "unencrypted" | "partial"; /** * Field included by default. */ flow_type: "api_call" | "database_replication" | "file_transfer" | "event_stream" | "user_access"; /** * Field included by default. */ frequency: "real_time" | "batch_daily" | "on_demand" | "scheduled"; /** * Field included by default. */ is_active: boolean; /** * Transport protocol (e.g., HTTPS/TLS 1.3). Field included by default. */ protocol?: string | null; /** * Soft ref to source EphiAsset — NOT a DB FK. Field included by default. */ source_asset_id: string; }; id: string; /** * A relationships object for a ephi-data-flow */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a crm-company */ export type CrmCompany = { /** * An attributes object for a crm-company */ attributes?: { /** * Field included by default. */ annual_revenue?: string | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ domain?: string | null; /** * Field included by default. */ employee_count?: number | null; /** * Field included by default. */ external_owner_id?: string | null; /** * Field included by default. */ founded_date?: string | null; /** * Field included by default. */ industry?: string | null; /** * Field included by default. */ lifecycle_stage?: "lead" | "marketing_qualified" | "sales_qualified" | "opportunity" | "customer" | "evangelist" | "churned" | "discharged"; /** * Field included by default. */ location?: string | null; /** * Field included by default. */ name: string; /** * Field included by default. */ owner_id?: string | null; primary_email?: string | null; primary_phone?: string | null; /** * Field included by default. */ properties?: { [key: string]: unknown; } | null; /** * Field included by default. */ source?: "manual" | "import" | "channel" | "connector" | "ai_extracted" | "api"; /** * VAT/EIN for invoicing cross-domain use. Field included by default. */ tax_id?: string | null; /** * Field included by default. */ type?: "public" | "private" | "nonprofit" | "government" | "partnership" | "other"; }; id: string; /** * A relationships object for a crm-company */ relationships?: { [key: string]: never; }; type: string; }; export type SchedulingEventLocationInputUpdateType = { address?: string | null; instructions?: string | null; latitude?: number | null; longitude?: number | null; name?: string | null; type?: "in_person" | "video" | "phone" | "custom_url"; url?: string | null; }; /** * A "Resource object" representing a review-queue-membership */ export type ReviewQueueMembership = { /** * An attributes object for a review-queue-membership */ attributes?: { /** * Field included by default. */ added_at: unknown; /** * Field included by default. */ membership_role: "member" | "supervisor"; /** * Field included by default. */ queue_id: string; /** * Field included by default. */ user_id: string; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a review-queue-membership */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-practice-resource-category */ export type ClinicalPracticeResourceCategory = { /** * An attributes object for a clinical-practice-resource-category */ attributes?: { /** * Field included by default. */ resource_count: number; }; id: string; /** * A relationships object for a clinical-practice-resource-category */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-intake-target */ export type ClinicalIntakeTarget = { /** * An attributes object for a clinical-intake-target */ attributes?: { /** * Field included by default. */ hydration_ml: string; /** * Field included by default. */ sex: "male" | "female"; /** * Field included by default. */ carbs_pct: number; is_archived?: boolean | null; /** * Field included by default. */ tdee: string; /** * Field included by default. */ goal_direction: "lose" | "maintain" | "gain"; /** * Field included by default. */ meals_per_day: number; /** * Field included by default. */ condition_rules: Array; /** * Field included by default. */ weight_kg: string; /** * Field included by default. */ fat_grams: string; /** * Field included by default. */ carbs_grams: string; /** * Field included by default. */ rate_lbs_per_week?: string | null; /** * Field included by default. */ bmr: string; /** * Field included by default. */ protein_g_per_kg?: string | null; /** * Field included by default. */ weight_used_kg: string; /** * Field included by default. */ activity_level: "sedentary" | "lightly_active" | "moderately_active" | "very_active" | "extremely_active"; /** * Field included by default. */ calorie_adjustment: number; /** * Field included by default. */ height_cm: string; /** * Field included by default. */ simple_carbs_pct?: number | null; /** * Field included by default. */ snacks_per_day: number; /** * Field included by default. */ vegetables_pct?: number | null; /** * Field included by default. */ weight_method: "actual" | "ideal" | "adjusted"; /** * Field included by default. */ protein_pct: number; /** * Field included by default. */ protein_grams: string; /** * Field included by default. */ is_active: boolean; /** * Field included by default. */ patient_id: string; /** * Field included by default. */ target_calories: number; /** * Field included by default. */ fruit_pct?: number | null; /** * Field included by default. */ metadata: { [key: string]: unknown; }; /** * Field included by default. */ macro_mode: "percentage" | "body_weight_protein" | "hybrid"; /** * Field included by default. */ fat_pct: number; notes?: string | null; /** * Field included by default. */ age: number; }; id: string; /** * A relationships object for a clinical-intake-target */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a support-ai-config */ export type SupportAiConfig = { /** * An attributes object for a support-ai-config */ attributes?: { /** * Field included by default. */ auto_classify: boolean; /** * Field included by default. */ auto_create_crm_contact: boolean; /** * Field included by default. */ auto_draft: boolean; /** * Field included by default. */ classification_model?: string | null; /** * Field included by default. */ confidence_threshold: number; /** * Field included by default. */ draft_model?: string | null; /** * Field included by default. */ sentiment_tracking: boolean; }; id: string; /** * A relationships object for a support-ai-config */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-practice-tool */ export type ClinicalPracticeTool = { /** * An attributes object for a clinical-practice-tool */ attributes?: { /** * Field included by default. */ app_store_url?: string | null; /** * Field included by default. */ category?: string | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ icon_url?: string | null; /** * Field included by default. */ integrations: Array; /** * Field included by default. */ is_active: boolean; is_archived?: boolean | null; is_catalog?: boolean | null; /** * Field included by default. */ logo_url?: string | null; /** * Field included by default. */ metadata: { [key: string]: unknown; }; /** * Field included by default. */ name: string; /** * Field included by default. */ platform?: string | null; /** * Field included by default. */ play_store_url?: string | null; /** * Field included by default. */ pricing_model?: "free" | "freemium" | "paid" | "prescription"; /** * Field included by default. */ privacy_rating: "hipaa_compliant" | "hipaa_partial" | "standard" | "unknown"; /** * Field included by default. */ rating?: string | null; /** * Field included by default. */ source_catalog_id?: string | null; /** * Field included by default. */ supported_platforms: Array; /** * Field included by default. */ tags: Array; /** * Field included by default. */ tool_type: string; /** * Field included by default. */ url?: string | null; /** * Field included by default. */ website_url?: string | null; }; id: string; /** * A relationships object for a clinical-practice-tool */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a catalog-view-rule */ export type CatalogViewRule = { /** * An attributes object for a catalog-view-rule */ attributes?: { /** * Field included by default. */ field: string; /** * Field included by default. */ group: number; /** * Field included by default. */ operator: "equals" | "not_equals" | "in" | "not_in" | "gt" | "lt" | "between" | "contains"; /** * Field included by default. */ value?: string | null; }; id: string; /** * A relationships object for a catalog-view-rule */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a permission-preset */ export type PermissionPreset = { /** * An attributes object for a permission-preset */ attributes?: { /** * Field included by default. */ app: string; /** * Field included by default. */ context: string; /** * Field included by default. */ description: string; /** * Field included by default. */ name: string; /** * Field included by default. */ permissions: Array; /** * Field included by default. */ role: string; }; id: string; /** * A relationships object for a permission-preset */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a token */ export type Token = { /** * An attributes object for a token */ attributes?: { /** * Field included by default. */ brand?: string | null; /** * Field included by default. */ exp_month?: number | null; /** * Field included by default. */ exp_year?: number | null; /** * Field included by default. */ last4?: string | null; /** * Field included by default. */ token?: string | null; }; id: string; /** * A relationships object for a token */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a customer */ export type Customer = { /** * An attributes object for a customer */ attributes?: { /** * Field included by default. */ billing_email?: string | null; /** * Field included by default. */ created_at: unknown; /** * Field included by default. */ payment_method_status?: "valid" | "invalid" | "missing"; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a customer */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a chat-message-feedback */ export type ChatMessageFeedback = { /** * An attributes object for a chat-message-feedback */ attributes?: { /** * Field included by default. */ comment?: string | null; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ message_id: string; /** * Field included by default. */ rating: "up" | "down"; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a chat-message-feedback */ relationships?: { message?: { /** * An identifier for message */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a watcher-claim */ export type WatcherClaim = { /** * An attributes object for a watcher-claim */ attributes?: { /** * Field included by default. */ claimed_at: unknown; /** * Field included by default. */ completed_at?: unknown; /** * Field included by default. */ document_id?: string | null; /** * Field included by default. */ error_message?: string | null; /** * Field included by default. */ expires_at: unknown; /** * Field included by default. */ file_hash: string; /** * Field included by default. */ file_name: string; /** * Field included by default. */ file_path: string; /** * Field included by default. */ file_size?: number | null; /** * Field included by default. */ machine_id: string; /** * Field included by default. */ machine_name: string; /** * Field included by default. */ retry_count: number; /** * Field included by default. */ status: "claimed" | "processing" | "completed" | "failed" | "expired" | "document_deleted"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a watcher-claim */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a support-tag */ export type SupportTag = { /** * An attributes object for a support-tag */ attributes?: { /** * Field included by default. */ color?: string | null; /** * Field included by default. */ name: string; }; id: string; /** * A relationships object for a support-tag */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-note-version */ export type ClinicalNoteVersion = { /** * An attributes object for a clinical-note-version */ attributes?: { /** * Field included by default. */ change_summary?: string | null; /** * Field included by default. */ edited_by_id?: string | null; /** * Field included by default. */ note_id: string; /** * Field included by default. */ version_number: number; }; id: string; /** * A relationships object for a clinical-note-version */ relationships?: { [key: string]: never; }; type: string; }; export type Links = { [key: string]: Link; }; /** * A "Resource object" representing a isv-revenue */ export type IsvRevenue = { /** * An attributes object for a isv-revenue */ attributes?: { /** * Total amount in USD. Field included by default. */ amount: { amount: string; currency: string; }; /** * Field included by default. */ created_at: unknown; /** * Field included by default. */ description: string; /** * Additional context (e.g., operation details, tenant info). Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Hard cost from provider (for usage_cost type). Field included by default. */ pass_through_cost?: { amount: string; currency: string; } | null | unknown; /** * Platform's 20% markup on pass_through_cost. Field included by default. */ platform_markup?: { amount: string; currency: string; } | null | unknown; /** * Field included by default. */ type: "subscription_revenue" | "package_revenue" | "usage_cost" | "storage_cost" | "payment_processing_cost" | "platform_fee" | "settlement" | "reinvestment"; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a isv-revenue */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a crm-contact */ export type CrmContact = { /** * An attributes object for a crm-contact */ attributes?: { /** * Field included by default. */ ai_score?: number | null; /** * Field included by default. */ ai_score_reasons?: { [key: string]: unknown; } | null; /** * Field included by default. */ avatar_url?: string | null; /** * Field included by default. */ date_of_birth?: string | null; /** * Field included by default. */ email?: string | null; /** * Field included by default. */ external_ids: { [key: string]: unknown; }; /** * Field included by default. */ external_owner_id?: string | null; /** * Field included by default. */ first_name: string; full_name?: string | null; /** * Field included by default. */ last_name: string; /** * Field included by default. */ lifecycle_stage?: "lead" | "marketing_qualified" | "sales_qualified" | "opportunity" | "customer" | "evangelist" | "churned" | "discharged"; /** * BCP 47 language tag (e.g., en-US). Field included by default. */ locale?: string | null; /** * Field included by default. */ middle_name?: string | null; /** * Field included by default. */ owner_id?: string | null; /** * Field included by default. */ phone?: string | null; /** * Field included by default. */ portal_user_id?: string | null; /** * Field included by default. */ prefix?: string | null; primary_email?: string | null; primary_phone?: string | null; /** * Field included by default. */ properties?: { [key: string]: unknown; } | null; /** * Field included by default. */ sex?: "male" | "female" | "other"; /** * Field included by default. */ source?: "manual" | "import" | "channel" | "connector" | "ai_extracted" | "api" | "portal"; /** * Field included by default. */ suffix?: string | null; /** * Field included by default. */ tags?: Array | null; /** * IANA timezone (e.g., America/New_York). Field included by default. */ timezone?: string | null; /** * Field included by default. */ title?: string | null; }; id: string; /** * A relationships object for a crm-contact */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a voice-session */ export type VoiceSession = { /** * An attributes object for a voice-session */ attributes?: { /** * Agent handling this session. Field included by default. */ agent_id?: string | null; /** * Field included by default. */ duration_seconds?: number | null; /** * Field included by default. */ ended_at?: unknown; /** * Timestamp when transcript finalization was dispatched. Field included by default. */ finalized_at?: unknown; /** * Field included by default. */ inserted_at: unknown; /** * LiveKit room name for the session. Field included by default. */ livekit_room?: string | null; /** * LiveKit JWT for immediate room connection. * * **One-time delivery only.** This field is populated in the `POST /voice/sessions` create * response and is null in ALL subsequent read operations (GET, list). The token is * injected in-memory by the `:start` after_action and is NEVER written to the database * (enforced by a database CHECK constraint). Clients must capture it from the create response * — it cannot be retrieved after that point. Field included by default. */ livekit_token?: string | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ session_type: "push_to_talk" | "bidirectional" | "telephony"; /** * Field included by default. */ status: "active" | "ended" | "failed" | "timed_out"; /** * Accumulated STT minutes for billing. Field included by default. */ stt_minutes?: number | null; /** * Chat thread linked to this session. Field included by default. */ thread_id?: string | null; /** * Accumulated TTS characters for billing. Field included by default. */ tts_characters?: number | null; /** * Field included by default. */ updated_at: unknown; /** * Field included by default. */ user_id: string; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a voice-session */ relationships?: { recordings?: { /** * Relationship data for recordings */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; transcription_results?: { /** * Relationship data for transcription_results */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; user?: { /** * An identifier for user */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a crm-custom-entity-type */ export type CrmCustomEntityType = { /** * An attributes object for a crm-custom-entity-type */ attributes?: { /** * Field included by default. */ field_definitions: Array<{ [key: string]: unknown; }>; /** * Field included by default. */ icon?: string | null; /** * Optional alias used as an include key in CRM data exports. When set, this * alias can be passed in the `include` array of a DataExportJob to embed * custom entities of this type into contact exports. If nil, the type is * not available as an export include. Must be unique per application. * Example: a CustomEntityType with slug "client_goals" and include_alias "goals" * allows `include: ["goals"]` in export requests. * . Field included by default. */ include_alias?: string | null; /** * Field included by default. */ name: string; /** * Field included by default. */ pipelineable?: boolean | null; /** * Field included by default. */ relationships_config?: { [key: string]: unknown; } | null; /** * Field included by default. */ searchable?: boolean | null; /** * Field included by default. */ slug: string; }; id: string; /** * A relationships object for a crm-custom-entity-type */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a recipes-collection-recipe */ export type RecipesCollectionRecipe = { /** * An attributes object for a recipes-collection-recipe */ attributes?: { /** * Field included by default. */ added_at?: unknown; /** * Field included by default. */ collection_id: string; /** * Field included by default. */ recipe_id: string; /** * Field included by default. */ sort_order?: number | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a recipes-collection-recipe */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a feature-usage */ export type FeatureUsage = { /** * An attributes object for a feature-usage */ attributes?: { /** * Timestamp of one-time activation (nil = not yet activated). Field included by default. */ activated_at?: string | null; /** * Field included by default. */ created_at: unknown; /** * Start of the current billing cycle (derived from subscription period). Field included by default. */ cycle_start?: string | null; /** * Timestamp of the most recent usage increment. Field included by default. */ last_used_at?: string | null; /** * Field included by default. */ updated_at: unknown; /** * Number of times this feature has been used in the current billing cycle. Field included by default. */ used_this_cycle: number; }; id: string; /** * A relationships object for a feature-usage */ relationships?: { feature_definition?: { /** * An identifier for feature_definition */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; export type InvoicesInvoiceShippingAddressInputUpdateType = { city?: string | null; /** * ISO 3166-1 alpha-2 country code */ country?: string | null; line1?: string | null; line2?: string | null; postal_code?: string | null; state?: string | null; }; /** * A "Resource object" representing a crawler-schedule */ export type CrawlerSchedule = { /** * An attributes object for a crawler-schedule */ attributes?: { news_monitor_id?: string | null; }; id: string; /** * A relationships object for a crawler-schedule */ relationships?: { jobs?: { /** * Relationship data for jobs */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; news_monitor?: { /** * An identifier for news_monitor */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a compliance-policy */ export type CompliancePolicy = { /** * An attributes object for a compliance-policy */ attributes?: { /** * Field included by default. */ application_id: string; /** * Field included by default. */ compliance_tag: string; /** * Field included by default. */ strategy: "redact_before_storage" | "encrypt_and_track" | "flag_only" | "block"; }; id: string; /** * A relationships object for a compliance-policy */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a toolkit-sync-version */ export type ToolkitSyncVersion = { /** * An attributes object for a toolkit-sync-version */ attributes?: { /** * Field included by default. */ client_id: string; /** * Field included by default. */ sequence: number; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a toolkit-sync-version */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a crm-email-address */ export type CrmEmailAddress = { /** * An attributes object for a crm-email-address */ attributes?: { /** * Field included by default. */ email: string; /** * Field included by default. */ entity_id: string; /** * Field included by default. */ entity_type: "contact" | "company"; /** * Field included by default. */ is_primary?: boolean | null; /** * Field included by default. */ is_verified?: boolean | null; /** * Field included by default. */ label?: "work" | "personal" | "billing" | "support" | "other"; }; id: string; /** * A relationships object for a crm-email-address */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a crm-social-profile */ export type CrmSocialProfile = { /** * An attributes object for a crm-social-profile */ attributes?: { /** * Field included by default. */ entity_id: string; /** * Field included by default. */ entity_type: "contact" | "company"; /** * Field included by default. */ handle?: string | null; /** * Field included by default. */ platform: "linkedin" | "twitter" | "facebook" | "instagram" | "github" | "youtube" | "tiktok" | "other"; /** * Field included by default. */ url?: string | null; }; id: string; /** * A relationships object for a crm-social-profile */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a pricing-strategy */ export type PricingStrategy = { /** * An attributes object for a pricing-strategy */ attributes?: { /** * Application ID. NULL means platform default. Field included by default. */ application_id?: string | null; /** * Field included by default. */ created_at: unknown; /** * The minimum price per unit for this service. Field included by default. */ floor_price: { amount: string; currency: string; }; /** * The mandatory margin percentage (default 20%). Field included by default. */ margin_percent: number; /** * The unit of measure (e.g., 'page', 'request', 'second'). Field included by default. */ metric: string; /** * Unique identifier for the service (e.g., 'doc_extraction', 'rag_pipeline'). Field included by default. */ service_id: string; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a pricing-strategy */ relationships?: { [key: string]: never; }; type: string; }; export type SchedulingAvailabilityRuleWeeklyScheduleInputCreateType = { friday?: Array | null; monday?: unknown | Array<{ end: string; start: string; }> | Array<{ end?: string | unknown; start?: string | unknown; }>; saturday?: Array | null; sunday?: Array | null; thursday?: Array | null; tuesday?: Array | null; wednesday?: Array | null; }; /** * A "Resource object" representing a transcription-job */ export type TranscriptionJob = { /** * An attributes object for a transcription-job */ attributes?: { /** * Field included by default. */ assembled_segments?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ assembled_text?: string | null; /** * Field included by default. */ completed_chunks: number; /** * Field included by default. */ enable_diarization?: boolean | null; /** * Field included by default. */ initial_prompt?: string | null; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ language?: string | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ model_size?: string | null; /** * Field included by default. */ num_speakers?: number | null; /** * Field included by default. */ pii_mode: "none" | "tokenize" | "tokenize_encrypt"; /** * Field included by default. */ status: "recording" | "assembling" | "completed" | "failed"; /** * Field included by default. */ total_chunks: number; /** * Field included by default. */ total_duration_seconds?: number | null; /** * Field included by default. */ transcription_result_id?: string | null; /** * Field included by default. */ updated_at: unknown; /** * Field included by default. */ user_id: string; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a transcription-job */ relationships?: { transcription_result?: { /** * An identifier for transcription_result */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; user?: { /** * An identifier for user */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a invoices-invoice */ export type InvoicesInvoice = { /** * An attributes object for a invoices-invoice */ attributes?: { /** * Field included by default. */ ai_confidence?: string | null; /** * Field included by default. */ ai_suggestions?: { [key: string]: unknown; } | null; /** * Field included by default. */ amount_due?: string | null; /** * Field included by default. */ amount_paid?: string | null; /** * Point-in-time billing address snapshot. Field included by default. */ billing_address?: { /** * Field included by default. */ city?: string | null; /** * ISO 3166-1 alpha-2 country code. Field included by default. */ country?: string | null; /** * Field included by default. */ line1?: string | null; /** * Field included by default. */ line2?: string | null; /** * Field included by default. */ postal_code?: string | null; /** * Field included by default. */ state?: string | null; } | null | unknown; /** * Field included by default. */ currency: string; /** * Field included by default. */ direction: "outbound" | "inbound"; /** * Field included by default. */ due_date?: string | null; /** * Field included by default. */ enrichment_status?: "pending" | "completed" | "skipped_no_credits" | "failed"; /** * Field included by default. */ extraction_result_id?: string | null; /** * Field included by default. */ invoice_number?: string | null; /** * Field included by default. */ issue_date?: string | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ notes?: string | null; /** * Field included by default. */ paid_at?: unknown; /** * Field included by default. */ payment_terms?: string | null; /** * Field included by default. */ pdf_storage_path?: string | null; /** * Field included by default. */ recurring_schedule_id?: string | null; /** * Field included by default. */ reference_number?: string | null; /** * Field included by default. */ sent_at?: unknown; /** * Point-in-time shipping address snapshot. Field included by default. */ shipping_address?: { /** * Field included by default. */ city?: string | null; /** * ISO 3166-1 alpha-2 country code. Field included by default. */ country?: string | null; /** * Field included by default. */ line1?: string | null; /** * Field included by default. */ line2?: string | null; /** * Field included by default. */ postal_code?: string | null; /** * Field included by default. */ state?: string | null; } | null | unknown; /** * Field included by default. */ source: "manual" | "ai_generated" | "ai_extracted" | "recurring" | "api"; /** * Field included by default. */ status: "draft" | "pending_approval" | "pending_review" | "approved" | "sent" | "viewed" | "partial" | "paid" | "overdue" | "collections" | "matched" | "disputed" | "scheduled" | "void"; /** * Field included by default. */ subtotal?: string | null; /** * Field included by default. */ tax_total?: string | null; /** * Field included by default. */ template_id?: string | null; /** * Field included by default. */ total?: string | null; /** * Field included by default. */ viewed_at?: unknown; /** * Field included by default. */ voided_at?: unknown; /** * Field included by default. */ voided_reason?: string | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a invoices-invoice */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a extraction-export */ export type ExtractionExport = { /** * An attributes object for a extraction-export */ attributes?: { /** * Field included by default. */ config: { [key: string]: unknown; }; /** * Field included by default. */ error_message?: string | null; /** * Field included by default. */ expires_at?: unknown; /** * Field included by default. */ file_size_bytes?: number | null; /** * Field included by default. */ file_url?: string | null; /** * Field included by default. */ format: "csv" | "json" | "excel" | "markdown"; /** * Field included by default. */ status: "pending" | "processing" | "completed" | "failed"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a extraction-export */ relationships?: { [key: string]: never; }; type: string; }; export type SchedulingEventRecurrenceRuleInputCreateType = { count?: number | null; day_of_month?: number | null; days_of_week?: Array<"monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday"> | null; exceptions?: Array | null; frequency: "daily" | "weekly" | "monthly" | "yearly"; interval?: number | null; until?: string | null; }; /** * A "Resource object" representing a agent-version */ export type AgentVersion = { /** * An attributes object for a agent-version */ attributes?: { /** * Field included by default. */ changes_summary?: string | null; /** * Strategy-specific chunking configuration. Field included by default. */ chunking_config?: { [key: string]: unknown; } | null; /** * Document chunking strategy for multi-chunk extraction. Field included by default. */ chunking_strategy?: "none" | "page_boundary" | "structural" | "sliding_window"; /** * Override default confidence signal weights. Field included by default. */ confidence_weights?: { [key: string]: unknown; } | null; /** * Field included by default. */ created_at: unknown; /** * When true, delegate_to_agent tool calls require HITL approval before child execution is created. Field included by default. */ delegation_requires_approval: boolean; display_version?: string | null; has_been_used?: boolean | null; /** * Maximum number of recent messages to include as conversation context. Defaults to 20 if nil. Field included by default. */ history_limit?: number | null; /** * JSON Schema (Draft 7) defining required input fields. nil means no input contract. Field included by default. */ input_schema?: { [key: string]: unknown; } | null; /** * When true, reject inputs that fail input_schema validation. Field included by default. */ input_strict: boolean; /** * Field included by default. */ is_active: boolean; /** * Whether this is a draft version being edited (mutually exclusive with is_active). Field included by default. */ is_draft: boolean; /** * ISV-configurable credit ceiling per execution. Nil means no limit. Field included by default. */ max_cost_credits?: string | null; /** * Maximum number of agent loop iterations per execution. Field included by default. */ max_iterations: number; /** * Maximum number of tool calls to execute concurrently. Field included by default. */ max_parallel_tools: number; /** * Maximum total tool calls allowed per execution. Field included by default. */ max_tool_calls: number; /** * OpenRouter model ID (e.g. 'anthropic/claude-sonnet-4'). Nil = inherit from ProviderConfig. Field included by default. */ model_id?: string | null; /** * JSON Schema (Draft 7) defining the agent's output structure. nil means untyped. Field included by default. */ output_schema?: { [key: string]: unknown; } | null; /** * When true, enforce output schema via API-level structured output if model supports it. Field included by default. */ output_strict: boolean; /** * Ordered extraction pipeline stages. Empty = single default stage. Field included by default. */ pipeline_stages?: Array<{ /** * Input mode: text-only, vision (image), or hybrid (both). Field included by default. */ input_mode?: "text" | "vision" | "hybrid" | unknown; /** * Human-readable stage name (e.g., 'extract_header', 'validate_totals'). Field included by default. */ name: string; /** * Execution order (0-based). Stages execute sequentially by order. Field included by default. */ order: number; /** * Optional stage-specific prompt template. Falls back to agent prompt if nil. Field included by default. */ prompt_template?: string | null | unknown; /** * What portion of the document this stage operates on. Field included by default. */ scope?: "full" | "pages" | "chunks" | "fields" | unknown; /** * Scope-specific configuration: * pages: %{"pages" => [1, 2, 3]} * chunks: %{"chunk_ids" => [...]} * fields: %{"fields" => ["amounts.total", "line_items"]} * . Field included by default. */ scope_config?: { [key: string]: unknown; } | null | unknown; /** * Stage execution strategy. Field included by default. */ strategy: "extract" | "validate" | "transform" | "enrich"; /** * Field paths this stage is responsible for producing. Field included by default. */ target_fields?: Array | null | unknown; /** * Maximum number of tool calls allowed per stage execution. Field included by default. */ tool_budget?: number | null | unknown; /** * Behavior when a tool call fails: continue extraction or fail the stage. Field included by default. */ tool_failure_mode?: "continue" | "fail_stage" | unknown; /** * Per-tool call timeout in milliseconds. Field included by default. */ tool_timeout_ms?: number | null | unknown; /** * Tool atoms available to this stage for augmented extraction. Field included by default. */ tools?: Array | null | unknown; }> | null; /** * Structured prompt template with system, sections, and output format. * Nil for clones — base prompt resolved at runtime via PromptResolver from source agent. * . Field included by default. */ prompt_template?: unknown; /** * Field included by default. */ report_delivery?: "email" | "webhook" | "storage_only"; /** * Field included by default. */ report_format?: "pdf" | "html" | "both"; /** * Field included by default. */ report_on_completion?: boolean | null; /** * Field included by default. */ report_template?: string | null; /** * Revision number within this schema version. Increments on prompt/description changes. Field included by default. */ revision: number; /** * LLM inference temperature override. Nil uses platform default. Field included by default. */ temperature?: string | null; /** * List of granted tool names for agentic execution. Stored as strings, validated against ToolRegistry. Field included by default. */ tool_grants?: Array | null; /** * Field included by default. */ updated_at: unknown; /** * Denormalized count of extraction results created with this version. Field included by default. */ usage_count: number; /** * Field included by default. */ version_number: number; }; id: string; /** * A relationships object for a agent-version */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a crm-activity */ export type CrmActivity = { /** * An attributes object for a crm-activity */ attributes?: { /** * Field included by default. */ ai_action_items?: { [key: string]: unknown; } | null; /** * Field included by default. */ ai_summary?: string | null; /** * Field included by default. */ body?: string | null; /** * Field included by default. */ direction?: "inbound" | "outbound" | "internal"; /** * Field included by default. */ duration_seconds?: number | null; /** * Field included by default. */ occurred_at: unknown; /** * Field included by default. */ properties?: { [key: string]: unknown; } | null; /** * Field included by default. */ sentiment?: "positive" | "neutral" | "negative"; /** * Field included by default. */ source?: "manual" | "import" | "channel" | "connector" | "ai_extracted" | "api"; /** * Field included by default. */ source_ref?: string | null; /** * Field included by default. */ subject?: string | null; /** * Field included by default. */ type: "call" | "email" | "meeting" | "note" | "task" | "sms" | "chat" | "custom"; }; id: string; /** * A relationships object for a crm-activity */ relationships?: { [key: string]: never; }; type: string; }; export type CaseTypeRoutingRulesInputCreateType = { default_queue_id?: string | null; overrides?: unknown | Array<{ queue_id: string; when?: { [key: string]: unknown; } | unknown; }> | Array<{ queue_id?: string | unknown; when?: { [key: string]: unknown; } | unknown; }>; }; /** * A "Resource object" representing a wallet-public */ export type WalletPublic = { /** * An attributes object for a wallet-public */ attributes?: { /** * Forensic tag of the Plan revision this tenant's subscription was pinned * to at create time. Format: `:`. * Combine with `plan_id` for cross-application uniqueness. Audit-only — not * read by runtime billing code. * . Field included by default. */ plan_revision_id?: string | null; /** * Whether promotional pricing is currently active. Field included by default. */ promotional_active?: boolean | null; /** * Timestamp at which this tenant's subscription was pinned to its Plan * revision (set on subscription create; immutable). * . Field included by default. */ pinned_at?: string | null; /** * Regular monthly price (after promo ends). Field included by default. */ regular_price?: { amount: string; currency: string; } | null | unknown; /** * Field included by default. */ credits: number; /** * Field included by default. */ credits_subscription?: number | null; /** * Field included by default. */ addons?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ storage_quota_bytes: number; /** * Whether this tenant uses credit-based or seat-based billing. Field included by default. */ billing_mode: "credits" | "seats"; /** * Immutable audit snapshot of every Plan attribute that affected this * subscription's terms at create time. Frozen on create; never updated by * standard actions. Audit-only — runtime billing reads the live scalar * attributes on the Subscription itself. * . Field included by default. */ plan_snapshot?: { [key: string]: unknown; } | null; /** * Current subscription plan ID. Field included by default. */ plan_id?: string | null; /** * Per-workspace storage breakdown. Field included by default. */ workspace_storage?: Array<{ [key: string]: unknown; }> | null; /** * Months left in promotional pricing period. Field included by default. */ promotional_months_remaining?: number | null; /** * When the next automatic payment retry will occur. Field included by default. */ next_retry_at?: string | null; /** * Field included by default. */ storage_used_bytes: number; /** * Field included by default. */ payment_methods?: Array<{ [key: string]: unknown; }> | null; /** * Effective date for plan change. Field included by default. */ effective_date?: string | null; /** * Current subscription plan slug. Field included by default. */ plan_slug?: string | null; /** * Current seat usage (members + pending invitations). Field included by default. */ seats_used?: number | null; /** * Field included by default. */ application_id: string; /** * Credit balance threshold to trigger auto top-up. Field included by default. */ auto_top_up_threshold?: number | null; /** * When the current billing period ends. Field included by default. */ current_period_end?: string | null; /** * Total subscription credits ever allocated to this tenant. Field included by default. */ credits_subscription_allocated?: number | null; /** * Whether the most recent payment attempt failed (subscription is past_due). Field included by default. */ payment_failed?: boolean | null; /** * Extra seats beyond the plan bundle. Field included by default. */ seats_overage?: number | null; /** * Field included by default. */ accounts?: Array<{ [key: string]: unknown; }> | null; /** * Current subscription status (nil if no subscription). Field included by default. */ subscription_status?: "active" | "past_due" | "canceled" | "incomplete" | "pending_cancellation"; /** * Current dunning retry stage (0 = none, 1-4 = retry stages). Field included by default. */ dunning_stage?: number | null; /** * Total promotional credits ever allocated to this tenant. Field included by default. */ credits_promotional_allocated?: number | null; /** * Per-workspace usage breakdown. Field included by default. */ workspace_usage?: Array<{ [key: string]: unknown; }> | null; /** * Detailed proration breakdown. Field included by default. */ proration_details?: { [key: string]: unknown; } | null; /** * Plan name for a pending downgrade. Field included by default. */ pending_plan_name?: string | null; /** * Seats included in the plan bundle (nil for credit-based). Field included by default. */ seats_included?: number | null; /** * Field included by default. */ credits_paid?: number | null; /** * Current overage cost (overage_seats * overage_seat_price). Field included by default. */ seats_overage_cost?: { amount: string; currency: string; } | null | unknown; /** * Plan slug for a pending downgrade (applied at period end). Field included by default. */ pending_plan_slug?: string | null; /** * Current promotional monthly price (nil if not in promo period). Field included by default. */ promotional_price?: { amount: string; currency: string; } | null | unknown; /** * Prorated cost for plan change in cents. Field included by default. */ proration_amount?: number | null; /** * Whether automatic credit top-up is enabled. Field included by default. */ auto_top_up_enabled: boolean; /** * Total purchased credits ever allocated to this tenant. Field included by default. */ credits_purchased_allocated?: number | null; /** * Daily usage history entries. Field included by default. */ usage_history?: Array<{ [key: string]: unknown; }> | null; /** * Amount of credits to purchase during auto top-up. Field included by default. */ auto_top_up_amount?: number | null; /** * Field included by default. */ credits_free?: number | null; }; id: string; /** * A relationships object for a wallet-public */ relationships?: { plan?: { /** * An identifier for plan */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a user-preference */ export type UserPreference = { /** * An attributes object for a user-preference */ attributes?: { /** * Field included by default. */ context_key: string; /** * Field included by default. */ preferences: { [key: string]: unknown; }; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a user-preference */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a recipes-tag */ export type RecipesTag = { /** * An attributes object for a recipes-tag */ attributes?: { /** * Field included by default. */ application_id: string; /** * Field included by default. */ category: "cuisine" | "diet" | "health" | "course" | "technique" | "custom"; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ name: string; /** * Field included by default. */ slug: string; }; id: string; /** * A relationships object for a recipes-tag */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a scheduling-reminder */ export type SchedulingReminder = { /** * An attributes object for a scheduling-reminder */ attributes?: { /** * Field included by default. */ channel?: "email" | "webhook" | "sms" | "whatsapp" | "slack"; /** * Field included by default. */ error?: string | null; /** * Field included by default. */ event_id: string; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ minutes_before: number; /** * Field included by default. */ recipient_participant_id?: string | null; /** * Field included by default. */ scheduled_at: unknown; /** * Field included by default. */ sent_at?: unknown; /** * Field included by default. */ status?: "pending" | "sent" | "failed" | "cancelled"; }; id: string; /** * A relationships object for a scheduling-reminder */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a agent-tool */ export type AgentTool = { /** * An attributes object for a agent-tool */ attributes?: { /** * Field included by default. */ classification: "read_only" | "mutating" | "sensitive" | "external"; /** * Field included by default. */ description: string; /** * Field included by default. */ name: string; /** * Field included by default. */ priority: "always" | "on_demand"; /** * Field included by default. */ timeout_ms: number; }; id: string; /** * A relationships object for a agent-tool */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-practice-tool-category */ export type ClinicalPracticeToolCategory = { /** * An attributes object for a clinical-practice-tool-category */ attributes?: { /** * Field included by default. */ tool_count: number; }; id: string; /** * A relationships object for a clinical-practice-tool-category */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a email-inbound-address */ export type EmailInboundAddress = { /** * An attributes object for a email-inbound-address */ attributes?: { /** * Field included by default. */ allowed_mime_types?: Array | null; /** * Field included by default. */ daily_receive_limit: number; /** * Field included by default. */ handler_config?: { [key: string]: unknown; } | null; /** * Field included by default. */ is_active: boolean; /** * Field included by default. */ max_attachment_size_mb: number; /** * Field included by default. */ name: string; /** * Field included by default. */ routing_target: "extraction" | "agent" | "invoices" | "crm"; /** * Field included by default. */ token: string; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a email-inbound-address */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-goal-association */ export type ClinicalGoalAssociation = { /** * An attributes object for a clinical-goal-association */ attributes?: { /** * Field included by default. */ client_goal_id: string; /** * Field included by default. */ entity_id: string; /** * Field included by default. */ entity_type: "meal_plan" | "session" | "health_metric" | "recipe" | "supplement"; /** * Field included by default. */ notes?: string | null; }; id: string; /** * A relationships object for a clinical-goal-association */ relationships?: { client_goal?: { /** * An identifier for client_goal */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a plan-feature-allocation */ export type PlanFeatureAllocation = { /** * An attributes object for a plan-feature-allocation */ attributes?: { /** * One-time credit charge to unlock this feature. nil = free activation. Field included by default. */ activation_cost?: number | null; /** * Field included by default. */ created_at: unknown; /** * Override the feature's credit_cost for this plan. nil = use feature default. Field included by default. */ credit_cost?: number | null; /** * Whether this feature is available on this plan. Field included by default. */ enabled: boolean; /** * Field included by default. */ feature_definition_id: string; /** * Override the feature's default_limit for this plan. nil = use feature default. Field included by default. */ limit?: number | null; /** * Field included by default. */ plan_id: string; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a plan-feature-allocation */ relationships?: { feature_definition?: { /** * An identifier for feature_definition */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; plan?: { /** * An identifier for plan */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a voice-recording */ export type VoiceRecording = { /** * An attributes object for a voice-recording */ attributes?: { /** * Extraction document linked to audio file. Field included by default. */ document_id?: string | null; /** * Field included by default. */ duration_seconds?: number | null; /** * Field included by default. */ file_size_bytes?: number | null; /** * Audio format: wav, mp3, ogg, etc. Field included by default. */ format: string; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Voice session that produced this recording. Field included by default. */ session_id?: string | null; /** * Field included by default. */ status: "recording" | "stored" | "transcribed" | "failed" | "deleted"; /** * Field included by default. */ updated_at: unknown; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a voice-recording */ relationships?: { session?: { /** * An identifier for session */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a clinical-client-resource-assignment */ export type ClinicalClientResourceAssignment = { /** * An attributes object for a clinical-client-resource-assignment */ attributes?: { /** * Field included by default. */ assigned_at: string; /** * Field included by default. */ completed_at?: string | null; is_archived?: boolean | null; /** * Field included by default. */ metadata: { [key: string]: unknown; }; /** * Field included by default. */ notes?: string | null; /** * Field included by default. */ patient_id: string; /** * Field included by default. */ resource_id: string; /** * Field included by default. */ status: "assigned" | "in_progress" | "completed" | "dismissed"; }; id: string; /** * A relationships object for a clinical-client-resource-assignment */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a account */ export type Account = { /** * An attributes object for a account */ attributes?: { /** * Field included by default. */ allow_overdraft: boolean; /** * Field included by default. */ credits: number; /** * Field included by default. */ currency: string; /** * Field included by default. */ expires_at?: string | null; /** * Field included by default. */ identifier: string; /** * Field included by default. */ name?: string | null; /** * Field included by default. */ type: "subscription" | "purchased" | "promotional" | "storage" | "conversational" | "rag" | "isv" | "application" | "treasury"; }; id: string; /** * A relationships object for a account */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a email-inclusion */ export type EmailInclusion = { /** * An attributes object for a email-inclusion */ attributes?: { /** * Field included by default. */ data?: { [key: string]: unknown; } | null; /** * Field included by default. */ inclusion_type: "chart" | "custom" | "goal" | "metric" | "resource" | "supplement"; /** * Field included by default. */ position?: number | null; /** * Field included by default. */ ref_id?: string | null; /** * Field included by default. */ rendered_html?: string | null; /** * Field included by default. */ title?: string | null; }; id: string; /** * A relationships object for a email-inclusion */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a plan-catalog */ export type PlanCatalog = { /** * An attributes object for a plan-catalog */ attributes?: { /** * Field included by default. */ application_id: string; /** * Field included by default. */ created_at: unknown; /** * Timestamp when the plan transitioned to :deprecated. Field included by default. */ deprecated_at?: string | null; /** * Distinguishes base plans from add-ons. Field included by default. */ is_addon: boolean; /** * Plan lifecycle stage. `:active` plans accept new subscriptions; * `:deprecated` plans are hidden from public catalogs but still renew; * `:sunset_pending` plans are scheduled for forced migration at `sunset_at`; * `:archived` plans are terminal. * . Field included by default. */ lifecycle_status: "active" | "deprecated" | "sunset_pending" | "archived"; /** * Hard cap on seats before overage. nil = unlimited. Field included by default. */ max_seats?: number | null; /** * Seats included in the bundle. Field included by default. */ min_seats?: number | null; /** * Field included by default. */ monthly_credits: number; /** * Field included by default. */ monthly_price: { amount: string; currency: string; }; /** * Field included by default. */ name: string; /** * Per-seat price beyond max_seats. nil = overage not allowed. Field included by default. */ overage_seat_price?: { amount: string; currency: string; } | null | unknown; /** * Platform tier this plan maps to. Field included by default. */ plan_tier: "free" | "pro" | "business" | "enterprise"; /** * The plan subscribers will be migrated to at sunset_at. Field included by default. */ replacement_plan_id?: string | null; /** * Field included by default. */ slug: string; /** * Storage included in plan (bytes). Field included by default. */ storage_included_bytes?: number | null; /** * Hard ceiling in bytes (nil = unlimited). Field included by default. */ storage_max_bytes?: number | null; /** * Cents per GB-month overage. Field included by default. */ storage_overage_rate_cents?: number | null; /** * Timestamp at which subscribers will be force-migrated to replacement_plan_id. Field included by default. */ sunset_at?: string | null; /** * Field included by default. */ type: "credits" | "storage" | "credits_storage" | "compute" | "seats" | "agents" | "support"; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a plan-catalog */ relationships?: { feature_allocations?: { /** * Relationship data for feature_allocations */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; }; type: string; }; /** * A "Resource object" representing a bulk-dismissal-result */ export type BulkDismissalResult = { /** * An attributes object for a bulk-dismissal-result */ attributes?: { /** * Field included by default. */ dismissed_count: number; /** * Field included by default. */ success: boolean; }; id: string; /** * A relationships object for a bulk-dismissal-result */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a catalog-product-classification */ export type CatalogProductClassification = { /** * An attributes object for a catalog-product-classification */ attributes?: { /** * Field included by default. */ confidence?: number | null; /** * Field included by default. */ position?: number | null; /** * Field included by default. */ source: "manual" | "ai_suggested" | "ai_auto"; }; id: string; /** * A relationships object for a catalog-product-classification */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a consent-record */ export type ConsentRecord = { /** * An attributes object for a consent-record */ attributes?: { /** * Human-readable description of what was consented to. Field included by default. */ description?: string | null; /** * Field included by default. */ granted_at: unknown; /** * GDPR Article 6 lawful basis for processing. Field included by default. */ lawful_basis: "consent" | "contract" | "legal_obligation" | "vital_interests" | "public_task" | "legitimate_interest"; /** * Field included by default. */ purpose: "ai_document_processing" | "data_analytics" | "marketing_communications" | "third_party_sharing" | "session_recording"; /** * Field included by default. */ status: "granted" | "withdrawn"; /** * Non-user subject identifier for consent (e.g., CRM contact UUID for HIPAA recording consent). Field included by default. */ subject_id?: string | null; /** * Field included by default. */ user_id?: string | null; /** * Field included by default. */ withdrawn_at?: unknown; /** * Workspace scope for subject-based consent records. Field included by default. */ workspace_id?: string | null; }; id: string; /** * A relationships object for a consent-record */ relationships?: { user?: { /** * An identifier for user */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a support-canned-response */ export type SupportCannedResponse = { /** * An attributes object for a support-canned-response */ attributes?: { /** * Field included by default. */ category?: string | null; /** * Field included by default. */ content: string; /** * Field included by default. */ name: string; /** * Field included by default. */ shortcut?: string | null; }; id: string; /** * A relationships object for a support-canned-response */ relationships?: { [key: string]: never; }; type: string; }; export type FormDeploymentSealPolicyInputUpdateType = { report_format?: "sealed" | "open"; execution_mode?: "sealed" | "open"; theme_overrides?: "sealed" | "open"; disclose_logic_trace?: "sealed" | "open"; prompt_variants?: "sealed" | "open"; chunking_strategy?: "sealed" | "open"; output_schema_locked?: "sealed" | "open"; confidence_weights?: "sealed" | "open"; logic_locked?: "sealed" | "open"; max_cost_credits?: "sealed" | "open"; abandonment_threshold_days?: "sealed" | "open"; theme_locked?: "sealed" | "open"; layout_locked?: "sealed" | "open"; data_retention_days?: "sealed" | "open"; report_template?: "sealed" | "open"; model_id?: "sealed" | "open"; description?: "sealed" | "open"; name?: "sealed" | "open"; temperature?: "sealed" | "open"; allowed_origins?: "sealed" | "open"; logic_rules?: "sealed" | "open"; max_iterations?: "sealed" | "open"; prompt_template?: "sealed" | "open"; output_schema_pins?: Array | null; tags?: "sealed" | "open"; theme_id?: "sealed" | "open"; public_key_jwk?: "sealed" | "open"; instructions?: "sealed" | "open"; max_parallel_tools?: "sealed" | "open"; access_mode?: "sealed" | "open"; chunking_config?: "sealed" | "open"; input_schema_pins?: Array | null; output_schema?: "sealed" | "open"; min_submit_delay_ms?: "sealed" | "open"; assistant_agent_version_id?: "sealed" | "open"; custom_css?: "sealed" | "open"; layout_tree?: "sealed" | "open"; default_instructions?: "sealed" | "open"; tool_grant_pins?: Array | null; max_tool_calls?: "sealed" | "open"; }; /** * A "Resource object" representing a catalog-price-suggestion */ export type CatalogPriceSuggestion = { /** * An attributes object for a catalog-price-suggestion */ attributes?: { /** * Field included by default. */ confidence: number; /** * Field included by default. */ current_price: string; /** * Field included by default. */ price_list_id?: string | null; /** * Field included by default. */ product_id?: string | null; /** * Field included by default. */ reasoning: string; /** * Field included by default. */ signals?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ status: "pending" | "accepted" | "rejected" | "expired"; /** * Field included by default. */ suggested_price: string; /** * Field included by default. */ variant_id?: string | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a catalog-price-suggestion */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a field-mapping-result */ export type FieldMappingResult = { /** * An attributes object for a field-mapping-result */ attributes?: { /** * Field included by default. */ document_id: string; /** * Fields that match exactly after normalization. Field included by default. */ exact_matches?: Array<{ [key: string]: unknown; }> | null; /** * Fields with high similarity requiring user confirmation. Field included by default. */ fuzzy_matches?: Array<{ [key: string]: unknown; }> | null; /** * Fields not found in schema, potential additions. Field included by default. */ new_fields?: Array<{ [key: string]: unknown; }> | null; }; id: string; /** * A relationships object for a field-mapping-result */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a form */ export type Form = { /** * An attributes object for a form */ attributes?: { /** * Field included by default. */ allow_tenant_clone: boolean; /** * Field included by default. */ application_id?: string | null; /** * Field included by default. */ created_at: unknown; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ is_system: boolean; /** * Field included by default. */ layout_locked: boolean; /** * Field included by default. */ logic_locked: boolean; /** * Field included by default. */ name: string; /** * Field included by default. */ output_schema_locked: boolean; /** * Field included by default. */ system_slug?: string | null; /** * Field included by default. */ tags: Array; /** * Field included by default. */ tenant_id: string; /** * Field included by default. */ theme_locked: boolean; /** * Field included by default. */ updated_at: unknown; /** * Field included by default. */ workspace_id?: string | null; }; id: string; /** * A relationships object for a form */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; tenant?: { /** * An identifier for tenant */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; workspace?: { /** * An identifier for workspace */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a connector-instance */ export type ConnectorInstance = { /** * An attributes object for a connector-instance */ attributes?: { /** * Field included by default. */ connector_type: "corehealth" | "custom" | "edamam" | "facebook" | "fhir_r4" | "fullscript" | "github" | "gitlab" | "gmail" | "google_calendar" | "google_chat" | "healthie" | "hubspot" | "instagram" | "jira" | "confluence" | "linkedin" | "microsoft_365" | "notion" | "outlook" | "practice_better" | "reddit" | "salesforce" | "sharepoint" | "slack" | "threads" | "twitter" | "bluesky"; /** * Field included by default. */ enabled?: boolean | null; /** * Field included by default. */ health_status?: "healthy" | "degraded" | "unhealthy" | "unknown"; /** * Field included by default. */ last_sync_at?: string | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ name: string; /** * Field included by default. */ sync_interval_minutes?: number | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a connector-instance */ relationships?: { workspace?: { /** * An identifier for workspace */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a breach-notification-artifact */ export type BreachNotificationArtifact = { /** * An attributes object for a breach-notification-artifact */ attributes?: { /** * Field included by default. */ artifact_type: "individual_notification" | "hhs_report" | "media_notice" | "state_ag_report"; /** * Field included by default. */ breach_incident_id: string; /** * Generated notification text. Field included by default. */ content: string; /** * Number of recipients for individual notifications. Field included by default. */ recipient_count?: number | null; /** * Field included by default. */ sent_at?: string | null; /** * Field included by default. */ status: "draft" | "reviewed" | "sent"; }; id: string; /** * A relationships object for a breach-notification-artifact */ relationships?: { breach_incident?: { /** * An identifier for breach_incident */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a compliance-document-template */ export type ComplianceDocumentTemplate = { /** * An attributes object for a compliance-document-template */ attributes?: { /** * Field included by default. */ application_id?: string | null; /** * Markdown/Mustache template with {{variables}}. Field included by default. */ content_template: string; /** * Field included by default. */ is_platform_managed: boolean; /** * Field included by default. */ regulatory_framework: "hipaa" | "gdpr" | "pci_dss" | "sox"; /** * Field included by default. */ required_variables: Array; /** * Field included by default. */ template_type: "baa" | "npp" | "privacy_policy" | "security_policy" | "incident_response_plan" | "contingency_plan" | "access_control_policy" | "risk_management_plan" | "training_policy" | "sanction_policy" | "breach_notification_policy" | "system_activity_review" | "data_retention_policy" | "minimum_necessary_policy" | "authorization_form" | "dpa"; /** * Field included by default. */ title: string; /** * Field included by default. */ version: string; }; id: string; /** * A relationships object for a compliance-document-template */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a clinical-goal-template-collection-membership */ export type ClinicalGoalTemplateCollectionMembership = { /** * An attributes object for a clinical-goal-template-collection-membership */ attributes?: { /** * Field included by default. */ added_at?: unknown; /** * Field included by default. */ collection_id: string; /** * Field included by default. */ sort_order?: number | null; /** * Field included by default. */ template_id: string; }; id: string; /** * A relationships object for a clinical-goal-template-collection-membership */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a submission */ export type Submission = { /** * An attributes object for a submission */ attributes?: { /** * Field included by default. */ consent_accepted_at?: unknown; /** * Field included by default. */ consent_version?: string | null; /** * Field included by default. */ current_page?: string | null; /** * Field included by default. */ form_id: string; /** * Field included by default. */ form_version_id: string; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ last_activity_at?: unknown; /** * Field included by default. */ locale?: string | null; /** * Field included by default. */ metadata: { [key: string]: unknown; }; /** * Field included by default. */ publication_id: string; /** * Field included by default. */ respondent_token_id?: string | null; /** * Monotonic counter initialized to 1 by :create_draft and incremented on every autosave/submit. Used as a concurrent-write guard. Field included by default. */ revision_counter: number; /** * Field included by default. */ source: "public" | "token_gated" | "authenticated" | "signed_embed"; /** * Field included by default. */ started_at?: unknown; /** * Field included by default. */ status: "draft" | "in_progress" | "submitted" | "approved" | "rejected" | "closed"; /** * Field included by default. */ submitted_at?: unknown; /** * Field included by default. */ updated_at: unknown; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a submission */ relationships?: { form?: { /** * An identifier for form */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; form_version?: { /** * An identifier for form_version */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; publication?: { /** * An identifier for publication */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; respondent_token?: { /** * An identifier for respondent_token */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; workspace?: { /** * An identifier for workspace */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a catalog-price-list-entry */ export type CatalogPriceListEntry = { /** * An attributes object for a catalog-price-list-entry */ attributes?: { /** * Field included by default. */ floor_price?: string | null; /** * Field included by default. */ modifier?: string | null; /** * Field included by default. */ price?: string | null; /** * Field included by default. */ tiers?: Array<{ [key: string]: unknown; }> | null; }; id: string; /** * A relationships object for a catalog-price-list-entry */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a access-grant */ export type AccessGrant = { /** * An attributes object for a access-grant */ attributes?: { /** * Permissions granted by this relation. Auto-populated from PermissionRegistry unless overridden. Field included by default. */ custom_permissions: Array; /** * Field included by default. */ expires_at?: string | null; /** * Field included by default. */ granted_by_id?: string | null; is_expired?: boolean | null; /** * Field included by default. */ join_source: "manual" | "invitation" | "domain_whitelist" | "sso_oidc" | "sso_saml" | "scim"; /** * Field included by default. */ object_id: string; /** * Field included by default. */ object_type: "tenant" | "workspace"; /** * Field included by default. */ relation: "tenant_admin" | "tenant_member" | "workspace_admin" | "workspace_editor" | "workspace_viewer"; /** * Field included by default. */ subject_id: string; /** * Field included by default. */ subject_type: "user" | "application"; }; id: string; /** * A relationships object for a access-grant */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a extraction-document */ export type ExtractionDocument = { /** * An attributes object for a extraction-document */ attributes?: { /** * Overall classification confidence (0.0 to 1.0). Field included by default. */ classification_confidence?: number | null; /** * Processing stage: queue, active, output, errors */ processing_stage: "queue" | "active" | "output" | "errors" | "unknown"; /** * Field included by default. */ uploaded_at?: string | null; /** * Current processing stage (reads processing_stage attribute). Field included by default. */ stage?: string | null; /** * Whether this document was returned as a duplicate via find_or_begin_upload. Field included by default. */ deduplicated?: boolean | null; /** * Schema revision number used for extraction. Field included by default. */ schema_revision?: number | null; /** * FK to storage.storage_files — tracks the S3 file via StorageFile */ storage_file_id?: string | null; /** * Credits billed for processing this document. Field included by default. */ billed_credits?: number | null; /** * Line count of extracted text. Field included by default. */ line_count?: number | null; /** * Image height in pixels (for image documents). Field included by default. */ image_height?: number | null; /** * Content hash for deduplication (blake3: or sha256: prefix + 64 hex characters) */ file_hash?: string | null; excluded_by?: string | null; /** * Character count of extracted text. Field included by default. */ char_count?: number | null; /** * DEPRECATED. The S3 bucket where this document is stored. Use storage_file_id instead. */ bucket_name?: string | null; deleted_at?: unknown; /** * Classification object containing domain, document_type, municipality, state, and confidence */ classification?: { [key: string]: unknown; } | null; content?: string | null; /** * Municipality/agency name extracted from document content. Field included by default. */ municipality?: string | null; /** * Reason why this document is in the review queue */ queue_reason?: string | null; /** * Field included by default. */ status?: "queued" | "processing" | "partial" | "completed" | "failed" | "cancelled" | "pending_credits"; /** * Field included by default. */ progress?: number | null; /** * Timestamp when document was moved to output/error bucket */ moved_at?: unknown; /** * Metadata about the training session for this document (trained_at, user_id, scores) */ training_metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ ocr_text?: string | null; /** * Field included by default. */ upload_url?: string | null; /** * Field included by default. */ pages?: number | null; /** * Image width in pixels (for image documents). Field included by default. */ image_width?: number | null; /** * The review/verification state of the document. Field included by default. */ verification_status?: "unverified" | "partially_verified" | "fully_verified"; processed_at?: unknown; /** * Field included by default. */ error_message?: string | null; /** * Field included by default. */ verified_by_user_id?: string | null; /** * Field included by default. */ file_type: "pdf" | "docx" | "image" | "zip" | "audio" | "video"; /** * Field included by default. */ file_size_bytes?: number | null; /** * Timestamp when document processing completed (status changed to :completed). Field included by default. */ completed_at?: unknown; /** * The version of the agent/schema used to process this document. Field included by default. */ schema_version?: string | null; /** * Field included by default. */ presigned_view_url?: string | null; /** * Field included by default. */ last_verified_at?: unknown; /** * State or province code (2-letter). Field included by default. */ state?: string | null; /** * Document domain from specialty agent (legal, financial, medical, etc.). Field included by default. */ domain?: string | null; /** * If true, this document is excluded from training (both creating new examples and being used in retrieval) */ excluded_from_training: boolean; /** * Word count of extracted text. Field included by default. */ word_count?: number | null; excluded_at?: unknown; /** * Field included by default. */ filename: string; /** * Average confidence score across all extracted fields (0.0 to 1.0). Field included by default. */ avg_confidence?: number | null; /** * Specific document type from specialty agent (Traffic Citation, Invoice, etc.). Field included by default. */ document_type?: string | null; }; id: string; /** * A relationships object for a extraction-document */ relationships?: { claim?: { /** * An identifier for claim */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; extraction_result?: { /** * An identifier for extraction_result */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; extraction_results?: { /** * Relationship data for extraction_results */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; }; type: string; }; /** * A "Resource object" representing a scan-result */ export type ScanResult = { /** * An attributes object for a scan-result */ attributes?: { /** * Snapshot of Application compliance_tags at scan time. Field included by default. */ compliance_tags: Array; /** * SHA-256 hex digest of scanned content (dedup key). Field included by default. */ content_hash: string; /** * Polymorphic reference: %{type: string, id: uuid}. Field included by default. */ content_ref: { [key: string]: unknown; }; /** * List of %{text, entity_type, confidence, start_offset, end_offset}. Field included by default. */ detected_entities: Array<{ [key: string]: unknown; }>; /** * Key identifier used for encryption (for future key rotation). Field included by default. */ encryption_key_id?: string | null; /** * Field included by default. */ scanner_used: "gliner" | "regex_fallback"; /** * Field included by default. */ strategy_applied: "redact_before_storage" | "encrypt_and_track" | "flag_only" | "block" | "skipped"; }; id: string; /** * A relationships object for a scan-result */ relationships?: { [key: string]: never; }; type: string; }; export type CaseTypeDecisionOutcomesInputUpdateType = { is_terminal?: boolean | null; label?: string | null; requires_note?: boolean | null; slug?: string | null; }; /** * A "Resource object" representing a support-sync-config */ export type SupportSyncConfig = { /** * An attributes object for a support-sync-config */ attributes?: { /** * Field included by default. */ connector_instance_id: string; /** * Field included by default. */ direction: "bidirectional" | "inbound" | "outbound"; /** * Field included by default. */ enabled: boolean; /** * Field included by default. */ last_synced_at?: unknown; /** * Field included by default. */ status_mapping?: { [key: string]: unknown; } | null; /** * Field included by default. */ sync_interval_minutes: number; }; id: string; /** * A relationships object for a support-sync-config */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a recipes-recipe-collection */ export type RecipesRecipeCollection = { /** * An attributes object for a recipes-recipe-collection */ attributes?: { /** * Field included by default. */ contact_id?: string | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ name: string; recipe_count?: number | null; /** * Field included by default. */ scope: "workspace" | "contact"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a recipes-recipe-collection */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-supplement-template */ export type ClinicalSupplementTemplate = { /** * An attributes object for a clinical-supplement-template */ attributes?: { /** * Field included by default. */ applicable_conditions: Array; /** * Field included by default. */ category?: string | null; /** * Field included by default. */ created_by_id?: string | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ is_active: boolean; is_archived?: boolean | null; is_catalog?: boolean | null; /** * Field included by default. */ metadata: { [key: string]: unknown; }; /** * Field included by default. */ name: string; /** * Field included by default. */ source_catalog_id?: string | null; /** * Field included by default. */ source_template_id?: string | null; /** * Field included by default. */ supplements: Array<{ [key: string]: unknown; }>; /** * Field included by default. */ tags: Array; }; id: string; /** * A relationships object for a clinical-supplement-template */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a catalog-stock-movement */ export type CatalogStockMovement = { /** * An attributes object for a catalog-stock-movement */ attributes?: { /** * Field included by default. */ occurred_at: unknown; /** * Field included by default. */ performed_by?: string | null; /** * Field included by default. */ quantity: number; /** * Field included by default. */ reason?: string | null; /** * Field included by default. */ reference_id?: string | null; /** * Field included by default. */ reference_type?: string | null; /** * Field included by default. */ stock_record_id: string; /** * Field included by default. */ transaction_id: string; /** * Field included by default. */ type: "receipt" | "sale" | "adjustment" | "transfer" | "return" | "reserve" | "release"; /** * Field included by default. */ unit_cost_at_movement?: string | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a catalog-stock-movement */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-supplement-template-collection-membership */ export type ClinicalSupplementTemplateCollectionMembership = { /** * An attributes object for a clinical-supplement-template-collection-membership */ attributes?: { /** * Field included by default. */ added_at?: unknown; /** * Field included by default. */ collection_id: string; /** * Field included by default. */ sort_order?: number | null; /** * Field included by default. */ template_id: string; }; id: string; /** * A relationships object for a clinical-supplement-template-collection-membership */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a legal-acceptance */ export type LegalAcceptance = { /** * An attributes object for a legal-acceptance */ attributes?: { /** * Field included by default. */ accepted_at: unknown; /** * Field included by default. */ application_id: string; /** * Field included by default. */ context: "registration" | "version_update" | "periodic_reaccept"; /** * Field included by default. */ document_type: "terms_of_service" | "privacy_policy" | "baa" | "dpa" | "scc" | "npp" | "security_policy" | "incident_response_plan" | "contingency_plan" | "access_control_policy" | "risk_management_plan" | "training_policy" | "sanction_policy" | "breach_notification_policy" | "system_activity_review" | "data_retention_policy" | "minimum_necessary_policy" | "authorization_form"; /** * Field included by default. */ user_id: string; /** * Field included by default. */ version: string; }; id: string; /** * A relationships object for a legal-acceptance */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; user?: { /** * An identifier for user */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a catalog-taxonomy */ export type CatalogTaxonomy = { /** * An attributes object for a catalog-taxonomy */ attributes?: { /** * Field included by default. */ ai_managed: boolean; /** * Field included by default. */ application_id: string; /** * Field included by default. */ is_hierarchical: boolean; /** * Field included by default. */ is_required: boolean; /** * Field included by default. */ max_depth?: number | null; /** * Field included by default. */ name: string; /** * Field included by default. */ scope: "application" | "workspace"; /** * Field included by default. */ slug: string; /** * Field included by default. */ workspace_id?: string | null; }; id: string; /** * A relationships object for a catalog-taxonomy */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a plan */ export type Plan = { /** * An attributes object for a plan */ attributes?: { /** * Field included by default. */ application_id: string; /** * Field included by default. */ billing_interval: number; /** * Capability tiers this plan entitles subscribers to. Field included by default. */ capability_tiers: Array<"core" | "standard" | "premium">; /** * Maximum number of concurrent long-running operations a tenant may have * in-flight under this plan (e.g. extraction jobs, batch agent runs). * `nil` means no plan-level limit. When set, must be > 0. * . Field included by default. */ concurrent_operations_limit?: number | null; /** * Field included by default. */ created_at: unknown; /** * Credits allocated per seat at renewal. nil = falls back to monthly_credits. Field included by default. */ credits_per_seat?: number | null; /** * Timestamp when the plan transitioned to :deprecated. Field included by default. */ deprecated_at?: string | null; /** * Optional ISV-configurable Layer 2 dunning cadence override. Nil falls * back to platform defaults. Supported keys: * "retry_days", "soft_suspend_day", "hard_cancel_day", "purge_day", * and "hard_purge_day". * . Field included by default. */ dunning_config?: { [key: string]: unknown; } | null; /** * Human-readable feature list derived from capability_tiers, for pricing tables */ features?: Array | null; /** * One-time credits granted upon first subscription (Welcome Bonus). Field included by default. */ initial_credits: number; /** * Distinguishes base plans from add-ons. Field included by default. */ is_addon: boolean; /** * Lifecycle stage of this plan. `:active` plans accept new subscriptions; `:deprecated` * plans are hidden from public catalogs but still renew; `:sunset_pending` plans are * scheduled for forced migration at `sunset_at`; `:archived` plans are terminal and * have no remaining subscribers. * . Field included by default. */ lifecycle_status: "active" | "deprecated" | "sunset_pending" | "archived"; /** * Maximum number of renewals for free trial (nil = unlimited). Field included by default. */ max_renewals?: number | null; /** * Hard cap on seats before overage. nil = unlimited seats. Field included by default. */ max_seats?: number | null; /** * Seats included in the bundle (for display/marketing). Field included by default. */ min_seats?: number | null; /** * Field included by default. */ monthly_credits: number; /** * Field included by default. */ monthly_price: { amount: string; currency: string; }; /** * Field included by default. */ name: string; /** * Per-seat price beyond max_seats. nil = overage not allowed (hard cap). Field included by default. */ overage_seat_price?: { amount: string; currency: string; } | null | unknown; /** * Platform tier this plan maps to. Controls platform-level feature gating. Field included by default. */ plan_tier: "free" | "pro" | "business" | "enterprise"; /** * Window size in seconds for `rate_limit_requests`. `nil` means no * plan-level rate limit. When set, must be > 0. * . Field included by default. */ rate_limit_period_seconds?: number | null; /** * Maximum number of API requests allowed per `rate_limit_period_seconds` * window for tenants subscribed to this plan. `nil` means no plan-level * rate limit (falls back to global default). When set, must be > 0. * * Free-tier plans (`monthly_price` = 0) cannot exceed the platform-wide * ceiling configured via `:platform_free_tier_max_rpm`. * . Field included by default. */ rate_limit_requests?: number | null; /** * The plan subscribers will be migrated to when this plan reaches `sunset_at`. * Must reference a Plan in the same Application. Required when * `lifecycle_status == :sunset_pending`. * . Field included by default. */ replacement_plan_id?: string | null; /** * Field included by default. */ slug: string; /** * Storage included in plan (bytes). Free=1GB, Pro=10GB, Business=50GB, Enterprise=500GB. Field included by default. */ storage_included_bytes: number; /** * Hard ceiling in bytes. Prevents runaway bills. nil = unlimited. Field included by default. */ storage_max_bytes?: number | null; /** * Cents per GB-month overage. Free=0 (hard cap), Pro=25, Business=20, Enterprise=15. Field included by default. */ storage_overage_rate_cents?: number | null; /** * Timestamp at which subscribers on this plan will be force-migrated to * `replacement_plan_id`. Required when `lifecycle_status == :sunset_pending`. * . Field included by default. */ sunset_at?: string | null; /** * Field included by default. */ type: "credits" | "storage" | "credits_storage" | "compute" | "seats" | "agents" | "support"; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a plan */ relationships?: { replacement_plan?: { /** * An identifier for replacement_plan */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; export type CaseTypeDecisionOutcomesInputCreateType = { is_terminal?: boolean | null; label: string; requires_note?: boolean | null; slug: string; }; /** * A "Resource object" representing a claimed-domain */ export type ClaimedDomain = { /** * An attributes object for a claimed-domain */ attributes?: { /** * Workspace IDs to auto-add users to on domain join. Field included by default. */ auto_join_workspace_ids: Array; /** * Role assigned to auto-joined users. Field included by default. */ default_role: "admin" | "member"; /** * Role assigned in auto-joined workspaces. Field included by default. */ default_workspace_role: "admin" | "editor" | "viewer"; /** * The claimed domain (e.g., acme.com). Field included by default. */ domain: string; /** * Field included by default. */ status: "pending" | "verified" | "revoked"; /** * Field included by default. */ tenant_id: string; /** * Field included by default. */ verification_method: "dns_txt" | "dns_cname" | "meta_tag" | "manual"; /** * Field included by default. */ verified_at?: string | null; }; id: string; /** * A relationships object for a claimed-domain */ relationships?: { tenant?: { /** * An identifier for tenant */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a case-document-link */ export type CaseDocumentLink = { /** * An attributes object for a case-document-link */ attributes?: { /** * Field included by default. */ attached_at: unknown; /** * Field included by default. */ auto_attached: boolean; /** * Field included by default. */ case_id: string; /** * Field included by default. */ document_id: string; /** * Field included by default. */ role: "primary" | "evidence" | "supporting"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a case-document-link */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-goal-template-collection */ export type ClinicalGoalTemplateCollection = { /** * An attributes object for a clinical-goal-template-collection */ attributes?: { /** * Field included by default. */ description?: string | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ name: string; template_count?: number | null; }; id: string; /** * A relationships object for a clinical-goal-template-collection */ relationships?: { [key: string]: never; }; type: string; }; export type CaseTypeRequiredReviewsInputUpdateType = { decision_trigger?: "always" | "on_priority" | "never"; field_triggers?: unknown | Array<{ confidence_below?: number | unknown; field: string; }> | Array<{ confidence_below?: number | unknown; field?: string | unknown; }>; }; /** * A "Resource object" representing a schema-discovery */ export type SchemaDiscovery = { /** * An attributes object for a schema-discovery */ attributes?: { /** * Field included by default. */ advanced_mode: boolean; /** * Field included by default. */ created_at: unknown; /** * Field included by default. */ discovered_fields?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ document_assessment?: { [key: string]: unknown; } | null; /** * Field included by default. */ error?: string | null; /** * Field included by default. */ source: "manual" | "ai_suggestions"; /** * Field included by default. */ status: "pending" | "processing" | "completed" | "failed"; /** * Field included by default. */ suggested_name?: string | null; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a schema-discovery */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a feature-summary */ export type FeatureSummary = { /** * An attributes object for a feature-summary */ attributes?: { /** * Whether this feature has been activated (for features with activation_cost). Field included by default. */ activated: boolean; /** * One-time credit cost to activate this feature. Field included by default. */ activation_cost?: number | null; /** * Credits deducted per use (for credit_cost metering). Field included by default. */ credit_cost?: number | null; /** * Whether this feature is enabled for the tenant's plan. Field included by default. */ enabled: boolean; /** * ID of the underlying feature definition. Field included by default. */ feature_definition_id: string; /** * Feature key (e.g., meal_patterns). Field included by default. */ key: string; /** * Usage limit per billing cycle (nil = unlimited). Field included by default. */ limit?: number | null; /** * How this feature is metered. Field included by default. */ metering_mode: "unlimited" | "counted" | "credit_cost"; /** * Feature display name. Field included by default. */ name: string; /** * Remaining usage (limit - used_this_cycle, nil if unlimited). Field included by default. */ remaining?: number | null; /** * Usage count in the current billing cycle. Field included by default. */ used_this_cycle: number; }; id: string; /** * A relationships object for a feature-summary */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a application */ export type Application = { /** * An attributes object for a application */ attributes?: { /** * Multi-tier MFA enforcement policy for this application. * * * `:required` — every user must complete MFA at login * * `:tenant_choice` — defer to each tenant's `mfa_policy`; login-time * aggregate evaluates all user tenants under this application * * `:user_choice` — defer to per-user opt-in via MfaCredential.mfa_required (default) * . Field included by default. */ mfa_policy: "required" | "tenant_choice" | "user_choice"; /** * When true, authenticated users may create org tenants (is_personal: false) via this application. Field included by default. */ allow_org_creation: boolean; acting_tenant_id?: string | null; /** * Controls who can send invitations: :open (any member with invite permission) or :admin_only (tenant admins only). Field included by default. */ invitation_mode: "open" | "admin_only"; /** * OAuth configuration for this application. Field included by default. */ oauth?: { /** * Allowed OAuth callback URLs for this application. Field included by default. */ callback_urls?: Array | null; /** * Default callback URL if not specified in request. Field included by default. */ default_callback_url?: string | null; /** * Which OAuth providers are enabled for this app. Field included by default. */ enabled_providers?: Array<"google" | "github" | "salesforce" | "microsoft"> | null; /** * Custom GitHub OAuth client ID (optional). Field included by default. */ github_client_id?: string | null; /** * Custom GitHub OAuth client secret (optional). Field included by default. */ github_client_secret?: string | null; /** * Custom Google OAuth client ID (optional). Field included by default. */ google_client_id?: string | null; /** * Custom Google OAuth client secret (optional). Field included by default. */ google_client_secret?: string | null; /** * Custom Microsoft OAuth client ID (optional). Field included by default. */ microsoft_client_id?: string | null; /** * Custom Microsoft OAuth client secret (optional). Field included by default. */ microsoft_client_secret?: string | null; } | null | unknown; /** * Email sender address (falls back to system default). Field included by default. */ sender_email?: string | null; /** * Failed logins permitted per email per lockout window before lockout triggers. Field included by default. */ login_lockout_threshold: number; /** * Platform-wide ceiling for concurrent tool execution per agent. Nil means no limit. Field included by default. */ max_parallel_tools_global?: number | null; /** * Maximum concurrent agent executions per workspace. Field included by default. */ max_concurrent_executions_per_workspace: number; /** * Maximum concurrent agent executions per tenant (aggregate across all workspaces). Field included by default. */ max_concurrent_executions_per_tenant: number; /** * Default portal configuration for all tenants under this application. Field included by default. */ portal_defaults?: { [key: string]: unknown; } | null; /** * When true, user registration requires invitation. Field included by default. */ invite_only: boolean; /** * Compliance tags (GDPR, HIPAA, SOC2, etc.) for data-handling safeguards. Tags do not force MFA; app-wide MFA enforcement is configured separately via Application.mfa_policy. Field included by default. */ compliance_tags?: Array | null; /** * ISV's base URL for email links (verification, password reset, magic links). Field included by default. */ base_url: string; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ name: string; /** * Email sender display name (falls back to system default). Field included by default. */ sender_name?: string | null; /** * How the platform delivers auth-related emails (verification, invitation, * and future similar flows) to users for this Application. * * * `:link` - emails contain a click-through URL anchored on `base_url` * * `:code` - emails contain a paste-able 6-character code; no link * * Per-call override is available on each email-emitting action via that * action's own argument (verification: `confirmation_method`; invitation: * `email_method`); the per-call value takes precedence over this default * when set. * . Field included by default. */ system_email_method: "link" | "code"; /** * Sliding window (seconds) over which failed attempts are counted. Field included by default. */ login_lockout_window_seconds: number; current_scopes?: Array | null; /** * Field included by default. */ badge_url?: string | null; /** * Workspace mode: single (auto-resolve) or multi (explicit). Field included by default. */ workspace_mode: "single" | "multi"; /** * Soft-lockout duration (seconds) once the threshold is hit. Field included by default. */ login_lockout_duration_seconds: number; generated_api_key?: string | null; /** * Version of capability_config schema for migration tracking (L1 security finding). Field included by default. */ capability_schema_version?: number | null; /** * Memorable slug for vanity URLs. Field included by default. */ vanity_slug?: string | null; /** * Additional ops/finance contacts for Layer 1 billing communications, * including overdraft warnings, account suspension notices, and payout * failures. Application owner delivery is handled separately. * . Field included by default. */ billing_contact_emails?: Array | null; /** * Payment gateway provider for this application's tenants. Field included by default. */ payment_provider: "qorpay" | "stripe"; /** * Voice session auto-timeout in minutes. NULL falls back to platform default (30). Field included by default. */ voice_session_timeout_minutes?: number | null; /** * Per-workspace concurrent voice session cap. NULL falls back to platform default (10). Field included by default. */ voice_max_sessions_per_workspace?: number | null; /** * When true, password registration withholds JWT until email is verified. Field included by default. */ require_email_verification: boolean; /** * Field included by default. */ slug: string; /** * When true, the application's registry at /r/{app_slug}/ is publicly readable without a token. Field included by default. */ public_registry?: boolean | null; /** * DEPRECATED: Use Plan.initial_credits instead. Credits allocated to new tenants registering via this application. Field included by default. */ default_free_credits: number; /** * Bundles enabled for this application. Standard tier enabled by default; premium bundles require a premium plan. The app-wide opt-in `ai_workload_routing` is added by name, not by default. Field included by default. */ enabled_capabilities?: Array | null; /** * Field included by default. */ logo_url?: string | null; }; id: string; /** * A relationships object for a application */ relationships?: { addons?: { /** * Relationship data for addons */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; credit_packages?: { /** * Relationship data for credit_packages */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; plans?: { /** * Relationship data for plans */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; workspaces?: { /** * Relationship data for workspaces */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; }; type: string; }; /** * A "Resource object" representing a invoices-activity */ export type InvoicesActivity = { /** * An attributes object for a invoices-activity */ attributes?: { /** * Field included by default. */ action: "created" | "status_changed" | "sent" | "viewed" | "payment_recorded" | "ai_enriched" | "ai_anomaly_flagged" | "edited" | "voided" | "comment_added" | "dunning_sent"; /** * Field included by default. */ actor_id?: string | null; /** * Field included by default. */ actor_type: "user" | "system" | "ai" | "automation"; /** * Field included by default. */ details?: { [key: string]: unknown; } | null; }; id: string; /** * A relationships object for a invoices-activity */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-client-supplement */ export type ClinicalClientSupplement = { /** * An attributes object for a clinical-client-supplement */ attributes?: { /** * Adherence percentage for current calendar month. Nil for supplements without frequency. */ adherence_rate?: string | null; /** * Consecutive adherent check-ins ending at today/yesterday. Nil for supplements without frequency. */ current_streak?: number | null; /** * Field included by default. */ discontinued_at?: string | null; /** * Field included by default. */ dosage?: string | null; /** * Field included by default. */ frequency?: string | null; /** * Field included by default. */ fullscript_product_id?: string | null; /** * Field included by default. */ fullscript_treatment_plan_id?: string | null; /** * Field included by default. */ fullscript_variant_id?: string | null; /** * Field included by default. */ instructions?: string | null; /** * Field included by default. */ interaction_flags?: Array | null; is_archived?: boolean | null; /** * Most recent check-in date. Nil for supplements without frequency or no check-ins. */ last_check_in_date?: string | null; /** * Historical maximum streak. Nil for supplements without frequency. */ longest_streak?: number | null; /** * Field included by default. */ metadata: { [key: string]: unknown; }; /** * Field included by default. */ name: string; /** * Field included by default. */ patient_id: string; /** * Field included by default. */ prescribed_at?: string | null; /** * Field included by default. */ protocol_template_id?: string | null; /** * Field included by default. */ rationale_client?: string | null; /** * Field included by default. */ rationale_clinical?: string | null; /** * Field included by default. */ route?: string | null; /** * Field included by default. */ source?: string | null; /** * Field included by default. */ status: "active" | "discontinued" | "on_hold"; }; id: string; /** * A relationships object for a clinical-client-supplement */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a schedule-execution */ export type ScheduleExecution = { /** * An attributes object for a schedule-execution */ attributes?: { /** * Field included by default. */ attempt: number; /** * Field included by default. */ completed_at?: unknown; /** * Field included by default. */ duration_ms?: number | null; /** * Field included by default. */ error_message?: string | null; /** * Field included by default. */ idempotency_key: string; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ result?: { [key: string]: unknown; } | null; /** * Field included by default. */ schedule_id: string; /** * Field included by default. */ scheduled_for: unknown; /** * Field included by default. */ started_at?: unknown; /** * Field included by default. */ status: "pending" | "running" | "succeeded" | "failed" | "skipped"; /** * Field included by default. */ updated_at: unknown; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a schedule-execution */ relationships?: { recurring_schedule?: { /** * An identifier for recurring_schedule */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a bulk-reprocess-result */ export type BulkReprocessResult = { /** * An attributes object for a bulk-reprocess-result */ attributes?: { /** * Field included by default. */ error_count: number; /** * Field included by default. */ errors: Array<{ [key: string]: unknown; }>; /** * Field included by default. */ queued_count: number; /** * Field included by default. */ success: boolean; }; id: string; /** * A relationships object for a bulk-reprocess-result */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a role */ export type Role = { /** * An attributes object for a role */ attributes?: { /** * Field included by default. */ application_id?: string | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ is_system_default: boolean; /** * Field included by default. */ name: string; /** * Field included by default. */ permissions?: Array | null; }; id: string; /** * A relationships object for a role */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a crawler-result */ export type CrawlerResult = { /** * An attributes object for a crawler-result */ attributes?: { [key: string]: never; }; id: string; /** * A relationships object for a crawler-result */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a form-generation-job */ export type FormGenerationJob = { /** * An attributes object for a form-generation-job */ attributes?: { /** * Field included by default. */ application_id: string; /** * Field included by default. */ completed_at?: unknown; /** * Field included by default. */ cost_credits: number; /** * Field included by default. */ error?: { [key: string]: unknown; } | null; /** * Field included by default. */ input_tokens: number; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ model_id?: string | null; /** * Field included by default. */ output_tokens: number; /** * Field included by default. */ started_at?: unknown; /** * Field included by default. */ status: "pending" | "running" | "completed" | "failed"; /** * Field included by default. */ tenant_id: string; /** * Field included by default. */ updated_at: unknown; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a form-generation-job */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; tenant?: { /** * An identifier for tenant */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; workspace?: { /** * An identifier for workspace */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a permission */ export type Permission = { /** * An attributes object for a permission */ attributes?: { /** * Field included by default. */ action: string; /** * Field included by default. */ app: string; /** * Field included by default. */ category: string; /** * Field included by default. */ contexts: Array; /** * Field included by default. */ description: string; /** * Field included by default. */ label: string; /** * Field included by default. */ resource: string; /** * Field included by default. */ scope: string; }; id: string; /** * A relationships object for a permission */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a audit-chain-entry */ export type AuditChainEntry = { /** * An attributes object for a audit-chain-entry */ attributes?: { /** * SHA-256 of (payload_hash + previous_hash + inserted_at + sequence_number). Field included by default. */ entry_hash: string; /** * JSON of the source event struct. Field included by default. */ event_data: { [key: string]: unknown; }; /** * e.g., content_scanned, consent_recorded, breach_reported. Field included by default. */ event_type: string; /** * From event's idempotency_key, prevents duplicate chain entries. Field included by default. */ idempotency_key: string; /** * Timestamp used in hash computation — set explicitly by AuditChain.append. Field included by default. */ inserted_at: unknown; /** * SHA-256 of canonical JSON event_data. Field included by default. */ payload_hash: string; /** * entry_hash of previous entry, or 'genesis' for first. Field included by default. */ previous_hash: string; /** * Field included by default. */ sequence_number: number; /** * HMAC-SHA256 of entry_hash with signing key. Field included by default. */ signature: string; /** * Field included by default. */ signing_key_id: string; }; id: string; /** * A relationships object for a audit-chain-entry */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a webhook-config */ export type WebhookConfig = { /** * An attributes object for a webhook-config */ attributes?: { /** * Field included by default. */ application_id: string; /** * Field included by default. */ enabled?: boolean | null; /** * Field included by default. */ events?: Array | null; /** * Optional payload filter applied before dispatching. When nil, all matching events are * delivered. When set, the expression is evaluated against the event payload and the webhook * is only delivered if it matches. Fails open — malformed expressions pass all events. * * Supported operators: "eq", "not_eq", "contains", "in", "not_null". * * Example: {"path": "data.status", "op": "eq", "value": "completed"} * . Field included by default. */ filter_expression?: { [key: string]: unknown; } | null; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ name: string; /** * Field included by default. */ tenant_id?: string | null; /** * ISV filter: specific tenant UUIDs to receive events from (null = all). Field included by default. */ tenant_ids?: Array | null; /** * Field included by default. */ updated_at: unknown; /** * Field included by default. */ url: string; /** * Tenant filter: specific workspace UUIDs to receive events from (null = all). Field included by default. */ workspace_ids?: Array | null; }; id: string; /** * A relationships object for a webhook-config */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; tenant?: { /** * An identifier for tenant */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a meeting-transcript */ export type MeetingTranscript = { /** * An attributes object for a meeting-transcript */ attributes?: { /** * Field included by default. */ language_code?: string | null; /** * Field included by default. */ meeting_id: string; /** * JSONB array of {speaker, start_offset_ms, end_offset_ms, text}. PHI opt-in: returns ciphertext unless the caller passes the AshJsonApi sparse fieldset `fields[meeting-transcript]=` listing this attribute. */ segments?: { [key: string]: unknown; } | null; /** * Field included by default. */ source: "isv_upload" | "audio_transcribe" | "m365_pull"; /** * PHI opt-in: returns ciphertext unless the caller passes the AshJsonApi sparse fieldset `fields[meeting-transcript]=` listing this attribute. */ transcript_text?: string | null; }; id: string; /** * A relationships object for a meeting-transcript */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a agent-usage */ export type AgentUsage = { /** * An attributes object for a agent-usage */ attributes?: { /** * Field included by default. */ agent_id?: string | null; /** * Field included by default. */ is_shared?: boolean | null; /** * Field included by default. */ is_system?: boolean | null; /** * Field included by default. */ owner?: { [key: string]: unknown; } | null; /** * Field included by default. */ using?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ using_count?: number | null; }; id: string; /** * A relationships object for a agent-usage */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a recipes-enrichment-job */ export type RecipesEnrichmentJob = { /** * An attributes object for a recipes-enrichment-job */ attributes?: { /** * Field included by default. */ completed_at?: unknown; /** * Field included by default. */ confidence_score?: number | null; /** * Field included by default. */ error_message?: string | null; /** * Field included by default. */ recipe_id: string; /** * Field included by default. */ started_at?: unknown; /** * Field included by default. */ status: "pending" | "extracting" | "resolving" | "computing" | "labeling" | "completed" | "failed"; }; id: string; /** * A relationships object for a recipes-enrichment-job */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a email-template-version */ export type EmailTemplateVersion = { /** * An attributes object for a email-template-version */ attributes?: { /** * Field included by default. */ body_html?: string | null; /** * Field included by default. */ body_mjml?: string | null; /** * Field included by default. */ published_at: string; /** * Field included by default. */ template_id: string; /** * Field included by default. */ variable_schema?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ version_number: number; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a email-template-version */ relationships?: { [key: string]: never; }; type: string; }; export type WorkspaceSettingsInputUpdateType = { ai?: { /** * The 'Mentor' Agent (System/Specialty) providing domain context */ base_agent_id?: string | unknown; /** * Agent that classifies documents before extraction (runs at triage) */ classifier_agent_id?: string | unknown; /** * If true, chat interactions automatically update the Custom Agent */ continuous_learning?: boolean | unknown; /** * The 'Student' Agent (Custom) learning specific rules */ custom_agent_id?: string | unknown; /** * Explicitly enabled AI features for this workspace */ enabled_capabilities?: Array | unknown; /** * Maps diarization speaker IDs to role labels for transcript formatting. * E.g.: %{"SPEAKER_00" => "RD", "SPEAKER_01" => "Client"} * ISV-configured. The platform normalizes transcripts to these labels before passing to agents. * */ speaker_role_map?: { [key: string]: unknown; } | unknown; /** * Agent that validates extracted data post-extraction */ validator_agent_id?: string | unknown; /** * Whether validator runs synchronously (:sync) or asynchronously via Oban (:async) */ validator_mode?: "sync" | "async" | unknown; } | null; billing?: { allow_overdraft?: boolean | unknown; /** * Maximum overdraft credits allowed per period */ overdraft_limit?: number | unknown; /** * Period for overdraft limit reset (daily, weekly, monthly) */ overdraft_period?: "daily" | "weekly" | "monthly" | unknown; /** * When the current overdraft period began */ overdraft_period_started_at?: unknown; /** * Credits used from overdraft in current period */ overdraft_used?: number | unknown; } | null; review_train?: { confidence_threshold?: number | unknown; /** * Default ReviewQueue UUID for workspace-scoped reviews when no Case is attached. */ default_review_queue_id?: string | unknown; } | null; storage?: unknown | { errors?: { copy_to_local?: boolean | unknown; local_path?: string | unknown; } | unknown; input?: { local_path?: string | unknown; source?: "local" | "cloud" | unknown; } | unknown; output?: { copy_to_local?: boolean | unknown; local_path?: string | unknown; } | unknown; } | { errors?: unknown; input?: unknown; output?: unknown; }; watcher?: unknown | { claim_expiry_minutes?: number | unknown; /** * Configuration for cloud input sources */ cloud_config?: { /** * Override bucket (defaults to tenant processing bucket) */ bucket?: string | unknown; /** * Delete source file instead of moving to processed */ delete_after_processing?: boolean | unknown; /** * Override error prefix (defaults to workspaces/{id}/errors/) */ error_prefix?: string | unknown; /** * Override input prefix (defaults to workspaces/{id}/input/) */ input_prefix?: string | unknown; poll_interval_seconds?: number | unknown; /** * Override processed prefix (defaults to workspaces/{id}/processed/) */ processed_prefix?: string | unknown; provider?: "s3" | "minio" | "gcs" | unknown; } | unknown; duplicate_action?: "skip" | "move_to_processed" | "move_to_skipped" | unknown; enabled?: boolean | unknown; log_retention_days?: number | unknown; max_retries?: number | unknown; retry_delay_ms?: number | unknown; source_type?: "local" | "cloud" | unknown; } | { claim_expiry_minutes?: number | unknown; /** * Configuration for cloud input sources */ cloud_config?: unknown; duplicate_action?: "skip" | "move_to_processed" | "move_to_skipped" | unknown; enabled?: boolean | unknown; log_retention_days?: number | unknown; max_retries?: number | unknown; retry_delay_ms?: number | unknown; source_type?: "local" | "cloud" | unknown; }; }; /** * A "Resource object" representing a pipeline */ export type Pipeline = { /** * An attributes object for a pipeline */ attributes?: { /** * When set, pipeline belongs to an ISV Application. Null = workspace-owned. Field included by default. */ application_id?: string | null; /** * Field included by default. */ chat_agent_id?: string | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ is_active: boolean; /** * Field included by default. */ name: string; /** * Reactor-compatible node graph definition. Each entry: * "node_id" => %{ * "agent_id" => "uuid", * "inputs" => %{"arg" => "source_node.output"}, * "depends_on" => ["source_node"] * } * . Field included by default. */ nodes: { [key: string]: unknown; }; pipeline_nodes_count?: number | null; /** * Stable identifier that survives database resets. Immutable after creation. Unique per application. Field included by default. */ system_slug?: string | null; /** * How the pipeline is triggered. Field included by default. */ trigger_type: "manual" | "event" | "schedule"; /** * Field included by default. */ updated_at: unknown; /** * Human-readable workflow label for display. Field included by default. */ workflow_label?: string | null; /** * Workflow classification for ISV portal routing. Field included by default. */ workflow_type?: "build" | "troubleshoot" | "security_scan" | "analyze" | "evaluate" | "custom" | "clinical_session" | "clinical_intake"; /** * When set, pipeline is scoped to this workspace. Field included by default. */ workspace_id?: string | null; }; id: string; /** * A relationships object for a pipeline */ relationships?: { chat_agent?: { /** * An identifier for chat_agent */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; pipeline_nodes?: { /** * Relationship data for pipeline_nodes */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; workspace?: { /** * An identifier for workspace */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a catalog-price-list */ export type CatalogPriceList = { /** * An attributes object for a catalog-price-list */ attributes?: { /** * Field included by default. */ application_id: string; /** * Field included by default. */ currency?: string | null; /** * Field included by default. */ default_modifier?: string | null; /** * Field included by default. */ name: string; /** * Field included by default. */ priority?: number | null; /** * Field included by default. */ slug: string; /** * Field included by default. */ status: "active" | "draft" | "expired"; /** * Field included by default. */ strategy: "fixed" | "percentage_discount" | "tiered"; /** * Field included by default. */ valid_from?: unknown; /** * Field included by default. */ valid_until?: unknown; /** * Field included by default. */ workspace_id?: string | null; }; id: string; /** * A relationships object for a catalog-price-list */ relationships?: { [key: string]: never; }; type: string; }; export type InvoicesInvoiceShippingAddressInputCreateType = { city?: string | null; /** * ISO 3166-1 alpha-2 country code */ country?: string | null; line1?: string | null; line2?: string | null; postal_code?: string | null; state?: string | null; }; /** * A "Resource object" representing a recipes-recipe-tag */ export type RecipesRecipeTag = { /** * An attributes object for a recipes-recipe-tag */ attributes?: { /** * Field included by default. */ recipe_id: string; /** * Field included by default. */ tag_id: string; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a recipes-recipe-tag */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a meeting */ export type Meeting = { /** * An attributes object for a meeting */ attributes?: { /** * Map of attendee_email -> %{name, response_status}. */ attendees?: { [key: string]: unknown; } | null; /** * Field included by default. */ custom_fields: { [key: string]: unknown; }; decisions?: Array | null; /** * Field included by default. */ end_time?: unknown; /** * Field included by default. */ external_url?: string | null; /** * Field included by default. */ join_url?: string | null; key_topics?: Array | null; /** * Field included by default. */ last_synced_at?: unknown; /** * Field included by default. */ location?: string | null; /** * Field included by default. */ organizer_email?: string | null; /** * Field included by default. */ processed_at?: unknown; /** * Field included by default. */ source_id: string; /** * Field included by default. */ source_system: "microsoft_365" | "google_calendar" | "manual"; /** * Field included by default. */ start_time?: unknown; /** * Field included by default. */ status: "scheduled" | "in_progress" | "completed" | "cancelled"; /** * Field included by default. */ summary_generated_at?: unknown; /** * Field included by default. */ summary_model?: string | null; /** * Set by :apply_processing — system-only. */ summary_text?: string | null; /** * Field included by default. */ title: string; }; id: string; /** * A relationships object for a meeting */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a feature-definition */ export type FeatureDefinition = { /** * An attributes object for a feature-definition */ attributes?: { /** * Field included by default. */ application_id: string; /** * Field included by default. */ created_at: unknown; /** * Credits deducted per use. Required for :credit_cost mode. Field included by default. */ credit_cost?: number | null; /** * Default usage limit per billing cycle. nil = unlimited. Only applies to :counted mode. Field included by default. */ default_limit?: number | null; /** * Unique feature key within the application (e.g., meal_plans). Field included by default. */ key: string; /** * ISV-custom data (icons, descriptions, display order). Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * How this feature is metered: unlimited, counted (with optional limit), or credit_cost (deducts credits per use). Field included by default. */ metering_mode: "unlimited" | "counted" | "credit_cost"; /** * Human-readable display name. Field included by default. */ name: string; /** * Optional link to a platform capability key. If set, feature is auto-disabled when the capability is off. Field included by default. */ platform_capability?: string | null; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a feature-definition */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a credit-package-catalog */ export type CreditPackageCatalog = { /** * An attributes object for a credit-package-catalog */ attributes?: { /** * Field included by default. */ application_id: string; /** * Field included by default. */ created_at: unknown; /** * Field included by default. */ credits: number; /** * Field included by default. */ name: string; /** * Field included by default. */ price: { amount: string; currency: string; }; /** * Field included by default. */ slug: string; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a credit-package-catalog */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a recipes-scheduled-meal */ export type RecipesScheduledMeal = { /** * An attributes object for a recipes-scheduled-meal */ attributes?: { /** * Field included by default. */ date: string; /** * Field included by default. */ meal_schedule_id: string; /** * Field included by default. */ meal_type: "breakfast" | "lunch" | "dinner" | "snack"; /** * Field included by default. */ recipe_id: string; /** * Field included by default. */ servings?: number | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a recipes-scheduled-meal */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a invoice */ export type Invoice = { /** * An attributes object for a invoice */ attributes?: { /** * Field included by default. */ application_id: string; /** * Field included by default. */ invoice_number: string; /** * Field included by default. */ issued_at?: unknown; /** * Field included by default. */ line_items?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ paid_at?: unknown; /** * Field included by default. */ pdf_storage_key?: string | null; /** * Field included by default. */ period_end: string; /** * Field included by default. */ period_start: string; /** * Field included by default. */ status: "draft" | "issued" | "paid" | "void"; /** * Field included by default. */ subtotal_credits?: number | null; /** * Field included by default. */ subtotal_usd?: string | null; /** * Field included by default. */ tenant_id: string; /** * Field included by default. */ voided_at?: unknown; }; id: string; /** * A relationships object for a invoice */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; tenant?: { /** * An identifier for tenant */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a support-ticket-message */ export type SupportTicketMessage = { /** * An attributes object for a support-ticket-message */ attributes?: { /** * Field included by default. */ ai_draft: boolean; /** * Field included by default. */ body: string; /** * Field included by default. */ channel?: string | null; /** * Field included by default. */ channel_message_id?: string | null; /** * Field included by default. */ is_internal_note: boolean; /** * Field included by default. */ sender_id?: string | null; /** * Field included by default. */ sender_type: "customer" | "agent" | "ai" | "system"; }; id: string; /** * A relationships object for a support-ticket-message */ relationships?: { [key: string]: never; }; type: string; }; export type AgentDeploymentSealPolicyInputUpdateType = { report_format?: "sealed" | "open"; execution_mode?: "sealed" | "open"; theme_overrides?: "sealed" | "open"; disclose_logic_trace?: "sealed" | "open"; prompt_variants?: "sealed" | "open"; chunking_strategy?: "sealed" | "open"; output_schema_locked?: "sealed" | "open"; confidence_weights?: "sealed" | "open"; logic_locked?: "sealed" | "open"; max_cost_credits?: "sealed" | "open"; abandonment_threshold_days?: "sealed" | "open"; theme_locked?: "sealed" | "open"; layout_locked?: "sealed" | "open"; data_retention_days?: "sealed" | "open"; report_template?: "sealed" | "open"; model_id?: "sealed" | "open"; description?: "sealed" | "open"; name?: "sealed" | "open"; temperature?: "sealed" | "open"; allowed_origins?: "sealed" | "open"; logic_rules?: "sealed" | "open"; max_iterations?: "sealed" | "open"; prompt_template?: "sealed" | "open"; output_schema_pins?: Array | null; tags?: "sealed" | "open"; theme_id?: "sealed" | "open"; public_key_jwk?: "sealed" | "open"; instructions?: "sealed" | "open"; max_parallel_tools?: "sealed" | "open"; access_mode?: "sealed" | "open"; chunking_config?: "sealed" | "open"; input_schema_pins?: Array | null; output_schema?: "sealed" | "open"; min_submit_delay_ms?: "sealed" | "open"; assistant_agent_version_id?: "sealed" | "open"; custom_css?: "sealed" | "open"; layout_tree?: "sealed" | "open"; default_instructions?: "sealed" | "open"; tool_grant_pins?: Array | null; max_tool_calls?: "sealed" | "open"; }; /** * A link MUST be represented as either: a string containing the link's URL or a link object. */ export type Link = string; /** * A "Resource object" representing a compliance-requirement */ export type ComplianceRequirement = { /** * An attributes object for a compliance-requirement */ attributes?: { /** * Field included by default. */ application_id: string; /** * Field included by default. */ deadline?: string | null; /** * Field included by default. */ description?: string | null; /** * Regulatory framework: gdpr, hipaa, pci_dss, etc. Field included by default. */ framework?: string | null; /** * Field included by default. */ is_blocking: boolean; /** * Field included by default. */ recurrence_days?: number | null; /** * Field included by default. */ recurring: boolean; /** * Field included by default. */ required_for_roles: Array; /** * Field included by default. */ requirement_type: "training" | "policy_acknowledgement" | "background_check" | "certification" | "attestation"; /** * Field included by default. */ title: string; }; id: string; /** * A relationships object for a compliance-requirement */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a form-respondent-token */ export type FormRespondentToken = { /** * An attributes object for a form-respondent-token */ attributes?: { /** * Field included by default. */ expires_at?: unknown; /** * Field included by default. */ identifier_hint?: string | null; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ last_used_at?: unknown; /** * Field included by default. */ max_uses_per_day: number; /** * Field included by default. */ publication_id: string; /** * Field included by default. */ revoked_at?: unknown; /** * Field included by default. */ updated_at: unknown; /** * Field included by default. */ usage_count: number; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a form-respondent-token */ relationships?: { publication?: { /** * An identifier for publication */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; workspace?: { /** * An identifier for workspace */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a transaction */ export type Transaction = { /** * An attributes object for a transaction */ attributes?: { /** * The amount of the transaction. For monetary transactions, this is in cents. For credit usage, this is in credits. Field included by default. */ amount: number; /** * Field included by default. */ created_at: unknown; /** * Field included by default. */ credits_added?: number | null; /** * Field included by default. */ credits_used?: number | null; /** * Field included by default. */ currency?: string | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ operation?: "subscription" | "topup" | "extraction" | "training" | "refund" | "addon"; /** * Field included by default. */ service_id?: string | null; /** * Field included by default. */ status: "pending" | "success" | "failed" | "refunded" | "voided"; /** * Field included by default. */ tenant_id: string; /** * Field included by default. */ transaction_type?: "credit" | "debit"; /** * Field included by default. */ type?: "sale" | "auth" | "refund" | "void"; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a transaction */ relationships?: { [key: string]: never; }; type: string; }; export type SchedulingAvailabilityRuleWeeklyScheduleInputUpdateType = { friday?: Array | null; monday?: unknown | Array<{ end: string; start: string; }> | Array<{ end?: string | unknown; start?: string | unknown; }>; saturday?: Array | null; sunday?: Array | null; thursday?: Array | null; tuesday?: Array | null; wednesday?: Array | null; }; /** * A "Resource object" representing a search-analytics */ export type SearchAnalytics = { /** * An attributes object for a search-analytics */ attributes?: { /** * Field included by default. */ avg_latency_ms?: number | null; /** * Field included by default. */ avg_result_count?: number | null; /** * Field included by default. */ keyword_searches?: number | null; /** * Field included by default. */ latency_ms?: number | null; /** * Field included by default. */ query: string; /** * Field included by default. */ result_count?: number | null; /** * Field included by default. */ routed_via?: "smart_router" | "explicit"; /** * Field included by default. */ search_type: "keyword" | "semantic" | "suggest" | "batch"; /** * Field included by default. */ semantic_searches?: number | null; /** * Field included by default. */ tenant_id: string; /** * Field included by default. */ total_searches?: number | null; /** * Field included by default. */ user_id?: string | null; }; id: string; /** * A relationships object for a search-analytics */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a chunk-entity-link */ export type ChunkEntityLink = { /** * An attributes object for a chunk-entity-link */ attributes?: { /** * Field included by default. */ chunk_index?: number | null; /** * Field included by default. */ document_chunk_id: string; /** * Field included by default. */ document_id: string; /** * Field included by default. */ entity_label: string; /** * Field included by default. */ entity_type?: string | null; /** * Field included by default. */ graph_node_id: string; /** * Field included by default. */ relevance_score?: number | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a chunk-entity-link */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a extraction-agent */ export type ExtractionAgent = { /** * An attributes object for a extraction-agent */ attributes?: { /** * Description of what this agent is good at, used for AI matching. Field included by default. */ capabilities: string; /** * Field included by default. */ description: string; /** * Field included by default. */ name: string; /** * Field included by default. */ slug: string; }; id: string; /** * A relationships object for a extraction-agent */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a extraction-analysis */ export type ExtractionAnalysis = { /** * An attributes object for a extraction-analysis */ attributes?: { /** * Field included by default. */ analysis_duration_ms?: number | null; /** * Field included by default. */ analysis_version: string; /** * Field included by default. */ analyzers_run?: Array | null; /** * Field included by default. */ barcodes?: Array | null; /** * Field included by default. */ blur_score?: number | null; /** * Field included by default. */ checkboxes_count?: number | null; /** * Field included by default. */ currency_amounts?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ dates_found?: Array | null; /** * Field included by default. */ entities_locations?: Array | null; /** * Field included by default. */ entities_organizations?: Array | null; /** * Field included by default. */ entities_people?: Array | null; /** * Field included by default. */ errors?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ extraction_result_id: string; /** * Field included by default. */ form_fields_count?: number | null; /** * Field included by default. */ handwriting_ratio?: number | null; /** * Field included by default. */ ocr_overall_confidence?: number | null; /** * Field included by default. */ phi_detected?: boolean | null; /** * Field included by default. */ phi_types?: Array | null; /** * Field included by default. */ pii_detected?: boolean | null; /** * Field included by default. */ pii_locations?: { [key: string]: unknown; } | null; /** * Field included by default. */ pii_types?: Array | null; /** * Field included by default. */ qr_codes?: Array | null; /** * Field included by default. */ redactions_detected?: number | null; /** * Field included by default. */ rotation_degrees?: number | null; /** * Field included by default. */ signatures_count?: number | null; /** * Field included by default. */ skew_degrees?: number | null; /** * Field included by default. */ tables_count?: number | null; /** * Field included by default. */ watermark_text?: string | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a extraction-analysis */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a agent-deployment */ export type AgentDeployment = { /** * An attributes object for a agent-deployment */ attributes?: { /** * Field included by default. */ allow_tenant_clone: boolean; /** * Field included by default. */ application_id: string; /** * Field included by default. */ auto_deploy_agents: boolean; /** * Field included by default. */ available_version_id?: string | null; /** * Field included by default. */ catalog_agent_id: string; /** * Field included by default. */ effective_version_id: string; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ is_application_default: boolean; /** * Field included by default. */ overrides: { [key: string]: unknown; }; /** * Field included by default. */ pinned_version_id?: string | null; /** * Field included by default. */ seal_policy?: { /** * Field included by default. */ report_format?: "sealed" | "open"; /** * Field included by default. */ execution_mode?: "sealed" | "open"; /** * Field included by default. */ theme_overrides?: "sealed" | "open"; /** * Field included by default. */ disclose_logic_trace?: "sealed" | "open"; /** * Field included by default. */ prompt_variants?: "sealed" | "open"; /** * Field included by default. */ chunking_strategy?: "sealed" | "open"; /** * Field included by default. */ output_schema_locked?: "sealed" | "open"; /** * Field included by default. */ confidence_weights?: "sealed" | "open"; /** * Field included by default. */ logic_locked?: "sealed" | "open"; /** * Field included by default. */ max_cost_credits?: "sealed" | "open"; /** * Field included by default. */ abandonment_threshold_days?: "sealed" | "open"; /** * Field included by default. */ theme_locked?: "sealed" | "open"; /** * Field included by default. */ layout_locked?: "sealed" | "open"; /** * Field included by default. */ data_retention_days?: "sealed" | "open"; /** * Field included by default. */ report_template?: "sealed" | "open"; /** * Field included by default. */ model_id?: "sealed" | "open"; /** * Field included by default. */ description?: "sealed" | "open"; /** * Field included by default. */ name?: "sealed" | "open"; /** * Field included by default. */ temperature?: "sealed" | "open"; /** * Field included by default. */ allowed_origins?: "sealed" | "open"; /** * Field included by default. */ logic_rules?: "sealed" | "open"; /** * Field included by default. */ max_iterations?: "sealed" | "open"; /** * Field included by default. */ prompt_template?: "sealed" | "open"; /** * Field included by default. */ output_schema_pins?: Array | null; /** * Field included by default. */ tags?: "sealed" | "open"; /** * Field included by default. */ theme_id?: "sealed" | "open"; /** * Field included by default. */ public_key_jwk?: "sealed" | "open"; /** * Field included by default. */ instructions?: "sealed" | "open"; /** * Field included by default. */ max_parallel_tools?: "sealed" | "open"; /** * Field included by default. */ access_mode?: "sealed" | "open"; /** * Field included by default. */ chunking_config?: "sealed" | "open"; /** * Field included by default. */ input_schema_pins?: Array | null; /** * Field included by default. */ output_schema?: "sealed" | "open"; /** * Field included by default. */ min_submit_delay_ms?: "sealed" | "open"; /** * Field included by default. */ assistant_agent_version_id?: "sealed" | "open"; /** * Field included by default. */ custom_css?: "sealed" | "open"; /** * Field included by default. */ layout_tree?: "sealed" | "open"; /** * Field included by default. */ default_instructions?: "sealed" | "open"; /** * Field included by default. */ tool_grant_pins?: Array | null; /** * Field included by default. */ max_tool_calls?: "sealed" | "open"; } | null | unknown; /** * Field included by default. */ tenant_id: string; /** * Field included by default. */ update_available: boolean; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a agent-deployment */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; available_version?: { /** * An identifier for available_version */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; catalog_agent?: { /** * An identifier for catalog_agent */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; effective_version?: { /** * An identifier for effective_version */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; pinned_version?: { /** * An identifier for pinned_version */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a training-analytics */ export type TrainingAnalytics = { /** * An attributes object for a training-analytics */ attributes?: { /** * Field included by default. */ accuracy_improvement?: number | null; /** * Field included by default. */ accuracy_trend?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ avg_confidence?: number | null; /** * Field included by default. */ confidence_threshold?: number | null; /** * Field included by default. */ docs_needing_review_count?: number | null; /** * Field included by default. */ low_confidence_documents?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ top_corrected_field?: string | null; /** * Field included by default. */ top_field_correction_count?: number | null; /** * Field included by default. */ total_examples?: number | null; /** * Field included by default. */ total_fields_confirmed?: number | null; /** * Field included by default. */ total_fields_corrected?: number | null; /** * Field included by default. */ total_fields_reviewed?: number | null; /** * Field included by default. */ trained?: number | null; /** * Field included by default. */ workspace_id?: string | null; }; id: string; /** * A relationships object for a training-analytics */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a storage-recommendation */ export type StorageRecommendation = { /** * An attributes object for a storage-recommendation */ attributes?: { /** * Field included by default. */ affected_file_ids?: Array | null; /** * Field included by default. */ description: string; /** * Field included by default. */ potential_savings?: number | null; /** * Field included by default. */ recommendation_type: "stale_files" | "duplicates" | "retention_suggestion" | "large_files"; /** * Field included by default. */ resolved_at?: unknown; /** * Field included by default. */ status: "pending" | "accepted" | "dismissed"; /** * Field included by default. */ title: string; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a storage-recommendation */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a data-subject-request */ export type DataSubjectRequest = { /** * An attributes object for a data-subject-request */ attributes?: { /** * Subject's appeal statement if request was denied. Field included by default. */ appeal_statement?: string | null; /** * Field included by default. */ completed_at?: unknown; /** * Field included by default. */ data_subject_email: string; /** * GDPR 30-day response deadline. Field included by default. */ deadline?: unknown; /** * Legal grounds for denying the request (HIPAA permits specific grounds). Field included by default. */ denial_grounds?: string | null; /** * HIPAA fee for access requests (cost-based, not unreasonable). Field included by default. */ fee_amount?: string | null; /** * Field included by default. */ notes?: string | null; /** * Field included by default. */ request_type: "access" | "erasure" | "portability" | "rectification" | "restriction" | "hipaa_access" | "hipaa_amendment" | "hipaa_restriction" | "hipaa_disclosure_accounting"; /** * Email or identifier of the person who submitted the request. Field included by default. */ requested_by: string; /** * Field included by default. */ status: "pending" | "in_progress" | "completed" | "rejected" | "expired"; /** * Third party to receive PHI copy (HIPAA right of access). Field included by default. */ third_party_recipient?: string | null; }; id: string; /** * A relationships object for a data-subject-request */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a crm-pipeline-stage */ export type CrmPipelineStage = { /** * An attributes object for a crm-pipeline-stage */ attributes?: { /** * Field included by default. */ automation_trigger?: string | null; /** * Field included by default. */ forecast_category?: "pipeline" | "best_case" | "commit" | "closed_won" | "closed_lost"; /** * Field included by default. */ is_closed: boolean; /** * Field included by default. */ name: string; /** * Field included by default. */ order: number; /** * Field included by default. */ probability?: number | null; }; id: string; /** * A relationships object for a crm-pipeline-stage */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a section-document */ export type SectionDocument = { /** * An attributes object for a section-document */ attributes?: { /** * Field included by default. */ doc_path?: string | null; /** * Field included by default. */ format?: "markdown" | "mdx" | "html" | "text" | "rst"; /** * Field included by default. */ indexed_at?: unknown; /** * Field included by default. */ section_count?: number | null; /** * Field included by default. */ source_id?: string | null; /** * Field included by default. */ source_type: "extraction" | "crawler" | "knowledge_file" | "direct"; /** * Field included by default. */ source_url?: string | null; }; id: string; /** * A relationships object for a section-document */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a tenant */ export type Tenant = { /** * An attributes object for a tenant */ attributes?: { /** * Field included by default. */ application_id?: string | null; /** * Amount of credits to purchase during auto top-up. Field included by default. */ auto_top_up_amount: number; /** * Field included by default. */ auto_top_up_enabled: boolean; /** * The credit package to purchase when auto top-up is triggered. Field included by default. */ auto_top_up_package_id?: string | null; /** * Credit balance threshold to trigger auto top-up. Field included by default. */ auto_top_up_threshold: number; /** * Field included by default. */ badge_url?: string | null; /** * Field included by default. */ contact_email?: string | null; /** * Field included by default. */ contact_phone?: string | null; credit_balance?: number | null; /** * Field included by default. */ deactivated_at?: unknown; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ initial_credits?: number | null; /** * True for auto-created personal tenants, false for organizations. Field included by default. */ is_personal: boolean; /** * Field included by default. */ kind: "platform" | "isv" | "tenant"; /** * Field included by default. */ logo_url?: string | null; /** * Freeform metadata for ISV-specific configuration (e.g. payout details). Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Tenant-level MFA enforcement policy. * * * `:required` — every request scoped to this tenant must present a session * JWT with `mfa_satisfied: true`. Enforced by the * `GptCoreWeb.Plugs.RequireTenantMfa` plug at request time. * * `:user_choice` — defer to per-user opt-in (default) * * Does not support `:tenant_choice` — that would be a cycle. * . Field included by default. */ mfa_policy: "required" | "user_choice"; /** * Field included by default. */ name: string; /** * Subscription tier that gates feature access. Field included by default. */ plan_tier: "free" | "pro" | "business" | "enterprise"; /** * Tenant-specific portal configuration overrides (merged over Application portal_defaults). Field included by default. */ portal_overrides?: { [key: string]: unknown; } | null; /** * Field included by default. */ slug: string; /** * Lifecycle status of the tenant. Field included by default. */ status: "active" | "suspended" | "cancelled" | "archived"; storage_quota_bytes?: number | null; /** * True if this tenant has Bucket DB rows for all three storage types (public/private/processing). Cheap DB-only check; does NOT call GCS. */ "storage_ready?"?: boolean | null; /** * Tenant-set overage ceiling in bytes. nil = use plan max. Field included by default. */ storage_spending_cap_bytes?: number | null; storage_used_bytes?: number | null; /** * Field included by default. */ suspended_at?: unknown; /** * Field included by default. */ suspension_reason?: string | null; /** * Cost in credits for training on a single document. Field included by default. */ training_price_credits: number; /** * Training pricing info for this tenant */ training_pricing?: { [key: string]: unknown; } | null; /** * Memorable slug for vanity URLs. Field included by default. */ vanity_slug?: string | null; }; id: string; /** * A relationships object for a tenant */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; workspaces?: { /** * Relationship data for workspaces */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; }; type: string; }; export type CaseTypeGroupingRulesInputUpdateType = { confidence_threshold?: number | null; default_behavior?: "match_or_create" | "match_only" | "create_only"; match_by_fields?: Array | null; match_window_hours?: number | null; }; /** * A "Resource object" representing a breach-notification */ export type BreachNotification = { /** * An attributes object for a breach-notification */ attributes?: { /** * Field included by default. */ affected_count: number; /** * Field included by default. */ breach_type: "phi_disclosure" | "phi_theft" | "phi_unauthorized_access" | "other"; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ discovery_date: string; /** * Field included by default. */ hhs_notification_date?: string | null; /** * Field included by default. */ notification_deadline?: string | null; /** * Field included by default. */ privacy_officer_contact?: string | null; /** * Field included by default. */ privacy_officer_notified?: boolean | null; /** * Field included by default. */ remediation_steps?: string | null; /** * Field included by default. */ status: "identified" | "notifying_privacy_officer" | "notified_hhs" | "resolved" | "false_positive"; }; id: string; /** * A relationships object for a breach-notification */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a agent-version-comparison */ export type AgentVersionComparison = { /** * An attributes object for a agent-version-comparison */ attributes?: { /** * Field included by default. */ created_at: unknown; /** * Field included by default. */ prompt_diff: { [key: string]: unknown; }; /** * Field included by default. */ schema_diff: { [key: string]: unknown; }; /** * Field included by default. */ version_a_id: string; /** * Field included by default. */ version_a_number: string; /** * Field included by default. */ version_b_id: string; /** * Field included by default. */ version_b_number: string; }; id: string; /** * A relationships object for a agent-version-comparison */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-session */ export type ClinicalSession = { /** * An attributes object for a clinical-session */ attributes?: { /** * Field included by default. */ duration_minutes?: number | null; /** * Field included by default. */ event_id?: string | null; /** * Field included by default. */ external_owner_id?: string | null; /** * Field included by default. */ metadata: { [key: string]: unknown; }; /** * Field included by default. */ owner_id?: string | null; /** * Field included by default. */ patient_id: string; /** * Field included by default. */ pipeline_execution_id?: string | null; /** * Field included by default. */ prep_execution_id?: string | null; /** * Field included by default. */ session_date?: string | null; /** * Field included by default. */ session_format: "in_person" | "telehealth" | "phone" | "async"; /** * Field included by default. */ session_status: "scheduled" | "in_progress" | "completed" | "cancelled" | "no_show"; /** * Field included by default. */ session_type: "initial" | "followup" | "discharge" | "emergency" | "group" | "phone_encounter" | "coordination" | "administrative"; }; id: string; /** * A relationships object for a clinical-session */ relationships?: { meal_plans?: { /** * Relationship data for meal_plans */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; session_notes?: { /** * Relationship data for session_notes */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; }; type: string; }; /** * A "Resource object" representing a policy-review-schedule */ export type PolicyReviewSchedule = { /** * An attributes object for a policy-review-schedule */ attributes?: { /** * Field included by default. */ application_id: string; /** * Field included by default. */ last_reviewed_at?: string | null; /** * Field included by default. */ next_review_due: string; /** * Field included by default. */ review_frequency_days: number; /** * Field included by default. */ review_notes?: string | null; /** * Field included by default. */ status: "current" | "review_due" | "overdue"; }; id: string; /** * A relationships object for a policy-review-schedule */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a meeting-action-item */ export type MeetingActionItem = { /** * An attributes object for a meeting-action-item */ attributes?: { /** * Field included by default. */ assignee_text?: string | null; /** * Field included by default. */ confidence?: string | null; /** * Field included by default. */ due_date_hint?: string | null; /** * Field included by default. */ extraction_metadata: { [key: string]: unknown; }; /** * Field included by default. */ extraction_model?: string | null; /** * Field included by default. */ meeting_id: string; /** * Field included by default. */ priority: "low" | "medium" | "high" | "critical"; task_text?: string | null; }; id: string; /** * A relationships object for a meeting-action-item */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a trending-snapshot */ export type TrendingSnapshot = { /** * An attributes object for a trending-snapshot */ attributes?: { /** * Field included by default. */ enrichment_level: "raw" | "scored" | "summarized" | "full"; /** * Field included by default. */ fetched_at: unknown; /** * Field included by default. */ item_count: number; /** * Field included by default. */ query?: string | null; /** * Field included by default. */ source_breakdown: { [key: string]: unknown; }; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a trending-snapshot */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a saved-search */ export type SavedSearch = { /** * An attributes object for a saved-search */ attributes?: { /** * Field included by default. */ executed_at?: string | null; /** * Field included by default. */ filters?: { [key: string]: unknown; } | null; /** * Field included by default. */ is_shared?: boolean | null; /** * Field included by default. */ name: string; /** * Field included by default. */ query: string; /** * Field included by default. */ search_type?: "keyword" | "semantic"; }; id: string; /** * A relationships object for a saved-search */ relationships?: { [key: string]: never; }; type: string; }; export type RecipesShoppingListType = { /** * Field included by default. */ contact_id?: string | null; /** * Field included by default. */ id?: string | null; /** * Field included by default. */ meal_schedule_id?: string | null; /** * Field included by default. */ name: string; /** * Field included by default. */ status: "draft" | "active" | "completed"; /** * Field included by default. */ workspace_id: string; }; /** * A "Resource object" representing a invoices-line */ export type InvoicesLine = { /** * An attributes object for a invoices-line */ attributes?: { /** * Field included by default. */ ai_gl_confidence?: string | null; /** * Field included by default. */ ai_suggested_gl?: string | null; /** * Field included by default. */ amount?: string | null; /** * Field included by default. */ category?: string | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ gl_code?: string | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ position: number; /** * Field included by default. */ quantity?: string | null; /** * Field included by default. */ tax_amount?: string | null; /** * Field included by default. */ tax_rate?: string | null; /** * Field included by default. */ unit_price?: string | null; }; id: string; /** * A relationships object for a invoices-line */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a news-summary */ export type NewsSummary = { /** * An attributes object for a news-summary */ attributes?: { /** * Field included by default. */ articles: { [key: string]: unknown; }; /** * Field included by default. */ generated_at: unknown; metadata: { [key: string]: unknown; }; /** * Field included by default. */ model: string; /** * Field included by default. */ news_monitor_id: string; /** * Field included by default. */ period_end: unknown; /** * Field included by default. */ period_start: unknown; /** * Field included by default. */ source_count: number; /** * Field included by default. */ summary_text: string; }; id: string; /** * A relationships object for a news-summary */ relationships?: { news_monitor?: { /** * An identifier for news_monitor */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a document-stats */ export type DocumentStats = { /** * An attributes object for a document-stats */ attributes?: { /** * Field included by default. */ completed?: number | null; /** * Field included by default. */ failed?: number | null; /** * Field included by default. */ processing?: number | null; /** * Field included by default. */ queued?: number | null; /** * Field included by default. */ total?: number | null; }; id: string; /** * A relationships object for a document-stats */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-meal-plan */ export type ClinicalMealPlan = { /** * An attributes object for a clinical-meal-plan */ attributes?: { /** * Field included by default. */ additional_tips?: Array | null; /** * Field included by default. */ clinical_rationale?: string | null; /** * Field included by default. */ food_group_targets?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ goal_calories?: number | null; /** * Field included by default. */ hand_portions?: { [key: string]: unknown; } | null; /** * Field included by default. */ hydration_guidelines?: string | null; /** * Field included by default. */ intro_paragraph?: string | null; is_archived?: boolean | null; /** * Field included by default. */ meal_schedule_id?: string | null; /** * Field included by default. */ metadata: { [key: string]: unknown; }; /** * Field included by default. */ next_steps?: Array | null; /** * Field included by default. */ nutrition_targets?: { [key: string]: unknown; } | null; /** * Field included by default. */ parent_plan_id?: string | null; /** * Field included by default. */ patient_id?: string | null; /** * Field included by default. */ pipeline_execution_id?: string | null; /** * Field included by default. */ plan_type: "daily" | "weekly" | "monthly"; /** * Field included by default. */ remember_message?: string | null; /** * Field included by default. */ session_id?: string | null; /** * Field included by default. */ status: "draft" | "approved" | "archived" | "sent_to_client"; }; id: string; /** * A relationships object for a clinical-meal-plan */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a amendment-request */ export type AmendmentRequest = { /** * An attributes object for a amendment-request */ attributes?: { /** * Field included by default. */ applied_at?: string | null; /** * Field included by default. */ deadline: string; /** * Field included by default. */ denial_reason?: string | null; /** * Domain that owns the resource to amend. Validated against AmendableResource registry. Field included by default. */ domain: string; /** * Field included by default. */ request_reason: string; /** * Field included by default. */ requested_changes: { [key: string]: unknown; }; /** * Field included by default. */ resource_id: string; /** * Type of resource to amend (e.g., clinical_note). Field included by default. */ resource_type: string; /** * Field included by default. */ reviewed_at?: string | null; /** * Field included by default. */ status: "pending" | "in_review" | "approved" | "denied" | "applied"; /** * Field included by default. */ subject_id: string; /** * Type of requesting subject (e.g., patient). Field included by default. */ subject_type: string; }; id: string; /** * A relationships object for a amendment-request */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a oauth-app-config */ export type OauthAppConfig = { /** * An attributes object for a oauth-app-config */ attributes?: { /** * Field included by default. */ application_id?: string | null; /** * Field included by default. */ platform: "facebook" | "instagram" | "threads" | "twitter" | "linkedin" | "reddit" | "bluesky"; /** * Field included by default. */ scope_type: "application" | "tenant"; /** * Field included by default. */ scopes: Array; /** * Field included by default. */ tenant_id?: string | null; }; id: string; /** * A relationships object for a oauth-app-config */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a credential */ export type Credential = { /** * An attributes object for a credential */ attributes?: { /** * Field included by default. */ application_id?: string | null; /** * Field included by default. */ auth_type: "oauth2" | "api_key" | "basic_auth" | "client_credentials"; /** * Field included by default. */ connector_type: "salesforce" | "hubspot" | "slack" | "notion" | "sharepoint" | "gmail" | "outlook" | "microsoft_365" | "practice_better" | "jira" | "confluence" | "fullscript" | "fhir_r4" | "github" | "gitlab" | "google_calendar" | "google_chat" | "custom" | "edamam" | "facebook" | "instagram" | "threads" | "twitter" | "linkedin" | "reddit" | "bluesky" | "newsapi" | "gnews" | "bing_news" | "corehealth" | "healthie"; /** * Field included by default. */ expires_at?: string | null; /** * Field included by default. */ last_refreshed_at?: string | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ refresh_status?: "valid" | "expiring_soon" | "refresh_failed" | "revoked"; /** * Field included by default. */ scope_level: "workspace" | "tenant" | "application"; /** * Field included by default. */ tenant_id?: string | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a credential */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a recipes-ingredient */ export type RecipesIngredient = { /** * An attributes object for a recipes-ingredient */ attributes?: { /** * Field included by default. */ food_group?: string | null; /** * Field included by default. */ food_item_id?: string | null; /** * Field included by default. */ name: string; /** * Field included by default. */ preparation_note?: string | null; /** * Field included by default. */ quantity?: number | null; /** * Field included by default. */ recipe_id: string; /** * Field included by default. */ sort_order?: number | null; /** * Field included by default. */ unit?: string | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a recipes-ingredient */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a social-account */ export type SocialAccount = { /** * An attributes object for a social-account */ attributes?: { /** * Field included by default. */ account_type: "personal" | "page" | "business" | "creator"; /** * Field included by default. */ avatar_url?: string | null; /** * Field included by default. */ display_name?: string | null; /** * Field included by default. */ is_active: boolean; /** * Field included by default. */ last_verified_at?: unknown; /** * Field included by default. */ metadata: { [key: string]: unknown; }; /** * Field included by default. */ platform: "facebook" | "instagram" | "threads" | "twitter" | "linkedin" | "reddit" | "bluesky"; /** * Field included by default. */ platform_user_id: string; /** * Field included by default. */ posting_enabled: boolean; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a social-account */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a post-processing-hook */ export type PostProcessingHook = { /** * An attributes object for a post-processing-hook */ attributes?: { /** * Optional application scope. When set, hook only runs for documents from this application. */ application_id?: string | null; /** * Whether webhook response can modify extracted fields (webhook type only). Field included by default. */ can_modify: boolean; /** * Type-specific configuration: * webhook: %{"url" => string, "timeout_ms" => integer, "retry_count" => integer, "headers" => map, "signing_secret" => string} * oban_worker: %{"worker" => string, "queue" => string, "args" => map} * reactor_step: %{"module" => string, "opts" => map} * . Field included by default. */ config?: { [key: string]: unknown; } | null; /** * Field included by default. */ enabled: boolean; /** * Glob patterns for fields that trigger this hook. Empty = all fields. Max 20. Field included by default. */ field_filter?: Array | null; /** * Human-readable hook name. Field included by default. */ name: string; /** * Execution order (ascending). Hooks at same order run sequentially. Field included by default. */ order: number; /** * When this hook fires in the extraction lifecycle. Field included by default. */ trigger: "after_extraction" | "after_validation" | "before_downstream"; /** * Execution type: webhook, oban_worker, or reactor_step. Field included by default. */ type: "webhook" | "oban_worker" | "reactor_step"; workspace_id: string; }; id: string; /** * A relationships object for a post-processing-hook */ relationships?: { [key: string]: never; }; type: string; }; export type CredentialType = { /** * Field included by default. */ application_id?: string | null; /** * Field included by default. */ auth_type: "oauth2" | "api_key" | "basic_auth" | "client_credentials"; /** * Field included by default. */ connector_type: "salesforce" | "hubspot" | "slack" | "notion" | "sharepoint" | "gmail" | "outlook" | "microsoft_365" | "practice_better" | "jira" | "confluence" | "fullscript" | "fhir_r4" | "github" | "gitlab" | "google_calendar" | "google_chat" | "custom" | "edamam" | "facebook" | "instagram" | "threads" | "twitter" | "linkedin" | "reddit" | "bluesky" | "newsapi" | "gnews" | "bing_news" | "corehealth" | "healthie"; /** * Field included by default. */ expires_at?: string | null; /** * Field included by default. */ id?: string | null; /** * Field included by default. */ last_refreshed_at?: string | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ refresh_status?: "valid" | "expiring_soon" | "refresh_failed" | "revoked"; /** * Field included by default. */ scope_level: "workspace" | "tenant" | "application"; /** * Field included by default. */ tenant_id?: string | null; /** * Field included by default. */ workspace_id: string; }; /** * A "Resource object" representing a catalog-stock-record */ export type CatalogStockRecord = { /** * An attributes object for a catalog-stock-record */ attributes?: { /** * Field included by default. */ product_id?: string | null; /** * Field included by default. */ quantity_on_hand: number; /** * Field included by default. */ quantity_reserved: number; /** * Field included by default. */ reorder_point?: number | null; /** * Field included by default. */ reorder_quantity?: number | null; /** * Field included by default. */ stock_location_id: string; /** * Field included by default. */ unit_cost?: string | null; /** * Field included by default. */ variant_id?: string | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a catalog-stock-record */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a catalog-classification-suggestion */ export type CatalogClassificationSuggestion = { /** * An attributes object for a catalog-classification-suggestion */ attributes?: { /** * Field included by default. */ confidence: number; /** * Field included by default. */ reasoning: string; /** * Field included by default. */ status: "pending" | "accepted" | "rejected"; /** * Field included by default. */ suggested_node_name?: string | null; /** * Field included by default. */ suggested_parent_id?: string | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a catalog-classification-suggestion */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a compliance-requirement-completion */ export type ComplianceRequirementCompletion = { /** * An attributes object for a compliance-requirement-completion */ attributes?: { /** * Field included by default. */ completed_at: string; /** * Field included by default. */ evidence?: { [key: string]: unknown; } | null; /** * Field included by default. */ expires_at?: string | null; /** * Field included by default. */ requirement_id: string; /** * Field included by default. */ user_id: string; }; id: string; /** * A relationships object for a compliance-requirement-completion */ relationships?: { requirement?: { /** * An identifier for requirement */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a breach-incident */ export type BreachIncident = { /** * An attributes object for a breach-incident */ attributes?: { /** * Number of affected data subjects. Field included by default. */ affected_count?: number | null; /** * Field included by default. */ description: string; /** * Field included by default. */ discovery_date: unknown; /** * Field included by default. */ incident_type: "data_breach" | "unauthorized_access" | "data_loss" | "system_compromise" | "insider_threat"; /** * Regulatory notification deadline (72h GDPR or 60 days HIPAA). Field included by default. */ notification_deadline?: unknown; /** * Field included by default. */ privacy_officer_notified: boolean; /** * Field included by default. */ regulator_notified: boolean; /** * Field included by default. */ remediation_notes?: string | null; /** * Field included by default. */ status: "identified" | "investigating" | "notifying" | "resolved" | "false_positive"; }; id: string; /** * A relationships object for a breach-incident */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a catalog-product-variant */ export type CatalogProductVariant = { /** * An attributes object for a catalog-product-variant */ attributes?: { /** * Field included by default. */ media?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ position?: number | null; /** * Field included by default. */ price_override?: string | null; /** * Field included by default. */ properties?: { [key: string]: unknown; } | null; /** * Field included by default. */ sku: string; /** * Field included by default. */ status: "active" | "archived"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a catalog-product-variant */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a workspace-form-config */ export type WorkspaceFormConfig = { /** * An attributes object for a workspace-form-config */ attributes?: { /** * Field included by default. */ created_at: unknown; /** * Field included by default. */ form_deployment_id: string; /** * Field included by default. */ overrides: { [key: string]: unknown; }; /** * Field included by default. */ schema_overrides: { [key: string]: unknown; }; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a workspace-form-config */ relationships?: { form_deployment?: { /** * An identifier for form_deployment */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; workspace?: { /** * An identifier for workspace */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a composite-operation */ export type CompositeOperation = { /** * An attributes object for a composite-operation */ attributes?: { /** * Application this composite operation belongs to. Field included by default. */ application_id: string; /** * List of {operation_key, quantity, unit} maps that make up this operation. Field included by default. */ components: Array<{ [key: string]: unknown; }>; /** * Default LLM model for token cost estimation (e.g., 'gpt-4o'). Field included by default. */ default_model?: string | null; /** * Description of what this composite operation does. Field included by default. */ description?: string | null; /** * Human-readable name (e.g., 'AI Clinical Notes'). Field included by default. */ display_name: string; /** * Whether this operation is visible in the client-facing capacity calculator. Field included by default. */ is_public: boolean; /** * Unique key within the application (e.g., 'clinical_note_generation'). Field included by default. */ key: string; /** * Display ordering in calculator and dashboards. Field included by default. */ sort_order: number; }; id: string; /** * A relationships object for a composite-operation */ relationships?: { [key: string]: never; }; type: string; }; export type CaseTypeStateMachineInputCreateType = { initial_state: string; reopen_target_state?: string | null; states?: Array | null; /** * States that count as terminal for this CaseType. Used by Case.is_open * (state not in terminal_states). Required (non-empty) — the migration * backfills existing CaseTypes via heuristic. * */ terminal_states?: Array | null; transitions?: unknown | Array<{ from: string; guards?: { [key: string]: unknown; } | unknown; to: string; }> | Array<{ from?: string | unknown; guards?: { [key: string]: unknown; } | unknown; to?: string | unknown; }>; }; export type ToolkitAgentRunType = { /** * Field included by default. */ capability_level: "browser" | "sidecar" | "native"; /** * Field included by default. */ content_hash: string; /** * Field included by default. */ id?: string | null; /** * Field included by default. */ latency_ms: number; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ model_name: string; /** * Field included by default. */ operation: "extract" | "classify" | "transcribe" | "reason" | "tool_call"; /** * Field included by default. */ status: "success" | "failure" | "timeout"; /** * Field included by default. */ tokens_in: number; /** * Field included by default. */ tokens_out: number; /** * Field included by default. */ user_id?: string | null; }; /** * A "Resource object" representing a chat-ai-message */ export type ChatAiMessage = { /** * An attributes object for a chat-ai-message */ attributes?: { /** * Field included by default. */ content: string; /** * Field included by default. */ role: "system" | "user" | "assistant"; }; id: string; /** * A relationships object for a chat-ai-message */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a crm-sync-config */ export type CrmSyncConfig = { /** * An attributes object for a crm-sync-config */ attributes?: { /** * Field included by default. */ auto_create_contacts?: boolean | null; /** * Field included by default. */ connector_instance_id: string; /** * Field included by default. */ enabled?: boolean | null; /** * Field included by default. */ entity_type_filters?: Array | null; /** * Field included by default. */ pii_scan_enabled?: boolean | null; }; id: string; /** * A relationships object for a crm-sync-config */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a user */ export type User = { /** * An attributes object for a user */ attributes?: { current_scopes?: Array | null; current_workspace_id?: string | null; /** * Default tenant for billing fallback (set for domain-joined and invitation-registered users). Field included by default. */ default_tenant_id?: string | null; display_name?: string | null; /** * Field included by default. */ email: string; /** * Field included by default. */ is_app_admin: boolean; /** * Field included by default. */ is_platform_admin: boolean; refresh_token?: string | null; tenant_id?: string | null; /** * Field included by default. */ theme_preference?: string | null; token?: string | null; user_tenants?: Array<{ [key: string]: unknown; }> | null; }; id: string; /** * A relationships object for a user */ relationships?: { notification_methods?: { /** * Relationship data for notification_methods */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; profile?: { /** * An identifier for profile */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a social-post */ export type SocialPost = { /** * An attributes object for a social-post */ attributes?: { /** * Field included by default. */ content?: string | null; /** * Field included by default. */ external_post_id?: string | null; /** * Field included by default. */ external_post_url?: string | null; /** * Field included by default. */ failure_reason?: string | null; /** * Field included by default. */ hashtags: Array; /** * Field included by default. */ link_metadata: { [key: string]: unknown; }; /** * Field included by default. */ link_url?: string | null; /** * Field included by default. */ media_urls: Array; /** * Field included by default. */ platform: "facebook" | "instagram" | "threads" | "twitter" | "linkedin" | "reddit" | "bluesky"; /** * Field included by default. */ platform_metadata: { [key: string]: unknown; }; /** * Field included by default. */ published_at?: unknown; /** * Field included by default. */ scheduled_at?: unknown; /** * Field included by default. */ seo_analysis: { [key: string]: unknown; }; /** * Field included by default. */ seo_score?: number | null; /** * Field included by default. */ social_campaign_id?: string | null; /** * Field included by default. */ status: "draft" | "scheduled" | "queued" | "publishing" | "published" | "failed" | "cancelled"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a social-post */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a email-tracking-event */ export type EmailTrackingEvent = { /** * An attributes object for a email-tracking-event */ attributes?: { /** * Field included by default. */ campaign_ref_id?: string | null; /** * Field included by default. */ event_type: "bounce" | "click" | "complaint" | "open"; /** * Field included by default. */ generated_email_ref_id?: string | null; /** * Field included by default. */ recipient_email: string; /** * Field included by default. */ url?: string | null; }; id: string; /** * A relationships object for a email-tracking-event */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a catalog-variant-option-value */ export type CatalogVariantOptionValue = { /** * An attributes object for a catalog-variant-option-value */ attributes?: { [key: string]: never; }; id: string; /** * A relationships object for a catalog-variant-option-value */ relationships?: { [key: string]: never; }; type: string; }; export type CrmContactType = { /** * Field included by default. */ ai_score?: number | null; /** * Field included by default. */ ai_score_reasons?: { [key: string]: unknown; } | null; /** * Field included by default. */ avatar_url?: string | null; /** * Field included by default. */ date_of_birth?: string | null; /** * Field included by default. */ email?: string | null; /** * Field included by default. */ external_ids: { [key: string]: unknown; }; /** * Field included by default. */ external_owner_id?: string | null; /** * Field included by default. */ first_name: string; /** * Field included by default. */ full_name?: string | null; /** * Field included by default. */ id?: string | null; /** * Field included by default. */ last_name: string; /** * Field included by default. */ lifecycle_stage?: "lead" | "marketing_qualified" | "sales_qualified" | "opportunity" | "customer" | "evangelist" | "churned" | "discharged"; /** * BCP 47 language tag (e.g., en-US). Field included by default. */ locale?: string | null; /** * Field included by default. */ middle_name?: string | null; /** * Field included by default. */ owner_id?: string | null; /** * Field included by default. */ phone?: string | null; /** * Field included by default. */ portal_user_id?: string | null; /** * Field included by default. */ prefix?: string | null; /** * Field included by default. */ primary_email?: string | null; /** * Field included by default. */ primary_phone?: string | null; /** * Field included by default. */ properties?: { [key: string]: unknown; } | null; /** * Field included by default. */ sex?: "male" | "female" | "other"; /** * Field included by default. */ source?: "manual" | "import" | "channel" | "connector" | "ai_extracted" | "api" | "portal"; /** * Field included by default. */ suffix?: string | null; /** * Field included by default. */ tags?: Array | null; /** * IANA timezone (e.g., America/New_York). Field included by default. */ timezone?: string | null; /** * Field included by default. */ title?: string | null; }; /** * A "Resource object" representing a clinical-patient */ export type ClinicalPatient = { /** * An attributes object for a clinical-patient */ attributes?: { sex?: string | null; carbs_pct?: string | null; weight_lbs?: string | null; /** * Field included by default. */ timezone?: string | null; goal_weight_lbs?: string | null; /** * Field included by default. */ protein_unit?: string | null; profile_data?: { [key: string]: unknown; } | null; /** * Field included by default. */ enrollment_type?: "initial_consultation" | "transfer" | "group_enrollment" | "readmission"; meals_per_day?: number | null; protein_per_weight?: string | null; referring_physician_name?: string | null; /** * Field included by default. */ assigned_user_id?: string | null; food_allergies?: Array | null; chief_concern?: string | null; /** * Field included by default. */ status: "active" | "inactive" | "archived" | "discharged"; primary_insurance?: string | null; diagnosis_codes?: Array | null; referring_physician_phone?: string | null; /** * Field included by default. */ external_ids: { [key: string]: unknown; }; /** * Field included by default. */ contact_id?: string | null; food_aversions?: Array | null; activity_level?: string | null; referring_physician_fax?: string | null; /** * Field included by default. */ tags: Array; snacks_per_day?: number | null; protein_pct?: string | null; date_of_birth?: string | null; eating_style?: Array | null; /** * Field included by default. */ state?: string | null; conditions?: Array | null; target_calories_override?: number | null; height_inches?: string | null; /** * Field included by default. */ followup_interval_value?: number | null; /** * Field included by default. */ referral_source?: "self" | "physician" | "insurance" | "employer_wellness" | "other"; /** * Field included by default. */ metadata: { [key: string]: unknown; }; surgical_history?: string | null; /** * Field included by default. */ followup_interval_unit?: string | null; fat_pct?: string | null; /** * Field included by default. */ preferred_name?: string | null; food_preferences?: Array | null; }; id: string; /** * A relationships object for a clinical-patient */ relationships?: { documents?: { /** * Relationship data for documents */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; goals?: { /** * Relationship data for goals */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; health_metrics?: { /** * Relationship data for health_metrics */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; insurance_records?: { /** * Relationship data for insurance_records */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; meal_plans?: { /** * Relationship data for meal_plans */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; medications?: { /** * Relationship data for medications */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; notes?: { /** * Relationship data for notes */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; resource_assignments?: { /** * Relationship data for resource_assignments */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; sessions?: { /** * Relationship data for sessions */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; supplements?: { /** * Relationship data for supplements */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; }; type: string; }; /** * A "Resource object" representing a email-marketing-sequence */ export type EmailMarketingSequence = { /** * An attributes object for a email-marketing-sequence */ attributes?: { /** * Field included by default. */ name: string; /** * Field included by default. */ status?: "draft" | "active" | "paused" | "completed" | "archived"; /** * Field included by default. */ trigger_deal_stage_id?: string | null; }; id: string; /** * A relationships object for a email-marketing-sequence */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a toolkit-shadow-comparison */ export type ToolkitShadowComparison = { /** * An attributes object for a toolkit-shadow-comparison */ attributes?: { /** * Field included by default. */ cloud_avg_confidence?: number | null; /** * Field included by default. */ content_hash: string; /** * Field included by default. */ elevation_reason?: string | null; /** * Field included by default. */ field_agreement: { [key: string]: unknown; }; /** * Field included by default. */ field_count: number; /** * Field included by default. */ file_type?: string | null; /** * Field included by default. */ local_avg_confidence?: number | null; /** * Field included by default. */ match_count: number; /** * Field included by default. */ mismatch_count: number; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a toolkit-shadow-comparison */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a scheduling-location */ export type SchedulingLocation = { /** * An attributes object for a scheduling-location */ attributes?: { /** * Field included by default. */ address?: string | null; /** * Field included by default. */ capacity?: number | null; /** * Field included by default. */ city?: string | null; /** * Field included by default. */ country?: string | null; /** * Field included by default. */ instructions?: string | null; /** * Field included by default. */ is_active?: boolean | null; /** * Field included by default. */ latitude?: number | null; /** * Field included by default. */ longitude?: number | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ name: string; /** * Field included by default. */ postal_code?: string | null; /** * Field included by default. */ state?: string | null; /** * Field included by default. */ type: "venue" | "room" | "virtual" | "resource"; /** * Field included by default. */ url?: string | null; }; id: string; /** * A relationships object for a scheduling-location */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a crawler-job */ export type CrawlerJob = { /** * An attributes object for a crawler-job */ attributes?: { [key: string]: never; }; id: string; /** * A relationships object for a crawler-job */ relationships?: { results?: { /** * Relationship data for results */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; }; type: string; }; /** * A "Resource object" representing a api-key */ export type ApiKey = { /** * An attributes object for a api-key */ attributes?: { /** * Required - the application this API key belongs to. Field included by default. */ application_id: string; /** * Credits remaining in current budget period */ budget_remaining?: number | null; /** * When the current budget period will reset */ budget_resets_at?: unknown; /** * Maximum credits allowed per period (null = unlimited). Field included by default. */ credit_limit?: number | null; /** * Budget reset period. Field included by default. */ credit_limit_period?: "daily" | "weekly" | "monthly" | "yearly" | "lifetime"; current_scopes?: Array | null; /** * Field included by default. */ expires_at?: unknown; /** * The raw API key token. Only returned once upon creation or rotation. */ generated_api_key?: string | null; /** * Field included by default. */ key_type: "user" | "application" | "system" | "server"; /** * Field included by default. */ last_used_at?: unknown; /** * Field included by default. */ name?: string | null; /** * Credits used in current period (resets based on period). Field included by default. */ period_credits_used: number; /** * When the current budget period began. Field included by default. */ period_started_at?: unknown; /** * Field included by default. */ prefix: string; /** * Rate limit period in seconds. Field included by default. */ rate_limit_period_seconds: number; /** * Maximum requests allowed per period. Field included by default. */ rate_limit_requests: number; /** * Field included by default. */ revoked_at?: unknown; /** * Field included by default. */ scopes?: Array | null; /** * Field included by default. */ status: "active" | "revoked" | "expired"; /** * Field included by default. */ tenant_id?: string | null; /** * Field included by default. */ total_credits_used: number; /** * Field included by default. */ total_requests: number; /** * Field included by default. */ user_id?: string | null; /** * Field included by default. */ workspace_id?: string | null; }; id: string; /** * A relationships object for a api-key */ relationships?: { account?: { /** * An identifier for account */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; tenant?: { /** * An identifier for tenant */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; user?: { /** * An identifier for user */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; workspace?: { /** * An identifier for workspace */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a case-entity-link */ export type CaseEntityLink = { /** * An attributes object for a case-entity-link */ attributes?: { /** * Field included by default. */ case_id: string; /** * Field included by default. */ entity_id: string; /** * Field included by default. */ entity_type: "extracted_person" | "extracted_org" | "extracted_location" | "custom"; /** * Field included by default. */ metadata: { [key: string]: unknown; }; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a case-entity-link */ relationships?: { [key: string]: never; }; type: string; }; export type FormDeploymentSealPolicyInputCreateType = { report_format?: "sealed" | "open"; execution_mode?: "sealed" | "open"; theme_overrides?: "sealed" | "open"; disclose_logic_trace?: "sealed" | "open"; prompt_variants?: "sealed" | "open"; chunking_strategy?: "sealed" | "open"; output_schema_locked?: "sealed" | "open"; confidence_weights?: "sealed" | "open"; logic_locked?: "sealed" | "open"; max_cost_credits?: "sealed" | "open"; abandonment_threshold_days?: "sealed" | "open"; theme_locked?: "sealed" | "open"; layout_locked?: "sealed" | "open"; data_retention_days?: "sealed" | "open"; report_template?: "sealed" | "open"; model_id?: "sealed" | "open"; description?: "sealed" | "open"; name?: "sealed" | "open"; temperature?: "sealed" | "open"; allowed_origins?: "sealed" | "open"; logic_rules?: "sealed" | "open"; max_iterations?: "sealed" | "open"; prompt_template?: "sealed" | "open"; output_schema_pins?: Array | null; tags?: "sealed" | "open"; theme_id?: "sealed" | "open"; public_key_jwk?: "sealed" | "open"; instructions?: "sealed" | "open"; max_parallel_tools?: "sealed" | "open"; access_mode?: "sealed" | "open"; chunking_config?: "sealed" | "open"; input_schema_pins?: Array | null; output_schema?: "sealed" | "open"; min_submit_delay_ms?: "sealed" | "open"; assistant_agent_version_id?: "sealed" | "open"; custom_css?: "sealed" | "open"; layout_tree?: "sealed" | "open"; default_instructions?: "sealed" | "open"; tool_grant_pins?: Array | null; max_tool_calls?: "sealed" | "open"; }; /** * A "Resource object" representing a clinical-practice-resource */ export type ClinicalPracticeResource = { /** * An attributes object for a clinical-practice-resource */ attributes?: { /** * Field included by default. */ applicable_conditions: Array; /** * Field included by default. */ audience: "patient" | "practitioner" | "both"; /** * Field included by default. */ author?: string | null; /** * Field included by default. */ category?: string | null; /** * Field included by default. */ condition_tags: Array; /** * Field included by default. */ content_format?: "pdf" | "html" | "video_embed" | "external_link" | "interactive"; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ estimated_duration_minutes?: number | null; /** * Field included by default. */ icon_url?: string | null; /** * Field included by default. */ is_active: boolean; is_archived?: boolean | null; is_catalog?: boolean | null; /** * Field included by default. */ language: string; /** * Field included by default. */ license?: string | null; /** * Field included by default. */ metadata: { [key: string]: unknown; }; /** * Field included by default. */ preview_url?: string | null; /** * Field included by default. */ reading_level?: "basic" | "intermediate" | "advanced" | "clinical"; /** * Field included by default. */ related_goal_types: Array; /** * Field included by default. */ resource_type: "article" | "video" | "handout" | "worksheet" | "tool_link" | "infographic" | "audio" | "recipe" | "checklist" | "protocol" | "assessment" | "exercise" | "template" | "presentation" | "ebook" | "other"; /** * Field included by default. */ source_catalog_id?: string | null; /** * Field included by default. */ tags: Array; /** * Field included by default. */ title: string; /** * Field included by default. */ url?: string | null; }; id: string; /** * A relationships object for a clinical-practice-resource */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a invoices-recurring-schedule */ export type InvoicesRecurringSchedule = { /** * An attributes object for a invoices-recurring-schedule */ attributes?: { /** * Field included by default. */ active?: boolean | null; /** * Field included by default. */ auto_send?: boolean | null; /** * Field included by default. */ end_date?: string | null; /** * Field included by default. */ frequency: "weekly" | "biweekly" | "monthly" | "quarterly" | "annually"; /** * Field included by default. */ last_invoice_id?: string | null; /** * Field included by default. */ line_items?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ name: string; /** * Field included by default. */ next_run_date?: string | null; /** * Field included by default. */ start_date: string; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a invoices-recurring-schedule */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a support-ticket-rating */ export type SupportTicketRating = { /** * An attributes object for a support-ticket-rating */ attributes?: { /** * Field included by default. */ comment?: string | null; /** * Field included by default. */ score: number; }; id: string; /** * A relationships object for a support-ticket-rating */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a embedding */ export type Embedding = { /** * An attributes object for a embedding */ attributes?: { /** * Field included by default. */ billed_credits?: number | null; /** * Field included by default. */ embedding?: unknown; /** * Field included by default. */ model?: string | null; /** * Field included by default. */ text?: string | null; /** * Field included by default. */ usage?: { [key: string]: unknown; } | null; }; id: string; /** * A relationships object for a embedding */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a email-inbound-email */ export type EmailInboundEmail = { /** * An attributes object for a email-inbound-email */ attributes?: { /** * Field included by default. */ attachment_count?: number | null; /** * Field included by default. */ body_text?: string | null; /** * Field included by default. */ cc_addresses?: Array | null; /** * Field included by default. */ from_email?: string | null; /** * Field included by default. */ from_name?: string | null; /** * Field included by default. */ inbound_address_id?: string | null; /** * Field included by default. */ message_id?: string | null; /** * Field included by default. */ provider: "postmark" | "mailgun" | "sendgrid" | "generic"; /** * Field included by default. */ received_at?: unknown; /** * Field included by default. */ routing_error?: string | null; /** * Field included by default. */ routing_status: "pending" | "routed" | "failed" | "skipped"; /** * Field included by default. */ routing_target?: "extraction" | "agent" | "invoices" | "crm"; /** * Field included by default. */ size_bytes?: number | null; /** * Field included by default. */ subject?: string | null; /** * Field included by default. */ to_addresses?: Array | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a email-inbound-email */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a form-analytics-query */ export type FormAnalyticsQuery = { /** * An attributes object for a form-analytics-query */ attributes?: { [key: string]: never; }; id: string; /** * A relationships object for a form-analytics-query */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a watcher-event */ export type WatcherEvent = { /** * An attributes object for a watcher-event */ attributes?: { /** * Field included by default. */ claim_id?: string | null; /** * Field included by default. */ cloud_storage_path?: string | null; /** * Field included by default. */ created_at: unknown; /** * Field included by default. */ destination_path?: string | null; /** * Field included by default. */ document_id?: string | null; /** * Field included by default. */ error_message?: string | null; /** * Field included by default. */ event_type: "detected" | "skipped" | "claimed" | "uploading" | "uploaded" | "moved" | "error"; /** * Field included by default. */ file_hash?: string | null; /** * Field included by default. */ file_name: string; /** * Field included by default. */ file_path: string; /** * Field included by default. */ file_size?: number | null; /** * Field included by default. */ machine_id?: string | null; /** * Field included by default. */ machine_name?: string | null; /** * Field included by default. */ retry_count?: number | null; /** * Field included by default. */ skip_reason?: string | null; /** * Field included by default. */ source: "local" | "cloud"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a watcher-event */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a usage-event */ export type UsageEvent = { /** * An attributes object for a usage-event */ attributes?: { /** * Field included by default. */ billing_mode: "credits" | "seats"; /** * Field included by default. */ credits_charged: number; /** * Field included by default. */ metadata: { [key: string]: unknown; }; /** * Field included by default. */ operation_type: "general" | "conversational" | "rag" | "training" | "field_mapping" | "extraction" | "ephemeral_extraction_base" | "analysis" | "communication" | "social" | "voice_transcription" | "voice_synthesis" | "invoicing" | "connector_tool_execution" | "email_inbound" | "agent_execution_step" | "agent_tool_call" | "agent_delegation" | "knowledge_file_ingest" | "knowledge_chunk_embed" | "crm_data_export" | "forms_generation" | "crawler"; /** * Field included by default. */ quantity: number; /** * Field included by default. */ tenant_id: string; /** * Field included by default. */ user_id?: string | null; /** * Field included by default. */ workspace_id?: string | null; }; id: string; /** * A relationships object for a usage-event */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a recipes-food-item */ export type RecipesFoodItem = { /** * An attributes object for a recipes-food-item */ attributes?: { /** * Field included by default. */ allergens?: Array | null; /** * Field included by default. */ application_id: string; /** * Field included by default. */ default_unit?: string | null; /** * Field included by default. */ external_id?: string | null; /** * Field included by default. */ external_source?: string | null; /** * Field included by default. */ food_group?: string | null; /** * Field included by default. */ name: string; /** * Field included by default. */ nutrition_per_100g?: { [key: string]: unknown; } | null; /** * Field included by default. */ unit_conversions?: { [key: string]: unknown; } | null; }; id: string; /** * A relationships object for a recipes-food-item */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a platform-pricing-config */ export type PlatformPricingConfig = { /** * An attributes object for a platform-pricing-config */ attributes?: { /** * Schedule A category (e.g., 'llm', 'agent', 'extraction', 'communication'). Field included by default. */ category?: string | null; /** * Pricing model: 'fixed' (credit rate) or 'passthrough' (provider cost + margin). Field included by default. */ cost_model?: string | null; /** * Default credit rate for this operation. NULL for passthrough (LLM). Field included by default. */ default_rate_credits?: number | null; /** * Human-readable description of this service. Field included by default. */ description?: string | null; /** * Human-readable name for admin UI (e.g., 'LLM Input Tokens'). Field included by default. */ display_name?: string | null; /** * Minimum price ISVs can charge. NULL means no configured floor. Field included by default. */ floor_price?: { amount: string; currency: string; } | null | unknown; /** * Platform COGS for this service (e.g., $0.002 per page for OCR). Field included by default. */ hard_cost?: { amount: string; currency: string; } | null | unknown; /** * Whether this operation incurs charges. False = metered only. Field included by default. */ is_billable: boolean; /** * Minimum margin percentage. NULL means no configured margin. Field included by default. */ margin_percent?: number | null; /** * Additional configuration metadata (e.g., metric unit, operation type). Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Schedule A operation key (e.g., 'llm_input_tokens', 'agent_execution_step'). Field included by default. */ operation_key?: string | null; /** * Service identifier (e.g., 'doc_extraction_base', 'llm_usage'). Field included by default. */ service_id: string; /** * Billing unit (e.g., 'per 1K tokens', 'per page', 'per email'). Field included by default. */ unit?: string | null; }; id: string; /** * A relationships object for a platform-pricing-config */ relationships?: { [key: string]: never; }; type: string; }; export type _Error = { /** * An application-specific error code, expressed as a string value. */ code?: string; /** * A human-readable explanation specific to this occurrence of the problem. */ detail?: string; /** * A unique identifier for this particular occurrence of the problem. */ id?: string; links?: Links; source?: { /** * A string indicating which query parameter caused the error. */ parameter?: string; /** * A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object, or "/data/attributes/title" for a specific attribute]. */ pointer?: string; }; /** * The HTTP status code applicable to this problem, expressed as a string value. */ status?: string; /** * A short, human-readable summary of the problem. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. */ title?: string; }; /** * A "Resource object" representing a browser-session */ export type BrowserSession = { /** * An attributes object for a browser-session */ attributes?: { /** * The target domain this session authenticates against (e.g. example.com). Field included by default. */ domain: string; /** * Field included by default. */ expires_at?: string | null; /** * Field included by default. */ last_used_at?: string | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a browser-session */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a recipes-recipe */ export type RecipesRecipe = { /** * An attributes object for a recipes-recipe */ attributes?: { /** * Field included by default. */ application_id?: string | null; /** * Field included by default. */ contact_id?: string | null; /** * Field included by default. */ cook_time_minutes?: number | null; /** * Field included by default. */ created_by?: string | null; /** * Field included by default. */ cuisine_type?: string | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ difficulty?: "easy" | "medium" | "hard"; /** * Field included by default. */ enrichment_status: "none" | "pending" | "completed" | "failed"; /** * Field included by default. */ image_url?: string | null; /** * Field included by default. */ image_urls?: Array | null; /** * Field included by default. */ instructions?: string | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ prep_time_minutes?: number | null; /** * Field included by default. */ servings?: number | null; /** * Field included by default. */ source_name?: string | null; /** * Field included by default. */ source_provider?: string | null; /** * Field included by default. */ source_type: "owned" | "external" | "imported"; /** * Field included by default. */ source_uri?: string | null; /** * Field included by default. */ source_url?: string | null; /** * Field included by default. */ status: "draft" | "published" | "archived"; /** * Field included by default. */ title: string; /** * Field included by default. */ total_time_minutes?: number | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a recipes-recipe */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a plan-feature-allocation-catalog */ export type PlanFeatureAllocationCatalog = { /** * An attributes object for a plan-feature-allocation-catalog */ attributes?: { /** * One-time credit charge to unlock this feature. nil = free activation. Field included by default. */ activation_cost?: number | null; /** * Field included by default. */ created_at: unknown; /** * Override the feature's credit_cost for this plan. nil = use feature default. Field included by default. */ credit_cost?: number | null; /** * Whether this feature is available on this plan. Field included by default. */ enabled: boolean; /** * Field included by default. */ feature_definition_id: string; /** * Override the feature's default_limit for this plan. nil = use feature default. Field included by default. */ limit?: number | null; /** * Field included by default. */ plan_id: string; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a plan-feature-allocation-catalog */ relationships?: { feature_definition?: { /** * An identifier for feature_definition */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; plan?: { /** * An identifier for plan */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a scheduling-booking */ export type SchedulingBooking = { /** * An attributes object for a scheduling-booking */ attributes?: { /** * Field included by default. */ booked_by_user_id?: string | null; /** * Field included by default. */ booker_contact_id?: string | null; /** * Field included by default. */ booker_email: string; /** * Field included by default. */ booker_name: string; /** * Field included by default. */ booker_phone?: string | null; /** * Field included by default. */ booker_timezone?: string | null; /** * Field included by default. */ cancellation_reason?: string | null; /** * Field included by default. */ cancelled_at?: unknown; /** * Field included by default. */ cancelled_by?: "booker" | "organizer" | "system"; /** * Field included by default. */ confirmed_at?: unknown; /** * Field included by default. */ event_id?: string | null; /** * Field included by default. */ event_type_id: string; /** * Field included by default. */ intake_responses?: { [key: string]: unknown; } | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ party_size?: number | null; /** * Field included by default. */ status?: "pending_approval" | "pending_verification" | "confirmed" | "cancelled" | "no_show"; }; id: string; /** * A relationships object for a scheduling-booking */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a document-section */ export type DocumentSection = { /** * An attributes object for a document-section */ attributes?: { /** * Field included by default. */ content_preview?: string | null; /** * Field included by default. */ doc_path: string; /** * Field included by default. */ level: number; /** * Field included by default. */ parent_stable_id?: string | null; /** * Field included by default. */ position?: number | null; /** * Field included by default. */ references?: Array | null; /** * Field included by default. */ stable_id: string; /** * Field included by default. */ summary?: string | null; /** * Field included by default. */ tags?: Array | null; /** * Field included by default. */ title: string; }; id: string; /** * A relationships object for a document-section */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a access-log */ export type AccessLog = { /** * An attributes object for a access-log */ attributes?: { /** * Reason for accessing the data. Field included by default. */ access_purpose: string; /** * Field included by default. */ access_timestamp: unknown; /** * ID of the user or system that accessed the resource. Field included by default. */ accessor_id: string; /** * Field included by default. */ accessor_type: "user" | "system" | "api_key"; /** * Summary of what was accessed (not full content). Field included by default. */ content_accessed?: string | null; /** * ID of the accessed resource. Field included by default. */ resource_id: string; /** * Type of resource accessed (e.g., patient_record, document). Field included by default. */ resource_type: string; }; id: string; /** * A relationships object for a access-log */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a crm-deal-product */ export type CrmDealProduct = { /** * An attributes object for a crm-deal-product */ attributes?: { /** * Field included by default. */ deal_id: string; /** * Weak reference to catalog product (not a FK). Field included by default. */ product_id: string; /** * Field included by default. */ properties?: { [key: string]: unknown; } | null; /** * Field included by default. */ quantity?: number | null; /** * Field included by default. */ unit_price?: string | null; }; id: string; /** * A relationships object for a crm-deal-product */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a email-send-limit */ export type EmailSendLimit = { /** * An attributes object for a email-send-limit */ attributes?: { /** * Field included by default. */ date: string; /** * Field included by default. */ limit_with_unsubscribe?: number | null; /** * Field included by default. */ limit_without_unsubscribe?: number | null; /** * Field included by default. */ sent_with_unsubscribe?: number | null; /** * Field included by default. */ sent_without_unsubscribe?: number | null; }; id: string; /** * A relationships object for a email-send-limit */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a toolkit-meter-event */ export type ToolkitMeterEvent = { /** * An attributes object for a toolkit-meter-event */ attributes?: { /** * Field included by default. */ content_hash?: string | null; /** * Field included by default. */ credits: number; /** * Field included by default. */ local_first?: boolean | null; /** * Field included by default. */ operation: string; /** * Field included by default. */ source: string; /** * Field included by default. */ synced: boolean; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a toolkit-meter-event */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-insurance-authorization */ export type ClinicalInsuranceAuthorization = { /** * An attributes object for a clinical-insurance-authorization */ attributes?: { authorization_end?: string | null; authorization_start?: string | null; /** * Field included by default. */ authorized_units: number; /** * Field included by default. */ cpt_codes_authorized: Array; /** * Field included by default. */ insurance_record_id: string; /** * Field included by default. */ metadata: { [key: string]: unknown; }; notes?: string | null; reauthorization_reminder?: string | null; /** * Field included by default. */ status: "active" | "exhausted" | "expired" | "cancelled"; /** * Field included by default. */ unit_type: "visits" | "hours"; /** * Field included by default. */ used_units: number; }; id: string; /** * A relationships object for a clinical-insurance-authorization */ relationships?: { insurance_record?: { /** * An identifier for insurance_record */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a clinical-delivery */ export type ClinicalDelivery = { /** * An attributes object for a clinical-delivery */ attributes?: { /** * Field included by default. */ delivered_at?: string | null; /** * Field included by default. */ delivery_type: "summary_email" | "goal_report" | "meal_plan" | "supplement_list"; /** * Field included by default. */ included_goal_ids: Array; /** * Field included by default. */ included_resource_ids: Array; /** * Field included by default. */ included_supplement_ids: Array; /** * Field included by default. */ metadata: { [key: string]: unknown; }; /** * Field included by default. */ patient_id: string; /** * Field included by default. */ session_id?: string | null; /** * Field included by default. */ status: "sent" | "delivered" | "failed" | "bounced"; }; id: string; /** * A relationships object for a clinical-delivery */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a storage-file */ export type StorageFile = { /** * An attributes object for a storage-file */ attributes?: { /** * Field included by default. */ checksum?: string | null; /** * Field included by default. */ content_type: string; /** * Field included by default. */ deleted_at?: unknown; /** * Field included by default. */ expires_at?: unknown; /** * Field included by default. */ filename: string; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ namespace: string; /** * Field included by default. */ origin_domain: string; /** * Field included by default. */ size_bytes: number; /** * Field included by default. */ source_type: "upload" | "generated" | "ingested" | "cloned"; /** * Field included by default. */ status: "active" | "archived" | "pending_deletion" | "quarantined" | "pending_upload"; /** * Field included by default. */ tags?: Array | null; /** * Field included by default. */ visibility: "private" | "workspace" | "tenant" | "public"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a storage-file */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a invoices-template */ export type InvoicesTemplate = { /** * An attributes object for a invoices-template */ attributes?: { /** * Field included by default. */ branding?: { [key: string]: unknown; } | null; /** * Field included by default. */ default_notes?: string | null; /** * Field included by default. */ default_payment_terms?: string | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ is_default?: boolean | null; /** * Field included by default. */ layout?: { [key: string]: unknown; } | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ name: string; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a invoices-template */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a trending-snapshot-item */ export type TrendingSnapshotItem = { /** * An attributes object for a trending-snapshot-item */ attributes?: { /** * Field included by default. */ author?: string | null; /** * Field included by default. */ composite_score: number; /** * Field included by default. */ enrichment?: { [key: string]: unknown; } | null; /** * Field included by default. */ excerpt?: string | null; /** * Field included by default. */ external_id?: string | null; /** * Field included by default. */ image_url?: string | null; /** * Field included by default. */ platform: "twitter" | "reddit" | "linkedin" | "facebook" | "instagram" | "newsapi" | "gnews" | "bing_news"; /** * Field included by default. */ position?: number | null; /** * Field included by default. */ published_at?: unknown; /** * Field included by default. */ raw_score: number; /** * Field included by default. */ snapshot_id: string; /** * Field included by default. */ source_name?: string | null; /** * Field included by default. */ stats: { [key: string]: unknown; }; /** * Field included by default. */ title: string; /** * Field included by default. */ type: "post" | "news"; /** * Field included by default. */ url: string; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a trending-snapshot-item */ relationships?: { snapshot?: { /** * An identifier for snapshot */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; export type Errors = Array<_Error>; /** * A "Resource object" representing a permission-meta */ export type PermissionMeta = { /** * An attributes object for a permission-meta */ attributes?: { /** * Field included by default. */ apps: Array; /** * Field included by default. */ cache_ttl: number; /** * Field included by default. */ categories: Array; /** * Field included by default. */ scopes: Array; /** * Field included by default. */ version: string; }; id: string; /** * A relationships object for a permission-meta */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a catalog-option-type */ export type CatalogOptionType = { /** * An attributes object for a catalog-option-type */ attributes?: { /** * Field included by default. */ application_id: string; /** * Field included by default. */ name: string; /** * Field included by default. */ position?: number | null; /** * Field included by default. */ slug: string; }; id: string; /** * A relationships object for a catalog-option-type */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a operation-success */ export type OperationSuccess = { /** * An attributes object for a operation-success */ attributes?: { /** * Field included by default. */ message?: string | null; /** * Field included by default. */ success: boolean; }; id: string; /** * A relationships object for a operation-success */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a disclosure-log */ export type DisclosureLog = { /** * An attributes object for a disclosure-log */ attributes?: { /** * Field included by default. */ disclosed_at: string; /** * Field included by default. */ disclosure_method: "api_call" | "email" | "webhook" | "file_transfer" | "manual"; /** * Reference to consent or BAA authorizing disclosure. Field included by default. */ legal_basis?: string | null; /** * Categories of PHI disclosed (e.g., demographics, clinical_notes). Field included by default. */ phi_categories: Array; /** * Field included by default. */ purpose: "treatment" | "payment" | "operations" | "legal" | "research" | "public_health" | "other"; /** * Name of the disclosure recipient (e.g., OpenRouter, Fullscript). Field included by default. */ recipient_name: string; /** * Field included by default. */ recipient_type: "llm_provider" | "integration_partner" | "healthcare_provider" | "health_plan" | "government" | "other"; /** * ID of the disclosed resource. Field included by default. */ resource_id: string; /** * Type of resource disclosed (e.g., clinical_note, health_metric). Field included by default. */ resource_type: string; /** * ID of the data subject whose PHI was disclosed. Field included by default. */ subject_id: string; /** * Type of data subject (e.g., patient, contact). Field included by default. */ subject_type: string; }; id: string; /** * A relationships object for a disclosure-log */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-supplement-rec-cache */ export type ClinicalSupplementRecCache = { /** * An attributes object for a clinical-supplement-rec-cache */ attributes?: { /** * Field included by default. */ expires_at?: string | null; /** * Field included by default. */ generated_at?: string | null; /** * Field included by default. */ patient_id: string; /** * Field included by default. */ pipeline_execution_id?: string | null; /** * Field included by default. */ recommendations?: { [key: string]: unknown; } | null; /** * Field included by default. */ status: "pending" | "ready" | "expired"; }; id: string; /** * A relationships object for a clinical-supplement-rec-cache */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a news-monitor */ export type NewsMonitor = { /** * An attributes object for a news-monitor */ attributes?: { /** * Field included by default. */ frequency: "daily" | "twice_daily" | "hourly"; /** * Field included by default. */ last_run_at?: unknown; metadata: { [key: string]: unknown; }; /** * Field included by default. */ name: string; /** * Field included by default. */ next_run_at?: unknown; /** * Field included by default. */ source_urls: Array; /** * Field included by default. */ status: "active" | "paused" | "archived"; /** * Field included by default. */ summary_model: "default" | "balanced" | "accurate"; /** * Field included by default. */ tags: Array; /** * Field included by default. */ topic: string; }; id: string; /** * A relationships object for a news-monitor */ relationships?: { schedules?: { /** * Relationship data for schedules */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; summaries?: { /** * Relationship data for summaries */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; }; type: string; }; /** * A "Resource object" representing a crm-pipeline */ export type CrmPipeline = { /** * An attributes object for a crm-pipeline */ attributes?: { /** * Field included by default. */ entity_type: string; /** * Field included by default. */ is_default: boolean; /** * Field included by default. */ name: string; }; id: string; /** * A relationships object for a crm-pipeline */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a catalog-product */ export type CatalogProduct = { /** * An attributes object for a catalog-product */ attributes?: { /** * Field included by default. */ ai_description?: string | null; /** * Field included by default. */ application_id?: string | null; /** * Field included by default. */ base_price?: string | null; /** * Field included by default. */ currency?: string | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ media?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ name: string; /** * Field included by default. */ properties?: { [key: string]: unknown; } | null; /** * Field included by default. */ short_description?: string | null; /** * Field included by default. */ sku?: string | null; /** * Field included by default. */ slug: string; /** * Field included by default. */ status: "draft" | "active" | "archived" | "discontinued"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a catalog-product */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a storage-stats */ export type StorageStats = { /** * An attributes object for a storage-stats */ attributes?: { /** * Field included by default. */ generated_at?: unknown; /** * Field included by default. */ tenant_id?: string | null; /** * Field included by default. */ total_buckets?: number | null; /** * Field included by default. */ total_objects?: number | null; /** * Field included by default. */ total_storage_bytes?: number | null; }; id: string; /** * A relationships object for a storage-stats */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a document-chunk */ export type DocumentChunk = { /** * An attributes object for a document-chunk */ attributes?: { /** * Field included by default. */ chunk_index: number; /** * Field included by default. */ content: string; /** * Opaque UUID of the owning record in its source domain. Not a typed reference — cross-tier coupling is avoided by keeping this untyped. Field included by default. */ document_id: string; /** * Type of source document: extraction_document, chat_message, knowledge_file. Field included by default. */ source_type: string; /** * Denormalized tenant scope. Populated by callers (derived from the workspace's tenant_id); used by :search to avoid a document → workspace → tenant_id traversal. Field included by default. */ tenant_id: string; /** * Denormalized workspace scope. Populated by callers; used directly by read policies and the :search action. Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a document-chunk */ relationships?: { workspace?: { /** * An identifier for workspace */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a case-type */ export type CaseType = { /** * An attributes object for a case-type */ attributes?: { /** * Field included by default. */ decision_outcomes?: Array<{ /** * Field included by default. */ is_terminal?: boolean | null | unknown; /** * Field included by default. */ label: string; /** * Field included by default. */ requires_note?: boolean | null | unknown; /** * Field included by default. */ slug: string; }> | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ expected_document_types?: Array | null; /** * Field included by default. */ grouping_rules: { /** * Field included by default. */ confidence_threshold?: number | null; /** * Field included by default. */ default_behavior?: "match_or_create" | "match_only" | "create_only"; /** * Field included by default. */ match_by_fields?: Array | null; /** * Field included by default. */ match_window_hours?: number | null; }; /** * Field included by default. */ is_active: boolean; /** * Field included by default. */ name: string; /** * Field included by default. */ required_reviews: { /** * Field included by default. */ decision_trigger?: "always" | "on_priority" | "never"; /** * Field included by default. */ field_triggers?: Array<{ /** * Field included by default. */ confidence_below?: number | null | unknown; /** * Field included by default. */ field: string; }> | null; }; /** * Field included by default. */ routing_rules: { /** * Field included by default. */ default_queue_id?: string | null; /** * Field included by default. */ overrides?: Array<{ /** * Field included by default. */ queue_id: string; /** * Field included by default. */ when?: { [key: string]: unknown; } | null | unknown; }> | null; }; /** * Field included by default. */ schema_family_id?: string | null; /** * Field included by default. */ slug: string; /** * Field included by default. */ state_machine: { /** * Field included by default. */ initial_state: string; /** * Field included by default. */ reopen_target_state?: string | null; /** * Field included by default. */ states: Array; /** * States that count as terminal for this CaseType. Used by Case.is_open * (state not in terminal_states). Required (non-empty) — the migration * backfills existing CaseTypes via heuristic. * . Field included by default. */ terminal_states: Array; /** * Field included by default. */ transitions?: Array<{ /** * Field included by default. */ from: string; /** * Field included by default. */ guards?: { [key: string]: unknown; } | null | unknown; /** * Field included by default. */ to: string; }> | null; }; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a case-type */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a training-example */ export type TrainingExample = { /** * An attributes object for a training-example */ attributes?: { /** * The AI's confidence score for the original extraction (0.0 - 1.0). Field included by default. */ confidence_score?: number | null; /** * The user's corrected value. Field included by default. */ corrected_value?: string | null; /** * Structured correction data: fields_changed, reason, original_confidence. Field included by default. */ correction_metadata?: { [key: string]: unknown; } | null; /** * Per-field correction reasons: %{field_name => reason_string}. Field included by default. */ correction_reasons?: { [key: string]: unknown; } | null; /** * Denormalized flag: true when source document is excluded from training. Field included by default. */ document_excluded: boolean; /** * The source document from which this training example was created. Field included by default. */ document_id?: string | null; /** * The type of document (e.g., 'Invoice', 'Receipt', 'Contract'). Field included by default. */ document_type?: string | null; /** * Field included by default. */ embedding?: unknown; /** * The field name that was corrected (e.g., 'customer_name', 'total_amount'). Field included by default. */ field_name?: string | null; /** * S3 path to the original document image for visual RAG retrieval. Field included by default. */ input_image_ref?: string | null; /** * Field included by default. */ input_text: string; /** * Field included by default. */ inserted_at: unknown; /** * Whether this example was explicitly confirmed by a user. Field included by default. */ is_confirmed: boolean; /** * The AI's original extraction value before user correction. Field included by default. */ original_value?: string | null; /** * Field included by default. */ output_json: { [key: string]: unknown; }; similarity?: number | null; /** * General note about these corrections (e.g., 'Poor OCR quality', 'Non-standard date format'). Field included by default. */ training_note?: string | null; /** * Field included by default. */ training_session_id?: string | null; /** * Field included by default. */ updated_at: unknown; /** * Field included by default. */ version_id?: string | null; /** * Field included by default. */ workspace_id?: string | null; }; id: string; /** * A relationships object for a training-example */ relationships?: { training_session?: { /** * An identifier for training_session */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; workspace?: { /** * An identifier for workspace */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a ownership-transfer */ export type OwnershipTransfer = { /** * An attributes object for a ownership-transfer */ attributes?: { /** * Field included by default. */ from_user_id?: string | null; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ reason?: string | null; /** * Field included by default. */ resource_id: string; /** * Field included by default. */ resource_type: string; /** * Field included by default. */ to_user_id?: string | null; /** * Field included by default. */ transferred_by_id: string; /** * Field included by default. */ transferred_by_type: "user" | "application"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a ownership-transfer */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a extraction-batch */ export type ExtractionBatch = { /** * An attributes object for a extraction-batch */ attributes?: { /** * Field included by default. */ name?: string | null; status?: string | null; /** * Generate presigned upload URLs for batch */ upload_urls?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ user_label?: string | null; }; id: string; /** * A relationships object for a extraction-batch */ relationships?: { [key: string]: never; }; type: string; }; export type SchedulingAvailabilityRuleDateOverridesInputCreateType = { date: string; windows?: Array | null; }; /** * A "Resource object" representing a pipeline-execution */ export type PipelineExecution = { /** * An attributes object for a pipeline-execution */ attributes?: { /** * Field included by default. */ checkpoint_data?: { [key: string]: unknown; } | null; /** * Field included by default. */ checkpoint_node?: string | null; /** * Field included by default. */ checkpoint_notes?: string | null; /** * Field included by default. */ checkpoint_refinements: Array<{ [key: string]: unknown; }>; /** * Field included by default. */ checkpoint_session_id?: string | null; /** * Field included by default. */ completed_at?: unknown; /** * Field included by default. */ error?: { [key: string]: unknown; } | null; /** * File inputs passed through to agent nodes. Field included by default. */ file_inputs: Array<{ [key: string]: unknown; }>; /** * Field included by default. */ input: { [key: string]: unknown; }; node_executions_count?: number | null; /** * Field included by default. */ node_outputs: { [key: string]: unknown; }; /** * Field included by default. */ pipeline_id: string; /** * Field included by default. */ started_at: unknown; /** * Field included by default. */ status: "running" | "awaiting_approval" | "approved" | "rejected" | "completed" | "failed" | "expired"; /** * Field included by default. */ workspace_id?: string | null; }; id: string; /** * A relationships object for a pipeline-execution */ relationships?: { node_executions?: { /** * Relationship data for node_executions */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; pipeline?: { /** * An identifier for pipeline */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a llm-analytics */ export type LlmAnalytics = { /** * An attributes object for a llm-analytics */ attributes?: { /** * Field included by default. */ audio_seconds?: string | null; /** * Field included by default. */ character_count?: number | null; /** * Field included by default. */ image_pages?: number | null; /** * Field included by default. */ image_tokens?: number | null; /** * Correlation ID to the unified UsageEvent record. Field included by default. */ usage_event_id?: string | null; /** * Field included by default. */ workload: string; }; id: string; /** * A relationships object for a llm-analytics */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a recipes-meal-schedule */ export type RecipesMealSchedule = { /** * An attributes object for a recipes-meal-schedule */ attributes?: { /** * Field included by default. */ contact_id?: string | null; /** * Field included by default. */ end_date?: string | null; /** * Field included by default. */ name: string; /** * Field included by default. */ start_date?: string | null; /** * Field included by default. */ status: "draft" | "active" | "completed"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a recipes-meal-schedule */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a ai-config */ export type AiConfig = { /** * An attributes object for a ai-config */ attributes?: { [key: string]: never; }; id: string; /** * A relationships object for a ai-config */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a settlement */ export type Settlement = { /** * An attributes object for a settlement */ attributes?: { /** * Field included by default. */ application_id: string; /** * Per-operation and per-tenant breakdown for ISV visibility. Field included by default. */ breakdown?: { [key: string]: unknown; } | null; /** * Error message if settlement failed. Field included by default. */ error_message?: string | null; /** * Date when funds can be released from hold. Field included by default. */ hold_until?: string | null; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ isv_id: string; /** * Field included by default. */ net_settlement_usd?: string | null; /** * When settlement was paid out. Field included by default. */ paid_at?: string | null; /** * Field included by default. */ period_end: string; /** * Field included by default. */ period_start: string; /** * QorPay ACH transaction ID for payout. Field included by default. */ qorpay_transaction_id?: string | null; /** * Field included by default. */ retail_revenue_usd?: string | null; /** * Field included by default. */ status?: "pending" | "calculated" | "held" | "released" | "paid" | "failed"; /** * Field included by default. */ updated_at: unknown; /** * Field included by default. */ wholesale_cost_usd?: string | null; }; id: string; /** * A relationships object for a settlement */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; isv?: { /** * An identifier for isv */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a plan-bundle */ export type PlanBundle = { /** * An attributes object for a plan-bundle */ attributes?: { [key: string]: never; }; id: string; /** * A relationships object for a plan-bundle */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a scheduling-event */ export type SchedulingEvent = { /** * An attributes object for a scheduling-event */ attributes?: { /** * Field included by default. */ cancellation_reason?: string | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ end_time: unknown; /** * Field included by default. */ event_type_id?: string | null; /** * Field included by default. */ external_calendar_id?: string | null; /** * Field included by default. */ location?: { /** * Field included by default. */ address?: string | null; /** * Field included by default. */ instructions?: string | null; /** * Field included by default. */ latitude?: number | null; /** * Field included by default. */ longitude?: number | null; /** * Field included by default. */ name?: string | null; /** * Field included by default. */ type?: "in_person" | "video" | "phone" | "custom_url"; /** * Field included by default. */ url?: string | null; } | null | unknown; /** * Field included by default. */ location_id?: string | null; /** * Field included by default. */ location_type?: "in_person" | "video" | "phone" | "custom_url"; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ notes?: string | null; /** * Field included by default. */ organizer_user_id: string; /** * Field included by default. */ recurrence_parent_id?: string | null; /** * Field included by default. */ recurrence_rule?: { /** * Field included by default. */ count?: number | null; /** * Field included by default. */ day_of_month?: number | null; /** * Field included by default. */ days_of_week?: Array<"monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday"> | null; /** * Field included by default. */ exceptions?: Array | null; /** * Field included by default. */ frequency: "daily" | "weekly" | "monthly" | "yearly"; /** * Field included by default. */ interval?: number | null; /** * Field included by default. */ until?: string | null; } | null | unknown; /** * Field included by default. */ source?: "platform" | "external" | "booking" | "agent" | "automation"; /** * Field included by default. */ start_time: unknown; /** * Field included by default. */ status?: "draft" | "confirmed" | "cancelled" | "completed"; /** * Field included by default. */ timezone?: string | null; /** * Field included by default. */ title?: string | null; }; id: string; /** * A relationships object for a scheduling-event */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a support-ticket */ export type SupportTicket = { /** * An attributes object for a support-ticket */ attributes?: { /** * Field included by default. */ ai_classification?: string | null; /** * Field included by default. */ ai_confidence?: number | null; /** * Field included by default. */ ai_sentiment?: string | null; /** * Field included by default. */ assigned_agent_id?: string | null; /** * Field included by default. */ crm_contact_id?: string | null; /** * Field included by default. */ custom_fields?: { [key: string]: unknown; } | null; /** * Field included by default. */ customer_email?: string | null; /** * Field included by default. */ customer_name?: string | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ external_id?: string | null; /** * Field included by default. */ external_owner_id?: string | null; /** * Field included by default. */ first_response_at?: unknown; /** * Field included by default. */ invoice_id?: string | null; /** * Field included by default. */ owner_id?: string | null; /** * Field included by default. */ priority: "low" | "normal" | "high" | "urgent"; /** * Field included by default. */ product_id?: string | null; /** * Field included by default. */ resolved_at?: unknown; /** * Field included by default. */ sla_breached: boolean; /** * Field included by default. */ sla_due_at?: unknown; /** * Field included by default. */ sla_policy_id?: string | null; /** * Field included by default. */ source: "email" | "chat" | "phone" | "web_form" | "api" | "internal" | "connector_sync"; /** * Field included by default. */ status: "new" | "open" | "pending" | "on_hold" | "resolved" | "closed"; /** * Field included by default. */ subject: string; /** * Field included by default. */ synced_at?: unknown; /** * Field included by default. */ tags?: Array | null; /** * Field included by default. */ ticket_number?: string | null; /** * Field included by default. */ type: "external" | "internal"; }; id: string; /** * A relationships object for a support-ticket */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a support-channel-capture-config */ export type SupportChannelCaptureConfig = { /** * An attributes object for a support-channel-capture-config */ attributes?: { /** * Field included by default. */ auto_create_tickets: boolean; /** * Field included by default. */ channel_types?: Array | null; /** * Field included by default. */ default_queue_id?: string | null; /** * Field included by default. */ enabled: boolean; }; id: string; /** * A relationships object for a support-channel-capture-config */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a support-routing-rule */ export type SupportRoutingRule = { /** * An attributes object for a support-routing-rule */ attributes?: { /** * Field included by default. */ action: "assign_queue" | "assign_queue_and_priority" | "assign_queue_and_tag"; /** * Parameters for the action (e.g., priority_override, tag). Separate from conditions. Field included by default. */ action_params: { [key: string]: unknown; }; /** * Field included by default. */ conditions: { [key: string]: unknown; }; /** * Field included by default. */ priority: number; }; id: string; /** * A relationships object for a support-routing-rule */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a workspace-document-stats */ export type WorkspaceDocumentStats = { /** * An attributes object for a workspace-document-stats */ attributes?: { /** * Field included by default. */ completed?: number | null; /** * Field included by default. */ failed?: number | null; /** * Field included by default. */ processing?: number | null; /** * Field included by default. */ queued?: number | null; /** * Field included by default. */ total?: number | null; /** * Field included by default. */ workspace_id: string; /** * Field included by default. */ workspace_name: string; }; id: string; /** * A relationships object for a workspace-document-stats */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a audit-log */ export type AuditLog = { /** * An attributes object for a audit-log */ attributes?: { /** * Field included by default. */ action: string; /** * Human-readable actor name; returns actor email or 'System' for system actions. */ actor_display_name?: string | null; /** * Field included by default. */ actor_id?: string | null; /** * Field included by default. */ changes?: { [key: string]: unknown; } | null; /** * Field included by default. */ resource_id: string; /** * Field included by default. */ resource_type: string; /** * UUID of target entity. Field included by default. */ target_id?: string | null; /** * Display name of target entity for UI rendering. Field included by default. */ target_name?: string | null; /** * Type of target entity (document, workspace, agent, member, export). Field included by default. */ target_type?: string | null; /** * Field included by default. */ tenant_id?: string | null; /** * Field included by default. */ workspace_id?: string | null; }; id: string; /** * A relationships object for a audit-log */ relationships?: { actor?: { /** * An identifier for actor */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; tenant?: { /** * An identifier for tenant */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; workspace?: { /** * An identifier for workspace */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a isv-pricing-override */ export type IsvPricingOverride = { /** * An attributes object for a isv-pricing-override */ attributes?: { /** * ISV Application this override applies to. Field included by default. */ application_id: string; /** * Field included by default. */ inserted_at: unknown; /** * Whether this override is active. Field included by default. */ is_enabled: boolean; /** * Custom margin % (NULL = use default). Field included by default. */ margin_percent?: number | null; /** * Admin notes about this override. Field included by default. */ notes?: string | null; /** * Schedule A operation key being overridden. Field included by default. */ operation_key: string; /** * Custom credit rate (NULL = use default from PlatformPricingConfig). Field included by default. */ rate_credits?: number | null; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a isv-pricing-override */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a pipeline-node */ export type PipelineNode = { /** * An attributes object for a pipeline-node */ attributes?: { /** * Field included by default. */ acceptance_criteria?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ action_config?: { [key: string]: unknown; } | null; /** * Field included by default. */ action_type?: string | null; /** * Field included by default. */ agent_id?: string | null; /** * Field included by default. */ approval_message?: string | null; avg_duration_ms?: number | null; /** * Field included by default. */ command_template?: string | null; /** * Field included by default. */ condition?: { [key: string]: unknown; } | null; /** * Field included by default. */ connector_type?: string | null; /** * Field included by default. */ depends_on: Array; /** * Field included by default. */ description?: string | null; execution_count?: number | null; /** * Field included by default. */ feedback_loop_acknowledged?: boolean | null; /** * Field included by default. */ inputs?: { [key: string]: unknown; } | null; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ label: string; /** * Field included by default. */ max_retries?: number | null; /** * Field included by default. */ model_id?: string | null; /** * Stable node identifier within the pipeline DAG. Must match [a-z_][a-z0-9_]{0,63}. Field included by default. */ node_key: string; /** * Field included by default. */ node_type: "prompt" | "command" | "connector_exec" | "checkpoint"; /** * Field included by default. */ order: number; /** * Field included by default. */ output_schema?: { [key: string]: unknown; } | null; /** * Field included by default. */ phase?: "define" | "plan" | "build" | "verify" | "review" | "ship"; /** * Field included by default. */ pipeline_id: string; /** * Field included by default. */ position_x?: number | null; /** * Field included by default. */ position_y?: number | null; /** * Field included by default. */ prompt_template?: string | null; /** * Field included by default. */ slot_definitions?: { [key: string]: unknown; } | null; success_rate?: number | null; /** * Field included by default. */ timeout_ms?: number | null; /** * Field included by default. */ tool_grants?: Array | null; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a pipeline-node */ relationships?: { agent?: { /** * An identifier for agent */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; node_executions?: { /** * Relationship data for node_executions */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; pipeline?: { /** * An identifier for pipeline */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a catalog-view-override */ export type CatalogViewOverride = { /** * An attributes object for a catalog-view-override */ attributes?: { /** * Field included by default. */ action: "pin" | "exclude"; /** * Field included by default. */ custom_data?: { [key: string]: unknown; } | null; /** * Field included by default. */ display_description?: string | null; /** * Field included by default. */ display_media?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ display_name?: string | null; /** * Field included by default. */ position?: number | null; }; id: string; /** * A relationships object for a catalog-view-override */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a case-pipeline-link */ export type CasePipelineLink = { /** * An attributes object for a case-pipeline-link */ attributes?: { /** * Field included by default. */ case_id: string; /** * Field included by default. */ pipeline_execution_id: string; /** * Field included by default. */ role: "decision" | "enrichment" | "validation"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a case-pipeline-link */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a settlement-statement */ export type SettlementStatement = { /** * An attributes object for a settlement-statement */ attributes?: { /** * Field included by default. */ disputed_at?: unknown; /** * Field included by default. */ issued_at?: unknown; /** * Field included by default. */ isv_tenant_id: string; /** * Field included by default. */ line_items?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ net_credits?: number | null; /** * Field included by default. */ net_usd?: string | null; /** * Field included by default. */ paid_at?: unknown; /** * Field included by default. */ pdf_storage_key?: string | null; /** * Field included by default. */ per_seat_fee_total?: number | null; /** * Field included by default. */ period_end: string; /** * Field included by default. */ period_start: string; /** * Field included by default. */ reconciled_at?: unknown; /** * Field included by default. */ retail_credits_total?: number | null; /** * Field included by default. */ settlement_id?: string | null; /** * Field included by default. */ statement_number: string; /** * Field included by default. */ status: "draft" | "issued" | "paid" | "reconciled" | "disputed"; /** * Field included by default. */ wholesale_credits_total?: number | null; }; id: string; /** * A relationships object for a settlement-statement */ relationships?: { isv_tenant?: { /** * An identifier for isv_tenant */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; settlement?: { /** * An identifier for settlement */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a email-template */ export type EmailTemplate = { /** * An attributes object for a email-template */ attributes?: { /** * Field included by default. */ application_id: string; /** * Email body in markdown (supports {{variable}} interpolation). Field included by default. */ body_markdown: string; /** * System templates are auto-created and cannot be deleted. Field included by default. */ category: "system" | "custom"; /** * Whether this email is sent. Field included by default. */ enabled: boolean; /** * Display name for the template. Field included by default. */ name: string; /** * Layer 1 platform-owned templates cannot have content edited by ISVs. Field included by default. */ platform_owned: boolean; /** * Primary brand color for email styling (hex). Field included by default. */ primary_color?: string | null; /** * Unique identifier for this template within the application. Field included by default. */ slug: string; /** * Email subject line (supports {{variable}} interpolation). Field included by default. */ subject: string; }; id: string; /** * A relationships object for a email-template */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a form-deployment */ export type FormDeployment = { /** * An attributes object for a form-deployment */ attributes?: { /** * Field included by default. */ allow_tenant_clone: boolean; /** * Field included by default. */ application_id: string; /** * Field included by default. */ auto_deploy: boolean; /** * Field included by default. */ available_version_id?: string | null; /** * Field included by default. */ created_at: unknown; /** * Field included by default. */ effective_version_id: string; /** * Field included by default. */ form_id: string; /** * Field included by default. */ is_application_default: boolean; /** * Field included by default. */ overrides: { [key: string]: unknown; }; /** * Field included by default. */ pinned_version_id?: string | null; /** * Field included by default. */ seal_policy?: { /** * Field included by default. */ report_format?: "sealed" | "open"; /** * Field included by default. */ execution_mode?: "sealed" | "open"; /** * Field included by default. */ theme_overrides?: "sealed" | "open"; /** * Field included by default. */ disclose_logic_trace?: "sealed" | "open"; /** * Field included by default. */ prompt_variants?: "sealed" | "open"; /** * Field included by default. */ chunking_strategy?: "sealed" | "open"; /** * Field included by default. */ output_schema_locked?: "sealed" | "open"; /** * Field included by default. */ confidence_weights?: "sealed" | "open"; /** * Field included by default. */ logic_locked?: "sealed" | "open"; /** * Field included by default. */ max_cost_credits?: "sealed" | "open"; /** * Field included by default. */ abandonment_threshold_days?: "sealed" | "open"; /** * Field included by default. */ theme_locked?: "sealed" | "open"; /** * Field included by default. */ layout_locked?: "sealed" | "open"; /** * Field included by default. */ data_retention_days?: "sealed" | "open"; /** * Field included by default. */ report_template?: "sealed" | "open"; /** * Field included by default. */ model_id?: "sealed" | "open"; /** * Field included by default. */ description?: "sealed" | "open"; /** * Field included by default. */ name?: "sealed" | "open"; /** * Field included by default. */ temperature?: "sealed" | "open"; /** * Field included by default. */ allowed_origins?: "sealed" | "open"; /** * Field included by default. */ logic_rules?: "sealed" | "open"; /** * Field included by default. */ max_iterations?: "sealed" | "open"; /** * Field included by default. */ prompt_template?: "sealed" | "open"; /** * Field included by default. */ output_schema_pins?: Array | null; /** * Field included by default. */ tags?: "sealed" | "open"; /** * Field included by default. */ theme_id?: "sealed" | "open"; /** * Field included by default. */ public_key_jwk?: "sealed" | "open"; /** * Field included by default. */ instructions?: "sealed" | "open"; /** * Field included by default. */ max_parallel_tools?: "sealed" | "open"; /** * Field included by default. */ access_mode?: "sealed" | "open"; /** * Field included by default. */ chunking_config?: "sealed" | "open"; /** * Field included by default. */ input_schema_pins?: Array | null; /** * Field included by default. */ output_schema?: "sealed" | "open"; /** * Field included by default. */ min_submit_delay_ms?: "sealed" | "open"; /** * Field included by default. */ assistant_agent_version_id?: "sealed" | "open"; /** * Field included by default. */ custom_css?: "sealed" | "open"; /** * Field included by default. */ layout_tree?: "sealed" | "open"; /** * Field included by default. */ default_instructions?: "sealed" | "open"; /** * Field included by default. */ tool_grant_pins?: Array | null; /** * Field included by default. */ max_tool_calls?: "sealed" | "open"; } | null | unknown; /** * Field included by default. */ tenant_id: string; /** * Field included by default. */ update_available: boolean; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a form-deployment */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; available_version?: { /** * An identifier for available_version */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; effective_version?: { /** * An identifier for effective_version */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; form?: { /** * An identifier for form */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; pinned_version?: { /** * An identifier for pinned_version */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; tenant?: { /** * An identifier for tenant */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a agent-version-revision */ export type AgentVersionRevision = { /** * An attributes object for a agent-version-revision */ attributes?: { /** * Field included by default. */ changes_summary?: string | null; /** * Field included by default. */ created_at: unknown; display_version?: string | null; /** * Field included by default. */ prompt_template: string; /** * Field included by default. */ revision: number; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a agent-version-revision */ relationships?: { [key: string]: never; }; type: string; }; export type InvoicesInvoiceBillingAddressInputCreateType = { city?: string | null; /** * ISO 3166-1 alpha-2 country code */ country?: string | null; line1?: string | null; line2?: string | null; postal_code?: string | null; state?: string | null; }; /** * A "Resource object" representing a brand-identity */ export type BrandIdentity = { /** * An attributes object for a brand-identity */ attributes?: { /** * Field included by default. */ color_palette: { [key: string]: unknown; }; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ industry?: string | null; /** * Field included by default. */ is_default: boolean; /** * Field included by default. */ logo_url?: string | null; /** * Field included by default. */ name: string; /** * Field included by default. */ target_audience?: string | null; /** * Field included by default. */ tenant_id: string; /** * Field included by default. */ values: Array; /** * Brand voice description (e.g., 'Professional but approachable'). Field included by default. */ voice?: string | null; /** * Field included by default. */ website_url?: string | null; /** * Field included by default. */ workspace_id?: string | null; }; id: string; /** * A relationships object for a brand-identity */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a graph-node */ export type GraphNode = { /** * An attributes object for a graph-node */ attributes?: { /** * Field included by default. */ confidence?: number | null; /** * Field included by default. */ document_id?: string | null; /** * Field included by default. */ entity_type?: string | null; /** * Field included by default. */ label: string; /** * Field included by default. */ properties?: { [key: string]: unknown; } | null; /** * Field included by default. */ tenant_id: string; /** * Field included by default. */ workspace_id?: string | null; }; id: string; /** * A relationships object for a graph-node */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a toolkit-agent-run */ export type ToolkitAgentRun = { /** * An attributes object for a toolkit-agent-run */ attributes?: { /** * Field included by default. */ capability_level: "browser" | "sidecar" | "native"; /** * Field included by default. */ content_hash: string; /** * Field included by default. */ latency_ms: number; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ model_name: string; /** * Field included by default. */ operation: "extract" | "classify" | "transcribe" | "reason" | "tool_call"; /** * Field included by default. */ status: "success" | "failure" | "timeout"; /** * Field included by default. */ tokens_in: number; /** * Field included by default. */ tokens_out: number; /** * Field included by default. */ user_id?: string | null; }; id: string; /** * A relationships object for a toolkit-agent-run */ relationships?: { [key: string]: never; }; type: string; }; export type CaseTypeGroupingRulesInputCreateType = { confidence_threshold?: number | null; default_behavior?: "match_or_create" | "match_only" | "create_only"; match_by_fields?: Array | null; match_window_hours?: number | null; }; export type CaseTypeRequiredReviewsInputCreateType = { decision_trigger?: "always" | "on_priority" | "never"; field_triggers?: unknown | Array<{ confidence_below?: number | unknown; field: string; }> | Array<{ confidence_below?: number | unknown; field?: string | unknown; }>; }; /** * A "Resource object" representing a payment-method */ export type PaymentMethod = { /** * An attributes object for a payment-method */ attributes?: { /** * Field included by default. */ billing_address?: string | null; /** * Field included by default. */ billing_city?: string | null; /** * Field included by default. */ billing_state?: string | null; /** * Field included by default. */ brand?: string | null; /** * Field included by default. */ created_at: unknown; /** * Field included by default. */ exp_month?: number | null; /** * Field included by default. */ exp_year?: number | null; /** * Field included by default. */ holder_name?: string | null; /** * Field included by default. */ is_default?: boolean | null; /** * Field included by default. */ last4?: string | null; /** * Field included by default. */ nickname?: string | null; provider: "qorpay" | "stripe"; /** * Field included by default. */ type: "card" | "bank_account"; /** * Field included by default. */ updated_at: unknown; /** * Field included by default. */ zip_code?: string | null; }; id: string; /** * A relationships object for a payment-method */ relationships?: { [key: string]: never; }; type: string; }; export type SchedulingEventTypeLocationInputUpdateType = { address?: string | null; instructions?: string | null; latitude?: number | null; longitude?: number | null; name?: string | null; type?: "in_person" | "video" | "phone" | "custom_url"; url?: string | null; }; /** * A "Resource object" representing a balance */ export type Balance = { /** * An attributes object for a balance */ attributes?: { [key: string]: never; }; id: string; /** * A relationships object for a balance */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-note-template */ export type ClinicalNoteTemplate = { /** * An attributes object for a clinical-note-template */ attributes?: { /** * Field included by default. */ category?: string | null; /** * Field included by default. */ created_by_id?: string | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ is_active: boolean; is_archived?: boolean | null; is_catalog?: boolean | null; /** * Field included by default. */ metadata: { [key: string]: unknown; }; /** * Field included by default. */ note_type: "soap" | "adime" | "progress" | "discharge" | "addendum"; /** * Field included by default. */ sections: { [key: string]: unknown; }; /** * Field included by default. */ source_catalog_id?: string | null; /** * Field included by default. */ source_template_id?: string | null; /** * Field included by default. */ tags: Array; /** * Field included by default. */ title: string; }; id: string; /** * A relationships object for a clinical-note-template */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a contract-renewal-alert */ export type ContractRenewalAlert = { /** * An attributes object for a contract-renewal-alert */ attributes?: { /** * Field included by default. */ contract_id: string; /** * Field included by default. */ renewal_date: string; /** * Field included by default. */ sent_at: unknown; /** * Field included by default. */ webhook_dispatched: boolean; /** * Field included by default. */ window: "thirty_days" | "fourteen_days" | "seven_days" | "one_day"; }; id: string; /** * A relationships object for a contract-renewal-alert */ relationships?: { contract?: { /** * An identifier for contract */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a semantic-cache-entry */ export type SemanticCacheEntry = { /** * An attributes object for a semantic-cache-entry */ attributes?: { /** * Workspace ID for multi-tenant isolation. Field included by default. */ workspace_id?: string | null; }; id: string; /** * A relationships object for a semantic-cache-entry */ relationships?: { workspace?: { /** * An identifier for workspace */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a payment */ export type Payment = { /** * An attributes object for a payment */ attributes?: { /** * Field included by default. */ amount?: number | null; /** * Field included by default. */ created_at: unknown; /** * Field included by default. */ currency?: string | null; /** * Field included by default. */ error_message?: string | null; /** * Field included by default. */ provider_reference?: string | null; /** * Field included by default. */ status?: string | null; }; id: string; /** * A relationships object for a payment */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a form-version-revision */ export type FormVersionRevision = { /** * An attributes object for a form-version-revision */ attributes?: { /** * Field included by default. */ changes_summary?: string | null; /** * Field included by default. */ created_at: unknown; /** * Field included by default. */ custom_css?: string | null; /** * Field included by default. */ form_version_id: string; /** * Field included by default. */ layout_tree: { [key: string]: unknown; }; /** * Field included by default. */ logic_rules: { [key: string]: unknown; }; /** * Field included by default. */ revision: number; /** * Field included by default. */ theme_overrides: { [key: string]: unknown; }; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a form-version-revision */ relationships?: { form_version?: { /** * An identifier for form_version */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a recipes-recipe-favorite */ export type RecipesRecipeFavorite = { /** * An attributes object for a recipes-recipe-favorite */ attributes?: { /** * Field included by default. */ contact_id?: string | null; /** * Field included by default. */ meal_type?: string | null; /** * Field included by default. */ notes?: string | null; /** * Field included by default. */ rating?: number | null; /** * Field included by default. */ recipe_id: string; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a recipes-recipe-favorite */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a invoices-quote-request */ export type InvoicesQuoteRequest = { /** * An attributes object for a invoices-quote-request */ attributes?: { /** * Field included by default. */ expires_at?: unknown; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ line_items: Array<{ [key: string]: unknown; }>; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ notes?: string | null; /** * Field included by default. */ requester_contact_id?: string | null; /** * Field included by default. */ requester_email?: string | null; /** * Field included by default. */ requester_name?: string | null; /** * Field included by default. */ status: "received" | "under_review" | "quoted" | "rejected" | "accepted" | "expired"; /** * Field included by default. */ submitted_via_form_id?: string | null; /** * Field included by default. */ submitted_via_submission_id?: string | null; /** * Field included by default. */ updated_at: unknown; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a invoices-quote-request */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a email-marketing-template */ export type EmailMarketingTemplate = { /** * An attributes object for a email-marketing-template */ attributes?: { /** * Field included by default. */ ai_instructions?: string | null; /** * Field included by default. */ archived?: boolean | null; /** * Field included by default. */ body_mjml?: string | null; /** * Field included by default. */ body_template?: string | null; /** * Field included by default. */ current_version?: number | null; /** * Field included by default. */ name: string; /** * Field included by default. */ published_at?: unknown; /** * Field included by default. */ published_body_html?: string | null; /** * Field included by default. */ subject_template?: string | null; /** * Field included by default. */ template_format?: string | null; /** * Field included by default. */ type?: "template" | "prompt"; /** * Field included by default. */ variable_schema?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ variables?: Array | null; }; id: string; /** * A relationships object for a email-marketing-template */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a chat-thread */ export type ChatThread = { /** * An attributes object for a chat-thread */ attributes?: { /** * Field included by default. */ agent_id?: string | null; /** * Field included by default. */ agent_version_id?: string | null; /** * Field included by default. */ archived_at?: unknown; /** * Field included by default. */ context_summary?: string | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ title?: string | null; }; id: string; /** * A relationships object for a chat-thread */ relationships?: { agent?: { /** * An identifier for agent */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; agent_version?: { /** * An identifier for agent_version */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; messages?: { /** * Relationship data for messages */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; }; type: string; }; /** * A "Resource object" representing a email-marketing-generated-email */ export type EmailMarketingGeneratedEmail = { /** * An attributes object for a email-marketing-generated-email */ attributes?: { /** * Field included by default. */ body?: string | null; /** * Field included by default. */ error_message?: string | null; /** * Field included by default. */ is_approved?: boolean | null; /** * Field included by default. */ is_edited?: boolean | null; /** * Field included by default. */ scheduled_for?: unknown; /** * Field included by default. */ sent_at?: unknown; /** * Field included by default. */ status?: "draft" | "approved" | "sending" | "sent" | "scheduled" | "failed"; /** * Field included by default. */ subject?: string | null; }; id: string; /** * A relationships object for a email-marketing-generated-email */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a data-transfer-record */ export type DataTransferRecord = { /** * An attributes object for a data-transfer-record */ attributes?: { /** * Field included by default. */ data_categories: Array; /** * ISO country code of the data destination. Field included by default. */ destination_jurisdiction: string; /** * Field included by default. */ legal_basis?: string | null; /** * ISO country code of the data source (e.g., 'DE', 'US'). Field included by default. */ source_jurisdiction: string; /** * Field included by default. */ transfer_mechanism: "scc" | "bcr" | "adequacy_decision" | "derogation" | "consent"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a data-transfer-record */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-health-metric */ export type ClinicalHealthMetric = { /** * An attributes object for a clinical-health-metric */ attributes?: { /** * Field included by default. */ confidence?: string | null; /** * Field included by default. */ context_tags: Array; /** * Field included by default. */ extracted_from?: string | null; is_archived?: boolean | null; /** * Field included by default. */ measured_at?: string | null; /** * Field included by default. */ metadata: { [key: string]: unknown; }; /** * Field included by default. */ metric_category: string; /** * Field included by default. */ metric_type: string; /** * Field included by default. */ patient_id: string; /** * Field included by default. */ pipeline_execution_id?: string | null; /** * Field included by default. */ session_id?: string | null; /** * Field included by default. */ source: string; /** * Field included by default. */ unit?: string | null; /** * Field included by default. */ value_numeric?: string | null; /** * Field included by default. */ value_text?: string | null; }; id: string; /** * A relationships object for a clinical-health-metric */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-client-medication */ export type ClinicalClientMedication = { /** * An attributes object for a clinical-client-medication */ attributes?: { /** * Field included by default. */ dosage?: string | null; /** * Field included by default. */ end_date?: string | null; /** * Field included by default. */ external_ids: { [key: string]: unknown; }; /** * Field included by default. */ frequency?: string | null; /** * Field included by default. */ generic_name?: string | null; /** * Field included by default. */ indication?: string | null; /** * Field included by default. */ instructions?: string | null; /** * Field included by default. */ interaction_flags: Array; is_archived?: boolean | null; /** * Field included by default. */ metadata: { [key: string]: unknown; }; /** * Field included by default. */ name: string; /** * Field included by default. */ ndc_code?: string | null; /** * Field included by default. */ patient_id: string; /** * Field included by default. */ pharmacy_name?: string | null; /** * Field included by default. */ pharmacy_phone?: string | null; /** * Field included by default. */ prescribed_at?: string | null; /** * Field included by default. */ prescriber_npi?: string | null; /** * Field included by default. */ refill_date?: string | null; /** * Field included by default. */ refills_remaining?: number | null; /** * Field included by default. */ route?: string | null; /** * Field included by default. */ source?: string | null; /** * Field included by default. */ start_date?: string | null; /** * Field included by default. */ status: "active" | "discontinued" | "on_hold" | "pending_review"; }; id: string; /** * A relationships object for a clinical-client-medication */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a agent-soul */ export type AgentSoul = { /** * An attributes object for a agent-soul */ attributes?: { /** * Field included by default. */ application_id?: string | null; /** * Field included by default. */ content: string; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ is_default: boolean; /** * Field included by default. */ name: string; /** * Field included by default. */ scope_type: "platform" | "application" | "workspace"; /** * Stable identifier for platform-provisioned souls. NULL for ISV-created souls. Field included by default. */ system_slug?: string | null; /** * Field included by default. */ updated_at: unknown; /** * Field included by default. */ version: number; /** * Field included by default. */ workspace_id?: string | null; }; id: string; /** * A relationships object for a agent-soul */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; workspace?: { /** * An identifier for workspace */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a extraction-workflow */ export type ExtractionWorkflow = { /** * An attributes object for a extraction-workflow */ attributes?: { /** * Optional description of the workflow purpose and behavior. Field included by default. */ description?: string | null; /** * Field included by default. */ enabled: boolean; /** * Human-readable workflow name. Field included by default. */ name: string; /** * Ordered list of workflow steps. Field included by default. */ steps?: Array<{ /** * Static agent UUID for classify/extract/validate steps. Field included by default. */ agent_id?: string | null | unknown; /** * How to resolve the agent. :from_classifier uses classifier output's recommended_agent_id. Field included by default. */ agent_source?: "static" | "from_classifier" | "from_previous" | unknown; /** * Step-type-specific configuration: * route: %{"conditions" => [%{"field" => "step.key", "op" => "gte"|"lt"|"eq", "value" => term, "goto" => "step_name"}], "default" => "step_name"} * human_review: %{"fields" => [string], "timeout_hours" => integer, "fallback" => "step_name"} * validate: %{"on_failure" => "flag_for_review"|"goto", "goto_step" => "step_name", "max_retries" => integer} * enrich: %{"tools" => [string], "fields" => [string]} * transform: %{"transforms" => [%{"field" => string, "format" => string}]} * webhook: %{"url" => string, "timeout_ms" => integer, "headers" => map} * group_into_case: %{"case_type_slug" => string, "on_no_match" => "create_new"|"flag_for_review"|"skip"} * . Field included by default. */ config?: { [key: string]: unknown; } | null | unknown; /** * Unique name for this step within the workflow, used for routing references. Field included by default. */ name: string; /** * Execution order within the workflow (ascending). Field included by default. */ order: number; /** * Named outputs this step produces, referenceable by later steps via 'step_name.output_key'. Field included by default. */ outputs?: Array | null | unknown; /** * Execution type — determines which WorkflowRunner handler is invoked. Field included by default. */ type: "classify" | "route" | "extract" | "validate" | "enrich" | "human_review" | "transform" | "webhook" | "group_into_case"; }> | null; /** * When this workflow is triggered. Field included by default. */ trigger: "on_upload" | "on_schedule" | "manual"; workspace_id: string; }; id: string; /** * A relationships object for a extraction-workflow */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a toolkit-quality-report */ export type ToolkitQualityReport = { /** * An attributes object for a toolkit-quality-report */ attributes?: { /** * Field included by default. */ cloud_elevated: boolean; /** * Field included by default. */ field_match_rate: number; /** * Field included by default. */ fields_compared: number; /** * Field included by default. */ local_confidence: number; /** * Field included by default. */ model_name: string; /** * Field included by default. */ operation: "extract" | "classify" | "transcribe" | "reason" | "tool_call"; /** * Field included by default. */ user_id?: string | null; }; id: string; /** * A relationships object for a toolkit-quality-report */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a shadow-comparison */ export type ShadowComparison = { /** * An attributes object for a shadow-comparison */ attributes?: { /** * Field included by default. */ compared_at?: string | null; /** * Field included by default. */ document_id: string; /** * Error information if either extractor failed. Field included by default. */ error_details?: { [key: string]: unknown; } | null; /** * Field included by default. */ file_size: number; /** * Field included by default. */ filename: string; /** * Field included by default. */ mime_type: string; /** * Field included by default. */ page_count?: number | null; /** * Field included by default. */ primary_confidence?: number | null; /** * Field included by default. */ primary_duration_ms?: number | null; /** * Field included by default. */ primary_extractor?: string | null; /** * Field included by default. */ primary_text_length?: number | null; /** * Field included by default. */ shadow_confidence?: number | null; /** * Field included by default. */ shadow_duration_ms?: number | null; /** * Field included by default. */ shadow_extractor: string; /** * Field included by default. */ shadow_text_length?: number | null; /** * Field included by default. */ status: "success" | "primary_failed" | "shadow_failed" | "both_failed"; /** * Difference in extracted text length (shadow - primary). Field included by default. */ text_length_diff?: number | null; /** * Similarity score between primary and shadow text (0.0-1.0). Field included by default. */ text_similarity?: number | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a shadow-comparison */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a invoices-rule */ export type InvoicesRule = { /** * An attributes object for a invoices-rule */ attributes?: { /** * Field included by default. */ actions?: { [key: string]: unknown; } | null; /** * Field included by default. */ active?: boolean | null; /** * Field included by default. */ conditions?: { [key: string]: unknown; } | null; /** * Field included by default. */ confidence?: string | null; /** * Field included by default. */ hit_count?: number | null; /** * Field included by default. */ last_hit_at?: unknown; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ name: string; /** * Field included by default. */ rule_type: "gl_mapping" | "categorization" | "approval_routing" | "anomaly_threshold" | "payment_terms"; /** * Field included by default. */ source: "ai_learned" | "user_defined"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a invoices-rule */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a transfer */ export type Transfer = { /** * An attributes object for a transfer */ attributes?: { [key: string]: never; }; id: string; /** * A relationships object for a transfer */ relationships?: { [key: string]: never; }; type: string; }; export type ToolkitQualityReportType = { /** * Field included by default. */ cloud_elevated: boolean; /** * Field included by default. */ field_match_rate: number; /** * Field included by default. */ fields_compared: number; /** * Field included by default. */ id?: string | null; /** * Field included by default. */ local_confidence: number; /** * Field included by default. */ model_name: string; /** * Field included by default. */ operation: "extract" | "classify" | "transcribe" | "reason" | "tool_call"; /** * Field included by default. */ user_id?: string | null; }; export type ApplicationOauthInputUpdateType = { /** * Allowed OAuth callback URLs for this application */ callback_urls?: Array | null; /** * Default callback URL if not specified in request */ default_callback_url?: string | null; /** * Which OAuth providers are enabled for this app */ enabled_providers?: Array<"google" | "github" | "salesforce" | "microsoft"> | null; /** * Custom GitHub OAuth client ID (optional) */ github_client_id?: string | null; /** * Custom GitHub OAuth client secret (optional) */ github_client_secret?: string | null; /** * Custom Google OAuth client ID (optional) */ google_client_id?: string | null; /** * Custom Google OAuth client secret (optional) */ google_client_secret?: string | null; /** * Custom Microsoft OAuth client ID (optional) */ microsoft_client_id?: string | null; /** * Custom Microsoft OAuth client secret (optional) */ microsoft_client_secret?: string | null; }; /** * A "Resource object" representing a training-session */ export type TrainingSession = { /** * An attributes object for a training-session */ attributes?: { /** * Field included by default. */ confirmations_count: number; /** * Field included by default. */ corrections_count: number; /** * Denormalized filename from the source document. Field included by default. */ document_filename?: string | null; /** * Field included by default. */ document_id: string; /** * Async calculated score of how much this session improved the model. Field included by default. */ impact_score?: number | null; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ reverted_at?: unknown; /** * Field included by default. */ status?: "queued" | "processing" | "completed" | "failed" | "reverted"; /** * Field included by default. */ training_note?: string | null; /** * Field included by default. */ updated_at: unknown; user_email?: string | null; user_name?: string | null; }; id: string; /** * A relationships object for a training-session */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a sync-log */ export type SyncLog = { /** * An attributes object for a sync-log */ attributes?: { /** * Field included by default. */ completed_at?: string | null; /** * Field included by default. */ connector_instance_id: string; /** * Field included by default. */ error_message?: string | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ records_created?: number | null; /** * Field included by default. */ records_failed?: number | null; /** * Field included by default. */ records_processed?: number | null; /** * Field included by default. */ records_updated?: number | null; /** * Field included by default. */ started_at?: string | null; /** * Field included by default. */ status?: "pending" | "running" | "completed" | "failed" | "cancelled"; /** * Field included by default. */ sync_type: "full" | "incremental" | "webhook" | "manual"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a sync-log */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a risk-assessment */ export type RiskAssessment = { /** * An attributes object for a risk-assessment */ attributes?: { /** * Field included by default. */ approved_at?: unknown; /** * Field included by default. */ assessment_type: "security" | "privacy" | "operational" | "compliance"; /** * Optional link to DPIA. Field included by default. */ dpia_id?: string | null; /** * Field included by default. */ expires_at?: unknown; /** * Field included by default. */ findings?: { [key: string]: unknown; } | null; /** * Field included by default. */ mitigations?: { [key: string]: unknown; } | null; /** * Optional link to ProcessingActivity. Field included by default. */ processing_activity_id?: string | null; /** * Field included by default. */ risk_level: "low" | "medium" | "high" | "critical"; /** * Field included by default. */ status: "draft" | "in_review" | "approved" | "expired"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a risk-assessment */ relationships?: { [key: string]: never; }; type: string; }; export type SchedulingEventLocationInputCreateType = { address?: string | null; instructions?: string | null; latitude?: number | null; longitude?: number | null; name?: string | null; type?: "in_person" | "video" | "phone" | "custom_url"; url?: string | null; }; /** * A "Resource object" representing a campaign */ export type Campaign = { /** * An attributes object for a campaign */ attributes?: { /** * Field included by default. */ csv_filename?: string | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ failed_count?: number | null; /** * Field included by default. */ generated_count?: number | null; /** * Field included by default. */ include_tracking_pixel?: boolean | null; /** * Field included by default. */ include_unsubscribe_link?: boolean | null; /** * Field included by default. */ name: string; /** * Field included by default. */ sender_email?: string | null; /** * Field included by default. */ sender_name?: string | null; /** * Field included by default. */ sender_signature?: string | null; /** * Field included by default. */ sent_count?: number | null; /** * Field included by default. */ status?: "draft" | "importing" | "mapping" | "ready_to_generate" | "generating" | "review" | "approved" | "sending" | "scheduled" | "completed" | "failed" | "archived"; /** * Field included by default. */ template_version_id?: string | null; /** * Field included by default. */ total_recipients?: number | null; /** * Field included by default. */ unsubscribe_message?: string | null; }; id: string; /** * A relationships object for a campaign */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a crm-deal */ export type CrmDeal = { /** * An attributes object for a crm-deal */ attributes?: { /** * Field included by default. */ ai_forecast_category?: "pipeline" | "best_case" | "commit" | "closed"; /** * Field included by default. */ ai_next_action?: string | null; /** * Field included by default. */ ai_risk_score?: number | null; /** * Field included by default. */ amount?: string | null; /** * Field included by default. */ close_date?: string | null; /** * Field included by default. */ currency?: string | null; /** * Field included by default. */ external_owner_id?: string | null; /** * Field included by default. */ lost_reason?: string | null; /** * Field included by default. */ name: string; /** * Field included by default. */ owner_id?: string | null; /** * Field included by default. */ probability?: number | null; /** * Field included by default. */ properties?: { [key: string]: unknown; } | null; /** * Field included by default. */ source?: "manual" | "import" | "channel" | "connector" | "ai_extracted" | "api"; /** * Field included by default. */ status?: "open" | "won" | "lost" | "abandoned"; }; id: string; /** * A relationships object for a crm-deal */ relationships?: { [key: string]: never; }; type: string; }; export type AgentVersionPipelineStagesInputUpdateType = { /** * Input mode: text-only, vision (image), or hybrid (both) */ input_mode?: "text" | "vision" | "hybrid"; /** * Human-readable stage name (e.g., 'extract_header', 'validate_totals') */ name?: string | null; /** * Execution order (0-based). Stages execute sequentially by order. */ order?: number | null; /** * Optional stage-specific prompt template. Falls back to agent prompt if nil. */ prompt_template?: string | null; /** * What portion of the document this stage operates on */ scope?: "full" | "pages" | "chunks" | "fields"; /** * Scope-specific configuration: * pages: %{"pages" => [1, 2, 3]} * chunks: %{"chunk_ids" => [...]} * fields: %{"fields" => ["amounts.total", "line_items"]} * */ scope_config?: { [key: string]: unknown; } | null; /** * Stage execution strategy */ strategy?: "extract" | "validate" | "transform" | "enrich"; /** * Field paths this stage is responsible for producing */ target_fields?: Array | null; /** * Maximum number of tool calls allowed per stage execution */ tool_budget?: number | null; /** * Behavior when a tool call fails: continue extraction or fail the stage */ tool_failure_mode?: "continue" | "fail_stage"; /** * Per-tool call timeout in milliseconds */ tool_timeout_ms?: number | null; /** * Tool atoms available to this stage for augmented extraction */ tools?: Array | null; }; /** * A "Resource object" representing a review */ export type Review = { /** * An attributes object for a review */ attributes?: { /** * Field included by default. */ assigned_user_id?: string | null; /** * Field included by default. */ claim_was_assigned?: boolean | null; /** * Field included by default. */ completed_at?: unknown; /** * Field included by default. */ correction_payload?: { [key: string]: unknown; } | null; /** * Field included by default. */ created_by_id?: string | null; /** * Field included by default. */ decision_payload?: { [key: string]: unknown; } | null; /** * Field included by default. */ due_at?: unknown; /** * Field included by default. */ expiry_reason?: "sla" | "reviewable_missing"; /** * Field included by default. */ field_path?: string | null; /** * Field included by default. */ notes?: string | null; /** * Field included by default. */ opened_at?: unknown; /** * Field included by default. */ priority: "low" | "normal" | "high" | "urgent"; /** * Field included by default. */ queue_id: string; /** * Field included by default. */ review_type: "field" | "decision"; /** * Field included by default. */ reviewable_id: string; /** * Field included by default. */ reviewable_type: "case" | "document" | "pipeline_execution" | "agent_execution" | "submission"; /** * Field included by default. */ status: "open" | "assigned" | "in_review" | "approved" | "rejected" | "corrected" | "escalated" | "expired"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a review */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a contract-clause */ export type ContractClause = { /** * An attributes object for a contract-clause */ attributes?: { /** * Field included by default. */ clause_text: string; /** * Field included by default. */ clause_type: "term_length" | "renewal_type" | "auto_renewal_clause" | "termination_notice" | "payment_terms" | "indemnification" | "limitation_of_liability" | "governing_law" | "confidentiality" | "assignment" | "force_majeure" | "sla" | "other"; /** * Field included by default. */ contract_id: string; /** * Field included by default. */ extraction_confidence?: string | null; /** * Field included by default. */ extraction_metadata: { [key: string]: unknown; }; /** * Field included by default. */ extraction_model?: string | null; }; id: string; /** * A relationships object for a contract-clause */ relationships?: { contract?: { /** * An identifier for contract */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a config */ export type Config = { /** * An attributes object for a config */ attributes?: { /** * Field included by default. */ description?: string | null; /** * Marks this config as containing sensitive data (API keys, secrets, etc.). Field included by default. */ is_sensitive?: boolean | null; /** * Field included by default. */ value: string; }; id: string; /** * A relationships object for a config */ relationships?: { [key: string]: never; }; type: string; }; export type AgentVersionPipelineStagesInputCreateType = { /** * Input mode: text-only, vision (image), or hybrid (both) */ input_mode?: "text" | "vision" | "hybrid"; /** * Human-readable stage name (e.g., 'extract_header', 'validate_totals') */ name: string; /** * Execution order (0-based). Stages execute sequentially by order. */ order?: number | null; /** * Optional stage-specific prompt template. Falls back to agent prompt if nil. */ prompt_template?: string | null; /** * What portion of the document this stage operates on */ scope?: "full" | "pages" | "chunks" | "fields"; /** * Scope-specific configuration: * pages: %{"pages" => [1, 2, 3]} * chunks: %{"chunk_ids" => [...]} * fields: %{"fields" => ["amounts.total", "line_items"]} * */ scope_config?: { [key: string]: unknown; } | null; /** * Stage execution strategy */ strategy: "extract" | "validate" | "transform" | "enrich"; /** * Field paths this stage is responsible for producing */ target_fields?: Array | null; /** * Maximum number of tool calls allowed per stage execution */ tool_budget?: number | null; /** * Behavior when a tool call fails: continue extraction or fail the stage */ tool_failure_mode?: "continue" | "fail_stage"; /** * Per-tool call timeout in milliseconds */ tool_timeout_ms?: number | null; /** * Tool atoms available to this stage for augmented extraction */ tools?: Array | null; }; /** * A "Resource object" representing a chat-thread-workspace-stats */ export type ChatThreadWorkspaceStats = { /** * An attributes object for a chat-thread-workspace-stats */ attributes?: { /** * Field included by default. */ active_threads_24h: number; /** * Field included by default. */ active_threads_7d: number; /** * Field included by default. */ generated_at: unknown; /** * Field included by default. */ messages_by_role: { [key: string]: unknown; }; /** * Field included by default. */ total_messages: number; /** * Field included by default. */ total_threads: number; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a chat-thread-workspace-stats */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a business-associate-agreement */ export type BusinessAssociateAgreement = { /** * An attributes object for a business-associate-agreement */ attributes?: { /** * Field included by default. */ application_id: string; /** * Field included by default. */ counterparty_name: string; /** * Field included by default. */ counterparty_signatory?: string | null; /** * Field included by default. */ counterparty_signed_at?: string | null; /** * Field included by default. */ counterparty_type: "covered_entity" | "business_associate" | "subcontractor"; /** * Field included by default. */ direction: "upstream" | "downstream"; /** * Field included by default. */ effective_date: string; /** * Field included by default. */ expiration_date?: string | null; /** * Field included by default. */ phi_scope: Array; /** * Field included by default. */ renewal_reminder_days: number; /** * Field included by default. */ renewal_type: "auto_renew" | "manual_renew" | "fixed_term"; /** * Field included by default. */ signed_at?: string | null; /** * Field included by default. */ status: "draft" | "pending_signature" | "active" | "expired" | "terminated"; /** * Field included by default. */ terminated_at?: string | null; /** * Field included by default. */ termination_reason?: string | null; }; id: string; /** * A relationships object for a business-associate-agreement */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a field-mapping-confirmation */ export type FieldMappingConfirmation = { /** * An attributes object for a field-mapping-confirmation */ attributes?: { /** * Field included by default. */ add_to_schema?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ confirmed?: boolean | null; /** * Field included by default. */ document_id: string; /** * Field included by default. */ fields_added?: Array | null; /** * Field included by default. */ fields_ignored?: number | null; /** * Field included by default. */ fields_mapped?: number | null; /** * Field included by default. */ ignored_fields?: Array | null; /** * Field included by default. */ mapping_confirmed?: boolean | null; /** * Field included by default. */ mapping_confirmed_at?: string | null; /** * Field included by default. */ mappings?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ schema_updated?: boolean | null; /** * Field included by default. */ schema_version?: number | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a field-mapping-confirmation */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a legal-document */ export type LegalDocument = { /** * An attributes object for a legal-document */ attributes?: { /** * Field included by default. */ active_from?: unknown; /** * Field included by default. */ active_until?: unknown; /** * Field included by default. */ application_id?: string | null; /** * Field included by default. */ content: string; /** * Field included by default. */ document_type: "terms_of_service" | "privacy_policy" | "baa" | "dpa" | "scc" | "npp" | "security_policy" | "incident_response_plan" | "contingency_plan" | "access_control_policy" | "risk_management_plan" | "training_policy" | "sanction_policy" | "breach_notification_policy" | "system_activity_review" | "data_retention_policy" | "minimum_necessary_policy" | "authorization_form"; /** * Field included by default. */ is_active: boolean; /** * Field included by default. */ locale: string; /** * Field included by default. */ published_at?: unknown; /** * Field included by default. */ published_by_user_id?: string | null; /** * Field included by default. */ region?: string | null; /** * Field included by default. */ requires_acceptance: boolean; /** * Field included by default. */ title: string; /** * Field included by default. */ version: string; }; id: string; /** * A relationships object for a legal-document */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; export type ErrorResponse = { errors: Array<{ /** * Human-readable explanation specific to this error occurrence */ detail?: string; /** * Additional non-standard meta-information about the error */ meta?: { [key: string]: unknown; }; source?: { /** * String indicating which URI query parameter caused the error */ parameter?: string; /** * JSON Pointer to the associated entity in the request */ pointer?: string; }; /** * HTTP status code as a string */ status: string; /** * Short, human-readable summary of the error */ title: string; }>; }; /** * A "Resource object" representing a toolkit-model-release */ export type ToolkitModelRelease = { /** * An attributes object for a toolkit-model-release */ attributes?: { /** * Field included by default. */ deprecated_at?: unknown; /** * Field included by default. */ model_name: string; /** * Field included by default. */ release_notes?: string | null; /** * Field included by default. */ released_at: unknown; /** * Field included by default. */ repo_id: string; /** * Field included by default. */ sha256: string; /** * Field included by default. */ size_bytes: number; /** * Field included by default. */ variant: "safetensors_fp16" | "safetensors_bf16" | "gguf_q4_k_m" | "gguf_q5_k_m" | "onnx_fp16"; /** * Field included by default. */ version: string; }; id: string; /** * A relationships object for a toolkit-model-release */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a seat-info */ export type SeatInfo = { /** * An attributes object for a seat-info */ attributes?: { /** * Monthly base price for the seat plan. Field included by default. */ base_price?: { amount: string; currency: string; } | null | unknown; /** * Whether this tenant uses credit or seat billing. Field included by default. */ billing_mode: "credits" | "seats"; /** * Price per additional seat beyond the included bundle. Field included by default. */ overage_price_per_seat?: { amount: string; currency: string; } | null | unknown; /** * Months remaining in promotional pricing period. Field included by default. */ promotional_months_remaining?: number | null; /** * Current promotional price (nil if not in promo period). Field included by default. */ promotional_price?: { amount: string; currency: string; } | null | unknown; /** * Whether more seats can be added. Field included by default. */ seats_available?: boolean | null; /** * Seats included in the plan bundle. Field included by default. */ seats_included?: number | null; /** * Max seats (nil = unlimited). Field included by default. */ seats_limit?: number | null; /** * Overage seats beyond bundle. Field included by default. */ seats_overage?: number | null; /** * Current members + pending invitations. Field included by default. */ seats_used?: number | null; /** * Total monthly cost (base_price + overage_seats * overage_price). Field included by default. */ total_monthly?: { amount: string; currency: string; } | null | unknown; }; id: string; /** * A relationships object for a seat-info */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-patient-insurance */ export type ClinicalPatientInsurance = { /** * An attributes object for a clinical-patient-insurance */ attributes?: { authorization_number?: string | null; carrier_name?: string | null; /** * Field included by default. */ copay_amount?: string | null; coverage_end?: string | null; coverage_start?: string | null; group_number?: string | null; member_id?: string | null; /** * Field included by default. */ metadata: { [key: string]: unknown; }; /** * Field included by default. */ patient_id: string; /** * Field included by default. */ payer_id?: string | null; plan_name?: string | null; /** * Field included by default. */ plan_type?: "ppo" | "hmo" | "epo" | "pos" | "hdhp" | "medicaid" | "medicare" | "tricare" | "other"; /** * Field included by default. */ rank: "primary" | "secondary" | "tertiary"; /** * Field included by default. */ status: "active" | "inactive" | "pending_verification"; subscriber_name?: string | null; /** * Field included by default. */ subscriber_relationship?: "self" | "spouse" | "child" | "other"; }; id: string; /** * A relationships object for a clinical-patient-insurance */ relationships?: { authorizations?: { /** * Relationship data for authorizations */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; patient?: { /** * An identifier for patient */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a config-enum */ export type ConfigEnum = { /** * An attributes object for a config-enum */ attributes?: { /** * Optional description of this enum value. Field included by default. */ description?: string | null; /** * Whether this enum value is active (inactive values are hidden by default). Field included by default. */ is_active: boolean; /** * Human-readable display label. Field included by default. */ label: string; /** * Sort order for display (lower numbers first). Field included by default. */ sort_order: number; /** * The enum type (e.g., 'agent_domain', 'document_category'). Field included by default. */ type: string; /** * The enum value (normalized to lowercase). Field included by default. */ value: string; }; id: string; /** * A relationships object for a config-enum */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a subscription */ export type Subscription = { /** * An attributes object for a subscription */ attributes?: { /** * Field included by default. */ billing_interval?: number | null; /** * Per-subscription override of `plan.concurrent_operations_limit`. * . Field included by default. */ concurrent_operations_limit_override?: number | null; /** * Field included by default. */ created_at: unknown; /** * Field included by default. */ current_period_end?: string | null; /** * Field included by default. */ dunning_stage: number; /** * Field included by default. */ is_addon: boolean; /** * Field included by default. */ monthly_credits?: number | null; /** * Field included by default. */ monthly_price?: { amount: string; currency: string; } | null | unknown; /** * Field included by default. */ next_retry_at?: string | null; /** * Field included by default. */ overage_seats: number; /** * Field included by default. */ pending_plan_id?: string | null; /** * Timestamp at which this subscription was pinned to its Plan revision. * Set on create; immutable. * . Field included by default. */ pinned_at?: string | null; /** * Forensic tag of the Plan revision this subscription was pinned to. * Format: `:`. Not globally unique — Plan * slugs are scoped per Application; pair with `plan_id` for * cross-application uniqueness. * . Field included by default. */ plan_revision_id?: string | null; /** * Immutable audit snapshot of every Plan attribute that affects subscriber * terms at subscription-create time. Frozen on create; never updated by * standard actions. Audit-only — not read by runtime billing code. * . Field included by default. */ plan_snapshot?: { [key: string]: unknown; } | null; /** * Field included by default. */ promotional_months?: number | null; /** * Field included by default. */ promotional_months_used: number; /** * Field included by default. */ promotional_price?: { amount: string; currency: string; } | null | unknown; /** * Field included by default. */ quantity: number; /** * Per-subscription override of `plan.rate_limit_period_seconds`. * . Field included by default. */ rate_limit_period_seconds_override?: number | null; /** * Per-subscription override of `plan.rate_limit_requests`. When set, must * be > 0. Settable only via the `:set_rate_limit_overrides` action by * Platform Admin or Application Owner. * . Field included by default. */ rate_limit_requests_override?: number | null; /** * Field included by default. */ renewal_count: number; /** * Field included by default. */ revoked_at?: string | null; /** * Field included by default. */ revoked_capability?: string | null; /** * Field included by default. */ status?: "active" | "past_due" | "canceled" | "incomplete" | "pending_cancellation" | "downgrade_scheduled" | "capability_revoked_grace" | "canceled_capability_revoked"; /** * Field included by default. */ type: "credits" | "storage" | "credits_storage" | "compute" | "seats" | "agents" | "support"; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a subscription */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a agent-training-stats */ export type AgentTrainingStats = { /** * An attributes object for a agent-training-stats */ attributes?: { /** * Field included by default. */ accuracy: number; /** * Field included by default. */ agent_id: string; /** * Field included by default. */ examples_last_7_days: number; /** * Field included by default. */ last_example_created_at?: unknown; /** * Field included by default. */ learning_active: boolean; /** * Field included by default. */ total_examples: number; /** * Field included by default. */ version: number; }; id: string; /** * A relationships object for a agent-training-stats */ relationships?: { agent?: { /** * An identifier for agent */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a email-recipient */ export type EmailRecipient = { /** * An attributes object for a email-recipient */ attributes?: { /** * Field included by default. */ email: string; /** * Field included by default. */ name?: string | null; /** * Field included by default. */ recipient_type?: "bcc" | "cc" | "to"; }; id: string; /** * A relationships object for a email-recipient */ relationships?: { [key: string]: never; }; type: string; }; export type AgentDeploymentSealPolicyInputCreateType = { report_format?: "sealed" | "open"; execution_mode?: "sealed" | "open"; theme_overrides?: "sealed" | "open"; disclose_logic_trace?: "sealed" | "open"; prompt_variants?: "sealed" | "open"; chunking_strategy?: "sealed" | "open"; output_schema_locked?: "sealed" | "open"; confidence_weights?: "sealed" | "open"; logic_locked?: "sealed" | "open"; max_cost_credits?: "sealed" | "open"; abandonment_threshold_days?: "sealed" | "open"; theme_locked?: "sealed" | "open"; layout_locked?: "sealed" | "open"; data_retention_days?: "sealed" | "open"; report_template?: "sealed" | "open"; model_id?: "sealed" | "open"; description?: "sealed" | "open"; name?: "sealed" | "open"; temperature?: "sealed" | "open"; allowed_origins?: "sealed" | "open"; logic_rules?: "sealed" | "open"; max_iterations?: "sealed" | "open"; prompt_template?: "sealed" | "open"; output_schema_pins?: Array | null; tags?: "sealed" | "open"; theme_id?: "sealed" | "open"; public_key_jwk?: "sealed" | "open"; instructions?: "sealed" | "open"; max_parallel_tools?: "sealed" | "open"; access_mode?: "sealed" | "open"; chunking_config?: "sealed" | "open"; input_schema_pins?: Array | null; output_schema?: "sealed" | "open"; min_submit_delay_ms?: "sealed" | "open"; assistant_agent_version_id?: "sealed" | "open"; custom_css?: "sealed" | "open"; layout_tree?: "sealed" | "open"; default_instructions?: "sealed" | "open"; tool_grant_pins?: Array | null; max_tool_calls?: "sealed" | "open"; }; /** * A "Resource object" representing a clinical-supplement-template-collection */ export type ClinicalSupplementTemplateCollection = { /** * An attributes object for a clinical-supplement-template-collection */ attributes?: { /** * Field included by default. */ description?: string | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ name: string; template_count?: number | null; }; id: string; /** * A relationships object for a clinical-supplement-template-collection */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a catalog-stock-location */ export type CatalogStockLocation = { /** * An attributes object for a catalog-stock-location */ attributes?: { /** * Field included by default. */ address?: { [key: string]: unknown; } | null; /** * Field included by default. */ application_id?: string | null; /** * Field included by default. */ is_default: boolean; /** * Field included by default. */ name: string; /** * Field included by default. */ slug: string; /** * Field included by default. */ status: "active" | "inactive"; /** * Field included by default. */ type: "warehouse" | "store" | "virtual" | "drop_ship" | "in_transit"; /** * Field included by default. */ valuation_method: "weighted_average" | "fifo"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a catalog-stock-location */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a compliance-posture */ export type CompliancePosture = { /** * An attributes object for a compliance-posture */ attributes?: { /** * Field included by default. */ active_retention_policies: number; /** * Field included by default. */ breach_breakdown: { [key: string]: unknown; }; /** * Field included by default. */ expiring_risk_assessments: number; /** * Field included by default. */ frameworks: Array<{ [key: string]: unknown; }>; /** * Field included by default. */ open_breaches: number; /** * Field included by default. */ overdue_dsrs: number; /** * Field included by default. */ pending_dsrs: number; /** * Field included by default. */ pii_scan_breakdown: { [key: string]: unknown; }; /** * Field included by default. */ pii_scans_last_30d: number; /** * Field included by default. */ risk_assessments_by_level: { [key: string]: unknown; }; /** * Field included by default. */ total_breaches: number; /** * Field included by default. */ total_consent_subjects: number; /** * Field included by default. */ total_dsrs: number; /** * Field included by default. */ total_retention_policies: number; /** * Field included by default. */ workspace_consents: number; }; id: string; /** * A relationships object for a compliance-posture */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a retention-policy */ export type RetentionPolicy = { /** * An attributes object for a retention-policy */ attributes?: { /** * Field included by default. */ action_on_expiry: "delete" | "archive" | "anonymize"; /** * Category of data (e.g., chat_messages, documents, knowledge_files). Field included by default. */ data_type: string; /** * Field included by default. */ enabled: boolean; /** * Field included by default. */ retention_days: number; }; id: string; /** * A relationships object for a retention-policy */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-goal-check-in */ export type ClinicalGoalCheckIn = { /** * An attributes object for a clinical-goal-check-in */ attributes?: { /** * Field included by default. */ check_in_date: string; /** * Field included by default. */ client_goal_id: string; /** * Field included by default. */ completed: boolean; /** * Field included by default. */ notes?: string | null; /** * Field included by default. */ recorded_by?: string | null; }; id: string; /** * A relationships object for a clinical-goal-check-in */ relationships?: { client_goal?: { /** * An identifier for client_goal */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a invoices-contact */ export type InvoicesContact = { /** * An attributes object for a invoices-contact */ attributes?: { /** * Field included by default. */ email?: string | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ name: string; /** * Field included by default. */ notes?: string | null; /** * Field included by default. */ payment_terms_default?: string | null; /** * Field included by default. */ phone?: string | null; /** * Field included by default. */ tax_id?: string | null; /** * Field included by default. */ type: "customer" | "vendor" | "both"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a invoices-contact */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a processing-activity */ export type ProcessingActivity = { /** * An attributes object for a processing-activity */ attributes?: { /** * EphiAsset IDs linked to this processing activity. Field included by default. */ asset_ids?: Array | null; /** * Categories of personal data processed. Field included by default. */ data_categories?: Array | null; /** * Categories of data subjects. Field included by default. */ data_subjects?: Array | null; /** * Whether this processing activity involves ePHI. Field included by default. */ ephi_classification?: "contains_ephi" | "no_ephi"; /** * Last review date for this processing activity. Field included by default. */ last_reviewed_at?: string | null; /** * Field included by default. */ legal_basis?: "consent" | "contract" | "legal_obligation" | "vital_interests" | "public_task" | "legitimate_interest"; /** * HIPAA minimum necessary standard justification. Field included by default. */ minimum_necessary_justification?: string | null; /** * Field included by default. */ name: string; /** * Purpose of processing. Field included by default. */ purpose: string; /** * Recipients or categories of recipients. Field included by default. */ recipients?: Array | null; /** * How long data is retained. Field included by default. */ retention_period?: string | null; /** * How often this activity should be reviewed (days). Field included by default. */ review_frequency_days?: number | null; /** * Description of technical and organizational security measures. Field included by default. */ security_measures?: string | null; /** * Field included by default. */ status: "active" | "archived"; /** * Countries where data is transferred. Field included by default. */ transfer_countries?: Array | null; }; id: string; /** * A relationships object for a processing-activity */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a support-sla-policy */ export type SupportSlaPolicy = { /** * An attributes object for a support-sla-policy */ attributes?: { /** * Field included by default. */ business_hours_only: boolean; /** * Field included by default. */ first_response_target: number; /** * Field included by default. */ name: string; /** * Field included by default. */ priority_filter?: Array | null; /** * Field included by default. */ resolution_target: number; }; id: string; /** * A relationships object for a support-sla-policy */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a notification-preference */ export type NotificationPreference = { /** * An attributes object for a notification-preference */ attributes?: { /** * Field included by default. */ channels?: Array | null; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ preferences?: { [key: string]: unknown; } | null; /** * Field included by default. */ updated_at: unknown; /** * Field included by default. */ user_id: string; }; id: string; /** * A relationships object for a notification-preference */ relationships?: { user?: { /** * An identifier for user */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a form-reminder-schedule */ export type FormReminderSchedule = { /** * An attributes object for a form-reminder-schedule */ attributes?: { /** * Field included by default. */ contact_email?: string | null; /** * Field included by default. */ contact_first_name?: string | null; /** * Field included by default. */ contact_id?: string | null; /** * Field included by default. */ frequency: "daily" | "every_other_day" | "weekly" | "biweekly" | "monthly"; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ last_sent_at?: unknown; /** * Field included by default. */ next_send_at: string; /** * Field included by default. */ paused: boolean; /** * Field included by default. */ respondent_token_id: string; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a form-reminder-schedule */ relationships?: { respondent_token?: { /** * An identifier for respondent_token */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a recurring-schedule */ export type RecurringSchedule = { /** * An attributes object for a recurring-schedule */ attributes?: { /** * Field included by default. */ cancelled_at?: unknown; /** * Field included by default. */ circuit_opened_at?: unknown; /** * Field included by default. */ circuit_state: "closed" | "open" | "half_open"; /** * Field included by default. */ completed_at?: unknown; /** * Field included by default. */ consecutive_failures: number; /** * Field included by default. */ cron_expression?: string | null; /** * Field included by default. */ enabled: boolean; /** * Field included by default. */ ends_at?: unknown; /** * Field included by default. */ execution_window_seconds: number; /** * Field included by default. */ handler_config: { [key: string]: unknown; }; /** * Field included by default. */ handler_type: string; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ interval_seconds?: number | null; /** * Field included by default. */ jitter_seconds: number; /** * Field included by default. */ last_run_at?: unknown; /** * Field included by default. */ max_failures: number; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ name: string; /** * Field included by default. */ next_run_at?: unknown; /** * Field included by default. */ paused_at?: unknown; /** * Field included by default. */ run_count: number; /** * Field included by default. */ starts_at?: unknown; /** * Field included by default. */ status: "active" | "paused" | "completed" | "cancelled"; /** * Field included by default. */ timezone: string; /** * Field included by default. */ updated_at: unknown; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a recurring-schedule */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a crm-phone-number */ export type CrmPhoneNumber = { /** * An attributes object for a crm-phone-number */ attributes?: { /** * Field included by default. */ country_code?: string | null; /** * Field included by default. */ entity_id: string; /** * Field included by default. */ entity_type: "contact" | "company"; /** * Field included by default. */ extension?: string | null; /** * Field included by default. */ is_primary: boolean; /** * Field included by default. */ label: "mobile" | "work" | "home" | "fax" | "main" | "other"; /** * Field included by default. */ number: string; }; id: string; /** * A relationships object for a crm-phone-number */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a search */ export type Search = { /** * An attributes object for a search */ attributes?: { /** * Field included by default. */ results?: Array<{ [key: string]: unknown; }> | null; }; id: string; /** * A relationships object for a search */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a catalog-view */ export type CatalogView = { /** * An attributes object for a catalog-view */ attributes?: { /** * Field included by default. */ application_id?: string | null; /** * Field included by default. */ channel_target?: string | null; /** * Field included by default. */ default_sort?: "name" | "newest" | "price_asc" | "price_desc"; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ locale?: string | null; /** * Field included by default. */ max_items?: number | null; /** * Field included by default. */ name: string; /** * Field included by default. */ slug: string; /** * Field included by default. */ status: "draft" | "active" | "archived"; /** * Field included by default. */ visibility: "public" | "private" | "restricted"; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a catalog-view */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a scheduling-calendar-sync */ export type SchedulingCalendarSync = { /** * An attributes object for a scheduling-calendar-sync */ attributes?: { /** * Field included by default. */ baa_attestation?: { /** * Field included by default. */ attestation_text: string; /** * Field included by default. */ attested_at: unknown; /** * Field included by default. */ attested_by_user_id: string; /** * Field included by default. */ platform_acknowledgment: string; /** * Field included by default. */ type: "google_workspace_baa" | "microsoft_baa" | "other"; } | null | unknown; /** * Field included by default. */ calendar_external_id: string; /** * Field included by default. */ calendar_name?: string | null; /** * Field included by default. */ connector_id: string; /** * Field included by default. */ error_count?: number | null; /** * Field included by default. */ error_message?: string | null; /** * Field included by default. */ events_synced?: number | null; /** * Field included by default. */ last_synced_at?: unknown; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ poll_interval_minutes?: number | null; /** * Field included by default. */ provider: "google" | "outlook"; /** * Field included by default. */ role: "conflict_check" | "add_events" | "both"; /** * Field included by default. */ settings?: { [key: string]: unknown; } | null; /** * Field included by default. */ sync_direction: "push" | "pull" | "bidirectional"; /** * Field included by default. */ sync_method: "poll"; /** * Field included by default. */ sync_status?: "active" | "paused" | "error"; /** * Field included by default. */ user_id: string; }; id: string; /** * A relationships object for a scheduling-calendar-sync */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a scheduling-availability-rule */ export type SchedulingAvailabilityRule = { /** * An attributes object for a scheduling-availability-rule */ attributes?: { /** * Field included by default. */ date_overrides?: Array<{ /** * Field included by default. */ date: string; /** * Field included by default. */ windows?: Array<{ /** * Field included by default. */ end: string; /** * Field included by default. */ start: string; }> | null | unknown; }> | null; /** * Field included by default. */ effective_from?: string | null; /** * Field included by default. */ effective_until?: string | null; /** * Field included by default. */ event_type_id?: string | null; /** * Field included by default. */ is_active?: boolean | null; /** * Field included by default. */ location_id?: string | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ name: string; /** * Field included by default. */ priority?: number | null; /** * Field included by default. */ timezone: string; /** * Field included by default. */ type: "recurring" | "override"; /** * Field included by default. */ user_id?: string | null; /** * Field included by default. */ weekly_schedule?: { /** * Field included by default. */ friday?: Array<{ /** * Field included by default. */ end: string; /** * Field included by default. */ start: string; }> | null; /** * Field included by default. */ monday?: Array<{ /** * Field included by default. */ end: string; /** * Field included by default. */ start: string; }> | null; /** * Field included by default. */ saturday?: Array<{ /** * Field included by default. */ end: string; /** * Field included by default. */ start: string; }> | null; /** * Field included by default. */ sunday?: Array<{ /** * Field included by default. */ end: string; /** * Field included by default. */ start: string; }> | null; /** * Field included by default. */ thursday?: Array<{ /** * Field included by default. */ end: string; /** * Field included by default. */ start: string; }> | null; /** * Field included by default. */ tuesday?: Array<{ /** * Field included by default. */ end: string; /** * Field included by default. */ start: string; }> | null; /** * Field included by default. */ wednesday?: Array<{ /** * Field included by default. */ end: string; /** * Field included by default. */ start: string; }> | null; } | null | unknown; }; id: string; /** * A relationships object for a scheduling-availability-rule */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a notification-method */ export type NotificationMethod = { /** * An attributes object for a notification-method */ attributes?: { /** * Configuration for the method, e.g. %{email: 'foo@bar.com'} or %{url: '...'}. Field included by default. */ config: { [key: string]: unknown; }; /** * Field included by default. */ is_primary?: boolean | null; /** * User-friendly name, e.g. 'Personal Email'. Field included by default. */ name: string; /** * Field included by default. */ type: "email" | "sms" | "slack_webhook" | "generic_webhook"; /** * Field included by default. */ user_id: string; /** * When the last verification token was sent. Field included by default. */ verification_sent_at?: unknown; /** * Field included by default. */ verified_at?: unknown; }; id: string; /** * A relationships object for a notification-method */ relationships?: { user?: { /** * An identifier for user */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a recipes-nutrition-summary */ export type RecipesNutritionSummary = { /** * An attributes object for a recipes-nutrition-summary */ attributes?: { /** * Field included by default. */ date: string; /** * Field included by default. */ incomplete?: boolean | null; /** * Field included by default. */ meal_breakdown?: { [key: string]: unknown; } | null; /** * Field included by default. */ meal_schedule_id: string; /** * Field included by default. */ recipe_count?: number | null; /** * Field included by default. */ total_calories?: number | null; /** * Field included by default. */ total_carbs_g?: number | null; /** * Field included by default. */ total_fat_g?: number | null; /** * Field included by default. */ total_fiber_g?: number | null; /** * Field included by default. */ total_protein_g?: number | null; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a recipes-nutrition-summary */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a agent-stats */ export type AgentStats = { /** * An attributes object for a agent-stats */ attributes?: { /** * Field included by default. */ agent_id: string; /** * Field included by default. */ total_calls: number; /** * Field included by default. */ total_cost: number; /** * Field included by default. */ total_tokens: number; }; id: string; /** * A relationships object for a agent-stats */ relationships?: { agent?: { /** * An identifier for agent */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a bucket */ export type Bucket = { /** * An attributes object for a bucket */ attributes?: { /** * Field included by default. */ name: string; /** * Field included by default. */ region?: string | null; storage_used?: number | null; /** * Field included by default. */ type: "public" | "private" | "processing"; }; id: string; /** * A relationships object for a bucket */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a chat-thread-stats */ export type ChatThreadStats = { /** * An attributes object for a chat-thread-stats */ attributes?: { /** * Field included by default. */ active_threads_24h: number; /** * Field included by default. */ active_threads_7d: number; /** * Field included by default. */ generated_at: unknown; /** * Field included by default. */ messages_by_role: { [key: string]: unknown; }; /** * Field included by default. */ top_workspaces: Array<{ [key: string]: unknown; }>; /** * Field included by default. */ total_messages: number; /** * Field included by default. */ total_threads: number; }; id: string; /** * A relationships object for a chat-thread-stats */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-note */ export type ClinicalNote = { /** * An attributes object for a clinical-note */ attributes?: { /** * Field included by default. */ amends_note_id?: string | null; /** * Field included by default. */ cosigned_at?: string | null; /** * Field included by default. */ cosigned_by_id?: string | null; is_archived?: boolean | null; /** * Field included by default. */ metadata: { [key: string]: unknown; }; /** * Field included by default. */ note_type: "adime" | "soap" | "progress" | "discharge" | "addendum"; /** * Field included by default. */ patient_id: string; /** * Field included by default. */ phi_scan_status: "pending" | "clean" | "phi_detected" | "error"; /** * Field included by default. */ phi_types_detected: Array; /** * Field included by default. */ pipeline_execution_id?: string | null; /** * Field included by default. */ requires_cosign: boolean; /** * Field included by default. */ reviewed_at?: string | null; /** * Field included by default. */ reviewed_by_id?: string | null; /** * Field included by default. */ session_id: string; /** * Field included by default. */ status: "draft" | "approved" | "rejected"; /** * Field included by default. */ tags: Array; }; id: string; /** * A relationships object for a clinical-note */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a agent */ export type Agent = { /** * An attributes object for a agent */ attributes?: { /** * Stable catalog taxonomy for what the agent primarily does * (for example: document_extraction, classification, generation, advisory). * . Field included by default. */ agent_function?: string | null; /** * When true (default), tenants can customize the agent's behavior via the `instructions` field. * When false, `instructions` is ignored during prompt resolution — only `default_instructions` * (set at clone time by the ISV) is used. Prevents tenant customization of compliance-sensitive * or regulated-workflow agents. * . Field included by default. */ allow_instruction_override: boolean; /** * When true, tenants under this application may clone this agent into their * workspace via :create_workspace_agent. When false (default), only system * actors and ISV server keys can provision workspace copies. Only meaningful * when application_id is set. * . Field included by default. */ allow_tenant_clone: boolean; /** * When set, this agent belongs to an ISV Application definition. Null = workspace-owned. Field included by default. */ application_id?: string | null; /** * Optional higher-level catalog grouping for browsing and UI segmentation * (for example: operations, extraction, generation, platform_advisors). * . Field included by default. */ catalog_family?: string | null; /** * Field included by default. */ cloned_from_id?: string | null; /** * Field included by default. */ created_at: unknown; /** * Field included by default. */ default_instructions?: string | null; /** * Field included by default. */ description?: string | null; /** * Agent execution mode: :extraction for document processing, :agentic for multi-turn tool-calling. Field included by default. */ execution_mode: "extraction" | "agentic"; /** * Stable catalog taxonomy for the primary input shape * (for example: document, text, transcript, brief, mixed_context). * . Field included by default. */ input_kind?: string | null; /** * When true, non-privileged actors cannot modify `input_schema` on any AgentVersion * belonging to this agent. Only SystemActor, platform admins, and ISV owners can bypass. * . Field included by default. */ input_schema_locked: boolean; /** * Field included by default. */ instructions?: string | null; /** * When true and application_id is set, this agent is auto-provisioned to new workspaces * created under the application. Workspace copies have workspace_id set and is_application_default: false. * . Field included by default. */ is_application_default: boolean; /** * Field included by default. */ is_system: boolean; /** * Optional platform-curated metadata populated for system agents and overridable on clones. Field included by default. */ metadata: { [key: string]: unknown; }; /** * Field included by default. */ name: string; /** * Stable catalog taxonomy for the primary output shape * (for example: structured_json, recommendation_json, scored_json, diagram_code). * . Field included by default. */ output_kind?: string | null; /** * When true, non-privileged actors cannot modify `output_schema` on any AgentVersion * belonging to this agent. Only SystemActor, platform admins, and ISV owners can bypass. * Used to protect production schemas from accidental changes. * . Field included by default. */ output_schema_locked: boolean; /** * ISV-defined keyed text fragments for system prompt interpolation. * * Supports two value types per key: * - **String**: static fragment injected at every execution. The prompt placeholder * `{key}` is replaced with this string. * - **Map**: input-driven. The prompt placeholder `{key}` is replaced with the * sub-map value looked up by the execution input of the same name. * * Example: * %{ * "transcript_context" => "Always interpret as one-sided audio...", * "detail_level" => %{ * "brief" => "BRIEF: bullet points only, <400 words.", * "standard" => "STANDARD: rich bullets, 2-4 sentences each.", * "detailed" => "DETAILED: comprehensive documentation." * } * } * * With this config, a prompt template containing `{transcript_context}` and * `{detail_level}` — and an execution input of `detail_level: "standard"` — * produces the fully resolved system prompt with both placeholders substituted. * . Field included by default. */ prompt_variants?: { [key: string]: unknown; } | null; /** * Points to the AgentVersion this agent was cloned from (for lineage tracking). Field included by default. */ source_version_id?: string | null; /** * Stable identifier for system agents. Matches registry slug. Immutable after creation. Field included by default. */ system_slug?: string | null; /** * Field included by default. */ tags: Array; /** * Denormalized from workspace for unique name constraint. Field included by default. */ tenant_id?: string | null; /** * Temporary model override for testing. Supersedes version model_id. Clear when done. Field included by default. */ test_model_override?: string | null; test_result?: { [key: string]: unknown; } | null; /** * Field included by default. */ updated_at: unknown; validation_result?: { [key: string]: unknown; } | null; /** * Industry vertical for the agent (validated against extraction.config_enums 'agent_vertical'). Field included by default. */ vertical: string; /** * List of exposed system field names to include in webhook payloads. Field included by default. */ webhook_system_fields?: Array | null; /** * Field included by default. */ workspace_id?: string | null; }; id: string; /** * A relationships object for a agent */ relationships?: { versions?: { /** * Relationship data for versions */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; workspace?: { /** * An identifier for workspace */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a capability-revocation */ export type CapabilityRevocation = { /** * An attributes object for a capability-revocation */ attributes?: { [key: string]: never; }; id: string; /** * A relationships object for a capability-revocation */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a scheduling-participant */ export type SchedulingParticipant = { /** * An attributes object for a scheduling-participant */ attributes?: { /** * Field included by default. */ contact_id?: string | null; /** * Field included by default. */ email: string; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ name?: string | null; /** * Field included by default. */ phone?: string | null; /** * Field included by default. */ responded_at?: unknown; /** * Field included by default. */ role?: "organizer" | "attendee" | "optional"; /** * Field included by default. */ status?: "invited" | "accepted" | "declined" | "tentative" | "no_response"; /** * Field included by default. */ user_id?: string | null; }; id: string; /** * A relationships object for a scheduling-participant */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a tenant-pricing-override */ export type TenantPricingOverride = { /** * An attributes object for a tenant-pricing-override */ attributes?: { /** * Field included by default. */ application_id: string; /** * When this override expires. NULL means no expiration. Field included by default. */ expires_at?: unknown; /** * Field included by default. */ floor_price?: { amount: string; currency: string; } | null | unknown; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ margin_percent?: number | null; /** * Audit trail: why this override was created (e.g., 'Volume discount', 'Promotional pricing'). Field included by default. */ reason?: string | null; /** * Field included by default. */ service_id: string; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a tenant-pricing-override */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a crm-data-export-job */ export type CrmDataExportJob = { /** * An attributes object for a crm-data-export-job */ attributes?: { /** * Field included by default. */ entity_subtype?: string | null; /** * Field included by default. */ entity_type: "contact" | "custom_entity" | "activity"; /** * Field included by default. */ error?: string | null; /** * Field included by default. */ file_url?: string | null; /** * Field included by default. */ filters?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ format: "json" | "csv"; /** * Field included by default. */ include?: Array | null; /** * Field included by default. */ row_count?: number | null; /** * Field included by default. */ status: "pending" | "processing" | "complete" | "failed" | "expired"; /** * Field included by default. */ url_expires_at?: unknown; }; id: string; /** * A relationships object for a crm-data-export-job */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a crm-address */ export type CrmAddress = { /** * An attributes object for a crm-address */ attributes?: { /** * Field included by default. */ city?: string | null; /** * Field included by default. */ country?: string | null; /** * Field included by default. */ entity_id: string; /** * Field included by default. */ entity_type: "contact" | "company"; formatted_address?: string | null; /** * Field included by default. */ is_primary: boolean; /** * Field included by default. */ label: "home" | "work" | "billing" | "shipping" | "headquarters" | "branch" | "other"; /** * Field included by default. */ latitude?: number | null; /** * Field included by default. */ line1?: string | null; /** * Field included by default. */ line2?: string | null; /** * Field included by default. */ longitude?: number | null; /** * Field included by default. */ postal_code?: string | null; /** * Field included by default. */ state?: string | null; }; id: string; /** * A relationships object for a crm-address */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a crm-channel-capture-config */ export type CrmChannelCaptureConfig = { /** * An attributes object for a crm-channel-capture-config */ attributes?: { /** * Field included by default. */ auto_create_contacts?: boolean | null; /** * Field included by default. */ channel_types?: Array | null; /** * Field included by default. */ content_retention_days?: number | null; /** * Field included by default. */ enabled?: boolean | null; /** * Field included by default. */ pii_scan_enabled?: boolean | null; }; id: string; /** * A relationships object for a crm-channel-capture-config */ relationships?: { [key: string]: never; }; type: string; }; export type CaseTypeStateMachineInputUpdateType = { initial_state?: string | null; reopen_target_state?: string | null; states?: Array | null; /** * States that count as terminal for this CaseType. Used by Case.is_open * (state not in terminal_states). Required (non-empty) — the migration * backfills existing CaseTypes via heuristic. * */ terminal_states?: Array | null; transitions?: unknown | Array<{ from: string; guards?: { [key: string]: unknown; } | unknown; to: string; }> | Array<{ from?: string | unknown; guards?: { [key: string]: unknown; } | unknown; to?: string | unknown; }>; }; /** * A "Resource object" representing a crm-relationship-type */ export type CrmRelationshipType = { /** * An attributes object for a crm-relationship-type */ attributes?: { /** * Field included by default. */ is_directional: boolean; /** * Field included by default. */ is_system: boolean; /** * Field included by default. */ name: string; /** * Field included by default. */ properties_schema?: { [key: string]: unknown; } | null; /** * Field included by default. */ slug: string; /** * Field included by default. */ source_entity_types: Array; /** * Field included by default. */ target_entity_types: Array; }; id: string; /** * A relationships object for a crm-relationship-type */ relationships?: { [key: string]: never; }; type: string; }; export type SchedulingEventTypeLocationInputCreateType = { address?: string | null; instructions?: string | null; latitude?: number | null; longitude?: number | null; name?: string | null; type?: "in_person" | "video" | "phone" | "custom_url"; url?: string | null; }; /** * A "Resource object" representing a scheduling-event-type */ export type SchedulingEventType = { /** * An attributes object for a scheduling-event-type */ attributes?: { /** * Field included by default. */ billing_operation?: string | null; /** * Field included by default. */ booking_cooldown_minutes?: number | null; /** * Field included by default. */ booking_enabled?: boolean | null; /** * Field included by default. */ buffer_after_minutes?: number | null; /** * Field included by default. */ buffer_before_minutes?: number | null; /** * Field included by default. */ capacity?: number | null; /** * Field included by default. */ color?: string | null; /** * Field included by default. */ default_reminder_offsets?: Array | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ duration_minutes: number; /** * Field included by default. */ intake_form_schema?: { [key: string]: unknown; } | null; /** * Field included by default. */ location?: { /** * Field included by default. */ address?: string | null; /** * Field included by default. */ instructions?: string | null; /** * Field included by default. */ latitude?: number | null; /** * Field included by default. */ longitude?: number | null; /** * Field included by default. */ name?: string | null; /** * Field included by default. */ type?: "in_person" | "video" | "phone" | "custom_url"; /** * Field included by default. */ url?: string | null; } | null | unknown; /** * Field included by default. */ location_id?: string | null; /** * Field included by default. */ location_type?: "in_person" | "video" | "phone" | "custom_url"; /** * Field included by default. */ max_advance_days?: number | null; /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ min_notice_minutes?: number | null; /** * Field included by default. */ name: string; /** * Field included by default. */ owner_user_id?: string | null; /** * Field included by default. */ requires_approval?: boolean | null; /** * Field included by default. */ slug: string; /** * Field included by default. */ status?: "active" | "archived"; }; id: string; /** * A relationships object for a scheduling-event-type */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a crm-custom-entity-version */ export type CrmCustomEntityVersion = { /** * An attributes object for a crm-custom-entity-version */ attributes?: { /** * Field included by default. */ attributes: { [key: string]: unknown; }; /** * Field included by default. */ version_number: number; }; id: string; /** * A relationships object for a crm-custom-entity-version */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a compliance-officer-designation */ export type ComplianceOfficerDesignation = { /** * An attributes object for a compliance-officer-designation */ attributes?: { /** * Field included by default. */ application_id: string; /** * Field included by default. */ designated_at: string; /** * Field included by default. */ revoked_at?: string | null; /** * Field included by default. */ role: "security_officer" | "privacy_officer" | "compliance_officer"; /** * Field included by default. */ status: "active" | "revoked"; /** * Field included by default. */ user_id: string; }; id: string; /** * A relationships object for a compliance-officer-designation */ relationships?: { application?: { /** * An identifier for application */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a email-marketing-sequence-step */ export type EmailMarketingSequenceStep = { /** * An attributes object for a email-marketing-sequence-step */ attributes?: { /** * Field included by default. */ ai_instructions?: string | null; /** * Field included by default. */ body_template?: string | null; /** * Field included by default. */ delay_hours?: number | null; /** * Field included by default. */ position: number; /** * Field included by default. */ scheduled_at?: unknown; /** * Field included by default. */ segment_filter?: { [key: string]: unknown; } | null; /** * Field included by default. */ sent_count?: number | null; /** * Field included by default. */ status?: "pending" | "scheduled" | "sending" | "completed" | "skipped"; /** * Field included by default. */ subject_template?: string | null; }; id: string; /** * A relationships object for a email-marketing-sequence-step */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a crm-custom-field-definition */ export type CrmCustomFieldDefinition = { /** * An attributes object for a crm-custom-field-definition */ attributes?: { /** * Field included by default. */ default_value?: string | null; /** * Field included by default. */ entity_type: string; /** * Field included by default. */ field_type: string; /** * Field included by default. */ filterable?: boolean | null; /** * Field included by default. */ label: string; /** * Field included by default. */ name: string; /** * Field included by default. */ options?: Array | null; /** * Field included by default. */ required?: boolean | null; /** * Field included by default. */ searchable?: boolean | null; /** * Field included by default. */ sort_order?: number | null; /** * Field included by default. */ validation_rules?: { [key: string]: unknown; } | null; }; id: string; /** * A relationships object for a crm-custom-field-definition */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a agent-test-result */ export type AgentTestResult = { /** * An attributes object for a agent-test-result */ attributes?: { /** * Field included by default. */ agent_version_id: string; /** * Field included by default. */ created_at: unknown; /** * Field included by default. */ document_id: string; /** * Field included by default. */ error_message?: string | null; /** * Field included by default. */ extracted_data?: { [key: string]: unknown; } | null; /** * Field included by default. */ status: "pending" | "completed" | "failed"; /** * Field included by default. */ usage?: { [key: string]: unknown; } | null; }; id: string; /** * A relationships object for a agent-test-result */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a workspace */ export type Workspace = { /** * An attributes object for a workspace */ attributes?: { /** * App type: extract, invoicing, crm, etc. Field included by default. */ app: string; /** * Required - the application this workspace belongs to. Field included by default. */ application_id: string; /** * Field included by default. */ archived_at?: unknown; /** * Field included by default. */ created_at: unknown; /** * When enabled, duplicate files (by SHA256 hash) are rejected. Field included by default. */ deduplicate_uploads: boolean; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ expires_at?: string | null; /** * Field included by default. */ is_default: boolean; /** * Timestamp of the last successful folder sweep. Field included by default. */ last_sweep_at?: unknown; /** * Field included by default. */ low_balance_threshold: number; /** * Field included by default. */ name: string; /** * ISV/app-defined metadata. Arbitrary key-value pairs for app-specific state. Field included by default. */ properties: { [key: string]: unknown; }; /** * Field included by default. */ renewal_params?: { [key: string]: unknown; } | null; /** * How the user got access: :inherited (from org role) or :direct (explicit invite) */ role_source?: string | null; /** * Field included by default. */ settings: { /** * Field included by default. */ ai: { /** * The 'Mentor' Agent (System/Specialty) providing domain context. Field included by default. */ base_agent_id?: string | null; /** * Agent that classifies documents before extraction (runs at triage). Field included by default. */ classifier_agent_id?: string | null; /** * If true, chat interactions automatically update the Custom Agent. Field included by default. */ continuous_learning: boolean; /** * The 'Student' Agent (Custom) learning specific rules. Field included by default. */ custom_agent_id?: string | null; /** * Explicitly enabled AI features for this workspace. Field included by default. */ enabled_capabilities?: Array | null; /** * Maps diarization speaker IDs to role labels for transcript formatting. * E.g.: %{"SPEAKER_00" => "RD", "SPEAKER_01" => "Client"} * ISV-configured. The platform normalizes transcripts to these labels before passing to agents. * . Field included by default. */ speaker_role_map: { [key: string]: unknown; }; /** * Agent that validates extracted data post-extraction. Field included by default. */ validator_agent_id?: string | null; /** * Whether validator runs synchronously (:sync) or asynchronously via Oban (:async). Field included by default. */ validator_mode: "sync" | "async"; }; /** * Field included by default. */ billing: { /** * Field included by default. */ allow_overdraft: boolean; /** * Maximum overdraft credits allowed per period. Field included by default. */ overdraft_limit?: number | null; /** * Period for overdraft limit reset (daily, weekly, monthly). Field included by default. */ overdraft_period?: "daily" | "weekly" | "monthly"; /** * When the current overdraft period began. Field included by default. */ overdraft_period_started_at?: unknown; /** * Credits used from overdraft in current period. Field included by default. */ overdraft_used?: number | null; }; /** * Field included by default. */ review_train: { /** * Field included by default. */ confidence_threshold: number; /** * Default ReviewQueue UUID for workspace-scoped reviews when no Case is attached. Field included by default. */ default_review_queue_id?: string | null; }; /** * Field included by default. */ storage: { /** * Field included by default. */ errors: { /** * Field included by default. */ copy_to_local: boolean; /** * Field included by default. */ local_path?: string | null; }; /** * Field included by default. */ input: { /** * Field included by default. */ local_path?: string | null; /** * Field included by default. */ source: "local" | "cloud"; }; /** * Field included by default. */ output: { /** * Field included by default. */ copy_to_local: boolean; /** * Field included by default. */ local_path?: string | null; }; }; /** * Field included by default. */ watcher: { /** * Field included by default. */ claim_expiry_minutes?: number | null; /** * Configuration for cloud input sources. Field included by default. */ cloud_config?: { /** * Override bucket (defaults to tenant processing bucket). Field included by default. */ bucket?: string | null; /** * Delete source file instead of moving to processed. Field included by default. */ delete_after_processing: boolean; /** * Override error prefix (defaults to workspaces/{id}/errors/). Field included by default. */ error_prefix?: string | null; /** * Override input prefix (defaults to workspaces/{id}/input/). Field included by default. */ input_prefix?: string | null; /** * Field included by default. */ poll_interval_seconds: number; /** * Override processed prefix (defaults to workspaces/{id}/processed/). Field included by default. */ processed_prefix?: string | null; /** * Field included by default. */ provider: "s3" | "minio" | "gcs"; } | null | unknown; /** * Field included by default. */ duplicate_action?: "skip" | "move_to_processed" | "move_to_skipped"; /** * Field included by default. */ enabled: boolean; /** * Field included by default. */ log_retention_days?: number | null; /** * Field included by default. */ max_retries?: number | null; /** * Field included by default. */ retry_delay_ms?: number | null; /** * Field included by default. */ source_type?: "local" | "cloud"; }; }; /** * Field included by default. */ slug: string; /** * Workspace liveness: :active = serving, :suspended = taken offline by ISV, :archived = retired. Field included by default. */ status: "active" | "archived" | "suspended"; /** * Field included by default. */ tenant_id: string; /** * Field included by default. */ updated_at: unknown; /** * The user's effective role in this workspace: admin, editor, or viewer */ user_role?: string | null; /** * Memorable slug for vanity URLs. Field included by default. */ vanity_slug?: string | null; }; id: string; /** * A relationships object for a workspace */ relationships?: { tenant?: { /** * An identifier for tenant */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a invitation */ export type Invitation = { /** * An attributes object for a invitation */ attributes?: { /** * User id of the actor that accepted the invitation. Nil for pending/declined/revoked/expired rows. Populated by all four acceptance paths so InvitationAccepted events carry a usable user_id. Field included by default. */ accepted_by_user_id?: string | null; /** * Optional personal message from the inviter. Field included by default. */ custom_message?: string | null; /** * Field included by default. */ email: string; /** * Field included by default. */ expires_at: string; /** * Field included by default. */ inviter_id?: string | null; /** * Permissions to grant on acceptance. Field included by default. */ permissions: Array; /** * Timestamp of recipient response (decline or accept). Field included by default. */ responded_at?: unknown; /** * Field included by default. */ role: "admin" | "member" | "editor" | "viewer"; /** * Field included by default. */ scope_id: string; /** * Field included by default. */ scope_type: "tenant" | "workspace"; /** * Field included by default. */ status: "pending" | "accepted" | "expired" | "revoked" | "declined"; /** * Denormalized tenant_id for multi-tenant filtering. Field included by default. */ tenant_id: string; }; id: string; /** * A relationships object for a invitation */ relationships?: { inviter?: { /** * An identifier for inviter */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; export type StorageStatsType = { /** * Field included by default. */ generated_at?: unknown; /** * Field included by default. */ id?: string | null; /** * Field included by default. */ tenant_id?: string | null; /** * Field included by default. */ total_buckets?: number | null; /** * Field included by default. */ total_objects?: number | null; /** * Field included by default. */ total_storage_bytes?: number | null; }; /** * A "Resource object" representing a pipeline-node-execution */ export type PipelineNodeExecution = { /** * An attributes object for a pipeline-node-execution */ attributes?: { /** * Field included by default. */ agent_execution_id?: string | null; /** * Field included by default. */ completed_at?: unknown; /** * Field included by default. */ credits_charged?: string | null; /** * Field included by default. */ criteria?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ duration_ms?: number | null; /** * Field included by default. */ error?: { [key: string]: unknown; } | null; /** * Field included by default. */ input?: { [key: string]: unknown; } | null; /** * Field included by default. */ inserted_at: unknown; /** * Field included by default. */ node_key: string; /** * Field included by default. */ node_type: "prompt" | "command" | "connector_exec" | "checkpoint"; /** * Field included by default. */ output?: { [key: string]: unknown; } | null; /** * Field included by default. */ phase?: "define" | "plan" | "build" | "verify" | "review" | "ship"; /** * Field included by default. */ pipeline_execution_id: string; /** * Field included by default. */ pipeline_node_id: string; /** * Field included by default. */ quality_scores?: { [key: string]: unknown; } | null; /** * Field included by default. */ started_at?: unknown; /** * Field included by default. */ status: "pending" | "running" | "completed" | "failed" | "skipped"; /** * Field included by default. */ tokens_used?: number | null; /** * Field included by default. */ updated_at: unknown; }; id: string; /** * A relationships object for a pipeline-node-execution */ relationships?: { agent_execution?: { /** * An identifier for agent_execution */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; pipeline_execution?: { /** * An identifier for pipeline_execution */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; pipeline_node?: { /** * An identifier for pipeline_node */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a review-queue */ export type ReviewQueue = { /** * An attributes object for a review-queue */ attributes?: { /** * Field included by default. */ default_sla_minutes?: number | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ is_archived: boolean; /** * Field included by default. */ name: string; /** * Field included by default. */ slug: string; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a review-queue */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a crm-custom-entity */ export type CrmCustomEntity = { /** * An attributes object for a crm-custom-entity */ attributes?: { /** * Field included by default. */ external_owner_id?: string | null; /** * Field included by default. */ name: string; /** * Field included by default. */ owner_id?: string | null; /** * Field included by default. */ properties?: { [key: string]: unknown; } | null; }; id: string; /** * A relationships object for a crm-custom-entity */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a case */ export type Case = { /** * An attributes object for a case */ attributes?: { /** * Field included by default. */ case_type_id: string; /** * Field included by default. */ closed_at?: unknown; /** * Field included by default. */ contact_id?: string | null; /** * Field included by default. */ custom_fields: { [key: string]: unknown; }; /** * Field included by default. */ deal_id?: string | null; /** * Field included by default. */ decided_at?: unknown; /** * Field included by default. */ decision_outcome?: string | null; /** * Field included by default. */ deleted_at?: unknown; /** * Field included by default. */ invoice_id?: string | null; /** * Denormalized: state not in case_type.state_machine.terminal_states. * Maintained by GptCore.Cases.Changes.MaintainIsOpen on every state-mutating * action. When CaseType.state_machine.terminal_states changes, * RecomputeIsOpenWorker recomputes for affected Cases. * . Field included by default. */ is_open: boolean; /** * Field included by default. */ opened_at: unknown; /** * Field included by default. */ owner_id?: string | null; /** * Field included by default. */ priority: string; /** * Field included by default. */ reference_number: string; /** * Field included by default. */ sla_due_at?: unknown; /** * Field included by default. */ state: string; /** * Field included by default. */ summary?: string | null; /** * Field included by default. */ title: string; /** * Field included by default. */ workspace_id: string; }; id: string; /** * A relationships object for a case */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a presigned-url */ export type PresignedUrl = { /** * An attributes object for a presigned-url */ attributes?: { /** * Field included by default. */ expires_in: number; /** * Field included by default. */ storage_path: string; /** * Field included by default. */ upload_url: string; }; id: string; /** * A relationships object for a presigned-url */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a clinical-client-goal */ export type ClinicalClientGoal = { /** * An attributes object for a clinical-client-goal */ attributes?: { /** * Field included by default. */ achieved_at?: string | null; /** * Field included by default. */ action_steps: Array; /** * Completion percentage for current calendar month. Nil for non-habits. */ adherence_rate?: string | null; /** * Field included by default. */ category?: string | null; /** * Consecutive completed check-ins ending at today/yesterday. Nil for non-habits. */ current_streak?: number | null; /** * Field included by default. */ current_value?: string | null; /** * Field included by default. */ description?: string | null; /** * Field included by default. */ email_sent_at?: string | null; /** * Field included by default. */ frequency?: "daily" | "weekly"; /** * Field included by default. */ goal_type: string; is_archived?: boolean | null; /** * Most recent check-in date. Nil for non-habits or no check-ins. */ last_check_in_date?: string | null; /** * Field included by default. */ linked_metric_type?: string | null; /** * Historical maximum streak. Nil for non-habits. */ longest_streak?: number | null; /** * Field included by default. */ metadata: { [key: string]: unknown; }; /** * Field included by default. */ patient_id: string; /** * Field included by default. */ position?: number | null; /** * Field included by default. */ priority?: "high" | "medium" | "low"; /** * Approval workflow state. Independent of `status` (lifecycle). Field included by default. */ review_status: "none" | "draft" | "approved" | "rejected"; /** * Field included by default. */ reviewed_at?: unknown; /** * Field included by default. */ reviewed_by_id?: string | null; /** * Field included by default. */ session_id?: string | null; /** * Field included by default. */ source: "manual" | "session" | "template"; /** * Field included by default. */ status: "active" | "completed" | "abandoned" | "paused" | "achieved" | "discontinued"; /** * Field included by default. */ target_date?: string | null; /** * Field included by default. */ target_value?: string | null; /** * Field included by default. */ template_id?: string | null; /** * Field included by default. */ timeframe?: string | null; /** * Field included by default. */ title: string; /** * Field included by default. */ tool_ids: Array; /** * Field included by default. */ unit?: string | null; }; id: string; /** * A relationships object for a clinical-client-goal */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a wholesale-agreement */ export type WholesaleAgreement = { /** * An attributes object for a wholesale-agreement */ attributes?: { /** * Field included by default. */ effective_date?: string | null; /** * Days to hold funds before release. Field included by default. */ hold_days: number; /** * Field included by default. */ isv_tenant_id: string; /** * Optional ISV-configurable Layer 1 dunning cadence override. * . Field included by default. */ layer1_dunning_config?: { [key: string]: unknown; } | null; /** * Minimum payout amount in cents ($25.00 default). Field included by default. */ minimum_payout_cents: number; /** * Per-service minimum retail floors that ISV must charge their tenants. * Format: [%{"service_id" => "doc_extraction_base", "minimum" => %Money{}}] * Platform admin sets these to ensure ISVs don't undercut below certain prices. * . Field included by default. */ minimum_retail_floors?: Array<{ [key: string]: unknown; }> | null; /** * Field included by default. */ notes?: string | null; /** * Per-ISV platform-account overdraft limit in credits. nil falls back to * the platform default. * . Field included by default. */ overdraft_limit_credits?: number | null; /** * Per-seat monthly platform fee in cents. Charged to the ISV's Application * liability account at each subscription renewal for seat-based plans. * e.g., 500 = $5.00/seat/month. nil = no per-seat fee (credit-only ISVs). * . Field included by default. */ per_seat_fee_cents?: number | null; /** * Which capability tiers this ISV may enable on applications. * . Field included by default. */ permitted_capability_tiers: Array<"core" | "standard" | "premium">; /** * Per-ISV refund-reversal window in days. nil falls back to platform default. * . Field included by default. */ refund_reversal_days?: number | null; /** * Field included by default. */ settlement_frequency: "monthly" | "weekly" | "daily"; /** * Per-ISV one-time signup-grant amount in credits, deposited to the * `Platform:Application:*` wholesale account when the ISV-tenant's first * Application is created (after proof-of-life passes). nil falls back to * `config :gpt_core, :default_isv_signup_grant_credits`. * . Field included by default. */ signup_grant_credits?: number | null; /** * Origin of the signup grant. * - `:default` — runtime-created ISV; subject to proof-of-life gate. * - `:pre_seeded` — platform-curated ISV from `priv/data/platform_isvs.json`; * bypasses proof-of-life (presence in the seed file is implicit trust). * Set by `PlatformIsvProvisioner` in Phase 4. * . Field included by default. */ signup_grant_source: "default" | "pre_seeded"; /** * Lifecycle state of the per-ISV signup grant. * - `:pending` — no Application has been created yet; grant has not fired. * - `:granted` — grant fired and `Platform:Application:*` was credited. * - `:insufficient_proof_of_life` — first Application creation found the * owner lacking verified email or registered payment method; grant deferred * until proof-of-life lands. * . Field included by default. */ signup_grant_status: "pending" | "granted" | "insufficient_proof_of_life"; }; id: string; /** * A relationships object for a wholesale-agreement */ relationships?: { isv_tenant?: { /** * An identifier for isv_tenant */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; /** * A "Resource object" representing a field-template */ export type FieldTemplate = { /** * An attributes object for a field-template */ attributes?: { /** * Field included by default. */ category: string; /** * Field included by default. */ created_at: unknown; /** * Field included by default. */ extraction_hints?: { [key: string]: unknown; } | null; /** * Field included by default. */ field_type: string; /** * Field included by default. */ is_system: boolean; /** * Field included by default. */ llm_instructions?: string | null; /** * Field included by default. */ name: string; /** * Field included by default. */ updated_at: unknown; /** * Field included by default. */ validation_pattern?: string | null; }; id: string; /** * A relationships object for a field-template */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a catalog-option-value */ export type CatalogOptionValue = { /** * An attributes object for a catalog-option-value */ attributes?: { /** * Field included by default. */ metadata?: { [key: string]: unknown; } | null; /** * Field included by default. */ name: string; /** * Field included by default. */ position?: number | null; /** * Field included by default. */ slug: string; }; id: string; /** * A relationships object for a catalog-option-value */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a crm-relationship */ export type CrmRelationship = { /** * An attributes object for a crm-relationship */ attributes?: { /** * Field included by default. */ properties?: { [key: string]: unknown; } | null; /** * Field included by default. */ source_entity_id: string; /** * Field included by default. */ source_entity_type: string; /** * Field included by default. */ strength?: number | null; /** * Field included by default. */ target_entity_id: string; /** * Field included by default. */ target_entity_type: string; }; id: string; /** * A relationships object for a crm-relationship */ relationships?: { [key: string]: never; }; type: string; }; /** * A "Resource object" representing a crm-website */ export type CrmWebsite = { /** * An attributes object for a crm-website */ attributes?: { /** * Field included by default. */ entity_id: string; /** * Field included by default. */ entity_type: "contact" | "company"; /** * Field included by default. */ is_primary?: boolean | null; /** * Field included by default. */ label?: "main" | "careers" | "blog" | "docs" | "portfolio" | "other"; /** * Field included by default. */ url: string; }; id: string; /** * A relationships object for a crm-website */ relationships?: { [key: string]: never; }; type: string; }; /** * Media type with API version. Format: `application/vnd.api+json; version=YYYY-MM-DD`. If omitted, defaults to the latest version (2026-05-13). */ export type ApiVersion = string; /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ export type XApplicationKey = string; export type GetAdminEmailTemplateVersionsTemplateByTemplateIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { template_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/template-versions/template/{template_id}"; }; export type GetAdminEmailTemplateVersionsTemplateByTemplateIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailTemplateVersionsTemplateByTemplateIdError = GetAdminEmailTemplateVersionsTemplateByTemplateIdErrors[keyof GetAdminEmailTemplateVersionsTemplateByTemplateIdErrors]; export type GetAdminEmailTemplateVersionsTemplateByTemplateIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a email-template-version */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailTemplateVersionsTemplateByTemplateIdResponse = GetAdminEmailTemplateVersionsTemplateByTemplateIdResponses[keyof GetAdminEmailTemplateVersionsTemplateByTemplateIdResponses]; export type PatchAdminRecipesByIdArchiveData = { /** * Request body for the /recipes/:id/archive operation on recipes-recipe resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "recipes-recipe"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/{id}/archive"; }; export type PatchAdminRecipesByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminRecipesByIdArchiveError = PatchAdminRecipesByIdArchiveErrors[keyof PatchAdminRecipesByIdArchiveErrors]; export type PatchAdminRecipesByIdArchiveResponses = { /** * Success */ 200: { data?: RecipesRecipe; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminRecipesByIdArchiveResponse = PatchAdminRecipesByIdArchiveResponses[keyof PatchAdminRecipesByIdArchiveResponses]; export type PostAdminBillingCapabilityRevocationsPreviewCascadeData = { /** * Request body for the /billing/capability-revocations/preview-cascade operation on capability-revocation resource */ body: { data: { application_id: string; capability: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/billing/capability-revocations/preview-cascade"; }; export type PostAdminBillingCapabilityRevocationsPreviewCascadeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminBillingCapabilityRevocationsPreviewCascadeError = PostAdminBillingCapabilityRevocationsPreviewCascadeErrors[keyof PostAdminBillingCapabilityRevocationsPreviewCascadeErrors]; export type PostAdminBillingCapabilityRevocationsPreviewCascadeResponses = { /** * Success */ 201: { result: { [key: string]: unknown; }; }; }; export type PostAdminBillingCapabilityRevocationsPreviewCascadeResponse = PostAdminBillingCapabilityRevocationsPreviewCascadeResponses[keyof PostAdminBillingCapabilityRevocationsPreviewCascadeResponses]; export type GetAdminRecipesRecipeNutritionsRecipeByRecipeIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { recipe_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/recipe-nutritions/recipe/{recipe_id}"; }; export type GetAdminRecipesRecipeNutritionsRecipeByRecipeIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesRecipeNutritionsRecipeByRecipeIdError = GetAdminRecipesRecipeNutritionsRecipeByRecipeIdErrors[keyof GetAdminRecipesRecipeNutritionsRecipeByRecipeIdErrors]; export type GetAdminRecipesRecipeNutritionsRecipeByRecipeIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a recipes-recipe-nutrition */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesRecipeNutritionsRecipeByRecipeIdResponse = GetAdminRecipesRecipeNutritionsRecipeByRecipeIdResponses[keyof GetAdminRecipesRecipeNutritionsRecipeByRecipeIdResponses]; export type GetAdminCrmSocialProfilesEntityByEntityTypeByEntityIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { entity_type: "contact" | "company"; entity_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/social-profiles/entity/{entity_type}/{entity_id}"; }; export type GetAdminCrmSocialProfilesEntityByEntityTypeByEntityIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmSocialProfilesEntityByEntityTypeByEntityIdError = GetAdminCrmSocialProfilesEntityByEntityTypeByEntityIdErrors[keyof GetAdminCrmSocialProfilesEntityByEntityTypeByEntityIdErrors]; export type GetAdminCrmSocialProfilesEntityByEntityTypeByEntityIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crm-social-profile */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmSocialProfilesEntityByEntityTypeByEntityIdResponse = GetAdminCrmSocialProfilesEntityByEntityTypeByEntityIdResponses[keyof GetAdminCrmSocialProfilesEntityByEntityTypeByEntityIdResponses]; export type GetAdminWorkspacesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; include_archived?: boolean; }; url: "/admin/workspaces"; }; export type GetAdminWorkspacesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWorkspacesError = GetAdminWorkspacesErrors[keyof GetAdminWorkspacesErrors]; export type GetAdminWorkspacesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a workspace */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWorkspacesResponse = GetAdminWorkspacesResponses[keyof GetAdminWorkspacesResponses]; export type PostAdminWorkspacesData = { /** * Request body for the /workspaces operation on workspace resource */ body: { data: { attributes?: { /** * App type: extract, invoicing, crm, etc. */ app?: string | null; /** * Optional - inferred from x-application-key header when not provided */ application_id?: string | null; /** * When enabled, duplicate files (by SHA256 hash) are rejected */ deduplicate_uploads?: boolean | null; description?: string | null; expires_at?: unknown; initial_credits?: number | null; is_default?: boolean | null; low_balance_threshold?: number | null; name: string; renewal_params?: { [key: string]: unknown; } | null; settings?: WorkspaceSettingsInputCreateType; slug: string; tenant_id: string; /** * Memorable slug for vanity URLs */ vanity_slug?: string | null; }; relationships?: { [key: string]: never; }; type?: "workspace"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspaces"; }; export type PostAdminWorkspacesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminWorkspacesError = PostAdminWorkspacesErrors[keyof PostAdminWorkspacesErrors]; export type PostAdminWorkspacesResponses = { /** * Success */ 201: { data?: Workspace; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminWorkspacesResponse = PostAdminWorkspacesResponses[keyof PostAdminWorkspacesResponses]; export type GetAdminAuditChainEntriesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/audit-chain-entries"; }; export type GetAdminAuditChainEntriesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAuditChainEntriesError = GetAdminAuditChainEntriesErrors[keyof GetAdminAuditChainEntriesErrors]; export type GetAdminAuditChainEntriesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a audit-chain-entry */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAuditChainEntriesResponse = GetAdminAuditChainEntriesResponses[keyof GetAdminAuditChainEntriesResponses]; export type DeleteAdminPortalInvitationsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/portal-invitations/{id}"; }; export type DeleteAdminPortalInvitationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminPortalInvitationsByIdError = DeleteAdminPortalInvitationsByIdErrors[keyof DeleteAdminPortalInvitationsByIdErrors]; export type DeleteAdminPortalInvitationsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type PatchAdminCrmPhoneNumbersByIdSetPrimaryData = { /** * Request body for the /crm/phone-numbers/:id/set-primary operation on crm-phone-number resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-phone-number"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/phone-numbers/{id}/set-primary"; }; export type PatchAdminCrmPhoneNumbersByIdSetPrimaryErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmPhoneNumbersByIdSetPrimaryError = PatchAdminCrmPhoneNumbersByIdSetPrimaryErrors[keyof PatchAdminCrmPhoneNumbersByIdSetPrimaryErrors]; export type PatchAdminCrmPhoneNumbersByIdSetPrimaryResponses = { /** * Success */ 200: { data?: CrmPhoneNumber; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmPhoneNumbersByIdSetPrimaryResponse = PatchAdminCrmPhoneNumbersByIdSetPrimaryResponses[keyof PatchAdminCrmPhoneNumbersByIdSetPrimaryResponses]; export type DeleteAdminVoiceTranscriptionJobsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/voice/transcription-jobs/{id}"; }; export type DeleteAdminVoiceTranscriptionJobsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminVoiceTranscriptionJobsByIdError = DeleteAdminVoiceTranscriptionJobsByIdErrors[keyof DeleteAdminVoiceTranscriptionJobsByIdErrors]; export type DeleteAdminVoiceTranscriptionJobsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminVoiceTranscriptionJobsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/voice/transcription-jobs/{id}"; }; export type GetAdminVoiceTranscriptionJobsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminVoiceTranscriptionJobsByIdError = GetAdminVoiceTranscriptionJobsByIdErrors[keyof GetAdminVoiceTranscriptionJobsByIdErrors]; export type GetAdminVoiceTranscriptionJobsByIdResponses = { /** * Success */ 200: { data?: TranscriptionJob; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminVoiceTranscriptionJobsByIdResponse = GetAdminVoiceTranscriptionJobsByIdResponses[keyof GetAdminVoiceTranscriptionJobsByIdResponses]; export type GetAdminWalletData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/wallet"; }; export type GetAdminWalletErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWalletError = GetAdminWalletErrors[keyof GetAdminWalletErrors]; export type GetAdminWalletResponses = { /** * Success */ 200: { data?: Wallet; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWalletResponse = GetAdminWalletResponses[keyof GetAdminWalletResponses]; export type PatchAdminUserProfilesByIdDismissWelcomeData = { /** * Request body for the /user-profiles/:id/dismiss-welcome operation on user-profile resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "user-profile"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/user-profiles/{id}/dismiss-welcome"; }; export type PatchAdminUserProfilesByIdDismissWelcomeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminUserProfilesByIdDismissWelcomeError = PatchAdminUserProfilesByIdDismissWelcomeErrors[keyof PatchAdminUserProfilesByIdDismissWelcomeErrors]; export type PatchAdminUserProfilesByIdDismissWelcomeResponses = { /** * Success */ 200: { data?: UserProfile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminUserProfilesByIdDismissWelcomeResponse = PatchAdminUserProfilesByIdDismissWelcomeResponses[keyof PatchAdminUserProfilesByIdDismissWelcomeResponses]; export type GetAdminNotificationLogsStatsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/notification-logs/stats"; }; export type GetAdminNotificationLogsStatsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminNotificationLogsStatsError = GetAdminNotificationLogsStatsErrors[keyof GetAdminNotificationLogsStatsErrors]; export type GetAdminNotificationLogsStatsResponses = { /** * Success */ 200: { result: { [key: string]: unknown; }; }; }; export type GetAdminNotificationLogsStatsResponse = GetAdminNotificationLogsStatsResponses[keyof GetAdminNotificationLogsStatsResponses]; export type DeleteAdminExtractionBatchesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/batches/{id}"; }; export type DeleteAdminExtractionBatchesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminExtractionBatchesByIdError = DeleteAdminExtractionBatchesByIdErrors[keyof DeleteAdminExtractionBatchesByIdErrors]; export type DeleteAdminExtractionBatchesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminExtractionBatchesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/batches/{id}"; }; export type GetAdminExtractionBatchesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionBatchesByIdError = GetAdminExtractionBatchesByIdErrors[keyof GetAdminExtractionBatchesByIdErrors]; export type GetAdminExtractionBatchesByIdResponses = { /** * Success */ 200: { data?: ExtractionBatch; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionBatchesByIdResponse = GetAdminExtractionBatchesByIdResponses[keyof GetAdminExtractionBatchesByIdResponses]; export type GetAdminSysSemanticCacheStatsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/sys/semantic-cache/stats"; }; export type GetAdminSysSemanticCacheStatsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSysSemanticCacheStatsError = GetAdminSysSemanticCacheStatsErrors[keyof GetAdminSysSemanticCacheStatsErrors]; export type GetAdminSysSemanticCacheStatsResponses = { /** * Success */ 200: { data?: SemanticCacheEntry; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSysSemanticCacheStatsResponse = GetAdminSysSemanticCacheStatsResponses[keyof GetAdminSysSemanticCacheStatsResponses]; export type GetAdminCatalogPriceSuggestionsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/price-suggestions/workspace/{workspace_id}"; }; export type GetAdminCatalogPriceSuggestionsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogPriceSuggestionsWorkspaceByWorkspaceIdError = GetAdminCatalogPriceSuggestionsWorkspaceByWorkspaceIdErrors[keyof GetAdminCatalogPriceSuggestionsWorkspaceByWorkspaceIdErrors]; export type GetAdminCatalogPriceSuggestionsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a catalog-price-suggestion */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogPriceSuggestionsWorkspaceByWorkspaceIdResponse = GetAdminCatalogPriceSuggestionsWorkspaceByWorkspaceIdResponses[keyof GetAdminCatalogPriceSuggestionsWorkspaceByWorkspaceIdResponses]; export type PatchAdminClinicalMealPlansByIdRestoreData = { /** * Request body for the /clinical/meal-plans/:id/restore operation on clinical-meal-plan resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-meal-plan"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/meal-plans/{id}/restore"; }; export type PatchAdminClinicalMealPlansByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalMealPlansByIdRestoreError = PatchAdminClinicalMealPlansByIdRestoreErrors[keyof PatchAdminClinicalMealPlansByIdRestoreErrors]; export type PatchAdminClinicalMealPlansByIdRestoreResponses = { /** * Success */ 200: { data?: ClinicalMealPlan; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalMealPlansByIdRestoreResponse = PatchAdminClinicalMealPlansByIdRestoreResponses[keyof PatchAdminClinicalMealPlansByIdRestoreResponses]; export type PostAdminCatalogOptionValuesData = { /** * Request body for the /catalog/option-values operation on catalog-option-value resource */ body: { data: { attributes?: { metadata?: { [key: string]: unknown; } | null; name: string; option_type_id: string; position?: number | null; slug: string; }; relationships?: { [key: string]: never; }; type?: "catalog-option-value"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/option-values"; }; export type PostAdminCatalogOptionValuesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCatalogOptionValuesError = PostAdminCatalogOptionValuesErrors[keyof PostAdminCatalogOptionValuesErrors]; export type PostAdminCatalogOptionValuesResponses = { /** * Success */ 201: { data?: CatalogOptionValue; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCatalogOptionValuesResponse = PostAdminCatalogOptionValuesResponses[keyof PostAdminCatalogOptionValuesResponses]; export type GetAdminEmailSendLimitsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/send-limits/workspace/{workspace_id}"; }; export type GetAdminEmailSendLimitsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailSendLimitsWorkspaceByWorkspaceIdError = GetAdminEmailSendLimitsWorkspaceByWorkspaceIdErrors[keyof GetAdminEmailSendLimitsWorkspaceByWorkspaceIdErrors]; export type GetAdminEmailSendLimitsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a email-send-limit */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailSendLimitsWorkspaceByWorkspaceIdResponse = GetAdminEmailSendLimitsWorkspaceByWorkspaceIdResponses[keyof GetAdminEmailSendLimitsWorkspaceByWorkspaceIdResponses]; export type PostAdminSocialPostsData = { /** * Request body for the /social/posts operation on social-post resource */ body: { data: { attributes?: { content?: string | null; hashtags?: Array | null; link_metadata?: { [key: string]: unknown; } | null; link_url?: string | null; max_retries?: number | null; media_urls?: Array | null; platform: "facebook" | "instagram" | "threads" | "twitter" | "linkedin" | "reddit" | "bluesky"; social_account_id: string; social_campaign_id?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "social-post"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/posts"; }; export type PostAdminSocialPostsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSocialPostsError = PostAdminSocialPostsErrors[keyof PostAdminSocialPostsErrors]; export type PostAdminSocialPostsResponses = { /** * Success */ 201: { data?: SocialPost; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSocialPostsResponse = PostAdminSocialPostsResponses[keyof PostAdminSocialPostsResponses]; export type PatchAdminFormVersionsByIdClassifyFieldData = { /** * Request body for the /form-versions/:id/classify-field operation on form-version resource */ body: { data: { attributes?: { custom_label?: string | null; field_path: string; protection_class: string; }; id: string; relationships?: { [key: string]: never; }; type?: "form-version"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/form-versions/{id}/classify-field"; }; export type PatchAdminFormVersionsByIdClassifyFieldErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminFormVersionsByIdClassifyFieldError = PatchAdminFormVersionsByIdClassifyFieldErrors[keyof PatchAdminFormVersionsByIdClassifyFieldErrors]; export type PatchAdminFormVersionsByIdClassifyFieldResponses = { /** * Success */ 200: { data?: FormVersion; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminFormVersionsByIdClassifyFieldResponse = PatchAdminFormVersionsByIdClassifyFieldResponses[keyof PatchAdminFormVersionsByIdClassifyFieldResponses]; export type GetAdminClinicalNotesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/notes/{id}"; }; export type GetAdminClinicalNotesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalNotesByIdError = GetAdminClinicalNotesByIdErrors[keyof GetAdminClinicalNotesByIdErrors]; export type GetAdminClinicalNotesByIdResponses = { /** * Success */ 200: { data?: ClinicalNote; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalNotesByIdResponse = GetAdminClinicalNotesByIdResponses[keyof GetAdminClinicalNotesByIdResponses]; export type PatchAdminClinicalNotesByIdData = { /** * Request body for the /clinical/notes/:id operation on clinical-note resource */ body?: { data: { attributes?: { metadata?: { [key: string]: unknown; } | null; note_content?: string | null; note_type?: "adime" | "soap" | "progress" | "discharge" | "addendum"; requires_cosign?: boolean | null; sections?: { [key: string]: unknown; } | null; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-note"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/notes/{id}"; }; export type PatchAdminClinicalNotesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalNotesByIdError = PatchAdminClinicalNotesByIdErrors[keyof PatchAdminClinicalNotesByIdErrors]; export type PatchAdminClinicalNotesByIdResponses = { /** * Success */ 200: { data?: ClinicalNote; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalNotesByIdResponse = PatchAdminClinicalNotesByIdResponses[keyof PatchAdminClinicalNotesByIdResponses]; export type GetAdminApplicationsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/applications"; }; export type GetAdminApplicationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminApplicationsError = GetAdminApplicationsErrors[keyof GetAdminApplicationsErrors]; export type GetAdminApplicationsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a application */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminApplicationsResponse = GetAdminApplicationsResponses[keyof GetAdminApplicationsResponses]; export type PostAdminApplicationsData = { /** * Request body for the /applications operation on application resource */ body: { data: { attributes?: { /** * When true, authenticated users may create org tenants (is_personal: false) via this application */ allow_org_creation?: boolean | null; /** * Optional allowlist of source IPs permitted to mint Forms access tokens via POST /apps/:app_id/form-access-tokens. `nil` = no IP check. */ allowed_server_ips?: Array | null; /** * Optional manual API key override (for system seeds) */ api_key?: string | null; badge_url?: string | null; /** * ISV's base URL for email links (verification, password reset, magic links) */ base_url?: string | null; /** * Additional ops/finance contacts for Layer 1 billing communications, * including overdraft warnings, account suspension notices, and payout * failures. Application owner delivery is handled separately. * */ billing_contact_emails?: Array | null; /** * Per-capability configuration (encrypted at rest) */ capability_config?: unknown; /** * DEPRECATED: Use Plan.initial_credits instead. Credits allocated to new tenants registering via this application */ default_free_credits?: number | null; description?: string | null; /** * Bundles enabled for this application. Standard tier enabled by default; premium bundles require a premium plan. The app-wide opt-in `ai_workload_routing` is added by name, not by default. */ enabled_capabilities?: Array | null; /** * Controls who can send invitations: :open (any member with invite permission) or :admin_only (tenant admins only) */ invitation_mode?: "open" | "admin_only"; /** * When true, user registration requires invitation */ invite_only?: boolean | null; logo_url?: string | null; /** * Multi-tier MFA enforcement policy for this application. * * * `:required` — every user must complete MFA at login * * `:tenant_choice` — defer to each tenant's `mfa_policy`; login-time * aggregate evaluates all user tenants under this application * * `:user_choice` — defer to per-user opt-in via MfaCredential.mfa_required (default) * */ mfa_policy?: "required" | "tenant_choice" | "user_choice"; name: string; oauth?: ApplicationOauthInputCreateType; owner_id?: string | null; /** * Payment gateway provider for this application's tenants */ payment_provider?: "qorpay" | "stripe"; /** * Default portal configuration for all tenants under this application */ portal_defaults?: { [key: string]: unknown; } | null; /** * When true, the application's registry at /r/{app_slug}/ is publicly readable without a token. */ public_registry?: boolean | null; /** * When true, password registration withholds JWT until email is verified */ require_email_verification?: boolean | null; /** * Email sender address (falls back to system default) */ sender_email?: string | null; /** * Email sender display name (falls back to system default) */ sender_name?: string | null; slug: string; /** * How the platform delivers auth-related emails (verification, invitation, * and future similar flows) to users for this Application. * * * `:link` - emails contain a click-through URL anchored on `base_url` * * `:code` - emails contain a paste-able 6-character code; no link * * Per-call override is available on each email-emitting action via that * action's own argument (verification: `confirmation_method`; invitation: * `email_method`); the per-call value takes precedence over this default * when set. * */ system_email_method?: "link" | "code"; /** * Memorable slug for vanity URLs */ vanity_slug?: string | null; /** * Workspace mode: single (auto-resolve) or multi (explicit) */ workspace_mode?: "single" | "multi"; }; relationships?: { [key: string]: never; }; type?: "application"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/applications"; }; export type PostAdminApplicationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminApplicationsError = PostAdminApplicationsErrors[keyof PostAdminApplicationsErrors]; export type PostAdminApplicationsResponses = { /** * Success */ 201: { data?: Application; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminApplicationsResponse = PostAdminApplicationsResponses[keyof PostAdminApplicationsResponses]; export type PatchAdminDataSubjectRequestsByIdStatusData = { /** * Request body for the /data-subject-requests/:id/status operation on data-subject-request resource */ body?: { data: { attributes?: { /** * Subject's appeal statement if request was denied */ appeal_statement?: string | null; completed_at?: unknown; /** * Legal grounds for denying the request (HIPAA permits specific grounds) */ denial_grounds?: string | null; fee_amount?: string | number | unknown; notes?: string | null; status?: "pending" | "in_progress" | "completed" | "rejected" | "expired"; /** * Third party to receive PHI copy (HIPAA right of access) */ third_party_recipient?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "data-subject-request"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/data-subject-requests/{id}/status"; }; export type PatchAdminDataSubjectRequestsByIdStatusErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminDataSubjectRequestsByIdStatusError = PatchAdminDataSubjectRequestsByIdStatusErrors[keyof PatchAdminDataSubjectRequestsByIdStatusErrors]; export type PatchAdminDataSubjectRequestsByIdStatusResponses = { /** * Success */ 200: { data?: DataSubjectRequest; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminDataSubjectRequestsByIdStatusResponse = PatchAdminDataSubjectRequestsByIdStatusResponses[keyof PatchAdminDataSubjectRequestsByIdStatusResponses]; export type DeleteAdminCatalogProductsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/products/{id}"; }; export type DeleteAdminCatalogProductsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCatalogProductsByIdError = DeleteAdminCatalogProductsByIdErrors[keyof DeleteAdminCatalogProductsByIdErrors]; export type DeleteAdminCatalogProductsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCatalogProductsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/products/{id}"; }; export type GetAdminCatalogProductsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogProductsByIdError = GetAdminCatalogProductsByIdErrors[keyof GetAdminCatalogProductsByIdErrors]; export type GetAdminCatalogProductsByIdResponses = { /** * Success */ 200: { data?: CatalogProduct; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogProductsByIdResponse = GetAdminCatalogProductsByIdResponses[keyof GetAdminCatalogProductsByIdResponses]; export type PatchAdminCatalogProductsByIdData = { /** * Request body for the /catalog/products/:id operation on catalog-product resource */ body?: { data: { attributes?: { ai_description?: string | null; base_price?: string | number | unknown; currency?: string | null; description?: string | null; media?: Array<{ [key: string]: unknown; }> | null; name?: string | null; properties?: { [key: string]: unknown; } | null; short_description?: string | null; sku?: string | null; slug?: string | null; status?: "draft" | "active" | "archived" | "discontinued"; }; id: string; relationships?: { [key: string]: never; }; type?: "catalog-product"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/products/{id}"; }; export type PatchAdminCatalogProductsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCatalogProductsByIdError = PatchAdminCatalogProductsByIdErrors[keyof PatchAdminCatalogProductsByIdErrors]; export type PatchAdminCatalogProductsByIdResponses = { /** * Success */ 200: { data?: CatalogProduct; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCatalogProductsByIdResponse = PatchAdminCatalogProductsByIdResponses[keyof PatchAdminCatalogProductsByIdResponses]; export type DeleteAdminSchedulingParticipantsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/participants/{id}"; }; export type DeleteAdminSchedulingParticipantsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminSchedulingParticipantsByIdError = DeleteAdminSchedulingParticipantsByIdErrors[keyof DeleteAdminSchedulingParticipantsByIdErrors]; export type DeleteAdminSchedulingParticipantsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminSchedulingParticipantsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/participants/{id}"; }; export type GetAdminSchedulingParticipantsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingParticipantsByIdError = GetAdminSchedulingParticipantsByIdErrors[keyof GetAdminSchedulingParticipantsByIdErrors]; export type GetAdminSchedulingParticipantsByIdResponses = { /** * Success */ 200: { data?: SchedulingParticipant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingParticipantsByIdResponse = GetAdminSchedulingParticipantsByIdResponses[keyof GetAdminSchedulingParticipantsByIdResponses]; export type PatchAdminSchedulingParticipantsByIdData = { /** * Request body for the /scheduling/participants/:id operation on scheduling-participant resource */ body?: { data: { attributes?: { metadata?: { [key: string]: unknown; } | null; name?: string | null; phone?: string | null; role?: "organizer" | "attendee" | "optional"; }; id: string; relationships?: { [key: string]: never; }; type?: "scheduling-participant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/participants/{id}"; }; export type PatchAdminSchedulingParticipantsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSchedulingParticipantsByIdError = PatchAdminSchedulingParticipantsByIdErrors[keyof PatchAdminSchedulingParticipantsByIdErrors]; export type PatchAdminSchedulingParticipantsByIdResponses = { /** * Success */ 200: { data?: SchedulingParticipant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSchedulingParticipantsByIdResponse = PatchAdminSchedulingParticipantsByIdResponses[keyof PatchAdminSchedulingParticipantsByIdResponses]; export type PatchAdminSupportTicketsByIdCloseData = { /** * Request body for the /support/tickets/:id/close operation on support-ticket resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "support-ticket"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/tickets/{id}/close"; }; export type PatchAdminSupportTicketsByIdCloseErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSupportTicketsByIdCloseError = PatchAdminSupportTicketsByIdCloseErrors[keyof PatchAdminSupportTicketsByIdCloseErrors]; export type PatchAdminSupportTicketsByIdCloseResponses = { /** * Success */ 200: { data?: SupportTicket; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSupportTicketsByIdCloseResponse = PatchAdminSupportTicketsByIdCloseResponses[keyof PatchAdminSupportTicketsByIdCloseResponses]; export type GetAdminClinicalSessionsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; owner_id?: string; }; url: "/admin/clinical/sessions"; }; export type GetAdminClinicalSessionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalSessionsError = GetAdminClinicalSessionsErrors[keyof GetAdminClinicalSessionsErrors]; export type GetAdminClinicalSessionsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-session */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalSessionsResponse = GetAdminClinicalSessionsResponses[keyof GetAdminClinicalSessionsResponses]; export type PostAdminClinicalSessionsData = { /** * Request body for the /clinical/sessions operation on clinical-session resource */ body: { data: { attributes?: { duration_minutes?: number | null; event_id?: string | null; external_ids?: { [key: string]: unknown; } | null; external_owner_id?: string | null; metadata?: { [key: string]: unknown; } | null; notes?: string | null; owner_id?: string | null; patient_id: string; prep_execution_id?: string | null; session_date?: unknown; session_format?: "in_person" | "telehealth" | "phone" | "async"; session_status?: "scheduled" | "in_progress" | "completed" | "cancelled" | "no_show"; session_summary?: string | null; session_type?: "initial" | "followup" | "discharge" | "emergency" | "group" | "phone_encounter" | "coordination" | "administrative"; transcript?: string | null; transcript_storage_key?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-session"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/sessions"; }; export type PostAdminClinicalSessionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalSessionsError = PostAdminClinicalSessionsErrors[keyof PostAdminClinicalSessionsErrors]; export type PostAdminClinicalSessionsResponses = { /** * Success */ 201: { data?: ClinicalSession; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalSessionsResponse = PostAdminClinicalSessionsResponses[keyof PostAdminClinicalSessionsResponses]; export type DeleteAdminSupportTicketsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/tickets/{id}"; }; export type DeleteAdminSupportTicketsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminSupportTicketsByIdError = DeleteAdminSupportTicketsByIdErrors[keyof DeleteAdminSupportTicketsByIdErrors]; export type DeleteAdminSupportTicketsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminSupportTicketsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/tickets/{id}"; }; export type GetAdminSupportTicketsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSupportTicketsByIdError = GetAdminSupportTicketsByIdErrors[keyof GetAdminSupportTicketsByIdErrors]; export type GetAdminSupportTicketsByIdResponses = { /** * Success */ 200: { data?: SupportTicket; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSupportTicketsByIdResponse = GetAdminSupportTicketsByIdResponses[keyof GetAdminSupportTicketsByIdResponses]; export type PatchAdminSupportTicketsByIdData = { /** * Request body for the /support/tickets/:id operation on support-ticket resource */ body?: { data: { attributes?: { ai_classification?: string | null; ai_confidence?: number | null; ai_sentiment?: string | null; assigned_agent_id?: string | null; crm_contact_id?: string | null; custom_fields?: { [key: string]: unknown; } | null; customer_email?: string | null; customer_name?: string | null; description?: string | null; external_id?: string | null; external_owner_id?: string | null; first_response_at?: unknown; invoice_id?: string | null; owner_id?: string | null; priority?: "low" | "normal" | "high" | "urgent"; product_id?: string | null; queue_id?: string | null; sla_breached?: boolean | null; sla_due_at?: unknown; sla_policy_id?: string | null; status?: "new" | "open" | "pending" | "on_hold" | "resolved" | "closed"; subject?: string | null; synced_at?: unknown; tags?: Array | null; }; id: string; relationships?: { [key: string]: never; }; type?: "support-ticket"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/tickets/{id}"; }; export type PatchAdminSupportTicketsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSupportTicketsByIdError = PatchAdminSupportTicketsByIdErrors[keyof PatchAdminSupportTicketsByIdErrors]; export type PatchAdminSupportTicketsByIdResponses = { /** * Success */ 200: { data?: SupportTicket; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSupportTicketsByIdResponse = PatchAdminSupportTicketsByIdResponses[keyof PatchAdminSupportTicketsByIdResponses]; export type GetAdminMessagesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/messages"; }; export type GetAdminMessagesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminMessagesError = GetAdminMessagesErrors[keyof GetAdminMessagesErrors]; export type GetAdminMessagesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a chat-message */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminMessagesResponse = GetAdminMessagesResponses[keyof GetAdminMessagesResponses]; export type PostAdminMessagesData = { /** * Request body for the /messages operation on chat-message resource */ body: { data: { attributes?: { content: string; metadata?: { [key: string]: unknown; } | null; role: "user" | "assistant" | "system" | "tool"; thread_id: string; }; relationships?: { [key: string]: never; }; type?: "chat-message"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/messages"; }; export type PostAdminMessagesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminMessagesError = PostAdminMessagesErrors[keyof PostAdminMessagesErrors]; export type PostAdminMessagesResponses = { /** * Success */ 201: { data?: ChatMessage; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminMessagesResponse = PostAdminMessagesResponses[keyof PostAdminMessagesResponses]; export type PostAdminConnectorsByIdPracticeBetterPushNoteData = { /** * Request body for the /connectors/:id/practice-better/push-note operation on connector-instance resource */ body: { data: { connector_id: string; contact_id: string; note_content: string; note_type?: string | null; title?: string | null; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/connectors/{id}/practice-better/push-note"; }; export type PostAdminConnectorsByIdPracticeBetterPushNoteErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsByIdPracticeBetterPushNoteError = PostAdminConnectorsByIdPracticeBetterPushNoteErrors[keyof PostAdminConnectorsByIdPracticeBetterPushNoteErrors]; export type PostAdminConnectorsByIdPracticeBetterPushNoteResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminConnectorsByIdPracticeBetterPushNoteResponse = PostAdminConnectorsByIdPracticeBetterPushNoteResponses[keyof PostAdminConnectorsByIdPracticeBetterPushNoteResponses]; export type GetAdminAccessLogsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/access-logs"; }; export type GetAdminAccessLogsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAccessLogsError = GetAdminAccessLogsErrors[keyof GetAdminAccessLogsErrors]; export type GetAdminAccessLogsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a access-log */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAccessLogsResponse = GetAdminAccessLogsResponses[keyof GetAdminAccessLogsResponses]; export type DeleteAdminClinicalMealPlansByIdPermanentData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/meal-plans/{id}/permanent"; }; export type DeleteAdminClinicalMealPlansByIdPermanentErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalMealPlansByIdPermanentError = DeleteAdminClinicalMealPlansByIdPermanentErrors[keyof DeleteAdminClinicalMealPlansByIdPermanentErrors]; export type DeleteAdminClinicalMealPlansByIdPermanentResponses = { /** * Deleted successfully */ 200: unknown; }; export type DeleteAdminFeatureDefinitionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/feature-definitions/{id}"; }; export type DeleteAdminFeatureDefinitionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminFeatureDefinitionsByIdError = DeleteAdminFeatureDefinitionsByIdErrors[keyof DeleteAdminFeatureDefinitionsByIdErrors]; export type DeleteAdminFeatureDefinitionsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminFeatureDefinitionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/feature-definitions/{id}"; }; export type GetAdminFeatureDefinitionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminFeatureDefinitionsByIdError = GetAdminFeatureDefinitionsByIdErrors[keyof GetAdminFeatureDefinitionsByIdErrors]; export type GetAdminFeatureDefinitionsByIdResponses = { /** * Success */ 200: { data?: FeatureDefinition; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminFeatureDefinitionsByIdResponse = GetAdminFeatureDefinitionsByIdResponses[keyof GetAdminFeatureDefinitionsByIdResponses]; export type PatchAdminFeatureDefinitionsByIdData = { /** * Request body for the /feature-definitions/:id operation on feature-definition resource */ body?: { data: { attributes?: { /** * Credits deducted per use. Required for :credit_cost mode. */ credit_cost?: number | null; /** * Default usage limit per billing cycle. nil = unlimited. Only applies to :counted mode. */ default_limit?: number | null; /** * ISV-custom data (icons, descriptions, display order) */ metadata?: { [key: string]: unknown; } | null; /** * How this feature is metered: unlimited, counted (with optional limit), or credit_cost (deducts credits per use) */ metering_mode?: "unlimited" | "counted" | "credit_cost"; /** * Human-readable display name */ name?: string | null; /** * Optional link to a platform capability key. If set, feature is auto-disabled when the capability is off. */ platform_capability?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "feature-definition"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/feature-definitions/{id}"; }; export type PatchAdminFeatureDefinitionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminFeatureDefinitionsByIdError = PatchAdminFeatureDefinitionsByIdErrors[keyof PatchAdminFeatureDefinitionsByIdErrors]; export type PatchAdminFeatureDefinitionsByIdResponses = { /** * Success */ 200: { data?: FeatureDefinition; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminFeatureDefinitionsByIdResponse = PatchAdminFeatureDefinitionsByIdResponses[keyof PatchAdminFeatureDefinitionsByIdResponses]; export type GetAdminAgentDeploymentsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-deployments"; }; export type GetAdminAgentDeploymentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentDeploymentsError = GetAdminAgentDeploymentsErrors[keyof GetAdminAgentDeploymentsErrors]; export type GetAdminAgentDeploymentsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a agent-deployment */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAgentDeploymentsResponse = GetAdminAgentDeploymentsResponses[keyof GetAdminAgentDeploymentsResponses]; export type PostAdminAgentDeploymentsData = { /** * Request body for the /agent-deployments operation on agent-deployment resource */ body: { data: { attributes?: { allow_tenant_clone?: boolean | null; application_id: string; auto_deploy_agents?: boolean | null; catalog_agent_id: string; effective_version_id: string; is_application_default?: boolean | null; overrides?: { [key: string]: unknown; } | null; pinned_version_id?: string | null; seal_policy?: AgentDeploymentSealPolicyInputCreateType; tenant_id: string; }; relationships?: { [key: string]: never; }; type?: "agent-deployment"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-deployments"; }; export type PostAdminAgentDeploymentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAgentDeploymentsError = PostAdminAgentDeploymentsErrors[keyof PostAdminAgentDeploymentsErrors]; export type PostAdminAgentDeploymentsResponses = { /** * Success */ 201: { data?: AgentDeployment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAgentDeploymentsResponse = PostAdminAgentDeploymentsResponses[keyof PostAdminAgentDeploymentsResponses]; export type DeleteAdminCrmWebsitesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/websites/{id}"; }; export type DeleteAdminCrmWebsitesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrmWebsitesByIdError = DeleteAdminCrmWebsitesByIdErrors[keyof DeleteAdminCrmWebsitesByIdErrors]; export type DeleteAdminCrmWebsitesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCrmWebsitesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/websites/{id}"; }; export type GetAdminCrmWebsitesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmWebsitesByIdError = GetAdminCrmWebsitesByIdErrors[keyof GetAdminCrmWebsitesByIdErrors]; export type GetAdminCrmWebsitesByIdResponses = { /** * Success */ 200: { data?: CrmWebsite; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmWebsitesByIdResponse = GetAdminCrmWebsitesByIdResponses[keyof GetAdminCrmWebsitesByIdResponses]; export type PatchAdminCrmWebsitesByIdData = { /** * Request body for the /crm/websites/:id operation on crm-website resource */ body?: { data: { attributes?: { is_primary?: boolean | null; label?: "main" | "careers" | "blog" | "docs" | "portfolio" | "other"; url?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-website"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/websites/{id}"; }; export type PatchAdminCrmWebsitesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmWebsitesByIdError = PatchAdminCrmWebsitesByIdErrors[keyof PatchAdminCrmWebsitesByIdErrors]; export type PatchAdminCrmWebsitesByIdResponses = { /** * Success */ 200: { data?: CrmWebsite; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmWebsitesByIdResponse = PatchAdminCrmWebsitesByIdResponses[keyof PatchAdminCrmWebsitesByIdResponses]; export type GetAdminSocialMetricsCampaignBySocialCampaignIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { social_campaign_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/metrics/campaign/{social_campaign_id}"; }; export type GetAdminSocialMetricsCampaignBySocialCampaignIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialMetricsCampaignBySocialCampaignIdError = GetAdminSocialMetricsCampaignBySocialCampaignIdErrors[keyof GetAdminSocialMetricsCampaignBySocialCampaignIdErrors]; export type GetAdminSocialMetricsCampaignBySocialCampaignIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a post-metric */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialMetricsCampaignBySocialCampaignIdResponse = GetAdminSocialMetricsCampaignBySocialCampaignIdResponses[keyof GetAdminSocialMetricsCampaignBySocialCampaignIdResponses]; export type GetAdminVoiceTranscriptionJobsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/voice/transcription-jobs"; }; export type GetAdminVoiceTranscriptionJobsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminVoiceTranscriptionJobsError = GetAdminVoiceTranscriptionJobsErrors[keyof GetAdminVoiceTranscriptionJobsErrors]; export type GetAdminVoiceTranscriptionJobsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a transcription-job */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminVoiceTranscriptionJobsResponse = GetAdminVoiceTranscriptionJobsResponses[keyof GetAdminVoiceTranscriptionJobsResponses]; export type PostAdminVoiceTranscriptionJobsData = { /** * Request body for the /voice/transcription-jobs operation on transcription-job resource */ body?: { data: { attributes?: { enable_diarization?: boolean | null; initial_prompt?: string | null; language?: string | null; metadata?: { [key: string]: unknown; } | null; model_size?: string | null; num_speakers?: number | null; pii_mode?: "none" | "tokenize" | "tokenize_encrypt"; }; relationships?: { [key: string]: never; }; type?: "transcription-job"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/voice/transcription-jobs"; }; export type PostAdminVoiceTranscriptionJobsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminVoiceTranscriptionJobsError = PostAdminVoiceTranscriptionJobsErrors[keyof PostAdminVoiceTranscriptionJobsErrors]; export type PostAdminVoiceTranscriptionJobsResponses = { /** * Success */ 201: { data?: TranscriptionJob; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminVoiceTranscriptionJobsResponse = PostAdminVoiceTranscriptionJobsResponses[keyof PostAdminVoiceTranscriptionJobsResponses]; export type GetAdminCrawlerNewsMonitorsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/news-monitors"; }; export type GetAdminCrawlerNewsMonitorsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrawlerNewsMonitorsError = GetAdminCrawlerNewsMonitorsErrors[keyof GetAdminCrawlerNewsMonitorsErrors]; export type GetAdminCrawlerNewsMonitorsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a news-monitor */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrawlerNewsMonitorsResponse = GetAdminCrawlerNewsMonitorsResponses[keyof GetAdminCrawlerNewsMonitorsResponses]; export type PostAdminCrawlerNewsMonitorsData = { /** * Request body for the /crawler/news-monitors operation on news-monitor resource */ body: { data: { attributes?: { frequency?: "daily" | "twice_daily" | "hourly"; metadata?: { [key: string]: unknown; } | null; name: string; source_urls?: Array | null; summary_model?: "default" | "balanced" | "accurate"; tags?: Array | null; topic: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "news-monitor"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/news-monitors"; }; export type PostAdminCrawlerNewsMonitorsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrawlerNewsMonitorsError = PostAdminCrawlerNewsMonitorsErrors[keyof PostAdminCrawlerNewsMonitorsErrors]; export type PostAdminCrawlerNewsMonitorsResponses = { /** * Success */ 201: { data?: NewsMonitor; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrawlerNewsMonitorsResponse = PostAdminCrawlerNewsMonitorsResponses[keyof PostAdminCrawlerNewsMonitorsResponses]; export type PostAdminPreferencesUpsertData = { /** * Request body for the /preferences/upsert operation on user-preference resource */ body: { data: { attributes?: { context_key: string; preferences?: { [key: string]: unknown; } | null; }; relationships?: { [key: string]: never; }; type?: "user-preference"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/preferences/upsert"; }; export type PostAdminPreferencesUpsertErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminPreferencesUpsertError = PostAdminPreferencesUpsertErrors[keyof PostAdminPreferencesUpsertErrors]; export type PostAdminPreferencesUpsertResponses = { /** * Success */ 201: { data?: UserPreference; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminPreferencesUpsertResponse = PostAdminPreferencesUpsertResponses[keyof PostAdminPreferencesUpsertResponses]; export type GetAdminFieldTemplatesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; category?: string; is_system?: boolean; }; url: "/admin/field-templates"; }; export type GetAdminFieldTemplatesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminFieldTemplatesError = GetAdminFieldTemplatesErrors[keyof GetAdminFieldTemplatesErrors]; export type GetAdminFieldTemplatesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a field-template */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminFieldTemplatesResponse = GetAdminFieldTemplatesResponses[keyof GetAdminFieldTemplatesResponses]; export type PostAdminFieldTemplatesData = { /** * Request body for the /field-templates operation on field-template resource */ body: { data: { attributes?: { category: string; extraction_hints?: { [key: string]: unknown; } | null; field_type?: string | null; is_system?: boolean | null; llm_instructions?: string | null; name: string; validation_pattern?: string | null; }; relationships?: { [key: string]: never; }; type?: "field-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/field-templates"; }; export type PostAdminFieldTemplatesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminFieldTemplatesError = PostAdminFieldTemplatesErrors[keyof PostAdminFieldTemplatesErrors]; export type PostAdminFieldTemplatesResponses = { /** * Success */ 201: { data?: FieldTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminFieldTemplatesResponse = PostAdminFieldTemplatesResponses[keyof PostAdminFieldTemplatesResponses]; export type PostAdminConnectorsData = { /** * Request body for the /connectors operation on connector-instance resource */ body: { data: { attributes?: { /** * Connector-specific configuration (URLs, mappings, etc.) */ config?: { [key: string]: unknown; } | null; connector_type: "corehealth" | "custom" | "edamam" | "facebook" | "fhir_r4" | "fullscript" | "github" | "gitlab" | "gmail" | "google_calendar" | "google_chat" | "healthie" | "hubspot" | "instagram" | "jira" | "confluence" | "linkedin" | "microsoft_365" | "notion" | "outlook" | "practice_better" | "reddit" | "salesforce" | "sharepoint" | "slack" | "threads" | "twitter" | "bluesky"; enabled?: boolean | null; metadata?: { [key: string]: unknown; } | null; name: string; sync_interval_minutes?: number | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "connector-instance"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/connectors"; }; export type PostAdminConnectorsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsError = PostAdminConnectorsErrors[keyof PostAdminConnectorsErrors]; export type PostAdminConnectorsResponses = { /** * Success */ 201: { data?: ConnectorInstance; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminConnectorsResponse = PostAdminConnectorsResponses[keyof PostAdminConnectorsResponses]; export type DeleteAdminCatalogViewOverridesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/view-overrides/{id}"; }; export type DeleteAdminCatalogViewOverridesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCatalogViewOverridesByIdError = DeleteAdminCatalogViewOverridesByIdErrors[keyof DeleteAdminCatalogViewOverridesByIdErrors]; export type DeleteAdminCatalogViewOverridesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type PatchAdminCatalogViewOverridesByIdData = { /** * Request body for the /catalog/view-overrides/:id operation on catalog-view-override resource */ body?: { data: { attributes?: { action?: "pin" | "exclude"; custom_data?: { [key: string]: unknown; } | null; display_description?: string | null; display_media?: Array<{ [key: string]: unknown; }> | null; display_name?: string | null; position?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "catalog-view-override"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/view-overrides/{id}"; }; export type PatchAdminCatalogViewOverridesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCatalogViewOverridesByIdError = PatchAdminCatalogViewOverridesByIdErrors[keyof PatchAdminCatalogViewOverridesByIdErrors]; export type PatchAdminCatalogViewOverridesByIdResponses = { /** * Success */ 200: { data?: CatalogViewOverride; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCatalogViewOverridesByIdResponse = PatchAdminCatalogViewOverridesByIdResponses[keyof PatchAdminCatalogViewOverridesByIdResponses]; export type DeleteAdminCampaignsSequencesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/campaigns/sequences/{id}"; }; export type DeleteAdminCampaignsSequencesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCampaignsSequencesByIdError = DeleteAdminCampaignsSequencesByIdErrors[keyof DeleteAdminCampaignsSequencesByIdErrors]; export type DeleteAdminCampaignsSequencesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCampaignsSequencesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/campaigns/sequences/{id}"; }; export type GetAdminCampaignsSequencesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCampaignsSequencesByIdError = GetAdminCampaignsSequencesByIdErrors[keyof GetAdminCampaignsSequencesByIdErrors]; export type GetAdminCampaignsSequencesByIdResponses = { /** * Success */ 200: { data?: EmailMarketingSequence; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCampaignsSequencesByIdResponse = GetAdminCampaignsSequencesByIdResponses[keyof GetAdminCampaignsSequencesByIdResponses]; export type PatchAdminCampaignsSequencesByIdData = { /** * Request body for the /campaigns/sequences/:id operation on email-marketing-sequence resource */ body?: { data: { attributes?: { name?: string | null; trigger_deal_stage_id?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "email-marketing-sequence"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/campaigns/sequences/{id}"; }; export type PatchAdminCampaignsSequencesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCampaignsSequencesByIdError = PatchAdminCampaignsSequencesByIdErrors[keyof PatchAdminCampaignsSequencesByIdErrors]; export type PatchAdminCampaignsSequencesByIdResponses = { /** * Success */ 200: { data?: EmailMarketingSequence; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCampaignsSequencesByIdResponse = PatchAdminCampaignsSequencesByIdResponses[keyof PatchAdminCampaignsSequencesByIdResponses]; export type PostAdminCatalogViewOverridesData = { /** * Request body for the /catalog/view-overrides operation on catalog-view-override resource */ body: { data: { attributes?: { action: "pin" | "exclude"; catalog_view_id: string; custom_data?: { [key: string]: unknown; } | null; display_description?: string | null; display_media?: Array<{ [key: string]: unknown; }> | null; display_name?: string | null; position?: number | null; product_id: string; }; relationships?: { [key: string]: never; }; type?: "catalog-view-override"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/view-overrides"; }; export type PostAdminCatalogViewOverridesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCatalogViewOverridesError = PostAdminCatalogViewOverridesErrors[keyof PostAdminCatalogViewOverridesErrors]; export type PostAdminCatalogViewOverridesResponses = { /** * Success */ 201: { data?: CatalogViewOverride; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCatalogViewOverridesResponse = PostAdminCatalogViewOverridesResponses[keyof PostAdminCatalogViewOverridesResponses]; export type DeleteAdminCrmRelationshipTypesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/relationship-types/{id}"; }; export type DeleteAdminCrmRelationshipTypesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrmRelationshipTypesByIdError = DeleteAdminCrmRelationshipTypesByIdErrors[keyof DeleteAdminCrmRelationshipTypesByIdErrors]; export type DeleteAdminCrmRelationshipTypesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCrmRelationshipTypesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/relationship-types/{id}"; }; export type GetAdminCrmRelationshipTypesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmRelationshipTypesByIdError = GetAdminCrmRelationshipTypesByIdErrors[keyof GetAdminCrmRelationshipTypesByIdErrors]; export type GetAdminCrmRelationshipTypesByIdResponses = { /** * Success */ 200: { data?: CrmRelationshipType; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmRelationshipTypesByIdResponse = GetAdminCrmRelationshipTypesByIdResponses[keyof GetAdminCrmRelationshipTypesByIdResponses]; export type PatchAdminCrmRelationshipTypesByIdData = { /** * Request body for the /crm/relationship-types/:id operation on crm-relationship-type resource */ body?: { data: { attributes?: { is_directional?: boolean | null; name?: string | null; properties_schema?: { [key: string]: unknown; } | null; source_entity_types?: Array | null; target_entity_types?: Array | null; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-relationship-type"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/relationship-types/{id}"; }; export type PatchAdminCrmRelationshipTypesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmRelationshipTypesByIdError = PatchAdminCrmRelationshipTypesByIdErrors[keyof PatchAdminCrmRelationshipTypesByIdErrors]; export type PatchAdminCrmRelationshipTypesByIdResponses = { /** * Success */ 200: { data?: CrmRelationshipType; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmRelationshipTypesByIdResponse = PatchAdminCrmRelationshipTypesByIdResponses[keyof PatchAdminCrmRelationshipTypesByIdResponses]; export type PostAdminContentGenerateTextData = { /** * Request body for the /content/generate-text operation on content-generation resource */ body: { data: { brand_identity_id?: string | null; prompt: string; task?: string | null; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/content/generate-text"; }; export type PostAdminContentGenerateTextErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminContentGenerateTextError = PostAdminContentGenerateTextErrors[keyof PostAdminContentGenerateTextErrors]; export type PostAdminContentGenerateTextResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminContentGenerateTextResponse = PostAdminContentGenerateTextResponses[keyof PostAdminContentGenerateTextResponses]; export type PatchAdminInvoicesByIdSubmitForApprovalData = { /** * Request body for the /invoices/:id/submit-for-approval operation on invoices-invoice resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "invoices-invoice"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/{id}/submit-for-approval"; }; export type PatchAdminInvoicesByIdSubmitForApprovalErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvoicesByIdSubmitForApprovalError = PatchAdminInvoicesByIdSubmitForApprovalErrors[keyof PatchAdminInvoicesByIdSubmitForApprovalErrors]; export type PatchAdminInvoicesByIdSubmitForApprovalResponses = { /** * Success */ 200: { data?: InvoicesInvoice; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvoicesByIdSubmitForApprovalResponse = PatchAdminInvoicesByIdSubmitForApprovalResponses[keyof PatchAdminInvoicesByIdSubmitForApprovalResponses]; export type GetAdminFeatureDefinitionsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/feature-definitions"; }; export type GetAdminFeatureDefinitionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminFeatureDefinitionsError = GetAdminFeatureDefinitionsErrors[keyof GetAdminFeatureDefinitionsErrors]; export type GetAdminFeatureDefinitionsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a feature-definition */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminFeatureDefinitionsResponse = GetAdminFeatureDefinitionsResponses[keyof GetAdminFeatureDefinitionsResponses]; export type PostAdminFeatureDefinitionsData = { /** * Request body for the /feature-definitions operation on feature-definition resource */ body: { data: { attributes?: { /** * Optional - inferred from x-application-key header when not provided */ application_id?: string | null; /** * Credits deducted per use. Required for :credit_cost mode. */ credit_cost?: number | null; /** * Default usage limit per billing cycle. nil = unlimited. Only applies to :counted mode. */ default_limit?: number | null; /** * Unique feature key within the application (e.g., meal_plans) */ key: string; /** * ISV-custom data (icons, descriptions, display order) */ metadata?: { [key: string]: unknown; } | null; /** * How this feature is metered: unlimited, counted (with optional limit), or credit_cost (deducts credits per use) */ metering_mode: "unlimited" | "counted" | "credit_cost"; /** * Human-readable display name */ name: string; /** * Optional link to a platform capability key. If set, feature is auto-disabled when the capability is off. */ platform_capability?: string | null; }; relationships?: { [key: string]: never; }; type?: "feature-definition"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/feature-definitions"; }; export type PostAdminFeatureDefinitionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminFeatureDefinitionsError = PostAdminFeatureDefinitionsErrors[keyof PostAdminFeatureDefinitionsErrors]; export type PostAdminFeatureDefinitionsResponses = { /** * Success */ 201: { data?: FeatureDefinition; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminFeatureDefinitionsResponse = PostAdminFeatureDefinitionsResponses[keyof PostAdminFeatureDefinitionsResponses]; export type PostAdminRecipesRecipeTagsData = { /** * Request body for the /recipes/recipe-tags operation on recipes-recipe-tag resource */ body: { data: { attributes?: { recipe_id: string; tag_id: string; }; relationships?: { [key: string]: never; }; type?: "recipes-recipe-tag"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/recipe-tags"; }; export type PostAdminRecipesRecipeTagsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminRecipesRecipeTagsError = PostAdminRecipesRecipeTagsErrors[keyof PostAdminRecipesRecipeTagsErrors]; export type PostAdminRecipesRecipeTagsResponses = { /** * Success */ 201: { data?: RecipesRecipeTag; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminRecipesRecipeTagsResponse = PostAdminRecipesRecipeTagsResponses[keyof PostAdminRecipesRecipeTagsResponses]; export type PostAdminRecipesTagsData = { /** * Request body for the /recipes/tags operation on recipes-tag resource */ body: { data: { attributes?: { application_id: string; category: "cuisine" | "diet" | "health" | "course" | "technique" | "custom"; metadata?: { [key: string]: unknown; } | null; name: string; }; relationships?: { [key: string]: never; }; type?: "recipes-tag"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/tags"; }; export type PostAdminRecipesTagsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminRecipesTagsError = PostAdminRecipesTagsErrors[keyof PostAdminRecipesTagsErrors]; export type PostAdminRecipesTagsResponses = { /** * Success */ 201: { data?: RecipesTag; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminRecipesTagsResponse = PostAdminRecipesTagsResponses[keyof PostAdminRecipesTagsResponses]; export type GetAdminEmailRecipientsEmailByOutboundEmailIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { outbound_email_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/recipients/email/{outbound_email_id}"; }; export type GetAdminEmailRecipientsEmailByOutboundEmailIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailRecipientsEmailByOutboundEmailIdError = GetAdminEmailRecipientsEmailByOutboundEmailIdErrors[keyof GetAdminEmailRecipientsEmailByOutboundEmailIdErrors]; export type GetAdminEmailRecipientsEmailByOutboundEmailIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a email-recipient */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailRecipientsEmailByOutboundEmailIdResponse = GetAdminEmailRecipientsEmailByOutboundEmailIdResponses[keyof GetAdminEmailRecipientsEmailByOutboundEmailIdResponses]; export type DeleteAdminCatalogPriceListEntriesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/price-list-entries/{id}"; }; export type DeleteAdminCatalogPriceListEntriesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCatalogPriceListEntriesByIdError = DeleteAdminCatalogPriceListEntriesByIdErrors[keyof DeleteAdminCatalogPriceListEntriesByIdErrors]; export type DeleteAdminCatalogPriceListEntriesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type PatchAdminCatalogPriceListEntriesByIdData = { /** * Request body for the /catalog/price-list-entries/:id operation on catalog-price-list-entry resource */ body?: { data: { attributes?: { floor_price?: string | number | unknown; modifier?: string | number | unknown; price?: string | number | unknown; tiers?: Array<{ [key: string]: unknown; }> | null; }; id: string; relationships?: { [key: string]: never; }; type?: "catalog-price-list-entry"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/price-list-entries/{id}"; }; export type PatchAdminCatalogPriceListEntriesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCatalogPriceListEntriesByIdError = PatchAdminCatalogPriceListEntriesByIdErrors[keyof PatchAdminCatalogPriceListEntriesByIdErrors]; export type PatchAdminCatalogPriceListEntriesByIdResponses = { /** * Success */ 200: { data?: CatalogPriceListEntry; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCatalogPriceListEntriesByIdResponse = PatchAdminCatalogPriceListEntriesByIdResponses[keyof PatchAdminCatalogPriceListEntriesByIdResponses]; export type DeleteAdminCrmSocialProfilesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/social-profiles/{id}"; }; export type DeleteAdminCrmSocialProfilesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrmSocialProfilesByIdError = DeleteAdminCrmSocialProfilesByIdErrors[keyof DeleteAdminCrmSocialProfilesByIdErrors]; export type DeleteAdminCrmSocialProfilesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCrmSocialProfilesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/social-profiles/{id}"; }; export type GetAdminCrmSocialProfilesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmSocialProfilesByIdError = GetAdminCrmSocialProfilesByIdErrors[keyof GetAdminCrmSocialProfilesByIdErrors]; export type GetAdminCrmSocialProfilesByIdResponses = { /** * Success */ 200: { data?: CrmSocialProfile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmSocialProfilesByIdResponse = GetAdminCrmSocialProfilesByIdResponses[keyof GetAdminCrmSocialProfilesByIdResponses]; export type PatchAdminCrmSocialProfilesByIdData = { /** * Request body for the /crm/social-profiles/:id operation on crm-social-profile resource */ body?: { data: { attributes?: { handle?: string | null; url?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-social-profile"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/social-profiles/{id}"; }; export type PatchAdminCrmSocialProfilesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmSocialProfilesByIdError = PatchAdminCrmSocialProfilesByIdErrors[keyof PatchAdminCrmSocialProfilesByIdErrors]; export type PatchAdminCrmSocialProfilesByIdResponses = { /** * Success */ 200: { data?: CrmSocialProfile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmSocialProfilesByIdResponse = PatchAdminCrmSocialProfilesByIdResponses[keyof PatchAdminCrmSocialProfilesByIdResponses]; export type PostAdminConnectorsOauthCallbackData = { /** * Request body for the /connectors/oauth/callback operation on connector-instance resource */ body: { data: { code: string; connector_type: string; redirect_uri?: string | null; state: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/connectors/oauth/callback"; }; export type PostAdminConnectorsOauthCallbackErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsOauthCallbackError = PostAdminConnectorsOauthCallbackErrors[keyof PostAdminConnectorsOauthCallbackErrors]; export type PostAdminConnectorsOauthCallbackResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminConnectorsOauthCallbackResponse = PostAdminConnectorsOauthCallbackResponses[keyof PostAdminConnectorsOauthCallbackResponses]; export type PostAdminCatalogViewsData = { /** * Request body for the /catalog/views operation on catalog-view resource */ body: { data: { attributes?: { application_id?: string | null; channel_target?: string | null; default_sort?: "name" | "newest" | "price_asc" | "price_desc"; description?: string | null; locale?: string | null; max_items?: number | null; name: string; price_list_id?: string | null; slug: string; status?: "draft" | "active" | "archived"; visibility?: "public" | "private" | "restricted"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "catalog-view"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/views"; }; export type PostAdminCatalogViewsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCatalogViewsError = PostAdminCatalogViewsErrors[keyof PostAdminCatalogViewsErrors]; export type PostAdminCatalogViewsResponses = { /** * Success */ 201: { data?: CatalogView; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCatalogViewsResponse = PostAdminCatalogViewsResponses[keyof PostAdminCatalogViewsResponses]; export type PatchAdminSchedulingBookingsByIdCancelData = { /** * Request body for the /scheduling/bookings/:id/cancel operation on scheduling-booking resource */ body?: { data: { attributes?: { cancellation_reason?: string | null; cancelled_by?: "booker" | "organizer" | "system"; }; id: string; relationships?: { [key: string]: never; }; type?: "scheduling-booking"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/bookings/{id}/cancel"; }; export type PatchAdminSchedulingBookingsByIdCancelErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSchedulingBookingsByIdCancelError = PatchAdminSchedulingBookingsByIdCancelErrors[keyof PatchAdminSchedulingBookingsByIdCancelErrors]; export type PatchAdminSchedulingBookingsByIdCancelResponses = { /** * Success */ 200: { data?: SchedulingBooking; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSchedulingBookingsByIdCancelResponse = PatchAdminSchedulingBookingsByIdCancelResponses[keyof PatchAdminSchedulingBookingsByIdCancelResponses]; export type DeleteAdminAccessGrantsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/access-grants/{id}"; }; export type DeleteAdminAccessGrantsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminAccessGrantsByIdError = DeleteAdminAccessGrantsByIdErrors[keyof DeleteAdminAccessGrantsByIdErrors]; export type DeleteAdminAccessGrantsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminAccessGrantsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/access-grants/{id}"; }; export type GetAdminAccessGrantsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAccessGrantsByIdError = GetAdminAccessGrantsByIdErrors[keyof GetAdminAccessGrantsByIdErrors]; export type GetAdminAccessGrantsByIdResponses = { /** * Success */ 200: { data?: AccessGrant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAccessGrantsByIdResponse = GetAdminAccessGrantsByIdResponses[keyof GetAdminAccessGrantsByIdResponses]; export type PatchAdminAccessGrantsByIdData = { /** * Request body for the /access-grants/:id operation on access-grant resource */ body?: { data: { attributes?: { /** * Permissions granted by this relation. Auto-populated from PermissionRegistry unless overridden. */ custom_permissions?: Array | null; expires_at?: unknown; relation?: "tenant_admin" | "tenant_member" | "workspace_admin" | "workspace_editor" | "workspace_viewer"; }; id: string; relationships?: { [key: string]: never; }; type?: "access-grant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/access-grants/{id}"; }; export type PatchAdminAccessGrantsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminAccessGrantsByIdError = PatchAdminAccessGrantsByIdErrors[keyof PatchAdminAccessGrantsByIdErrors]; export type PatchAdminAccessGrantsByIdResponses = { /** * Success */ 200: { data?: AccessGrant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminAccessGrantsByIdResponse = PatchAdminAccessGrantsByIdResponses[keyof PatchAdminAccessGrantsByIdResponses]; export type GetAdminClinicalNoteTemplatesCatalogByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/note-templates/catalog/{id}"; }; export type GetAdminClinicalNoteTemplatesCatalogByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalNoteTemplatesCatalogByIdError = GetAdminClinicalNoteTemplatesCatalogByIdErrors[keyof GetAdminClinicalNoteTemplatesCatalogByIdErrors]; export type GetAdminClinicalNoteTemplatesCatalogByIdResponses = { /** * Success */ 200: { data?: ClinicalNoteTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalNoteTemplatesCatalogByIdResponse = GetAdminClinicalNoteTemplatesCatalogByIdResponses[keyof GetAdminClinicalNoteTemplatesCatalogByIdResponses]; export type PatchAdminClinicalNoteTemplatesCatalogByIdData = { /** * Request body for the /clinical/note-templates/catalog/:id operation on clinical-note-template resource */ body?: { data: { attributes?: { category?: string | null; description?: string | null; is_active?: boolean | null; metadata?: { [key: string]: unknown; } | null; note_type?: "soap" | "adime" | "progress" | "discharge" | "addendum"; sections?: { [key: string]: unknown; } | null; tags?: Array | null; title?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-note-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/note-templates/catalog/{id}"; }; export type PatchAdminClinicalNoteTemplatesCatalogByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalNoteTemplatesCatalogByIdError = PatchAdminClinicalNoteTemplatesCatalogByIdErrors[keyof PatchAdminClinicalNoteTemplatesCatalogByIdErrors]; export type PatchAdminClinicalNoteTemplatesCatalogByIdResponses = { /** * Success */ 200: { data?: ClinicalNoteTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalNoteTemplatesCatalogByIdResponse = PatchAdminClinicalNoteTemplatesCatalogByIdResponses[keyof PatchAdminClinicalNoteTemplatesCatalogByIdResponses]; export type GetAdminAgentsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agents"; }; export type GetAdminAgentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentsError = GetAdminAgentsErrors[keyof GetAdminAgentsErrors]; export type GetAdminAgentsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a agent */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAgentsResponse = GetAdminAgentsResponses[keyof GetAdminAgentsResponses]; export type PostAdminAgentsData = { /** * Request body for the /agents operation on agent resource */ body: { data: { attributes?: { /** * Stable catalog taxonomy for what the agent primarily does * (for example: document_extraction, classification, generation, advisory). * */ agent_function?: string | null; /** * When true (default), tenants can customize the agent's behavior via the `instructions` field. * When false, `instructions` is ignored during prompt resolution — only `default_instructions` * (set at clone time by the ISV) is used. Prevents tenant customization of compliance-sensitive * or regulated-workflow agents. * */ allow_instruction_override?: boolean | null; /** * When true, tenants under this application may clone this agent into their * workspace via :create_workspace_agent. When false (default), only system * actors and ISV server keys can provision workspace copies. Only meaningful * when application_id is set. * */ allow_tenant_clone?: boolean | null; /** * When set, this agent belongs to an ISV Application definition. Null = workspace-owned. */ application_id?: string | null; /** * Optional higher-level catalog grouping for browsing and UI segmentation * (for example: operations, extraction, generation, platform_advisors). * */ catalog_family?: string | null; cloned_from_id?: string | null; default_instructions?: string | null; description?: string | null; /** * Agent execution mode: :extraction for document processing, :agentic for multi-turn tool-calling */ execution_mode?: "extraction" | "agentic"; /** * Stable catalog taxonomy for the primary input shape * (for example: document, text, transcript, brief, mixed_context). * */ input_kind?: string | null; /** * When true, non-privileged actors cannot modify `input_schema` on any AgentVersion * belonging to this agent. Only SystemActor, platform admins, and ISV owners can bypass. * */ input_schema_locked?: boolean | null; instructions?: string | null; /** * When true and application_id is set, this agent is auto-provisioned to new workspaces * created under the application. Workspace copies have workspace_id set and is_application_default: false. * */ is_application_default?: boolean | null; is_system?: boolean | null; /** * Optional platform-curated metadata populated for system agents and overridable on clones. */ metadata?: { [key: string]: unknown; } | null; name: string; /** * Stable catalog taxonomy for the primary output shape * (for example: structured_json, recommendation_json, scored_json, diagram_code). * */ output_kind?: string | null; /** * When true, non-privileged actors cannot modify `output_schema` on any AgentVersion * belonging to this agent. Only SystemActor, platform admins, and ISV owners can bypass. * Used to protect production schemas from accidental changes. * */ output_schema_locked?: boolean | null; /** * ISV-defined keyed text fragments for system prompt interpolation. * * Supports two value types per key: * - **String**: static fragment injected at every execution. The prompt placeholder * `{key}` is replaced with this string. * - **Map**: input-driven. The prompt placeholder `{key}` is replaced with the * sub-map value looked up by the execution input of the same name. * * Example: * %{ * "transcript_context" => "Always interpret as one-sided audio...", * "detail_level" => %{ * "brief" => "BRIEF: bullet points only, <400 words.", * "standard" => "STANDARD: rich bullets, 2-4 sentences each.", * "detailed" => "DETAILED: comprehensive documentation." * } * } * * With this config, a prompt template containing `{transcript_context}` and * `{detail_level}` — and an execution input of `detail_level: "standard"` — * produces the fully resolved system prompt with both placeholders substituted. * */ prompt_variants?: { [key: string]: unknown; } | null; /** * Points to the AgentVersion this agent was cloned from (for lineage tracking) */ source_version_id?: string | null; /** * Stable identifier for system agents. Matches registry slug. Immutable after creation. */ system_slug?: string | null; tags?: Array | null; /** * Denormalized from workspace for unique name constraint */ tenant_id?: string | null; /** * Industry vertical for the agent (validated against extraction.config_enums 'agent_vertical') */ vertical?: string | null; /** * List of exposed system field names to include in webhook payloads */ webhook_system_fields?: Array | null; workspace_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "agent"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agents"; }; export type PostAdminAgentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAgentsError = PostAdminAgentsErrors[keyof PostAdminAgentsErrors]; export type PostAdminAgentsResponses = { /** * Success */ 201: { data?: Agent; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAgentsResponse = PostAdminAgentsResponses[keyof PostAdminAgentsResponses]; export type GetAdminClinicalGoalTemplatesMineData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; created_by_id: string; }; url: "/admin/clinical/goal-templates/mine"; }; export type GetAdminClinicalGoalTemplatesMineErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalGoalTemplatesMineError = GetAdminClinicalGoalTemplatesMineErrors[keyof GetAdminClinicalGoalTemplatesMineErrors]; export type GetAdminClinicalGoalTemplatesMineResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-goal-template */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalGoalTemplatesMineResponse = GetAdminClinicalGoalTemplatesMineResponses[keyof GetAdminClinicalGoalTemplatesMineResponses]; export type GetAdminRecipesNutritionSummariesMealScheduleByMealScheduleIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { meal_schedule_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/nutrition-summaries/meal-schedule/{meal_schedule_id}"; }; export type GetAdminRecipesNutritionSummariesMealScheduleByMealScheduleIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesNutritionSummariesMealScheduleByMealScheduleIdError = GetAdminRecipesNutritionSummariesMealScheduleByMealScheduleIdErrors[keyof GetAdminRecipesNutritionSummariesMealScheduleByMealScheduleIdErrors]; export type GetAdminRecipesNutritionSummariesMealScheduleByMealScheduleIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a recipes-nutrition-summary */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesNutritionSummariesMealScheduleByMealScheduleIdResponse = GetAdminRecipesNutritionSummariesMealScheduleByMealScheduleIdResponses[keyof GetAdminRecipesNutritionSummariesMealScheduleByMealScheduleIdResponses]; export type PatchAdminSettlementStatementsByIdMarkReconciledData = { /** * Request body for the /settlement-statements/:id/mark-reconciled operation on settlement-statement resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "settlement-statement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/settlement-statements/{id}/mark-reconciled"; }; export type PatchAdminSettlementStatementsByIdMarkReconciledErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSettlementStatementsByIdMarkReconciledError = PatchAdminSettlementStatementsByIdMarkReconciledErrors[keyof PatchAdminSettlementStatementsByIdMarkReconciledErrors]; export type PatchAdminSettlementStatementsByIdMarkReconciledResponses = { /** * Success */ 200: { data?: SettlementStatement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSettlementStatementsByIdMarkReconciledResponse = PatchAdminSettlementStatementsByIdMarkReconciledResponses[keyof PatchAdminSettlementStatementsByIdMarkReconciledResponses]; export type DeleteAdminBrandIdentitiesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/brand-identities/{id}"; }; export type DeleteAdminBrandIdentitiesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminBrandIdentitiesByIdError = DeleteAdminBrandIdentitiesByIdErrors[keyof DeleteAdminBrandIdentitiesByIdErrors]; export type DeleteAdminBrandIdentitiesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminBrandIdentitiesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/brand-identities/{id}"; }; export type GetAdminBrandIdentitiesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminBrandIdentitiesByIdError = GetAdminBrandIdentitiesByIdErrors[keyof GetAdminBrandIdentitiesByIdErrors]; export type GetAdminBrandIdentitiesByIdResponses = { /** * Success */ 200: { data?: BrandIdentity; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminBrandIdentitiesByIdResponse = GetAdminBrandIdentitiesByIdResponses[keyof GetAdminBrandIdentitiesByIdResponses]; export type PatchAdminBrandIdentitiesByIdData = { /** * Request body for the /brand-identities/:id operation on brand-identity resource */ body?: { data: { attributes?: { color_palette?: { [key: string]: unknown; } | null; description?: string | null; industry?: string | null; logo_url?: string | null; name?: string | null; target_audience?: string | null; values?: Array | null; /** * Brand voice description (e.g., 'Professional but approachable') */ voice?: string | null; website_url?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "brand-identity"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/brand-identities/{id}"; }; export type PatchAdminBrandIdentitiesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminBrandIdentitiesByIdError = PatchAdminBrandIdentitiesByIdErrors[keyof PatchAdminBrandIdentitiesByIdErrors]; export type PatchAdminBrandIdentitiesByIdResponses = { /** * Success */ 200: { data?: BrandIdentity; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminBrandIdentitiesByIdResponse = PatchAdminBrandIdentitiesByIdResponses[keyof PatchAdminBrandIdentitiesByIdResponses]; export type PatchAdminClinicalGoalTemplatesCatalogByIdArchiveData = { /** * Request body for the /clinical/goal-templates/catalog/:id/archive operation on clinical-goal-template resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-goal-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-templates/catalog/{id}/archive"; }; export type PatchAdminClinicalGoalTemplatesCatalogByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalGoalTemplatesCatalogByIdArchiveError = PatchAdminClinicalGoalTemplatesCatalogByIdArchiveErrors[keyof PatchAdminClinicalGoalTemplatesCatalogByIdArchiveErrors]; export type PatchAdminClinicalGoalTemplatesCatalogByIdArchiveResponses = { /** * Success */ 200: { data?: ClinicalGoalTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalGoalTemplatesCatalogByIdArchiveResponse = PatchAdminClinicalGoalTemplatesCatalogByIdArchiveResponses[keyof PatchAdminClinicalGoalTemplatesCatalogByIdArchiveResponses]; export type GetAdminEmailInboundReceivedAddressByInboundAddressIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { inbound_address_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/inbound/received/address/{inbound_address_id}"; }; export type GetAdminEmailInboundReceivedAddressByInboundAddressIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailInboundReceivedAddressByInboundAddressIdError = GetAdminEmailInboundReceivedAddressByInboundAddressIdErrors[keyof GetAdminEmailInboundReceivedAddressByInboundAddressIdErrors]; export type GetAdminEmailInboundReceivedAddressByInboundAddressIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a email-inbound-email */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailInboundReceivedAddressByInboundAddressIdResponse = GetAdminEmailInboundReceivedAddressByInboundAddressIdResponses[keyof GetAdminEmailInboundReceivedAddressByInboundAddressIdResponses]; export type GetAdminClinicalPatientsByIdMedicationsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/patients/{id}/medications"; }; export type GetAdminClinicalPatientsByIdMedicationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPatientsByIdMedicationsError = GetAdminClinicalPatientsByIdMedicationsErrors[keyof GetAdminClinicalPatientsByIdMedicationsErrors]; export type GetAdminClinicalPatientsByIdMedicationsResponses = { /** * Success */ 200: { data?: ClinicalClientMedication; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPatientsByIdMedicationsResponse = GetAdminClinicalPatientsByIdMedicationsResponses[keyof GetAdminClinicalPatientsByIdMedicationsResponses]; export type GetAdminRecipesWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; status?: "draft" | "published"; created_by?: string; }; url: "/admin/recipes/workspace/{workspace_id}"; }; export type GetAdminRecipesWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesWorkspaceByWorkspaceIdError = GetAdminRecipesWorkspaceByWorkspaceIdErrors[keyof GetAdminRecipesWorkspaceByWorkspaceIdErrors]; export type GetAdminRecipesWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a recipes-recipe */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesWorkspaceByWorkspaceIdResponse = GetAdminRecipesWorkspaceByWorkspaceIdResponses[keyof GetAdminRecipesWorkspaceByWorkspaceIdResponses]; export type GetAdminClinicalHealthMetricsBySessionData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; session_id: string; }; url: "/admin/clinical/health-metrics/by-session"; }; export type GetAdminClinicalHealthMetricsBySessionErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalHealthMetricsBySessionError = GetAdminClinicalHealthMetricsBySessionErrors[keyof GetAdminClinicalHealthMetricsBySessionErrors]; export type GetAdminClinicalHealthMetricsBySessionResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-health-metric */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalHealthMetricsBySessionResponse = GetAdminClinicalHealthMetricsBySessionResponses[keyof GetAdminClinicalHealthMetricsBySessionResponses]; export type DeleteAdminAgentVersionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-versions/{id}"; }; export type DeleteAdminAgentVersionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminAgentVersionsByIdError = DeleteAdminAgentVersionsByIdErrors[keyof DeleteAdminAgentVersionsByIdErrors]; export type DeleteAdminAgentVersionsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminAgentVersionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-versions/{id}"; }; export type GetAdminAgentVersionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentVersionsByIdError = GetAdminAgentVersionsByIdErrors[keyof GetAdminAgentVersionsByIdErrors]; export type GetAdminAgentVersionsByIdResponses = { /** * Success */ 200: { data?: AgentVersion; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAgentVersionsByIdResponse = GetAdminAgentVersionsByIdResponses[keyof GetAdminAgentVersionsByIdResponses]; export type PatchAdminAgentVersionsByIdData = { /** * Request body for the /agent-versions/:id operation on agent-version resource */ body?: { data: { attributes?: { changes_summary?: string | null; /** * Strategy-specific chunking configuration */ chunking_config?: { [key: string]: unknown; } | null; /** * Document chunking strategy for multi-chunk extraction */ chunking_strategy?: "none" | "page_boundary" | "structural" | "sliding_window"; /** * Override default confidence signal weights */ confidence_weights?: { [key: string]: unknown; } | null; /** * When true, delegate_to_agent tool calls require HITL approval before child execution is created */ delegation_requires_approval?: boolean | null; /** * Maximum number of recent messages to include as conversation context. Defaults to 20 if nil. */ history_limit?: number | null; /** * JSON Schema (Draft 7) defining required input fields. nil means no input contract. */ input_schema?: { [key: string]: unknown; } | null; /** * When true, reject inputs that fail input_schema validation. */ input_strict?: boolean | null; /** * Whether this is a draft version being edited (mutually exclusive with is_active) */ is_draft?: boolean | null; max_cost_credits?: string | number | unknown; /** * Maximum number of agent loop iterations per execution */ max_iterations?: number | null; /** * Maximum number of tool calls to execute concurrently */ max_parallel_tools?: number | null; /** * Maximum total tool calls allowed per execution */ max_tool_calls?: number | null; /** * OpenRouter model ID (e.g. 'anthropic/claude-sonnet-4'). Nil = inherit from ProviderConfig. */ model_id?: string | null; /** * JSON Schema (Draft 7) defining the agent's output structure. nil means untyped. */ output_schema?: { [key: string]: unknown; } | null; /** * When true, enforce output schema via API-level structured output if model supports it. */ output_strict?: boolean | null; /** * Ordered extraction pipeline stages. Empty = single default stage. */ pipeline_stages?: Array | null; /** * Structured prompt template with system, sections, and output format. * Nil for clones — base prompt resolved at runtime via PromptResolver from source agent. * */ prompt_template?: unknown; report_delivery?: "email" | "webhook" | "storage_only"; report_format?: "pdf" | "html" | "both"; report_on_completion?: boolean | null; report_template?: string | null; soul_id?: string | null; /** * Layer 1 system core prompt. Platform-locked — only writable by system actors. * Prepended by PromptResolver before all other content (soul, base, instructions). * ISV cannot read, modify, or override this field. * */ system_preamble?: string | null; temperature?: string | number | unknown; /** * List of granted tool names for agentic execution. Stored as strings, validated against ToolRegistry. */ tool_grants?: Array | null; version_number?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "agent-version"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-versions/{id}"; }; export type PatchAdminAgentVersionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminAgentVersionsByIdError = PatchAdminAgentVersionsByIdErrors[keyof PatchAdminAgentVersionsByIdErrors]; export type PatchAdminAgentVersionsByIdResponses = { /** * Success */ 200: { data?: AgentVersion; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminAgentVersionsByIdResponse = PatchAdminAgentVersionsByIdResponses[keyof PatchAdminAgentVersionsByIdResponses]; export type GetAdminLedgerByAccountByAccountIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { account_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ledger/by-account/{account_id}"; }; export type GetAdminLedgerByAccountByAccountIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminLedgerByAccountByAccountIdError = GetAdminLedgerByAccountByAccountIdErrors[keyof GetAdminLedgerByAccountByAccountIdErrors]; export type GetAdminLedgerByAccountByAccountIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a ledger */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminLedgerByAccountByAccountIdResponse = GetAdminLedgerByAccountByAccountIdResponses[keyof GetAdminLedgerByAccountByAccountIdResponses]; export type DeleteAdminCrmRelationshipsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/relationships/{id}"; }; export type DeleteAdminCrmRelationshipsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrmRelationshipsByIdError = DeleteAdminCrmRelationshipsByIdErrors[keyof DeleteAdminCrmRelationshipsByIdErrors]; export type DeleteAdminCrmRelationshipsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCrmRelationshipsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/relationships/{id}"; }; export type GetAdminCrmRelationshipsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmRelationshipsByIdError = GetAdminCrmRelationshipsByIdErrors[keyof GetAdminCrmRelationshipsByIdErrors]; export type GetAdminCrmRelationshipsByIdResponses = { /** * Success */ 200: { data?: CrmRelationship; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmRelationshipsByIdResponse = GetAdminCrmRelationshipsByIdResponses[keyof GetAdminCrmRelationshipsByIdResponses]; export type DeleteAdminNotificationMethodsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/notification-methods/{id}"; }; export type DeleteAdminNotificationMethodsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminNotificationMethodsByIdError = DeleteAdminNotificationMethodsByIdErrors[keyof DeleteAdminNotificationMethodsByIdErrors]; export type DeleteAdminNotificationMethodsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminNotificationMethodsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/notification-methods/{id}"; }; export type GetAdminNotificationMethodsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminNotificationMethodsByIdError = GetAdminNotificationMethodsByIdErrors[keyof GetAdminNotificationMethodsByIdErrors]; export type GetAdminNotificationMethodsByIdResponses = { /** * Success */ 200: { data?: NotificationMethod; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminNotificationMethodsByIdResponse = GetAdminNotificationMethodsByIdResponses[keyof GetAdminNotificationMethodsByIdResponses]; export type PatchAdminNotificationMethodsByIdData = { /** * Request body for the /notification-methods/:id operation on notification-method resource */ body?: { data: { attributes?: { /** * Configuration for the method, e.g. %{email: 'foo@bar.com'} or %{url: '...'} */ config?: { [key: string]: unknown; } | null; /** * User-friendly name, e.g. 'Personal Email' */ name?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "notification-method"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/notification-methods/{id}"; }; export type PatchAdminNotificationMethodsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminNotificationMethodsByIdError = PatchAdminNotificationMethodsByIdErrors[keyof PatchAdminNotificationMethodsByIdErrors]; export type PatchAdminNotificationMethodsByIdResponses = { /** * Success */ 200: { data?: NotificationMethod; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminNotificationMethodsByIdResponse = PatchAdminNotificationMethodsByIdResponses[keyof PatchAdminNotificationMethodsByIdResponses]; export type PostAdminEmailMarketingCampaignsByIdCreateFollowupData = { /** * Request body for the /email-marketing/campaigns/:id/create-followup operation on campaign resource */ body: { data: { campaign_id: string; instructions: string; non_engaged_emails?: Array | null; original_body: string; original_subject: string; targeting: "unopened" | "unclicked"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/email-marketing/campaigns/{id}/create-followup"; }; export type PostAdminEmailMarketingCampaignsByIdCreateFollowupErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminEmailMarketingCampaignsByIdCreateFollowupError = PostAdminEmailMarketingCampaignsByIdCreateFollowupErrors[keyof PostAdminEmailMarketingCampaignsByIdCreateFollowupErrors]; export type PostAdminEmailMarketingCampaignsByIdCreateFollowupResponses = { /** * Success */ 201: { result: { [key: string]: unknown; }; }; }; export type PostAdminEmailMarketingCampaignsByIdCreateFollowupResponse = PostAdminEmailMarketingCampaignsByIdCreateFollowupResponses[keyof PostAdminEmailMarketingCampaignsByIdCreateFollowupResponses]; export type GetAdminExtractionResultsDocumentByDocumentIdHistoryData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { document_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/results/document/{document_id}/history"; }; export type GetAdminExtractionResultsDocumentByDocumentIdHistoryErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionResultsDocumentByDocumentIdHistoryError = GetAdminExtractionResultsDocumentByDocumentIdHistoryErrors[keyof GetAdminExtractionResultsDocumentByDocumentIdHistoryErrors]; export type GetAdminExtractionResultsDocumentByDocumentIdHistoryResponses = { /** * Success */ 200: { /** * An array of resource objects representing a extraction-result */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionResultsDocumentByDocumentIdHistoryResponse = GetAdminExtractionResultsDocumentByDocumentIdHistoryResponses[keyof GetAdminExtractionResultsDocumentByDocumentIdHistoryResponses]; export type PostAdminSupportChannelCaptureConfigsData = { /** * Request body for the /support/channel-capture-configs operation on support-channel-capture-config resource */ body: { data: { attributes?: { auto_create_tickets?: boolean | null; channel_types?: Array | null; default_queue_id?: string | null; enabled?: boolean | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "support-channel-capture-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/channel-capture-configs"; }; export type PostAdminSupportChannelCaptureConfigsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSupportChannelCaptureConfigsError = PostAdminSupportChannelCaptureConfigsErrors[keyof PostAdminSupportChannelCaptureConfigsErrors]; export type PostAdminSupportChannelCaptureConfigsResponses = { /** * Success */ 201: { data?: SupportChannelCaptureConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSupportChannelCaptureConfigsResponse = PostAdminSupportChannelCaptureConfigsResponses[keyof PostAdminSupportChannelCaptureConfigsResponses]; export type PatchAdminStorageFilesByIdSoftDeleteData = { /** * Request body for the /storage-files/:id/soft-delete operation on storage-file resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "storage-file"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/storage-files/{id}/soft-delete"; }; export type PatchAdminStorageFilesByIdSoftDeleteErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminStorageFilesByIdSoftDeleteError = PatchAdminStorageFilesByIdSoftDeleteErrors[keyof PatchAdminStorageFilesByIdSoftDeleteErrors]; export type PatchAdminStorageFilesByIdSoftDeleteResponses = { /** * Success */ 200: { data?: StorageFile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminStorageFilesByIdSoftDeleteResponse = PatchAdminStorageFilesByIdSoftDeleteResponses[keyof PatchAdminStorageFilesByIdSoftDeleteResponses]; export type PostAdminCrmDealsData = { /** * Request body for the /crm/deals operation on crm-deal resource */ body: { data: { attributes?: { amount?: string | number | unknown; application_id?: string | null; close_date?: string | null; company_id?: string | null; currency?: string | null; external_owner_id?: string | null; lost_reason?: string | null; name: string; owner_id?: string | null; pipeline_id?: string | null; pipeline_stage_id?: string | null; probability?: number | null; properties?: { [key: string]: unknown; } | null; source?: "manual" | "import" | "channel" | "connector" | "ai_extracted" | "api"; status?: "open" | "won" | "lost" | "abandoned"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "crm-deal"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/deals"; }; export type PostAdminCrmDealsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrmDealsError = PostAdminCrmDealsErrors[keyof PostAdminCrmDealsErrors]; export type PostAdminCrmDealsResponses = { /** * Success */ 201: { data?: CrmDeal; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrmDealsResponse = PostAdminCrmDealsResponses[keyof PostAdminCrmDealsResponses]; export type PatchAdminClinicalIntakeTargetsByIdArchiveData = { /** * Request body for the /clinical/intake-targets/:id/archive operation on clinical-intake-target resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-intake-target"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/intake-targets/{id}/archive"; }; export type PatchAdminClinicalIntakeTargetsByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalIntakeTargetsByIdArchiveError = PatchAdminClinicalIntakeTargetsByIdArchiveErrors[keyof PatchAdminClinicalIntakeTargetsByIdArchiveErrors]; export type PatchAdminClinicalIntakeTargetsByIdArchiveResponses = { /** * Success */ 200: { data?: ClinicalIntakeTarget; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalIntakeTargetsByIdArchiveResponse = PatchAdminClinicalIntakeTargetsByIdArchiveResponses[keyof PatchAdminClinicalIntakeTargetsByIdArchiveResponses]; export type GetAdminSchedulingEventsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/scheduling/events"; }; export type GetAdminSchedulingEventsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingEventsError = GetAdminSchedulingEventsErrors[keyof GetAdminSchedulingEventsErrors]; export type GetAdminSchedulingEventsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a scheduling-event */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingEventsResponse = GetAdminSchedulingEventsResponses[keyof GetAdminSchedulingEventsResponses]; export type PostAdminSchedulingEventsData = { /** * Request body for the /scheduling/events operation on scheduling-event resource */ body: { data: { attributes?: { description?: string | null; end_time: unknown; event_type_id?: string | null; external_calendar_id?: string | null; location?: SchedulingEventLocationInputCreateType; location_id?: string | null; location_type?: "in_person" | "video" | "phone" | "custom_url"; metadata?: { [key: string]: unknown; } | null; notes?: string | null; organizer_user_id?: string | null; recurrence_parent_id?: string | null; recurrence_rule?: SchedulingEventRecurrenceRuleInputCreateType; source?: "platform" | "external" | "booking" | "agent" | "automation"; start_time: unknown; status?: "draft" | "confirmed" | "cancelled" | "completed"; timezone?: string | null; title?: string | null; workspace_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "scheduling-event"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/events"; }; export type PostAdminSchedulingEventsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSchedulingEventsError = PostAdminSchedulingEventsErrors[keyof PostAdminSchedulingEventsErrors]; export type PostAdminSchedulingEventsResponses = { /** * Success */ 201: { data?: SchedulingEvent; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSchedulingEventsResponse = PostAdminSchedulingEventsResponses[keyof PostAdminSchedulingEventsResponses]; export type GetAdminClinicalPracticeResourcesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/practice-resources"; }; export type GetAdminClinicalPracticeResourcesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPracticeResourcesError = GetAdminClinicalPracticeResourcesErrors[keyof GetAdminClinicalPracticeResourcesErrors]; export type GetAdminClinicalPracticeResourcesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-practice-resource */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPracticeResourcesResponse = GetAdminClinicalPracticeResourcesResponses[keyof GetAdminClinicalPracticeResourcesResponses]; export type PostAdminClinicalPracticeResourcesData = { /** * Request body for the /clinical/practice-resources operation on clinical-practice-resource resource */ body: { data: { attributes?: { applicable_conditions?: Array | null; audience?: "patient" | "practitioner" | "both"; author?: string | null; category?: string | null; condition_tags?: Array | null; content_format?: "pdf" | "html" | "video_embed" | "external_link" | "interactive"; description?: string | null; estimated_duration_minutes?: number | null; icon_url?: string | null; is_active?: boolean | null; language?: string | null; license?: string | null; metadata?: { [key: string]: unknown; } | null; preview_url?: string | null; reading_level?: "basic" | "intermediate" | "advanced" | "clinical"; related_goal_types?: Array | null; resource_type?: "article" | "video" | "handout" | "worksheet" | "tool_link" | "infographic" | "audio" | "recipe" | "checklist" | "protocol" | "assessment" | "exercise" | "template" | "presentation" | "ebook" | "other"; source_catalog_id?: string | null; storage_key?: string | null; tags?: Array | null; title: string; url?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-practice-resource"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-resources"; }; export type PostAdminClinicalPracticeResourcesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalPracticeResourcesError = PostAdminClinicalPracticeResourcesErrors[keyof PostAdminClinicalPracticeResourcesErrors]; export type PostAdminClinicalPracticeResourcesResponses = { /** * Success */ 201: { data?: ClinicalPracticeResource; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalPracticeResourcesResponse = PostAdminClinicalPracticeResourcesResponses[keyof PostAdminClinicalPracticeResourcesResponses]; export type PatchAdminCatalogPriceSuggestionsByIdAcceptData = { /** * Request body for the /catalog/price-suggestions/:id/accept operation on catalog-price-suggestion resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "catalog-price-suggestion"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/price-suggestions/{id}/accept"; }; export type PatchAdminCatalogPriceSuggestionsByIdAcceptErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCatalogPriceSuggestionsByIdAcceptError = PatchAdminCatalogPriceSuggestionsByIdAcceptErrors[keyof PatchAdminCatalogPriceSuggestionsByIdAcceptErrors]; export type PatchAdminCatalogPriceSuggestionsByIdAcceptResponses = { /** * Success */ 200: { data?: CatalogPriceSuggestion; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCatalogPriceSuggestionsByIdAcceptResponse = PatchAdminCatalogPriceSuggestionsByIdAcceptResponses[keyof PatchAdminCatalogPriceSuggestionsByIdAcceptResponses]; export type GetAdminSearchAnalyticsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/search/analytics"; }; export type GetAdminSearchAnalyticsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSearchAnalyticsError = GetAdminSearchAnalyticsErrors[keyof GetAdminSearchAnalyticsErrors]; export type GetAdminSearchAnalyticsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a search-analytics */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSearchAnalyticsResponse = GetAdminSearchAnalyticsResponses[keyof GetAdminSearchAnalyticsResponses]; export type GetAdminFormGenerationsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/form-generations/{id}"; }; export type GetAdminFormGenerationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminFormGenerationsByIdError = GetAdminFormGenerationsByIdErrors[keyof GetAdminFormGenerationsByIdErrors]; export type GetAdminFormGenerationsByIdResponses = { /** * Success */ 200: { data?: FormGenerationJob; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminFormGenerationsByIdResponse = GetAdminFormGenerationsByIdResponses[keyof GetAdminFormGenerationsByIdResponses]; export type PatchAdminCampaignsSequencesByIdActivateData = { /** * Request body for the /campaigns/sequences/:id/activate operation on email-marketing-sequence resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "email-marketing-sequence"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/campaigns/sequences/{id}/activate"; }; export type PatchAdminCampaignsSequencesByIdActivateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCampaignsSequencesByIdActivateError = PatchAdminCampaignsSequencesByIdActivateErrors[keyof PatchAdminCampaignsSequencesByIdActivateErrors]; export type PatchAdminCampaignsSequencesByIdActivateResponses = { /** * Success */ 200: { data?: EmailMarketingSequence; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCampaignsSequencesByIdActivateResponse = PatchAdminCampaignsSequencesByIdActivateResponses[keyof PatchAdminCampaignsSequencesByIdActivateResponses]; export type PostAdminConnectorsByIdHealthieAppointmentsSyncData = { /** * Request body for the /connectors/:id/healthie/appointments/sync operation on connector-instance resource */ body: { data: { connector_id: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/connectors/{id}/healthie/appointments/sync"; }; export type PostAdminConnectorsByIdHealthieAppointmentsSyncErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsByIdHealthieAppointmentsSyncError = PostAdminConnectorsByIdHealthieAppointmentsSyncErrors[keyof PostAdminConnectorsByIdHealthieAppointmentsSyncErrors]; export type PostAdminConnectorsByIdHealthieAppointmentsSyncResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminConnectorsByIdHealthieAppointmentsSyncResponse = PostAdminConnectorsByIdHealthieAppointmentsSyncResponses[keyof PostAdminConnectorsByIdHealthieAppointmentsSyncResponses]; export type GetAdminLlmAnalyticsSummaryData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; start_date?: string; end_date?: string; }; url: "/admin/llm-analytics/summary"; }; export type GetAdminLlmAnalyticsSummaryErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminLlmAnalyticsSummaryError = GetAdminLlmAnalyticsSummaryErrors[keyof GetAdminLlmAnalyticsSummaryErrors]; export type GetAdminLlmAnalyticsSummaryResponses = { /** * Success */ 200: { data?: LlmAnalytics; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminLlmAnalyticsSummaryResponse = GetAdminLlmAnalyticsSummaryResponses[keyof GetAdminLlmAnalyticsSummaryResponses]; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdTrainedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; limit?: number; agent_version_id?: string; /** * Version mode: 'active' (default, filter to workspace agent's active version), 'all' (no version filtering) */ version_mode?: string; }; url: "/admin/extraction/documents/workspace/{workspace_id}/trained"; }; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdTrainedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdTrainedError = GetAdminExtractionDocumentsWorkspaceByWorkspaceIdTrainedErrors[keyof GetAdminExtractionDocumentsWorkspaceByWorkspaceIdTrainedErrors]; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdTrainedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a extraction-document */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdTrainedResponse = GetAdminExtractionDocumentsWorkspaceByWorkspaceIdTrainedResponses[keyof GetAdminExtractionDocumentsWorkspaceByWorkspaceIdTrainedResponses]; export type PostAdminTenantsPersonalData = { /** * Request body for the /tenants/personal operation on tenant resource */ body?: { data: { attributes?: { [key: string]: never; }; relationships?: { [key: string]: never; }; type?: "tenant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants/personal"; }; export type PostAdminTenantsPersonalErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminTenantsPersonalError = PostAdminTenantsPersonalErrors[keyof PostAdminTenantsPersonalErrors]; export type PostAdminTenantsPersonalResponses = { /** * Success */ 201: { data?: Tenant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminTenantsPersonalResponse = PostAdminTenantsPersonalResponses[keyof PostAdminTenantsPersonalResponses]; export type PatchAdminInvoicesByIdMarkOverdueData = { /** * Request body for the /invoices/:id/mark-overdue operation on invoices-invoice resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "invoices-invoice"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/{id}/mark-overdue"; }; export type PatchAdminInvoicesByIdMarkOverdueErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvoicesByIdMarkOverdueError = PatchAdminInvoicesByIdMarkOverdueErrors[keyof PatchAdminInvoicesByIdMarkOverdueErrors]; export type PatchAdminInvoicesByIdMarkOverdueResponses = { /** * Success */ 200: { data?: InvoicesInvoice; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvoicesByIdMarkOverdueResponse = PatchAdminInvoicesByIdMarkOverdueResponses[keyof PatchAdminInvoicesByIdMarkOverdueResponses]; export type PostAdminInvoicesLinesData = { /** * Request body for the /invoices/lines operation on invoices-line resource */ body: { data: { attributes?: { ai_gl_confidence?: string | number | unknown; ai_suggested_gl?: string | null; category?: string | null; description?: string | null; gl_code?: string | null; invoice_id: string; metadata?: { [key: string]: unknown; } | null; position?: number | null; quantity?: string | number | unknown; tax_rate?: string | number | unknown; unit_price?: string | number | unknown; }; relationships?: { [key: string]: never; }; type?: "invoices-line"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/lines"; }; export type PostAdminInvoicesLinesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminInvoicesLinesError = PostAdminInvoicesLinesErrors[keyof PostAdminInvoicesLinesErrors]; export type PostAdminInvoicesLinesResponses = { /** * Success */ 201: { data?: InvoicesLine; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminInvoicesLinesResponse = PostAdminInvoicesLinesResponses[keyof PostAdminInvoicesLinesResponses]; export type GetAdminClinicalClientGoalsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; patient_id: string; /** * Filter by goal_type value (e.g., 'habit', 'goal') */ goal_type?: string; /** * Filter by frequency (daily or weekly) */ frequency?: "daily" | "weekly"; }; url: "/admin/clinical/client-goals"; }; export type GetAdminClinicalClientGoalsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalClientGoalsError = GetAdminClinicalClientGoalsErrors[keyof GetAdminClinicalClientGoalsErrors]; export type GetAdminClinicalClientGoalsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-client-goal */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalClientGoalsResponse = GetAdminClinicalClientGoalsResponses[keyof GetAdminClinicalClientGoalsResponses]; export type PostAdminClinicalClientGoalsData = { /** * Request body for the /clinical/client-goals operation on clinical-client-goal resource */ body: { data: { attributes?: { achieved_at?: unknown; action_steps?: Array | null; category?: string | null; current_value?: string | number | unknown; description?: string | null; email_sent_at?: unknown; frequency?: "daily" | "weekly"; goal_type: string; linked_metric_type?: string | null; metadata?: { [key: string]: unknown; } | null; patient_id: string; position?: number | null; priority?: "high" | "medium" | "low"; progress_notes?: string | null; /** * Approval workflow state. Independent of `status` (lifecycle). */ review_status?: "none" | "draft" | "approved" | "rejected"; session_id?: string | null; source?: "manual" | "session" | "template"; status?: "active" | "completed" | "abandoned" | "paused" | "achieved" | "discontinued"; target_date?: string | null; target_value?: string | number | unknown; template_id?: string | null; timeframe?: string | null; title: string; tool_ids?: Array | null; unit?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-client-goal"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-goals"; }; export type PostAdminClinicalClientGoalsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalClientGoalsError = PostAdminClinicalClientGoalsErrors[keyof PostAdminClinicalClientGoalsErrors]; export type PostAdminClinicalClientGoalsResponses = { /** * Success */ 201: { data?: ClinicalClientGoal; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalClientGoalsResponse = PostAdminClinicalClientGoalsResponses[keyof PostAdminClinicalClientGoalsResponses]; export type PatchAdminCampaignsSequencesByIdResumeData = { /** * Request body for the /campaigns/sequences/:id/resume operation on email-marketing-sequence resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "email-marketing-sequence"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/campaigns/sequences/{id}/resume"; }; export type PatchAdminCampaignsSequencesByIdResumeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCampaignsSequencesByIdResumeError = PatchAdminCampaignsSequencesByIdResumeErrors[keyof PatchAdminCampaignsSequencesByIdResumeErrors]; export type PatchAdminCampaignsSequencesByIdResumeResponses = { /** * Success */ 200: { data?: EmailMarketingSequence; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCampaignsSequencesByIdResumeResponse = PatchAdminCampaignsSequencesByIdResumeResponses[keyof PatchAdminCampaignsSequencesByIdResumeResponses]; export type PatchAdminTenantsByIdAutoTopUpData = { /** * Request body for the /tenants/:id/auto-top-up operation on tenant resource */ body: { data: { attributes?: { amount: number; enabled: boolean; package_id?: string | null; threshold: number; }; id: string; relationships?: { [key: string]: never; }; type?: "tenant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants/{id}/auto-top-up"; }; export type PatchAdminTenantsByIdAutoTopUpErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminTenantsByIdAutoTopUpError = PatchAdminTenantsByIdAutoTopUpErrors[keyof PatchAdminTenantsByIdAutoTopUpErrors]; export type PatchAdminTenantsByIdAutoTopUpResponses = { /** * Success */ 200: { data?: Tenant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminTenantsByIdAutoTopUpResponse = PatchAdminTenantsByIdAutoTopUpResponses[keyof PatchAdminTenantsByIdAutoTopUpResponses]; export type GetAdminExtractionAnalysesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/analyses/{id}"; }; export type GetAdminExtractionAnalysesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionAnalysesByIdError = GetAdminExtractionAnalysesByIdErrors[keyof GetAdminExtractionAnalysesByIdErrors]; export type GetAdminExtractionAnalysesByIdResponses = { /** * Success */ 200: { data?: ExtractionAnalysis; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionAnalysesByIdResponse = GetAdminExtractionAnalysesByIdResponses[keyof GetAdminExtractionAnalysesByIdResponses]; export type PostAdminConnectorsFullscriptTreatmentPlansCreateData = { /** * Request body for the /connectors/fullscript/treatment-plans/create operation on connector-instance resource */ body: { data: { connector_id: string; message?: string | null; patient_id: string; recommendations: Array<{ [key: string]: unknown; }>; send_invitation?: boolean | null; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/connectors/fullscript/treatment-plans/create"; }; export type PostAdminConnectorsFullscriptTreatmentPlansCreateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsFullscriptTreatmentPlansCreateError = PostAdminConnectorsFullscriptTreatmentPlansCreateErrors[keyof PostAdminConnectorsFullscriptTreatmentPlansCreateErrors]; export type PostAdminConnectorsFullscriptTreatmentPlansCreateResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminConnectorsFullscriptTreatmentPlansCreateResponse = PostAdminConnectorsFullscriptTreatmentPlansCreateResponses[keyof PostAdminConnectorsFullscriptTreatmentPlansCreateResponses]; export type PostAdminContentGenerateHashtagsData = { /** * Request body for the /content/generate-hashtags operation on content-generation resource */ body: { data: { count?: number | null; industry?: string | null; platform: string; text: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/content/generate-hashtags"; }; export type PostAdminContentGenerateHashtagsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminContentGenerateHashtagsError = PostAdminContentGenerateHashtagsErrors[keyof PostAdminContentGenerateHashtagsErrors]; export type PostAdminContentGenerateHashtagsResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminContentGenerateHashtagsResponse = PostAdminContentGenerateHashtagsResponses[keyof PostAdminContentGenerateHashtagsResponses]; export type PatchAdminClinicalNoteTemplatesCatalogByIdRestoreData = { /** * Request body for the /clinical/note-templates/catalog/:id/restore operation on clinical-note-template resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-note-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/note-templates/catalog/{id}/restore"; }; export type PatchAdminClinicalNoteTemplatesCatalogByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalNoteTemplatesCatalogByIdRestoreError = PatchAdminClinicalNoteTemplatesCatalogByIdRestoreErrors[keyof PatchAdminClinicalNoteTemplatesCatalogByIdRestoreErrors]; export type PatchAdminClinicalNoteTemplatesCatalogByIdRestoreResponses = { /** * Success */ 200: { data?: ClinicalNoteTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalNoteTemplatesCatalogByIdRestoreResponse = PatchAdminClinicalNoteTemplatesCatalogByIdRestoreResponses[keyof PatchAdminClinicalNoteTemplatesCatalogByIdRestoreResponses]; export type GetAdminThreadsWorkspaceStatsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/threads/workspace-stats"; }; export type GetAdminThreadsWorkspaceStatsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminThreadsWorkspaceStatsError = GetAdminThreadsWorkspaceStatsErrors[keyof GetAdminThreadsWorkspaceStatsErrors]; export type GetAdminThreadsWorkspaceStatsResponses = { /** * Success */ 200: { data?: ChatThreadWorkspaceStats; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminThreadsWorkspaceStatsResponse = GetAdminThreadsWorkspaceStatsResponses[keyof GetAdminThreadsWorkspaceStatsResponses]; export type PostAdminApplicationsByApplicationIdEmailTemplatesBySlugPreviewData = { /** * Request body for the /applications/:application_id/email-templates/:slug/preview operation on email-template resource */ body?: { data: { sample_data?: { [key: string]: unknown; } | null; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { slug: string; application_id: string; }; query?: never; url: "/admin/applications/{application_id}/email-templates/{slug}/preview"; }; export type PostAdminApplicationsByApplicationIdEmailTemplatesBySlugPreviewErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminApplicationsByApplicationIdEmailTemplatesBySlugPreviewError = PostAdminApplicationsByApplicationIdEmailTemplatesBySlugPreviewErrors[keyof PostAdminApplicationsByApplicationIdEmailTemplatesBySlugPreviewErrors]; export type PostAdminApplicationsByApplicationIdEmailTemplatesBySlugPreviewResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminApplicationsByApplicationIdEmailTemplatesBySlugPreviewResponse = PostAdminApplicationsByApplicationIdEmailTemplatesBySlugPreviewResponses[keyof PostAdminApplicationsByApplicationIdEmailTemplatesBySlugPreviewResponses]; export type GetAdminCrmEmailAddressesEntityByEntityTypeByEntityIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { entity_type: "contact" | "company"; entity_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/email-addresses/entity/{entity_type}/{entity_id}"; }; export type GetAdminCrmEmailAddressesEntityByEntityTypeByEntityIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmEmailAddressesEntityByEntityTypeByEntityIdError = GetAdminCrmEmailAddressesEntityByEntityTypeByEntityIdErrors[keyof GetAdminCrmEmailAddressesEntityByEntityTypeByEntityIdErrors]; export type GetAdminCrmEmailAddressesEntityByEntityTypeByEntityIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crm-email-address */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmEmailAddressesEntityByEntityTypeByEntityIdResponse = GetAdminCrmEmailAddressesEntityByEntityTypeByEntityIdResponses[keyof GetAdminCrmEmailAddressesEntityByEntityTypeByEntityIdResponses]; export type GetAdminThreadsMineData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/threads/mine"; }; export type GetAdminThreadsMineErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminThreadsMineError = GetAdminThreadsMineErrors[keyof GetAdminThreadsMineErrors]; export type GetAdminThreadsMineResponses = { /** * Success */ 200: { /** * An array of resource objects representing a chat-thread */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminThreadsMineResponse = GetAdminThreadsMineResponses[keyof GetAdminThreadsMineResponses]; export type PatchAdminTenantsByIdConvertToOrgData = { /** * Request body for the /tenants/:id/convert-to-org operation on tenant resource */ body: { data: { attributes?: { application_id?: string | null; name: string; slug?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "tenant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants/{id}/convert-to-org"; }; export type PatchAdminTenantsByIdConvertToOrgErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminTenantsByIdConvertToOrgError = PatchAdminTenantsByIdConvertToOrgErrors[keyof PatchAdminTenantsByIdConvertToOrgErrors]; export type PatchAdminTenantsByIdConvertToOrgResponses = { /** * Success */ 200: { data?: Tenant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminTenantsByIdConvertToOrgResponse = PatchAdminTenantsByIdConvertToOrgResponses[keyof PatchAdminTenantsByIdConvertToOrgResponses]; export type GetAdminClinicalHealthMetricsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/health-metrics/{id}"; }; export type GetAdminClinicalHealthMetricsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalHealthMetricsByIdError = GetAdminClinicalHealthMetricsByIdErrors[keyof GetAdminClinicalHealthMetricsByIdErrors]; export type GetAdminClinicalHealthMetricsByIdResponses = { /** * Success */ 200: { data?: ClinicalHealthMetric; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalHealthMetricsByIdResponse = GetAdminClinicalHealthMetricsByIdResponses[keyof GetAdminClinicalHealthMetricsByIdResponses]; export type PatchAdminClinicalHealthMetricsByIdData = { /** * Request body for the /clinical/health-metrics/:id operation on clinical-health-metric resource */ body?: { data: { attributes?: { confidence?: string | number | unknown; context_tags?: Array | null; measured_at?: unknown; metadata?: { [key: string]: unknown; } | null; metric_category?: string | null; metric_type?: string | null; source?: string | null; unit?: string | null; value_numeric?: string | number | unknown; value_text?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-health-metric"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/health-metrics/{id}"; }; export type PatchAdminClinicalHealthMetricsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalHealthMetricsByIdError = PatchAdminClinicalHealthMetricsByIdErrors[keyof PatchAdminClinicalHealthMetricsByIdErrors]; export type PatchAdminClinicalHealthMetricsByIdResponses = { /** * Success */ 200: { data?: ClinicalHealthMetric; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalHealthMetricsByIdResponse = PatchAdminClinicalHealthMetricsByIdResponses[keyof PatchAdminClinicalHealthMetricsByIdResponses]; export type GetAdminCrmAddressesEntityByEntityTypeByEntityIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { entity_type: "contact" | "company"; entity_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/addresses/entity/{entity_type}/{entity_id}"; }; export type GetAdminCrmAddressesEntityByEntityTypeByEntityIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmAddressesEntityByEntityTypeByEntityIdError = GetAdminCrmAddressesEntityByEntityTypeByEntityIdErrors[keyof GetAdminCrmAddressesEntityByEntityTypeByEntityIdErrors]; export type GetAdminCrmAddressesEntityByEntityTypeByEntityIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crm-address */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmAddressesEntityByEntityTypeByEntityIdResponse = GetAdminCrmAddressesEntityByEntityTypeByEntityIdResponses[keyof GetAdminCrmAddressesEntityByEntityTypeByEntityIdResponses]; export type GetAdminFeatureUsagesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/feature-usages/{id}"; }; export type GetAdminFeatureUsagesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminFeatureUsagesByIdError = GetAdminFeatureUsagesByIdErrors[keyof GetAdminFeatureUsagesByIdErrors]; export type GetAdminFeatureUsagesByIdResponses = { /** * Success */ 200: { data?: FeatureUsage; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminFeatureUsagesByIdResponse = GetAdminFeatureUsagesByIdResponses[keyof GetAdminFeatureUsagesByIdResponses]; export type DeleteAdminNotificationPreferencesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/notification-preferences/{id}"; }; export type DeleteAdminNotificationPreferencesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminNotificationPreferencesByIdError = DeleteAdminNotificationPreferencesByIdErrors[keyof DeleteAdminNotificationPreferencesByIdErrors]; export type DeleteAdminNotificationPreferencesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminNotificationPreferencesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/notification-preferences/{id}"; }; export type GetAdminNotificationPreferencesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminNotificationPreferencesByIdError = GetAdminNotificationPreferencesByIdErrors[keyof GetAdminNotificationPreferencesByIdErrors]; export type GetAdminNotificationPreferencesByIdResponses = { /** * Success */ 200: { data?: NotificationPreference; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminNotificationPreferencesByIdResponse = GetAdminNotificationPreferencesByIdResponses[keyof GetAdminNotificationPreferencesByIdResponses]; export type PatchAdminNotificationPreferencesByIdData = { /** * Request body for the /notification-preferences/:id operation on notification-preference resource */ body?: { data: { attributes?: { channels?: Array | null; preferences?: { [key: string]: unknown; } | null; }; id: string; relationships?: { [key: string]: never; }; type?: "notification-preference"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/notification-preferences/{id}"; }; export type PatchAdminNotificationPreferencesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminNotificationPreferencesByIdError = PatchAdminNotificationPreferencesByIdErrors[keyof PatchAdminNotificationPreferencesByIdErrors]; export type PatchAdminNotificationPreferencesByIdResponses = { /** * Success */ 200: { data?: NotificationPreference; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminNotificationPreferencesByIdResponse = PatchAdminNotificationPreferencesByIdResponses[keyof PatchAdminNotificationPreferencesByIdResponses]; export type GetAdminSchedulingCalendarSyncsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; user_id: string; }; url: "/admin/scheduling/calendar-syncs"; }; export type GetAdminSchedulingCalendarSyncsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingCalendarSyncsError = GetAdminSchedulingCalendarSyncsErrors[keyof GetAdminSchedulingCalendarSyncsErrors]; export type GetAdminSchedulingCalendarSyncsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a scheduling-calendar-sync */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingCalendarSyncsResponse = GetAdminSchedulingCalendarSyncsResponses[keyof GetAdminSchedulingCalendarSyncsResponses]; export type PostAdminSchedulingCalendarSyncsData = { /** * Request body for the /scheduling/calendar-syncs operation on scheduling-calendar-sync resource */ body: { data: { attributes?: { baa_attestation?: SchedulingCalendarSyncBaaAttestationInputCreateType; calendar_external_id: string; calendar_name?: string | null; connector_id: string; metadata?: { [key: string]: unknown; } | null; poll_interval_minutes?: number | null; provider: "google" | "outlook"; role?: "conflict_check" | "add_events" | "both"; settings?: { [key: string]: unknown; } | null; sync_direction: "push" | "pull" | "bidirectional"; sync_method?: "poll"; user_id: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "scheduling-calendar-sync"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/calendar-syncs"; }; export type PostAdminSchedulingCalendarSyncsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSchedulingCalendarSyncsError = PostAdminSchedulingCalendarSyncsErrors[keyof PostAdminSchedulingCalendarSyncsErrors]; export type PostAdminSchedulingCalendarSyncsResponses = { /** * Success */ 201: { data?: SchedulingCalendarSync; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSchedulingCalendarSyncsResponse = PostAdminSchedulingCalendarSyncsResponses[keyof PostAdminSchedulingCalendarSyncsResponses]; export type PostAdminEmailMarketingCampaignsByIdAnalyzeData = { /** * Request body for the /email-marketing/campaigns/:id/analyze operation on campaign resource */ body: { data: { campaign_id: string; campaign_stats?: { [key: string]: unknown; } | null; recipient_segments?: string | null; tracking_summary?: string | null; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/email-marketing/campaigns/{id}/analyze"; }; export type PostAdminEmailMarketingCampaignsByIdAnalyzeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminEmailMarketingCampaignsByIdAnalyzeError = PostAdminEmailMarketingCampaignsByIdAnalyzeErrors[keyof PostAdminEmailMarketingCampaignsByIdAnalyzeErrors]; export type PostAdminEmailMarketingCampaignsByIdAnalyzeResponses = { /** * Success */ 201: { result: { [key: string]: unknown; }; }; }; export type PostAdminEmailMarketingCampaignsByIdAnalyzeResponse = PostAdminEmailMarketingCampaignsByIdAnalyzeResponses[keyof PostAdminEmailMarketingCampaignsByIdAnalyzeResponses]; export type PatchAdminReviewsByIdAssignData = { /** * Request body for the /reviews/:id/assign operation on review resource */ body?: { data: { attributes?: { assigned_user_id?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "review"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/reviews/{id}/assign"; }; export type PatchAdminReviewsByIdAssignErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminReviewsByIdAssignError = PatchAdminReviewsByIdAssignErrors[keyof PatchAdminReviewsByIdAssignErrors]; export type PatchAdminReviewsByIdAssignResponses = { /** * Success */ 200: { data?: Review; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminReviewsByIdAssignResponse = PatchAdminReviewsByIdAssignResponses[keyof PatchAdminReviewsByIdAssignResponses]; export type PostAdminCrmCustomEntitiesData = { /** * Request body for the /crm/custom-entities operation on crm-custom-entity resource */ body: { data: { attributes?: { application_id?: string | null; contact_id?: string | null; custom_entity_type_id: string; external_owner_id?: string | null; name: string; owner_id?: string | null; pipeline_id?: string | null; pipeline_stage_id?: string | null; properties?: { [key: string]: unknown; } | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "crm-custom-entity"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/custom-entities"; }; export type PostAdminCrmCustomEntitiesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrmCustomEntitiesError = PostAdminCrmCustomEntitiesErrors[keyof PostAdminCrmCustomEntitiesErrors]; export type PostAdminCrmCustomEntitiesResponses = { /** * Success */ 201: { data?: CrmCustomEntity; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrmCustomEntitiesResponse = PostAdminCrmCustomEntitiesResponses[keyof PostAdminCrmCustomEntitiesResponses]; export type PostAdminConnectorsCredentialsDeleteByTypeData = { /** * Request body for the /connectors/credentials/delete-by-type operation on credential resource */ body: { data: { connector_type: "salesforce" | "hubspot" | "slack" | "notion" | "sharepoint" | "gmail" | "outlook" | "microsoft_365" | "practice_better" | "jira" | "confluence" | "fullscript" | "fhir_r4" | "github" | "gitlab" | "google_calendar" | "google_chat" | "custom" | "edamam" | "facebook" | "instagram" | "threads" | "twitter" | "linkedin" | "reddit" | "bluesky" | "newsapi" | "gnews" | "bing_news" | "corehealth" | "healthie"; scope_level: "workspace" | "tenant" | "application"; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/connectors/credentials/delete-by-type"; }; export type PostAdminConnectorsCredentialsDeleteByTypeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsCredentialsDeleteByTypeError = PostAdminConnectorsCredentialsDeleteByTypeErrors[keyof PostAdminConnectorsCredentialsDeleteByTypeErrors]; export type PostAdminConnectorsCredentialsDeleteByTypeResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminConnectorsCredentialsDeleteByTypeResponse = PostAdminConnectorsCredentialsDeleteByTypeResponses[keyof PostAdminConnectorsCredentialsDeleteByTypeResponses]; export type PatchAdminAccountsByIdCreditData = { /** * Request body for the /accounts/:id/credit operation on account resource */ body: { data: { attributes?: { amount: number; description?: string | null; operation?: "topup" | "subscription" | "refund" | "adjustment" | "promotional"; source_account_id?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "account"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/accounts/{id}/credit"; }; export type PatchAdminAccountsByIdCreditErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminAccountsByIdCreditError = PatchAdminAccountsByIdCreditErrors[keyof PatchAdminAccountsByIdCreditErrors]; export type PatchAdminAccountsByIdCreditResponses = { /** * Success */ 200: { data?: Account; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminAccountsByIdCreditResponse = PatchAdminAccountsByIdCreditResponses[keyof PatchAdminAccountsByIdCreditResponses]; export type GetAdminStorageFilesChildrenData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; parent_id: string; }; url: "/admin/storage-files/children"; }; export type GetAdminStorageFilesChildrenErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminStorageFilesChildrenError = GetAdminStorageFilesChildrenErrors[keyof GetAdminStorageFilesChildrenErrors]; export type GetAdminStorageFilesChildrenResponses = { /** * Success */ 200: { data?: StorageFile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminStorageFilesChildrenResponse = GetAdminStorageFilesChildrenResponses[keyof GetAdminStorageFilesChildrenResponses]; export type PostAdminDocumentsPresignedUploadData = { /** * Request body for the /documents/presigned-upload operation on presigned-url resource */ body: { data: { attributes?: { filename: string; mime_type: string; size_bytes: number; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "presigned-url"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/documents/presigned-upload"; }; export type PostAdminDocumentsPresignedUploadErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminDocumentsPresignedUploadError = PostAdminDocumentsPresignedUploadErrors[keyof PostAdminDocumentsPresignedUploadErrors]; export type PostAdminDocumentsPresignedUploadResponses = { /** * Success */ 201: { data?: PresignedUrl; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminDocumentsPresignedUploadResponse = PostAdminDocumentsPresignedUploadResponses[keyof PostAdminDocumentsPresignedUploadResponses]; export type DeleteAdminWorkspacesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspaces/{id}"; }; export type DeleteAdminWorkspacesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminWorkspacesByIdError = DeleteAdminWorkspacesByIdErrors[keyof DeleteAdminWorkspacesByIdErrors]; export type DeleteAdminWorkspacesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminWorkspacesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; include_archived?: boolean; }; url: "/admin/workspaces/{id}"; }; export type GetAdminWorkspacesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWorkspacesByIdError = GetAdminWorkspacesByIdErrors[keyof GetAdminWorkspacesByIdErrors]; export type GetAdminWorkspacesByIdResponses = { /** * Success */ 200: { data?: Workspace; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWorkspacesByIdResponse = GetAdminWorkspacesByIdResponses[keyof GetAdminWorkspacesByIdResponses]; export type PatchAdminWorkspacesByIdData = { /** * Request body for the /workspaces/:id operation on workspace resource */ body?: { data: { attributes?: { /** * Required - the application this workspace belongs to */ application_id?: string | null; /** * When enabled, duplicate files (by SHA256 hash) are rejected */ deduplicate_uploads?: boolean | null; is_default?: boolean | null; low_balance_threshold?: number | null; name?: string | null; /** * ISV/app-defined metadata. Arbitrary key-value pairs for app-specific state. */ properties?: { [key: string]: unknown; } | null; settings?: WorkspaceSettingsInputUpdateType; slug?: string | null; /** * Memorable slug for vanity URLs */ vanity_slug?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "workspace"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspaces/{id}"; }; export type PatchAdminWorkspacesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminWorkspacesByIdError = PatchAdminWorkspacesByIdErrors[keyof PatchAdminWorkspacesByIdErrors]; export type PatchAdminWorkspacesByIdResponses = { /** * Success */ 200: { data?: Workspace; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminWorkspacesByIdResponse = PatchAdminWorkspacesByIdResponses[keyof PatchAdminWorkspacesByIdResponses]; export type GetAdminReviewsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/reviews/{id}"; }; export type GetAdminReviewsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminReviewsByIdError = GetAdminReviewsByIdErrors[keyof GetAdminReviewsByIdErrors]; export type GetAdminReviewsByIdResponses = { /** * Success */ 200: { data?: Review; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminReviewsByIdResponse = GetAdminReviewsByIdResponses[keyof GetAdminReviewsByIdResponses]; export type GetAdminClinicalIntakeTargetsByWorkspaceData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/intake-targets/by-workspace"; }; export type GetAdminClinicalIntakeTargetsByWorkspaceErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalIntakeTargetsByWorkspaceError = GetAdminClinicalIntakeTargetsByWorkspaceErrors[keyof GetAdminClinicalIntakeTargetsByWorkspaceErrors]; export type GetAdminClinicalIntakeTargetsByWorkspaceResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-intake-target */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalIntakeTargetsByWorkspaceResponse = GetAdminClinicalIntakeTargetsByWorkspaceResponses[keyof GetAdminClinicalIntakeTargetsByWorkspaceResponses]; export type DeleteAdminInvoicesLinesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/lines/{id}"; }; export type DeleteAdminInvoicesLinesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminInvoicesLinesByIdError = DeleteAdminInvoicesLinesByIdErrors[keyof DeleteAdminInvoicesLinesByIdErrors]; export type DeleteAdminInvoicesLinesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminInvoicesLinesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/lines/{id}"; }; export type GetAdminInvoicesLinesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminInvoicesLinesByIdError = GetAdminInvoicesLinesByIdErrors[keyof GetAdminInvoicesLinesByIdErrors]; export type GetAdminInvoicesLinesByIdResponses = { /** * Success */ 200: { data?: InvoicesLine; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminInvoicesLinesByIdResponse = GetAdminInvoicesLinesByIdResponses[keyof GetAdminInvoicesLinesByIdResponses]; export type PatchAdminInvoicesLinesByIdData = { /** * Request body for the /invoices/lines/:id operation on invoices-line resource */ body?: { data: { attributes?: { ai_gl_confidence?: string | number | unknown; ai_suggested_gl?: string | null; category?: string | null; description?: string | null; gl_code?: string | null; metadata?: { [key: string]: unknown; } | null; position?: number | null; quantity?: string | number | unknown; tax_rate?: string | number | unknown; unit_price?: string | number | unknown; }; id: string; relationships?: { [key: string]: never; }; type?: "invoices-line"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/lines/{id}"; }; export type PatchAdminInvoicesLinesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvoicesLinesByIdError = PatchAdminInvoicesLinesByIdErrors[keyof PatchAdminInvoicesLinesByIdErrors]; export type PatchAdminInvoicesLinesByIdResponses = { /** * Success */ 200: { data?: InvoicesLine; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvoicesLinesByIdResponse = PatchAdminInvoicesLinesByIdResponses[keyof PatchAdminInvoicesLinesByIdResponses]; export type PatchAdminRecipesByIdReEnrichData = { /** * Request body for the /recipes/:id/re-enrich operation on recipes-recipe resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "recipes-recipe"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/{id}/re-enrich"; }; export type PatchAdminRecipesByIdReEnrichErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminRecipesByIdReEnrichError = PatchAdminRecipesByIdReEnrichErrors[keyof PatchAdminRecipesByIdReEnrichErrors]; export type PatchAdminRecipesByIdReEnrichResponses = { /** * Success */ 200: { data?: RecipesRecipe; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminRecipesByIdReEnrichResponse = PatchAdminRecipesByIdReEnrichResponses[keyof PatchAdminRecipesByIdReEnrichResponses]; export type DeleteAdminIsvCrmEntityTypesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/isv/crm/entity-types/{id}"; }; export type DeleteAdminIsvCrmEntityTypesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminIsvCrmEntityTypesByIdError = DeleteAdminIsvCrmEntityTypesByIdErrors[keyof DeleteAdminIsvCrmEntityTypesByIdErrors]; export type DeleteAdminIsvCrmEntityTypesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminIsvCrmEntityTypesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/isv/crm/entity-types/{id}"; }; export type GetAdminIsvCrmEntityTypesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminIsvCrmEntityTypesByIdError = GetAdminIsvCrmEntityTypesByIdErrors[keyof GetAdminIsvCrmEntityTypesByIdErrors]; export type GetAdminIsvCrmEntityTypesByIdResponses = { /** * Success */ 200: { data?: CrmCustomEntityType; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminIsvCrmEntityTypesByIdResponse = GetAdminIsvCrmEntityTypesByIdResponses[keyof GetAdminIsvCrmEntityTypesByIdResponses]; export type PatchAdminIsvCrmEntityTypesByIdData = { /** * Request body for the /isv/crm/entity-types/:id operation on crm-custom-entity-type resource */ body?: { data: { attributes?: { field_definitions?: Array<{ [key: string]: unknown; }> | null; icon?: string | null; /** * Optional alias used as an include key in CRM data exports. When set, this * alias can be passed in the `include` array of a DataExportJob to embed * custom entities of this type into contact exports. If nil, the type is * not available as an export include. Must be unique per application. * Example: a CustomEntityType with slug "client_goals" and include_alias "goals" * allows `include: ["goals"]` in export requests. * */ include_alias?: string | null; name?: string | null; pipelineable?: boolean | null; relationships_config?: { [key: string]: unknown; } | null; searchable?: boolean | null; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-custom-entity-type"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/isv/crm/entity-types/{id}"; }; export type PatchAdminIsvCrmEntityTypesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminIsvCrmEntityTypesByIdError = PatchAdminIsvCrmEntityTypesByIdErrors[keyof PatchAdminIsvCrmEntityTypesByIdErrors]; export type PatchAdminIsvCrmEntityTypesByIdResponses = { /** * Success */ 200: { data?: CrmCustomEntityType; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminIsvCrmEntityTypesByIdResponse = PatchAdminIsvCrmEntityTypesByIdResponses[keyof PatchAdminIsvCrmEntityTypesByIdResponses]; export type GetAdminReviewQueuesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/review-queues"; }; export type GetAdminReviewQueuesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminReviewQueuesError = GetAdminReviewQueuesErrors[keyof GetAdminReviewQueuesErrors]; export type GetAdminReviewQueuesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a review-queue */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminReviewQueuesResponse = GetAdminReviewQueuesResponses[keyof GetAdminReviewQueuesResponses]; export type PostAdminReviewQueuesData = { /** * Request body for the /review-queues operation on review-queue resource */ body: { data: { attributes?: { default_sla_minutes?: number | null; description?: string | null; name: string; slug: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "review-queue"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/review-queues"; }; export type PostAdminReviewQueuesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminReviewQueuesError = PostAdminReviewQueuesErrors[keyof PostAdminReviewQueuesErrors]; export type PostAdminReviewQueuesResponses = { /** * Success */ 201: { data?: ReviewQueue; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminReviewQueuesResponse = PostAdminReviewQueuesResponses[keyof PostAdminReviewQueuesResponses]; export type GetAdminWorkspacesByWorkspaceIdTrainingAnalyticsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspaces/{workspace_id}/training/analytics"; }; export type GetAdminWorkspacesByWorkspaceIdTrainingAnalyticsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWorkspacesByWorkspaceIdTrainingAnalyticsError = GetAdminWorkspacesByWorkspaceIdTrainingAnalyticsErrors[keyof GetAdminWorkspacesByWorkspaceIdTrainingAnalyticsErrors]; export type GetAdminWorkspacesByWorkspaceIdTrainingAnalyticsResponses = { /** * Success */ 200: { data?: TrainingAnalytics; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWorkspacesByWorkspaceIdTrainingAnalyticsResponse = GetAdminWorkspacesByWorkspaceIdTrainingAnalyticsResponses[keyof GetAdminWorkspacesByWorkspaceIdTrainingAnalyticsResponses]; export type PostAdminRecipesMealSchedulesData = { /** * Request body for the /recipes/meal-schedules operation on recipes-meal-schedule resource */ body: { data: { attributes?: { contact_id?: string | null; end_date?: string | null; name: string; start_date?: string | null; status?: "draft" | "active" | "completed"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "recipes-meal-schedule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/meal-schedules"; }; export type PostAdminRecipesMealSchedulesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminRecipesMealSchedulesError = PostAdminRecipesMealSchedulesErrors[keyof PostAdminRecipesMealSchedulesErrors]; export type PostAdminRecipesMealSchedulesResponses = { /** * Success */ 201: { data?: RecipesMealSchedule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminRecipesMealSchedulesResponse = PostAdminRecipesMealSchedulesResponses[keyof PostAdminRecipesMealSchedulesResponses]; export type GetAdminClinicalMealPlansByPatientData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; patient_id: string; }; url: "/admin/clinical/meal-plans/by-patient"; }; export type GetAdminClinicalMealPlansByPatientErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalMealPlansByPatientError = GetAdminClinicalMealPlansByPatientErrors[keyof GetAdminClinicalMealPlansByPatientErrors]; export type GetAdminClinicalMealPlansByPatientResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-meal-plan */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalMealPlansByPatientResponse = GetAdminClinicalMealPlansByPatientResponses[keyof GetAdminClinicalMealPlansByPatientResponses]; export type PostAdminCampaignsSequenceStepsData = { /** * Request body for the /campaigns/sequence-steps operation on email-marketing-sequence-step resource */ body: { data: { attributes?: { ai_instructions?: string | null; body_template?: string | null; delay_hours?: number | null; position: number; segment_filter?: { [key: string]: unknown; } | null; sequence_id: string; subject_template?: string | null; template_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "email-marketing-sequence-step"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/campaigns/sequence-steps"; }; export type PostAdminCampaignsSequenceStepsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCampaignsSequenceStepsError = PostAdminCampaignsSequenceStepsErrors[keyof PostAdminCampaignsSequenceStepsErrors]; export type PostAdminCampaignsSequenceStepsResponses = { /** * Success */ 201: { data?: EmailMarketingSequenceStep; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCampaignsSequenceStepsResponse = PostAdminCampaignsSequenceStepsResponses[keyof PostAdminCampaignsSequenceStepsResponses]; export type GetAdminAiGraphNodesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ai/graph/nodes"; }; export type GetAdminAiGraphNodesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAiGraphNodesError = GetAdminAiGraphNodesErrors[keyof GetAdminAiGraphNodesErrors]; export type GetAdminAiGraphNodesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a graph-node */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAiGraphNodesResponse = GetAdminAiGraphNodesResponses[keyof GetAdminAiGraphNodesResponses]; export type PostAdminAiGraphNodesData = { /** * Request body for the /ai/graph/nodes operation on graph-node resource */ body: { data: { attributes?: { document_id?: string | null; entity_type?: string | null; label: string; properties?: { [key: string]: unknown; } | null; workspace_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "graph-node"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ai/graph/nodes"; }; export type PostAdminAiGraphNodesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAiGraphNodesError = PostAdminAiGraphNodesErrors[keyof PostAdminAiGraphNodesErrors]; export type PostAdminAiGraphNodesResponses = { /** * Success */ 201: { data?: GraphNode; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAiGraphNodesResponse = PostAdminAiGraphNodesResponses[keyof PostAdminAiGraphNodesResponses]; export type PatchAdminEmailMarketingGeneratedEmailsByIdRejectData = { /** * Request body for the /email-marketing/generated-emails/:id/reject operation on email-marketing-generated-email resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "email-marketing-generated-email"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/generated-emails/{id}/reject"; }; export type PatchAdminEmailMarketingGeneratedEmailsByIdRejectErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailMarketingGeneratedEmailsByIdRejectError = PatchAdminEmailMarketingGeneratedEmailsByIdRejectErrors[keyof PatchAdminEmailMarketingGeneratedEmailsByIdRejectErrors]; export type PatchAdminEmailMarketingGeneratedEmailsByIdRejectResponses = { /** * Success */ 200: { data?: EmailMarketingGeneratedEmail; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailMarketingGeneratedEmailsByIdRejectResponse = PatchAdminEmailMarketingGeneratedEmailsByIdRejectResponses[keyof PatchAdminEmailMarketingGeneratedEmailsByIdRejectResponses]; export type GetAdminCrmPipelineStagesPipelineByPipelineIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { pipeline_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/pipeline-stages/pipeline/{pipeline_id}"; }; export type GetAdminCrmPipelineStagesPipelineByPipelineIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmPipelineStagesPipelineByPipelineIdError = GetAdminCrmPipelineStagesPipelineByPipelineIdErrors[keyof GetAdminCrmPipelineStagesPipelineByPipelineIdErrors]; export type GetAdminCrmPipelineStagesPipelineByPipelineIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crm-pipeline-stage */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmPipelineStagesPipelineByPipelineIdResponse = GetAdminCrmPipelineStagesPipelineByPipelineIdResponses[keyof GetAdminCrmPipelineStagesPipelineByPipelineIdResponses]; export type PostAdminUsersAuthResendConfirmationData = { /** * Request body for the /users/auth/resend-confirmation operation on user resource */ body: { data: { attributes?: { email: string; }; relationships?: { [key: string]: never; }; type?: "user"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/users/auth/resend-confirmation"; }; export type PostAdminUsersAuthResendConfirmationErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminUsersAuthResendConfirmationError = PostAdminUsersAuthResendConfirmationErrors[keyof PostAdminUsersAuthResendConfirmationErrors]; export type PostAdminUsersAuthResendConfirmationResponses = { /** * Success */ 201: { data?: User; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminUsersAuthResendConfirmationResponse = PostAdminUsersAuthResendConfirmationResponses[keyof PostAdminUsersAuthResendConfirmationResponses]; export type GetAdminTrainingSessionsAgentsByAgentIdSessionsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { agent_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/training-sessions/agents/{agent_id}/sessions"; }; export type GetAdminTrainingSessionsAgentsByAgentIdSessionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminTrainingSessionsAgentsByAgentIdSessionsError = GetAdminTrainingSessionsAgentsByAgentIdSessionsErrors[keyof GetAdminTrainingSessionsAgentsByAgentIdSessionsErrors]; export type GetAdminTrainingSessionsAgentsByAgentIdSessionsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a training-session */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminTrainingSessionsAgentsByAgentIdSessionsResponse = GetAdminTrainingSessionsAgentsByAgentIdSessionsResponses[keyof GetAdminTrainingSessionsAgentsByAgentIdSessionsResponses]; export type PatchAdminExtractionDocumentsByIdCancelData = { /** * Request body for the /extraction/documents/:id/cancel operation on extraction-document resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "extraction-document"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/documents/{id}/cancel"; }; export type PatchAdminExtractionDocumentsByIdCancelErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminExtractionDocumentsByIdCancelError = PatchAdminExtractionDocumentsByIdCancelErrors[keyof PatchAdminExtractionDocumentsByIdCancelErrors]; export type PatchAdminExtractionDocumentsByIdCancelResponses = { /** * Success */ 200: { data?: ExtractionDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminExtractionDocumentsByIdCancelResponse = PatchAdminExtractionDocumentsByIdCancelResponses[keyof PatchAdminExtractionDocumentsByIdCancelResponses]; export type GetAdminTenantPricingOverridesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenant-pricing-overrides"; }; export type GetAdminTenantPricingOverridesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminTenantPricingOverridesError = GetAdminTenantPricingOverridesErrors[keyof GetAdminTenantPricingOverridesErrors]; export type GetAdminTenantPricingOverridesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a tenant-pricing-override */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminTenantPricingOverridesResponse = GetAdminTenantPricingOverridesResponses[keyof GetAdminTenantPricingOverridesResponses]; export type PostAdminTenantPricingOverridesData = { /** * Request body for the /tenant-pricing-overrides operation on tenant-pricing-override resource */ body: { data: { attributes?: { application_id: string; /** * When this override expires. NULL means no expiration. */ expires_at?: unknown; floor_price?: { amount: string; currency: string; } | unknown; margin_percent?: number | null; /** * Audit trail: why this override was created (e.g., 'Volume discount', 'Promotional pricing') */ reason?: string | null; service_id: string; tenant_id: string; }; relationships?: { [key: string]: never; }; type?: "tenant-pricing-override"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenant-pricing-overrides"; }; export type PostAdminTenantPricingOverridesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminTenantPricingOverridesError = PostAdminTenantPricingOverridesErrors[keyof PostAdminTenantPricingOverridesErrors]; export type PostAdminTenantPricingOverridesResponses = { /** * Success */ 201: { data?: TenantPricingOverride; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminTenantPricingOverridesResponse = PostAdminTenantPricingOverridesResponses[keyof PostAdminTenantPricingOverridesResponses]; export type GetAdminSearchStatusData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/search/status"; }; export type GetAdminSearchStatusErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSearchStatusError = GetAdminSearchStatusErrors[keyof GetAdminSearchStatusErrors]; export type GetAdminSearchStatusResponses = { /** * Success */ 200: { /** * An array of resource objects representing a search */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSearchStatusResponse = GetAdminSearchStatusResponses[keyof GetAdminSearchStatusResponses]; export type PostAdminAgentTestResultsData = { /** * Request body for the /agent-test-results operation on agent-test-result resource */ body: { data: { attributes?: { agent_version_id: string; content: string; document_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "agent-test-result"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-test-results"; }; export type PostAdminAgentTestResultsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAgentTestResultsError = PostAdminAgentTestResultsErrors[keyof PostAdminAgentTestResultsErrors]; export type PostAdminAgentTestResultsResponses = { /** * Success */ 201: { data?: AgentTestResult; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAgentTestResultsResponse = PostAdminAgentTestResultsResponses[keyof PostAdminAgentTestResultsResponses]; export type PatchAdminEmailMarketingTemplatesByIdUnpublishData = { /** * Request body for the /email-marketing/templates/:id/unpublish operation on email-marketing-template resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "email-marketing-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/templates/{id}/unpublish"; }; export type PatchAdminEmailMarketingTemplatesByIdUnpublishErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailMarketingTemplatesByIdUnpublishError = PatchAdminEmailMarketingTemplatesByIdUnpublishErrors[keyof PatchAdminEmailMarketingTemplatesByIdUnpublishErrors]; export type PatchAdminEmailMarketingTemplatesByIdUnpublishResponses = { /** * Success */ 200: { data?: EmailMarketingTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailMarketingTemplatesByIdUnpublishResponse = PatchAdminEmailMarketingTemplatesByIdUnpublishResponses[keyof PatchAdminEmailMarketingTemplatesByIdUnpublishResponses]; export type DeleteAdminClinicalDocumentsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/documents/{id}"; }; export type DeleteAdminClinicalDocumentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalDocumentsByIdError = DeleteAdminClinicalDocumentsByIdErrors[keyof DeleteAdminClinicalDocumentsByIdErrors]; export type DeleteAdminClinicalDocumentsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminClinicalDocumentsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/documents/{id}"; }; export type GetAdminClinicalDocumentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalDocumentsByIdError = GetAdminClinicalDocumentsByIdErrors[keyof GetAdminClinicalDocumentsByIdErrors]; export type GetAdminClinicalDocumentsByIdResponses = { /** * Success */ 200: { data?: ClinicalDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalDocumentsByIdResponse = GetAdminClinicalDocumentsByIdResponses[keyof GetAdminClinicalDocumentsByIdResponses]; export type PatchAdminClinicalDocumentsByIdData = { /** * Request body for the /clinical/documents/:id operation on clinical-document resource */ body?: { data: { attributes?: { contact_id?: string | null; document_type?: string | null; expires_at?: unknown; source_date?: string | null; source_platform?: string | null; title?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-document"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/documents/{id}"; }; export type PatchAdminClinicalDocumentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalDocumentsByIdError = PatchAdminClinicalDocumentsByIdErrors[keyof PatchAdminClinicalDocumentsByIdErrors]; export type PatchAdminClinicalDocumentsByIdResponses = { /** * Success */ 200: { data?: ClinicalDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalDocumentsByIdResponse = PatchAdminClinicalDocumentsByIdResponses[keyof PatchAdminClinicalDocumentsByIdResponses]; export type PatchAdminBreachNotificationArtifactsByIdSendData = { /** * Request body for the /breach-notification-artifacts/:id/send operation on breach-notification-artifact resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "breach-notification-artifact"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/breach-notification-artifacts/{id}/send"; }; export type PatchAdminBreachNotificationArtifactsByIdSendErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminBreachNotificationArtifactsByIdSendError = PatchAdminBreachNotificationArtifactsByIdSendErrors[keyof PatchAdminBreachNotificationArtifactsByIdSendErrors]; export type PatchAdminBreachNotificationArtifactsByIdSendResponses = { /** * Success */ 200: { data?: BreachNotificationArtifact; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminBreachNotificationArtifactsByIdSendResponse = PatchAdminBreachNotificationArtifactsByIdSendResponses[keyof PatchAdminBreachNotificationArtifactsByIdSendResponses]; export type PostAdminCrmWebsitesData = { /** * Request body for the /crm/websites operation on crm-website resource */ body: { data: { attributes?: { entity_id: string; entity_type: "contact" | "company"; is_primary?: boolean | null; label?: "main" | "careers" | "blog" | "docs" | "portfolio" | "other"; url: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "crm-website"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/websites"; }; export type PostAdminCrmWebsitesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrmWebsitesError = PostAdminCrmWebsitesErrors[keyof PostAdminCrmWebsitesErrors]; export type PostAdminCrmWebsitesResponses = { /** * Success */ 201: { data?: CrmWebsite; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrmWebsitesResponse = PostAdminCrmWebsitesResponses[keyof PostAdminCrmWebsitesResponses]; export type PostAdminWebhookConfigsByIdReplayData = { /** * Request body for the /webhook-configs/:id/replay operation on webhook-config resource */ body?: { data: { date_range?: { [key: string]: unknown; } | null; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/webhook-configs/{id}/replay"; }; export type PostAdminWebhookConfigsByIdReplayErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminWebhookConfigsByIdReplayError = PostAdminWebhookConfigsByIdReplayErrors[keyof PostAdminWebhookConfigsByIdReplayErrors]; export type PostAdminWebhookConfigsByIdReplayResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminWebhookConfigsByIdReplayResponse = PostAdminWebhookConfigsByIdReplayResponses[keyof PostAdminWebhookConfigsByIdReplayResponses]; export type DeleteAdminClaimedDomainsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/claimed-domains/{id}"; }; export type DeleteAdminClaimedDomainsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClaimedDomainsByIdError = DeleteAdminClaimedDomainsByIdErrors[keyof DeleteAdminClaimedDomainsByIdErrors]; export type DeleteAdminClaimedDomainsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminClaimedDomainsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/claimed-domains/{id}"; }; export type GetAdminClaimedDomainsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClaimedDomainsByIdError = GetAdminClaimedDomainsByIdErrors[keyof GetAdminClaimedDomainsByIdErrors]; export type GetAdminClaimedDomainsByIdResponses = { /** * Success */ 200: { data?: ClaimedDomain; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClaimedDomainsByIdResponse = GetAdminClaimedDomainsByIdResponses[keyof GetAdminClaimedDomainsByIdResponses]; export type PatchAdminClaimedDomainsByIdData = { /** * Request body for the /claimed-domains/:id operation on claimed-domain resource */ body?: { data: { attributes?: { /** * Workspace IDs to auto-add users to on domain join */ auto_join_workspace_ids?: Array | null; /** * Role assigned to auto-joined users */ default_role?: "admin" | "member"; /** * Role assigned in auto-joined workspaces */ default_workspace_role?: "admin" | "editor" | "viewer"; }; id: string; relationships?: { [key: string]: never; }; type?: "claimed-domain"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/claimed-domains/{id}"; }; export type PatchAdminClaimedDomainsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClaimedDomainsByIdError = PatchAdminClaimedDomainsByIdErrors[keyof PatchAdminClaimedDomainsByIdErrors]; export type PatchAdminClaimedDomainsByIdResponses = { /** * Success */ 200: { data?: ClaimedDomain; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClaimedDomainsByIdResponse = PatchAdminClaimedDomainsByIdResponses[keyof PatchAdminClaimedDomainsByIdResponses]; export type GetAdminUsersMeData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/users/me"; }; export type GetAdminUsersMeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminUsersMeError = GetAdminUsersMeErrors[keyof GetAdminUsersMeErrors]; export type GetAdminUsersMeResponses = { /** * Success */ 200: { data?: User; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminUsersMeResponse = GetAdminUsersMeResponses[keyof GetAdminUsersMeResponses]; export type PatchAdminInvoicesByIdDisputeData = { /** * Request body for the /invoices/:id/dispute operation on invoices-invoice resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "invoices-invoice"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/{id}/dispute"; }; export type PatchAdminInvoicesByIdDisputeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvoicesByIdDisputeError = PatchAdminInvoicesByIdDisputeErrors[keyof PatchAdminInvoicesByIdDisputeErrors]; export type PatchAdminInvoicesByIdDisputeResponses = { /** * Success */ 200: { data?: InvoicesInvoice; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvoicesByIdDisputeResponse = PatchAdminInvoicesByIdDisputeResponses[keyof PatchAdminInvoicesByIdDisputeResponses]; export type PatchAdminSocialPostsByIdScheduleData = { /** * Request body for the /social/posts/:id/schedule operation on social-post resource */ body?: { data: { attributes?: { scheduled_at?: unknown; }; id: string; relationships?: { [key: string]: never; }; type?: "social-post"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/posts/{id}/schedule"; }; export type PatchAdminSocialPostsByIdScheduleErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSocialPostsByIdScheduleError = PatchAdminSocialPostsByIdScheduleErrors[keyof PatchAdminSocialPostsByIdScheduleErrors]; export type PatchAdminSocialPostsByIdScheduleResponses = { /** * Success */ 200: { data?: SocialPost; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSocialPostsByIdScheduleResponse = PatchAdminSocialPostsByIdScheduleResponses[keyof PatchAdminSocialPostsByIdScheduleResponses]; export type DeleteAdminCrawlerBrowserSessionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/browser-sessions/{id}"; }; export type DeleteAdminCrawlerBrowserSessionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrawlerBrowserSessionsByIdError = DeleteAdminCrawlerBrowserSessionsByIdErrors[keyof DeleteAdminCrawlerBrowserSessionsByIdErrors]; export type DeleteAdminCrawlerBrowserSessionsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCrawlerBrowserSessionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/browser-sessions/{id}"; }; export type GetAdminCrawlerBrowserSessionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrawlerBrowserSessionsByIdError = GetAdminCrawlerBrowserSessionsByIdErrors[keyof GetAdminCrawlerBrowserSessionsByIdErrors]; export type GetAdminCrawlerBrowserSessionsByIdResponses = { /** * Success */ 200: { data?: BrowserSession; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrawlerBrowserSessionsByIdResponse = GetAdminCrawlerBrowserSessionsByIdResponses[keyof GetAdminCrawlerBrowserSessionsByIdResponses]; export type PatchAdminSocialAccountsByIdDisablePostingData = { /** * Request body for the /social/accounts/:id/disable-posting operation on social-account resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "social-account"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/accounts/{id}/disable-posting"; }; export type PatchAdminSocialAccountsByIdDisablePostingErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSocialAccountsByIdDisablePostingError = PatchAdminSocialAccountsByIdDisablePostingErrors[keyof PatchAdminSocialAccountsByIdDisablePostingErrors]; export type PatchAdminSocialAccountsByIdDisablePostingResponses = { /** * Success */ 200: { data?: SocialAccount; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSocialAccountsByIdDisablePostingResponse = PatchAdminSocialAccountsByIdDisablePostingResponses[keyof PatchAdminSocialAccountsByIdDisablePostingResponses]; export type PatchAdminCatalogClassificationSuggestionsByIdAcceptData = { /** * Request body for the /catalog/classification-suggestions/:id/accept operation on catalog-classification-suggestion resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "catalog-classification-suggestion"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/classification-suggestions/{id}/accept"; }; export type PatchAdminCatalogClassificationSuggestionsByIdAcceptErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCatalogClassificationSuggestionsByIdAcceptError = PatchAdminCatalogClassificationSuggestionsByIdAcceptErrors[keyof PatchAdminCatalogClassificationSuggestionsByIdAcceptErrors]; export type PatchAdminCatalogClassificationSuggestionsByIdAcceptResponses = { /** * Success */ 200: { data?: CatalogClassificationSuggestion; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCatalogClassificationSuggestionsByIdAcceptResponse = PatchAdminCatalogClassificationSuggestionsByIdAcceptResponses[keyof PatchAdminCatalogClassificationSuggestionsByIdAcceptResponses]; export type PatchAdminApiKeysByIdSetBudgetData = { /** * Request body for the /api-keys/:id/set-budget operation on api-key resource */ body?: { data: { attributes?: { /** * Maximum credits per period (null to remove limit) */ credit_limit?: number | null; /** * Budget reset period (null to remove limit) */ credit_limit_period?: "daily" | "weekly" | "monthly" | "yearly" | "lifetime"; }; id: string; relationships?: { [key: string]: never; }; type?: "api-key"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/api-keys/{id}/set-budget"; }; export type PatchAdminApiKeysByIdSetBudgetErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminApiKeysByIdSetBudgetError = PatchAdminApiKeysByIdSetBudgetErrors[keyof PatchAdminApiKeysByIdSetBudgetErrors]; export type PatchAdminApiKeysByIdSetBudgetResponses = { /** * Success */ 200: { data?: ApiKey; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminApiKeysByIdSetBudgetResponse = PatchAdminApiKeysByIdSetBudgetResponses[keyof PatchAdminApiKeysByIdSetBudgetResponses]; export type PostAdminSupportQueuesData = { /** * Request body for the /support/queues operation on support-queue resource */ body: { data: { attributes?: { ai_agent_id?: string | null; ai_mode?: "ai_first" | "human_first" | "ai_only"; application_id: string; business_hours?: { [key: string]: unknown; } | null; description?: string | null; is_default?: boolean | null; name: string; priority_boost?: number | null; sla_policy_id?: string | null; type?: "external" | "internal" | "mixed"; }; relationships?: { [key: string]: never; }; type?: "support-queue"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/queues"; }; export type PostAdminSupportQueuesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSupportQueuesError = PostAdminSupportQueuesErrors[keyof PostAdminSupportQueuesErrors]; export type PostAdminSupportQueuesResponses = { /** * Success */ 201: { data?: SupportQueue; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSupportQueuesResponse = PostAdminSupportQueuesResponses[keyof PostAdminSupportQueuesResponses]; export type DeleteAdminCrawlerSchedulesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/schedules/{id}"; }; export type DeleteAdminCrawlerSchedulesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrawlerSchedulesByIdError = DeleteAdminCrawlerSchedulesByIdErrors[keyof DeleteAdminCrawlerSchedulesByIdErrors]; export type DeleteAdminCrawlerSchedulesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCrawlerSchedulesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/schedules/{id}"; }; export type GetAdminCrawlerSchedulesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrawlerSchedulesByIdError = GetAdminCrawlerSchedulesByIdErrors[keyof GetAdminCrawlerSchedulesByIdErrors]; export type GetAdminCrawlerSchedulesByIdResponses = { /** * Success */ 200: { data?: CrawlerSchedule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrawlerSchedulesByIdResponse = GetAdminCrawlerSchedulesByIdResponses[keyof GetAdminCrawlerSchedulesByIdResponses]; export type PatchAdminCrawlerSchedulesByIdData = { /** * Request body for the /crawler/schedules/:id operation on crawler-schedule resource */ body?: { data: { attributes?: { crawl_config?: { [key: string]: unknown; } | null; cron_expression?: string | null; frequency?: "hourly" | "daily" | "weekly" | "monthly"; mode?: "single" | "site" | "sitemap"; name?: string | null; news_monitor_id?: string | null; notify_on_change?: boolean | null; url?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "crawler-schedule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/schedules/{id}"; }; export type PatchAdminCrawlerSchedulesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrawlerSchedulesByIdError = PatchAdminCrawlerSchedulesByIdErrors[keyof PatchAdminCrawlerSchedulesByIdErrors]; export type PatchAdminCrawlerSchedulesByIdResponses = { /** * Success */ 200: { data?: CrawlerSchedule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrawlerSchedulesByIdResponse = PatchAdminCrawlerSchedulesByIdResponses[keyof PatchAdminCrawlerSchedulesByIdResponses]; export type GetAdminExtractionAnalysesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/analyses"; }; export type GetAdminExtractionAnalysesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionAnalysesError = GetAdminExtractionAnalysesErrors[keyof GetAdminExtractionAnalysesErrors]; export type GetAdminExtractionAnalysesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a extraction-analysis */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionAnalysesResponse = GetAdminExtractionAnalysesResponses[keyof GetAdminExtractionAnalysesResponses]; export type GetAdminWorkspacesSharedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspaces/shared"; }; export type GetAdminWorkspacesSharedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWorkspacesSharedError = GetAdminWorkspacesSharedErrors[keyof GetAdminWorkspacesSharedErrors]; export type GetAdminWorkspacesSharedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a workspace */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWorkspacesSharedResponse = GetAdminWorkspacesSharedResponses[keyof GetAdminWorkspacesSharedResponses]; export type GetAdminAgentVersionsByIdRevisionsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/agent-versions/{id}/revisions"; }; export type GetAdminAgentVersionsByIdRevisionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentVersionsByIdRevisionsError = GetAdminAgentVersionsByIdRevisionsErrors[keyof GetAdminAgentVersionsByIdRevisionsErrors]; export type GetAdminAgentVersionsByIdRevisionsResponses = { /** * Success */ 200: unknown; }; export type GetAdminAccessLogsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/access-logs/{id}"; }; export type GetAdminAccessLogsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAccessLogsByIdError = GetAdminAccessLogsByIdErrors[keyof GetAdminAccessLogsByIdErrors]; export type GetAdminAccessLogsByIdResponses = { /** * Success */ 200: { data?: AccessLog; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAccessLogsByIdResponse = GetAdminAccessLogsByIdResponses[keyof GetAdminAccessLogsByIdResponses]; export type PatchAdminEmailMarketingTemplatesByIdArchiveData = { /** * Request body for the /email-marketing/templates/:id/archive operation on email-marketing-template resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "email-marketing-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/templates/{id}/archive"; }; export type PatchAdminEmailMarketingTemplatesByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailMarketingTemplatesByIdArchiveError = PatchAdminEmailMarketingTemplatesByIdArchiveErrors[keyof PatchAdminEmailMarketingTemplatesByIdArchiveErrors]; export type PatchAdminEmailMarketingTemplatesByIdArchiveResponses = { /** * Success */ 200: { data?: EmailMarketingTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailMarketingTemplatesByIdArchiveResponse = PatchAdminEmailMarketingTemplatesByIdArchiveResponses[keyof PatchAdminEmailMarketingTemplatesByIdArchiveResponses]; export type PatchAdminSchedulingEventsByIdRescheduleData = { /** * Request body for the /scheduling/events/:id/reschedule operation on scheduling-event resource */ body: { data: { attributes?: { new_end_time: unknown; new_start_time: unknown; }; id: string; relationships?: { [key: string]: never; }; type?: "scheduling-event"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/events/{id}/reschedule"; }; export type PatchAdminSchedulingEventsByIdRescheduleErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSchedulingEventsByIdRescheduleError = PatchAdminSchedulingEventsByIdRescheduleErrors[keyof PatchAdminSchedulingEventsByIdRescheduleErrors]; export type PatchAdminSchedulingEventsByIdRescheduleResponses = { /** * Success */ 200: { data?: SchedulingEvent; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSchedulingEventsByIdRescheduleResponse = PatchAdminSchedulingEventsByIdRescheduleResponses[keyof PatchAdminSchedulingEventsByIdRescheduleResponses]; export type PostAdminPlanBundlesPreviewEconomicsData = { /** * Request body for the /plan-bundles/preview-economics operation on plan-bundle resource */ body: { data: { /** * Optional — resolved from x-application-key context when omitted. Required for `IsApplicationOwner` policy resolution when calling outside an application-scoped key. */ application_id?: string | null; bundle: { [key: string]: unknown; }; /** * Optional tier-mix assumption (e.g. %{"core" => %{count: 100, avg_ops_per_month: %{feature_key: 10}}}). Defaults to a sample mix derived from `plan.capability_tiers` when omitted. */ mix?: { [key: string]: unknown; } | null; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/plan-bundles/preview-economics"; }; export type PostAdminPlanBundlesPreviewEconomicsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminPlanBundlesPreviewEconomicsError = PostAdminPlanBundlesPreviewEconomicsErrors[keyof PostAdminPlanBundlesPreviewEconomicsErrors]; export type PostAdminPlanBundlesPreviewEconomicsResponses = { /** * Success */ 201: { result: { [key: string]: unknown; }; }; }; export type PostAdminPlanBundlesPreviewEconomicsResponse = PostAdminPlanBundlesPreviewEconomicsResponses[keyof PostAdminPlanBundlesPreviewEconomicsResponses]; export type DeleteAdminMeetingsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/meetings/{id}"; }; export type DeleteAdminMeetingsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminMeetingsByIdError = DeleteAdminMeetingsByIdErrors[keyof DeleteAdminMeetingsByIdErrors]; export type DeleteAdminMeetingsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminMeetingsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/meetings/{id}"; }; export type GetAdminMeetingsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminMeetingsByIdError = GetAdminMeetingsByIdErrors[keyof GetAdminMeetingsByIdErrors]; export type GetAdminMeetingsByIdResponses = { /** * Success */ 200: { data?: Meeting; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminMeetingsByIdResponse = GetAdminMeetingsByIdResponses[keyof GetAdminMeetingsByIdResponses]; export type PatchAdminMeetingsByIdData = { /** * Request body for the /meetings/:id operation on meeting resource */ body?: { data: { attributes?: { attendees?: { [key: string]: unknown; } | null; custom_fields?: { [key: string]: unknown; } | null; end_time?: unknown; external_url?: string | null; join_url?: string | null; location?: string | null; organizer_email?: string | null; start_time?: unknown; status?: "scheduled" | "in_progress" | "completed" | "cancelled"; title?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "meeting"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/meetings/{id}"; }; export type PatchAdminMeetingsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminMeetingsByIdError = PatchAdminMeetingsByIdErrors[keyof PatchAdminMeetingsByIdErrors]; export type PatchAdminMeetingsByIdResponses = { /** * Success */ 200: { data?: Meeting; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminMeetingsByIdResponse = PatchAdminMeetingsByIdResponses[keyof PatchAdminMeetingsByIdResponses]; export type GetAdminUsageEventsSummaryData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; tenant_id: string; start_date?: unknown; end_date?: unknown; }; url: "/admin/usage-events/summary"; }; export type GetAdminUsageEventsSummaryErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminUsageEventsSummaryError = GetAdminUsageEventsSummaryErrors[keyof GetAdminUsageEventsSummaryErrors]; export type GetAdminUsageEventsSummaryResponses = { /** * Success */ 200: { /** * An array of resource objects representing a usage-event */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminUsageEventsSummaryResponse = GetAdminUsageEventsSummaryResponses[keyof GetAdminUsageEventsSummaryResponses]; export type GetAdminMessageFeedbackData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/message-feedback"; }; export type GetAdminMessageFeedbackErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminMessageFeedbackError = GetAdminMessageFeedbackErrors[keyof GetAdminMessageFeedbackErrors]; export type GetAdminMessageFeedbackResponses = { /** * Success */ 200: { /** * An array of resource objects representing a chat-message-feedback */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminMessageFeedbackResponse = GetAdminMessageFeedbackResponses[keyof GetAdminMessageFeedbackResponses]; export type PostAdminMessageFeedbackData = { /** * Request body for the /message-feedback operation on chat-message-feedback resource */ body: { data: { attributes?: { comment?: string | null; message_id: string; rating: string | number; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "chat-message-feedback"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/message-feedback"; }; export type PostAdminMessageFeedbackErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminMessageFeedbackError = PostAdminMessageFeedbackErrors[keyof PostAdminMessageFeedbackErrors]; export type PostAdminMessageFeedbackResponses = { /** * Success */ 201: { data?: ChatMessageFeedback; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminMessageFeedbackResponse = PostAdminMessageFeedbackResponses[keyof PostAdminMessageFeedbackResponses]; export type PostAdminConnectorsByIdSyncData = { /** * Request body for the /connectors/:id/sync operation on connector-instance resource */ body: { data: { action_name: "full" | "incremental" | "webhook" | "manual"; connector_id: string; params?: { [key: string]: unknown; } | null; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/connectors/{id}/sync"; }; export type PostAdminConnectorsByIdSyncErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsByIdSyncError = PostAdminConnectorsByIdSyncErrors[keyof PostAdminConnectorsByIdSyncErrors]; export type PostAdminConnectorsByIdSyncResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminConnectorsByIdSyncResponse = PostAdminConnectorsByIdSyncResponses[keyof PostAdminConnectorsByIdSyncResponses]; export type PostAdminClinicalNoteTemplatesFromExistingData = { /** * Request body for the /clinical/note-templates/from-existing operation on clinical-note-template resource */ body: { data: { attributes?: { source_template_id: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-note-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/note-templates/from-existing"; }; export type PostAdminClinicalNoteTemplatesFromExistingErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalNoteTemplatesFromExistingError = PostAdminClinicalNoteTemplatesFromExistingErrors[keyof PostAdminClinicalNoteTemplatesFromExistingErrors]; export type PostAdminClinicalNoteTemplatesFromExistingResponses = { /** * Success */ 201: { data?: ClinicalNoteTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalNoteTemplatesFromExistingResponse = PostAdminClinicalNoteTemplatesFromExistingResponses[keyof PostAdminClinicalNoteTemplatesFromExistingResponses]; export type GetAdminSocialPostsScheduledData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/posts/scheduled"; }; export type GetAdminSocialPostsScheduledErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialPostsScheduledError = GetAdminSocialPostsScheduledErrors[keyof GetAdminSocialPostsScheduledErrors]; export type GetAdminSocialPostsScheduledResponses = { /** * Success */ 200: { /** * An array of resource objects representing a social-post */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialPostsScheduledResponse = GetAdminSocialPostsScheduledResponses[keyof GetAdminSocialPostsScheduledResponses]; export type PostAdminWebhookConfigsBulkEnableData = { /** * Request body for the /webhook-configs/bulk-enable operation on webhook-config resource */ body: { data: { ids: Array; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/webhook-configs/bulk-enable"; }; export type PostAdminWebhookConfigsBulkEnableErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminWebhookConfigsBulkEnableError = PostAdminWebhookConfigsBulkEnableErrors[keyof PostAdminWebhookConfigsBulkEnableErrors]; export type PostAdminWebhookConfigsBulkEnableResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminWebhookConfigsBulkEnableResponse = PostAdminWebhookConfigsBulkEnableResponses[keyof PostAdminWebhookConfigsBulkEnableResponses]; export type GetAdminExtractionDocumentsWorkspaceThroughputData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { window?: "today" | "7d" | "30d"; }; url: "/admin/extraction/documents/workspace-throughput"; }; export type GetAdminExtractionDocumentsWorkspaceThroughputErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionDocumentsWorkspaceThroughputError = GetAdminExtractionDocumentsWorkspaceThroughputErrors[keyof GetAdminExtractionDocumentsWorkspaceThroughputErrors]; export type GetAdminExtractionDocumentsWorkspaceThroughputResponses = { /** * Success */ 200: { [key: string]: unknown; }; }; export type GetAdminExtractionDocumentsWorkspaceThroughputResponse = GetAdminExtractionDocumentsWorkspaceThroughputResponses[keyof GetAdminExtractionDocumentsWorkspaceThroughputResponses]; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdReviewQueueData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; limit?: number; agent_version_id?: string; /** * Version mode: 'active' (default, filter to workspace agent's active version), 'all' (no version filtering) */ version_mode?: string; }; url: "/admin/extraction/documents/workspace/{workspace_id}/review-queue"; }; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdReviewQueueErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdReviewQueueError = GetAdminExtractionDocumentsWorkspaceByWorkspaceIdReviewQueueErrors[keyof GetAdminExtractionDocumentsWorkspaceByWorkspaceIdReviewQueueErrors]; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdReviewQueueResponses = { /** * Success */ 200: { /** * An array of resource objects representing a extraction-document */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdReviewQueueResponse = GetAdminExtractionDocumentsWorkspaceByWorkspaceIdReviewQueueResponses[keyof GetAdminExtractionDocumentsWorkspaceByWorkspaceIdReviewQueueResponses]; export type GetAdminBrandIdentitiesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/brand-identities"; }; export type GetAdminBrandIdentitiesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminBrandIdentitiesError = GetAdminBrandIdentitiesErrors[keyof GetAdminBrandIdentitiesErrors]; export type GetAdminBrandIdentitiesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a brand-identity */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminBrandIdentitiesResponse = GetAdminBrandIdentitiesResponses[keyof GetAdminBrandIdentitiesResponses]; export type PostAdminBrandIdentitiesData = { /** * Request body for the /brand-identities operation on brand-identity resource */ body: { data: { attributes?: { color_palette?: { [key: string]: unknown; } | null; description?: string | null; industry?: string | null; is_default?: boolean | null; logo_url?: string | null; name: string; target_audience?: string | null; tenant_id: string; values?: Array | null; /** * Brand voice description (e.g., 'Professional but approachable') */ voice?: string | null; website_url?: string | null; workspace_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "brand-identity"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/brand-identities"; }; export type PostAdminBrandIdentitiesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminBrandIdentitiesError = PostAdminBrandIdentitiesErrors[keyof PostAdminBrandIdentitiesErrors]; export type PostAdminBrandIdentitiesResponses = { /** * Success */ 201: { data?: BrandIdentity; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminBrandIdentitiesResponse = PostAdminBrandIdentitiesResponses[keyof PostAdminBrandIdentitiesResponses]; export type DeleteAdminClinicalGoalAssociationsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-associations/{id}"; }; export type DeleteAdminClinicalGoalAssociationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalGoalAssociationsByIdError = DeleteAdminClinicalGoalAssociationsByIdErrors[keyof DeleteAdminClinicalGoalAssociationsByIdErrors]; export type DeleteAdminClinicalGoalAssociationsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminClinicalGoalAssociationsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-associations/{id}"; }; export type GetAdminClinicalGoalAssociationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalGoalAssociationsByIdError = GetAdminClinicalGoalAssociationsByIdErrors[keyof GetAdminClinicalGoalAssociationsByIdErrors]; export type GetAdminClinicalGoalAssociationsByIdResponses = { /** * Success */ 200: { data?: ClinicalGoalAssociation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalGoalAssociationsByIdResponse = GetAdminClinicalGoalAssociationsByIdResponses[keyof GetAdminClinicalGoalAssociationsByIdResponses]; export type GetAdminCatalogStockLocationsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/stock-locations/workspace/{workspace_id}"; }; export type GetAdminCatalogStockLocationsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogStockLocationsWorkspaceByWorkspaceIdError = GetAdminCatalogStockLocationsWorkspaceByWorkspaceIdErrors[keyof GetAdminCatalogStockLocationsWorkspaceByWorkspaceIdErrors]; export type GetAdminCatalogStockLocationsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a catalog-stock-location */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogStockLocationsWorkspaceByWorkspaceIdResponse = GetAdminCatalogStockLocationsWorkspaceByWorkspaceIdResponses[keyof GetAdminCatalogStockLocationsWorkspaceByWorkspaceIdResponses]; export type GetAdminSupportTagsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/tags/workspace/{workspace_id}"; }; export type GetAdminSupportTagsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSupportTagsWorkspaceByWorkspaceIdError = GetAdminSupportTagsWorkspaceByWorkspaceIdErrors[keyof GetAdminSupportTagsWorkspaceByWorkspaceIdErrors]; export type GetAdminSupportTagsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a support-tag */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSupportTagsWorkspaceByWorkspaceIdResponse = GetAdminSupportTagsWorkspaceByWorkspaceIdResponses[keyof GetAdminSupportTagsWorkspaceByWorkspaceIdResponses]; export type GetAdminDataSubjectRequestsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/data-subject-requests"; }; export type GetAdminDataSubjectRequestsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminDataSubjectRequestsError = GetAdminDataSubjectRequestsErrors[keyof GetAdminDataSubjectRequestsErrors]; export type GetAdminDataSubjectRequestsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a data-subject-request */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminDataSubjectRequestsResponse = GetAdminDataSubjectRequestsResponses[keyof GetAdminDataSubjectRequestsResponses]; export type PostAdminDataSubjectRequestsData = { /** * Request body for the /data-subject-requests operation on data-subject-request resource */ body: { data: { attributes?: { /** * Subject's appeal statement if request was denied */ appeal_statement?: string | null; data_subject_email: string; /** * Legal grounds for denying the request (HIPAA permits specific grounds) */ denial_grounds?: string | null; fee_amount?: string | number | unknown; notes?: string | null; request_type: "access" | "erasure" | "portability" | "rectification" | "restriction" | "hipaa_access" | "hipaa_amendment" | "hipaa_restriction" | "hipaa_disclosure_accounting"; /** * Email or identifier of the person who submitted the request */ requested_by: string; status?: "pending" | "in_progress" | "completed" | "rejected" | "expired"; /** * Third party to receive PHI copy (HIPAA right of access) */ third_party_recipient?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "data-subject-request"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/data-subject-requests"; }; export type PostAdminDataSubjectRequestsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminDataSubjectRequestsError = PostAdminDataSubjectRequestsErrors[keyof PostAdminDataSubjectRequestsErrors]; export type PostAdminDataSubjectRequestsResponses = { /** * Success */ 201: { data?: DataSubjectRequest; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminDataSubjectRequestsResponse = PostAdminDataSubjectRequestsResponses[keyof PostAdminDataSubjectRequestsResponses]; export type PostAdminContentRewriteToneData = { /** * Request body for the /content/rewrite-tone operation on content-generation resource */ body: { data: { max_length?: number | null; target_tone: string; text: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/content/rewrite-tone"; }; export type PostAdminContentRewriteToneErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminContentRewriteToneError = PostAdminContentRewriteToneErrors[keyof PostAdminContentRewriteToneErrors]; export type PostAdminContentRewriteToneResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminContentRewriteToneResponse = PostAdminContentRewriteToneResponses[keyof PostAdminContentRewriteToneResponses]; export type GetAdminTransfersData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/transfers"; }; export type GetAdminTransfersErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminTransfersError = GetAdminTransfersErrors[keyof GetAdminTransfersErrors]; export type GetAdminTransfersResponses = { /** * Success */ 200: { /** * An array of resource objects representing a transfer */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminTransfersResponse = GetAdminTransfersResponses[keyof GetAdminTransfersResponses]; export type GetAdminCatalogPriceListEntriesPriceListByPriceListIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { price_list_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/price-list-entries/price-list/{price_list_id}"; }; export type GetAdminCatalogPriceListEntriesPriceListByPriceListIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogPriceListEntriesPriceListByPriceListIdError = GetAdminCatalogPriceListEntriesPriceListByPriceListIdErrors[keyof GetAdminCatalogPriceListEntriesPriceListByPriceListIdErrors]; export type GetAdminCatalogPriceListEntriesPriceListByPriceListIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a catalog-price-list-entry */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogPriceListEntriesPriceListByPriceListIdResponse = GetAdminCatalogPriceListEntriesPriceListByPriceListIdResponses[keyof GetAdminCatalogPriceListEntriesPriceListByPriceListIdResponses]; export type PostAdminSupportTicketAttachmentsData = { /** * Request body for the /support/ticket-attachments operation on support-ticket-attachment resource */ body: { data: { attributes?: { content_type?: string | null; filename: string; size_bytes?: number | null; storage_path: string; ticket_message_id: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "support-ticket-attachment"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/ticket-attachments"; }; export type PostAdminSupportTicketAttachmentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSupportTicketAttachmentsError = PostAdminSupportTicketAttachmentsErrors[keyof PostAdminSupportTicketAttachmentsErrors]; export type PostAdminSupportTicketAttachmentsResponses = { /** * Success */ 201: { data?: SupportTicketAttachment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSupportTicketAttachmentsResponse = PostAdminSupportTicketAttachmentsResponses[keyof PostAdminSupportTicketAttachmentsResponses]; export type PostAdminConnectorsByIdHealthiePatientsListData = { /** * Request body for the /connectors/:id/healthie/patients/list operation on connector-instance resource */ body: { data: { connector_id: string; since?: unknown; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/connectors/{id}/healthie/patients/list"; }; export type PostAdminConnectorsByIdHealthiePatientsListErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsByIdHealthiePatientsListError = PostAdminConnectorsByIdHealthiePatientsListErrors[keyof PostAdminConnectorsByIdHealthiePatientsListErrors]; export type PostAdminConnectorsByIdHealthiePatientsListResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminConnectorsByIdHealthiePatientsListResponse = PostAdminConnectorsByIdHealthiePatientsListResponses[keyof PostAdminConnectorsByIdHealthiePatientsListResponses]; export type PostAdminAgentsCloneForWorkspaceData = { /** * Request body for the /agents/clone-for-workspace operation on agent resource */ body: { data: { attributes?: { base_agent_id: string; customize?: { [key: string]: unknown; } | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "agent"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agents/clone-for-workspace"; }; export type PostAdminAgentsCloneForWorkspaceErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAgentsCloneForWorkspaceError = PostAdminAgentsCloneForWorkspaceErrors[keyof PostAdminAgentsCloneForWorkspaceErrors]; export type PostAdminAgentsCloneForWorkspaceResponses = { /** * Success */ 201: { data?: Agent; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAgentsCloneForWorkspaceResponse = PostAdminAgentsCloneForWorkspaceResponses[keyof PostAdminAgentsCloneForWorkspaceResponses]; export type PatchAdminBreachIncidentsByIdStatusData = { /** * Request body for the /breach-incidents/:id/status operation on breach-incident resource */ body?: { data: { attributes?: { privacy_officer_notified?: boolean | null; regulator_notified?: boolean | null; remediation_notes?: string | null; status?: "identified" | "investigating" | "notifying" | "resolved" | "false_positive"; }; id: string; relationships?: { [key: string]: never; }; type?: "breach-incident"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/breach-incidents/{id}/status"; }; export type PatchAdminBreachIncidentsByIdStatusErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminBreachIncidentsByIdStatusError = PatchAdminBreachIncidentsByIdStatusErrors[keyof PatchAdminBreachIncidentsByIdStatusErrors]; export type PatchAdminBreachIncidentsByIdStatusResponses = { /** * Success */ 200: { data?: BreachIncident; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminBreachIncidentsByIdStatusResponse = PatchAdminBreachIncidentsByIdStatusResponses[keyof PatchAdminBreachIncidentsByIdStatusResponses]; export type GetAdminBusinessAssociateAgreementsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/business-associate-agreements"; }; export type GetAdminBusinessAssociateAgreementsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminBusinessAssociateAgreementsError = GetAdminBusinessAssociateAgreementsErrors[keyof GetAdminBusinessAssociateAgreementsErrors]; export type GetAdminBusinessAssociateAgreementsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a business-associate-agreement */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminBusinessAssociateAgreementsResponse = GetAdminBusinessAssociateAgreementsResponses[keyof GetAdminBusinessAssociateAgreementsResponses]; export type PostAdminBusinessAssociateAgreementsData = { /** * Request body for the /business-associate-agreements operation on business-associate-agreement resource */ body: { data: { attributes?: { application_id: string; counterparty_name: string; counterparty_signatory?: string | null; counterparty_type: "covered_entity" | "business_associate" | "subcontractor"; direction: "upstream" | "downstream"; effective_date: string; ephi_asset_id?: string | null; expiration_date?: string | null; legal_document_id?: string | null; phi_scope?: Array | null; renewal_reminder_days?: number | null; renewal_type: "auto_renew" | "manual_renew" | "fixed_term"; workspace_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "business-associate-agreement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/business-associate-agreements"; }; export type PostAdminBusinessAssociateAgreementsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminBusinessAssociateAgreementsError = PostAdminBusinessAssociateAgreementsErrors[keyof PostAdminBusinessAssociateAgreementsErrors]; export type PostAdminBusinessAssociateAgreementsResponses = { /** * Success */ 201: { data?: BusinessAssociateAgreement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminBusinessAssociateAgreementsResponse = PostAdminBusinessAssociateAgreementsResponses[keyof PostAdminBusinessAssociateAgreementsResponses]; export type DeleteAdminClinicalClientGoalsByIdPermanentData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-goals/{id}/permanent"; }; export type DeleteAdminClinicalClientGoalsByIdPermanentErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalClientGoalsByIdPermanentError = DeleteAdminClinicalClientGoalsByIdPermanentErrors[keyof DeleteAdminClinicalClientGoalsByIdPermanentErrors]; export type DeleteAdminClinicalClientGoalsByIdPermanentResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminWorkspaceFormConfigsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspace-form-configs"; }; export type GetAdminWorkspaceFormConfigsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWorkspaceFormConfigsError = GetAdminWorkspaceFormConfigsErrors[keyof GetAdminWorkspaceFormConfigsErrors]; export type GetAdminWorkspaceFormConfigsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a workspace-form-config */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWorkspaceFormConfigsResponse = GetAdminWorkspaceFormConfigsResponses[keyof GetAdminWorkspaceFormConfigsResponses]; export type PostAdminWorkspaceFormConfigsData = { /** * Request body for the /workspace-form-configs operation on workspace-form-config resource */ body: { data: { attributes?: { form_deployment_id: string; overrides?: { [key: string]: unknown; } | null; schema_overrides?: { [key: string]: unknown; } | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "workspace-form-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspace-form-configs"; }; export type PostAdminWorkspaceFormConfigsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminWorkspaceFormConfigsError = PostAdminWorkspaceFormConfigsErrors[keyof PostAdminWorkspaceFormConfigsErrors]; export type PostAdminWorkspaceFormConfigsResponses = { /** * Success */ 201: { data?: WorkspaceFormConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminWorkspaceFormConfigsResponse = PostAdminWorkspaceFormConfigsResponses[keyof PostAdminWorkspaceFormConfigsResponses]; export type GetAdminRecipesWorkspaceByWorkspaceIdContactByContactIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; contact_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/workspace/{workspace_id}/contact/{contact_id}"; }; export type GetAdminRecipesWorkspaceByWorkspaceIdContactByContactIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesWorkspaceByWorkspaceIdContactByContactIdError = GetAdminRecipesWorkspaceByWorkspaceIdContactByContactIdErrors[keyof GetAdminRecipesWorkspaceByWorkspaceIdContactByContactIdErrors]; export type GetAdminRecipesWorkspaceByWorkspaceIdContactByContactIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a recipes-recipe */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesWorkspaceByWorkspaceIdContactByContactIdResponse = GetAdminRecipesWorkspaceByWorkspaceIdContactByContactIdResponses[keyof GetAdminRecipesWorkspaceByWorkspaceIdContactByContactIdResponses]; export type DeleteAdminCatalogOptionTypesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/option-types/{id}"; }; export type DeleteAdminCatalogOptionTypesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCatalogOptionTypesByIdError = DeleteAdminCatalogOptionTypesByIdErrors[keyof DeleteAdminCatalogOptionTypesByIdErrors]; export type DeleteAdminCatalogOptionTypesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCatalogOptionTypesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/option-types/{id}"; }; export type GetAdminCatalogOptionTypesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogOptionTypesByIdError = GetAdminCatalogOptionTypesByIdErrors[keyof GetAdminCatalogOptionTypesByIdErrors]; export type GetAdminCatalogOptionTypesByIdResponses = { /** * Success */ 200: { data?: CatalogOptionType; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogOptionTypesByIdResponse = GetAdminCatalogOptionTypesByIdResponses[keyof GetAdminCatalogOptionTypesByIdResponses]; export type PatchAdminCatalogOptionTypesByIdData = { /** * Request body for the /catalog/option-types/:id operation on catalog-option-type resource */ body?: { data: { attributes?: { name?: string | null; position?: number | null; slug?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "catalog-option-type"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/option-types/{id}"; }; export type PatchAdminCatalogOptionTypesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCatalogOptionTypesByIdError = PatchAdminCatalogOptionTypesByIdErrors[keyof PatchAdminCatalogOptionTypesByIdErrors]; export type PatchAdminCatalogOptionTypesByIdResponses = { /** * Success */ 200: { data?: CatalogOptionType; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCatalogOptionTypesByIdResponse = PatchAdminCatalogOptionTypesByIdResponses[keyof PatchAdminCatalogOptionTypesByIdResponses]; export type PostAdminTenantsByIdCreditData = { /** * Request body for the /tenants/:id/credit operation on tenant resource */ body: { data: { attributes?: { amount: number; description?: string | null; operation?: string | null; }; relationships?: { [key: string]: never; }; type?: "tenant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants/{id}/credit"; }; export type PostAdminTenantsByIdCreditErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminTenantsByIdCreditError = PostAdminTenantsByIdCreditErrors[keyof PostAdminTenantsByIdCreditErrors]; export type PostAdminTenantsByIdCreditResponses = { /** * Success */ 201: { data?: Tenant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminTenantsByIdCreditResponse = PostAdminTenantsByIdCreditResponses[keyof PostAdminTenantsByIdCreditResponses]; export type PatchAdminInvoicesRulesByIdDeactivateData = { /** * Request body for the /invoices/rules/:id/deactivate operation on invoices-rule resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "invoices-rule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/rules/{id}/deactivate"; }; export type PatchAdminInvoicesRulesByIdDeactivateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvoicesRulesByIdDeactivateError = PatchAdminInvoicesRulesByIdDeactivateErrors[keyof PatchAdminInvoicesRulesByIdDeactivateErrors]; export type PatchAdminInvoicesRulesByIdDeactivateResponses = { /** * Success */ 200: { data?: InvoicesRule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvoicesRulesByIdDeactivateResponse = PatchAdminInvoicesRulesByIdDeactivateResponses[keyof PatchAdminInvoicesRulesByIdDeactivateResponses]; export type GetAdminExtractionChunkEntityLinksChunkByDocumentChunkIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { document_chunk_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/chunk-entity-links/chunk/{document_chunk_id}"; }; export type GetAdminExtractionChunkEntityLinksChunkByDocumentChunkIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionChunkEntityLinksChunkByDocumentChunkIdError = GetAdminExtractionChunkEntityLinksChunkByDocumentChunkIdErrors[keyof GetAdminExtractionChunkEntityLinksChunkByDocumentChunkIdErrors]; export type GetAdminExtractionChunkEntityLinksChunkByDocumentChunkIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a chunk-entity-link */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionChunkEntityLinksChunkByDocumentChunkIdResponse = GetAdminExtractionChunkEntityLinksChunkByDocumentChunkIdResponses[keyof GetAdminExtractionChunkEntityLinksChunkByDocumentChunkIdResponses]; export type PatchAdminExtractionDocumentsByIdIncludeData = { /** * Request body for the /extraction/documents/:id/include operation on extraction-document resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "extraction-document"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/documents/{id}/include"; }; export type PatchAdminExtractionDocumentsByIdIncludeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminExtractionDocumentsByIdIncludeError = PatchAdminExtractionDocumentsByIdIncludeErrors[keyof PatchAdminExtractionDocumentsByIdIncludeErrors]; export type PatchAdminExtractionDocumentsByIdIncludeResponses = { /** * Success */ 200: { data?: ExtractionDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminExtractionDocumentsByIdIncludeResponse = PatchAdminExtractionDocumentsByIdIncludeResponses[keyof PatchAdminExtractionDocumentsByIdIncludeResponses]; export type DeleteAdminCustomersByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/customers/{id}"; }; export type DeleteAdminCustomersByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCustomersByIdError = DeleteAdminCustomersByIdErrors[keyof DeleteAdminCustomersByIdErrors]; export type DeleteAdminCustomersByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCustomersByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/customers/{id}"; }; export type GetAdminCustomersByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCustomersByIdError = GetAdminCustomersByIdErrors[keyof GetAdminCustomersByIdErrors]; export type GetAdminCustomersByIdResponses = { /** * Success */ 200: { data?: Customer; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCustomersByIdResponse = GetAdminCustomersByIdResponses[keyof GetAdminCustomersByIdResponses]; export type PatchAdminCustomersByIdData = { /** * Request body for the /customers/:id operation on customer resource */ body?: { data: { attributes?: { billing_email?: string | null; gateway_customer_id?: string | null; payment_method_status?: "valid" | "invalid" | "missing"; }; id: string; relationships?: { [key: string]: never; }; type?: "customer"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/customers/{id}"; }; export type PatchAdminCustomersByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCustomersByIdError = PatchAdminCustomersByIdErrors[keyof PatchAdminCustomersByIdErrors]; export type PatchAdminCustomersByIdResponses = { /** * Success */ 200: { data?: Customer; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCustomersByIdResponse = PatchAdminCustomersByIdResponses[keyof PatchAdminCustomersByIdResponses]; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; batch_id?: string; }; url: "/admin/extraction/documents/workspace/{workspace_id}"; }; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdError = GetAdminExtractionDocumentsWorkspaceByWorkspaceIdErrors[keyof GetAdminExtractionDocumentsWorkspaceByWorkspaceIdErrors]; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a extraction-document */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdResponse = GetAdminExtractionDocumentsWorkspaceByWorkspaceIdResponses[keyof GetAdminExtractionDocumentsWorkspaceByWorkspaceIdResponses]; export type GetAdminClinicalNoteTemplatesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/note-templates/{id}"; }; export type GetAdminClinicalNoteTemplatesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalNoteTemplatesByIdError = GetAdminClinicalNoteTemplatesByIdErrors[keyof GetAdminClinicalNoteTemplatesByIdErrors]; export type GetAdminClinicalNoteTemplatesByIdResponses = { /** * Success */ 200: { data?: ClinicalNoteTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalNoteTemplatesByIdResponse = GetAdminClinicalNoteTemplatesByIdResponses[keyof GetAdminClinicalNoteTemplatesByIdResponses]; export type PatchAdminClinicalNoteTemplatesByIdData = { /** * Request body for the /clinical/note-templates/:id operation on clinical-note-template resource */ body?: { data: { attributes?: { category?: string | null; description?: string | null; is_active?: boolean | null; metadata?: { [key: string]: unknown; } | null; note_type?: "soap" | "adime" | "progress" | "discharge" | "addendum"; sections?: { [key: string]: unknown; } | null; tags?: Array | null; title?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-note-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/note-templates/{id}"; }; export type PatchAdminClinicalNoteTemplatesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalNoteTemplatesByIdError = PatchAdminClinicalNoteTemplatesByIdErrors[keyof PatchAdminClinicalNoteTemplatesByIdErrors]; export type PatchAdminClinicalNoteTemplatesByIdResponses = { /** * Success */ 200: { data?: ClinicalNoteTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalNoteTemplatesByIdResponse = PatchAdminClinicalNoteTemplatesByIdResponses[keyof PatchAdminClinicalNoteTemplatesByIdResponses]; export type DeleteAdminCrmDealProductsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/deal-products/{id}"; }; export type DeleteAdminCrmDealProductsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrmDealProductsByIdError = DeleteAdminCrmDealProductsByIdErrors[keyof DeleteAdminCrmDealProductsByIdErrors]; export type DeleteAdminCrmDealProductsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCrmDealProductsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/deal-products/{id}"; }; export type GetAdminCrmDealProductsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmDealProductsByIdError = GetAdminCrmDealProductsByIdErrors[keyof GetAdminCrmDealProductsByIdErrors]; export type GetAdminCrmDealProductsByIdResponses = { /** * Success */ 200: { data?: CrmDealProduct; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmDealProductsByIdResponse = GetAdminCrmDealProductsByIdResponses[keyof GetAdminCrmDealProductsByIdResponses]; export type PostAdminCatalogViewRulesData = { /** * Request body for the /catalog/view-rules operation on catalog-view-rule resource */ body: { data: { attributes?: { catalog_view_id: string; field: string; group?: number | null; operator: "equals" | "not_equals" | "in" | "not_in" | "gt" | "lt" | "between" | "contains"; value?: string | null; }; relationships?: { [key: string]: never; }; type?: "catalog-view-rule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/view-rules"; }; export type PostAdminCatalogViewRulesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCatalogViewRulesError = PostAdminCatalogViewRulesErrors[keyof PostAdminCatalogViewRulesErrors]; export type PostAdminCatalogViewRulesResponses = { /** * Success */ 201: { data?: CatalogViewRule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCatalogViewRulesResponse = PostAdminCatalogViewRulesResponses[keyof PostAdminCatalogViewRulesResponses]; export type PatchAdminTenantsByIdDeactivateData = { /** * Request body for the /tenants/:id/deactivate operation on tenant resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "tenant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants/{id}/deactivate"; }; export type PatchAdminTenantsByIdDeactivateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminTenantsByIdDeactivateError = PatchAdminTenantsByIdDeactivateErrors[keyof PatchAdminTenantsByIdDeactivateErrors]; export type PatchAdminTenantsByIdDeactivateResponses = { /** * Success */ 200: { data?: Tenant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminTenantsByIdDeactivateResponse = PatchAdminTenantsByIdDeactivateResponses[keyof PatchAdminTenantsByIdDeactivateResponses]; export type DeleteAdminAgentsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agents/{id}"; }; export type DeleteAdminAgentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminAgentsByIdError = DeleteAdminAgentsByIdErrors[keyof DeleteAdminAgentsByIdErrors]; export type DeleteAdminAgentsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminAgentsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agents/{id}"; }; export type GetAdminAgentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentsByIdError = GetAdminAgentsByIdErrors[keyof GetAdminAgentsByIdErrors]; export type GetAdminAgentsByIdResponses = { /** * Success */ 200: { data?: Agent; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAgentsByIdResponse = GetAdminAgentsByIdResponses[keyof GetAdminAgentsByIdResponses]; export type PatchAdminAgentsByIdData = { /** * Request body for the /agents/:id operation on agent resource */ body?: { data: { attributes?: { /** * Stable catalog taxonomy for what the agent primarily does * (for example: document_extraction, classification, generation, advisory). * */ agent_function?: string | null; /** * When true (default), tenants can customize the agent's behavior via the `instructions` field. * When false, `instructions` is ignored during prompt resolution — only `default_instructions` * (set at clone time by the ISV) is used. Prevents tenant customization of compliance-sensitive * or regulated-workflow agents. * */ allow_instruction_override?: boolean | null; /** * When true, tenants under this application may clone this agent into their * workspace via :create_workspace_agent. When false (default), only system * actors and ISV server keys can provision workspace copies. Only meaningful * when application_id is set. * */ allow_tenant_clone?: boolean | null; /** * When set, this agent belongs to an ISV Application definition. Null = workspace-owned. */ application_id?: string | null; /** * Optional higher-level catalog grouping for browsing and UI segmentation * (for example: operations, extraction, generation, platform_advisors). * */ catalog_family?: string | null; default_instructions?: string | null; description?: string | null; /** * Agent execution mode: :extraction for document processing, :agentic for multi-turn tool-calling */ execution_mode?: "extraction" | "agentic"; /** * Stable catalog taxonomy for the primary input shape * (for example: document, text, transcript, brief, mixed_context). * */ input_kind?: string | null; /** * When true, non-privileged actors cannot modify `input_schema` on any AgentVersion * belonging to this agent. Only SystemActor, platform admins, and ISV owners can bypass. * */ input_schema_locked?: boolean | null; instructions?: string | null; /** * When true and application_id is set, this agent is auto-provisioned to new workspaces * created under the application. Workspace copies have workspace_id set and is_application_default: false. * */ is_application_default?: boolean | null; is_system?: boolean | null; /** * Optional platform-curated metadata populated for system agents and overridable on clones. */ metadata?: { [key: string]: unknown; } | null; name?: string | null; /** * Stable catalog taxonomy for the primary output shape * (for example: structured_json, recommendation_json, scored_json, diagram_code). * */ output_kind?: string | null; /** * When true, non-privileged actors cannot modify `output_schema` on any AgentVersion * belonging to this agent. Only SystemActor, platform admins, and ISV owners can bypass. * Used to protect production schemas from accidental changes. * */ output_schema_locked?: boolean | null; /** * ISV-defined keyed text fragments for system prompt interpolation. * * Supports two value types per key: * - **String**: static fragment injected at every execution. The prompt placeholder * `{key}` is replaced with this string. * - **Map**: input-driven. The prompt placeholder `{key}` is replaced with the * sub-map value looked up by the execution input of the same name. * * Example: * %{ * "transcript_context" => "Always interpret as one-sided audio...", * "detail_level" => %{ * "brief" => "BRIEF: bullet points only, <400 words.", * "standard" => "STANDARD: rich bullets, 2-4 sentences each.", * "detailed" => "DETAILED: comprehensive documentation." * } * } * * With this config, a prompt template containing `{transcript_context}` and * `{detail_level}` — and an execution input of `detail_level: "standard"` — * produces the fully resolved system prompt with both placeholders substituted. * */ prompt_variants?: { [key: string]: unknown; } | null; tags?: Array | null; /** * Denormalized from workspace for unique name constraint */ tenant_id?: string | null; /** * Industry vertical for the agent (validated against extraction.config_enums 'agent_vertical') */ vertical?: string | null; /** * List of exposed system field names to include in webhook payloads */ webhook_system_fields?: Array | null; }; id: string; relationships?: { [key: string]: never; }; type?: "agent"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agents/{id}"; }; export type PatchAdminAgentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminAgentsByIdError = PatchAdminAgentsByIdErrors[keyof PatchAdminAgentsByIdErrors]; export type PatchAdminAgentsByIdResponses = { /** * Success */ 200: { data?: Agent; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminAgentsByIdResponse = PatchAdminAgentsByIdResponses[keyof PatchAdminAgentsByIdResponses]; export type PatchAdminWorkspacesByIdGoLiveData = { /** * Request body for the /workspaces/:id/go-live operation on workspace resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "workspace"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspaces/{id}/go-live"; }; export type PatchAdminWorkspacesByIdGoLiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminWorkspacesByIdGoLiveError = PatchAdminWorkspacesByIdGoLiveErrors[keyof PatchAdminWorkspacesByIdGoLiveErrors]; export type PatchAdminWorkspacesByIdGoLiveResponses = { /** * Success */ 200: { data?: Workspace; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminWorkspacesByIdGoLiveResponse = PatchAdminWorkspacesByIdGoLiveResponses[keyof PatchAdminWorkspacesByIdGoLiveResponses]; export type PostAdminInvoicesTemplatesData = { /** * Request body for the /invoices/templates operation on invoices-template resource */ body: { data: { attributes?: { branding?: { [key: string]: unknown; } | null; default_notes?: string | null; default_payment_terms?: string | null; description?: string | null; is_default?: boolean | null; layout?: { [key: string]: unknown; } | null; metadata?: { [key: string]: unknown; } | null; name: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "invoices-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/templates"; }; export type PostAdminInvoicesTemplatesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminInvoicesTemplatesError = PostAdminInvoicesTemplatesErrors[keyof PostAdminInvoicesTemplatesErrors]; export type PostAdminInvoicesTemplatesResponses = { /** * Success */ 201: { data?: InvoicesTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminInvoicesTemplatesResponse = PostAdminInvoicesTemplatesResponses[keyof PostAdminInvoicesTemplatesResponses]; export type GetAdminFormDeploymentsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/form-deployments"; }; export type GetAdminFormDeploymentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminFormDeploymentsError = GetAdminFormDeploymentsErrors[keyof GetAdminFormDeploymentsErrors]; export type GetAdminFormDeploymentsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a form-deployment */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminFormDeploymentsResponse = GetAdminFormDeploymentsResponses[keyof GetAdminFormDeploymentsResponses]; export type PostAdminFormDeploymentsData = { /** * Request body for the /form-deployments operation on form-deployment resource */ body: { data: { attributes?: { allow_tenant_clone?: boolean | null; application_id: string; auto_deploy?: boolean | null; effective_version_id: string; form_id: string; is_application_default?: boolean | null; overrides?: { [key: string]: unknown; } | null; pinned_version_id?: string | null; seal_policy?: FormDeploymentSealPolicyInputCreateType; tenant_id: string; }; relationships?: { [key: string]: never; }; type?: "form-deployment"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/form-deployments"; }; export type PostAdminFormDeploymentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminFormDeploymentsError = PostAdminFormDeploymentsErrors[keyof PostAdminFormDeploymentsErrors]; export type PostAdminFormDeploymentsResponses = { /** * Success */ 201: { data?: FormDeployment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminFormDeploymentsResponse = PostAdminFormDeploymentsResponses[keyof PostAdminFormDeploymentsResponses]; export type GetAdminSettlementsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/settlements"; }; export type GetAdminSettlementsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSettlementsError = GetAdminSettlementsErrors[keyof GetAdminSettlementsErrors]; export type GetAdminSettlementsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a settlement */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSettlementsResponse = GetAdminSettlementsResponses[keyof GetAdminSettlementsResponses]; export type PostAdminSettlementsData = { /** * Request body for the /settlements operation on settlement resource */ body: { data: { attributes?: { application_id: string; /** * Per-operation and per-tenant breakdown for ISV visibility */ breakdown?: { [key: string]: unknown; } | null; isv_id: string; net_settlement_usd?: string | number | unknown; period_end: unknown; period_start: unknown; retail_revenue_usd?: string | number | unknown; status?: "pending" | "calculated" | "held" | "released" | "paid" | "failed"; wholesale_cost_usd?: string | number | unknown; }; relationships?: { [key: string]: never; }; type?: "settlement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/settlements"; }; export type PostAdminSettlementsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSettlementsError = PostAdminSettlementsErrors[keyof PostAdminSettlementsErrors]; export type PostAdminSettlementsResponses = { /** * Success */ 201: { data?: Settlement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSettlementsResponse = PostAdminSettlementsResponses[keyof PostAdminSettlementsResponses]; export type DeleteAdminReviewQueuesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/review-queues/{id}"; }; export type DeleteAdminReviewQueuesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminReviewQueuesByIdError = DeleteAdminReviewQueuesByIdErrors[keyof DeleteAdminReviewQueuesByIdErrors]; export type DeleteAdminReviewQueuesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminReviewQueuesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/review-queues/{id}"; }; export type GetAdminReviewQueuesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminReviewQueuesByIdError = GetAdminReviewQueuesByIdErrors[keyof GetAdminReviewQueuesByIdErrors]; export type GetAdminReviewQueuesByIdResponses = { /** * Success */ 200: { data?: ReviewQueue; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminReviewQueuesByIdResponse = GetAdminReviewQueuesByIdResponses[keyof GetAdminReviewQueuesByIdResponses]; export type PatchAdminReviewQueuesByIdData = { /** * Request body for the /review-queues/:id operation on review-queue resource */ body?: { data: { attributes?: { default_sla_minutes?: number | null; description?: string | null; is_archived?: boolean | null; name?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "review-queue"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/review-queues/{id}"; }; export type PatchAdminReviewQueuesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminReviewQueuesByIdError = PatchAdminReviewQueuesByIdErrors[keyof PatchAdminReviewQueuesByIdErrors]; export type PatchAdminReviewQueuesByIdResponses = { /** * Success */ 200: { data?: ReviewQueue; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminReviewQueuesByIdResponse = PatchAdminReviewQueuesByIdResponses[keyof PatchAdminReviewQueuesByIdResponses]; export type PatchAdminSocialTrendingWatchesByIdMarkTriggeredData = { /** * Request body for the /social/trending/watches/:id/mark-triggered operation on trending-watch resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "trending-watch"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/trending/watches/{id}/mark-triggered"; }; export type PatchAdminSocialTrendingWatchesByIdMarkTriggeredErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSocialTrendingWatchesByIdMarkTriggeredError = PatchAdminSocialTrendingWatchesByIdMarkTriggeredErrors[keyof PatchAdminSocialTrendingWatchesByIdMarkTriggeredErrors]; export type PatchAdminSocialTrendingWatchesByIdMarkTriggeredResponses = { /** * Success */ 200: { data?: TrendingWatch; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSocialTrendingWatchesByIdMarkTriggeredResponse = PatchAdminSocialTrendingWatchesByIdMarkTriggeredResponses[keyof PatchAdminSocialTrendingWatchesByIdMarkTriggeredResponses]; export type GetAdminEmailInclusionsEmailByOutboundEmailIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { outbound_email_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/inclusions/email/{outbound_email_id}"; }; export type GetAdminEmailInclusionsEmailByOutboundEmailIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailInclusionsEmailByOutboundEmailIdError = GetAdminEmailInclusionsEmailByOutboundEmailIdErrors[keyof GetAdminEmailInclusionsEmailByOutboundEmailIdErrors]; export type GetAdminEmailInclusionsEmailByOutboundEmailIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a email-inclusion */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailInclusionsEmailByOutboundEmailIdResponse = GetAdminEmailInclusionsEmailByOutboundEmailIdResponses[keyof GetAdminEmailInclusionsEmailByOutboundEmailIdResponses]; export type GetAdminConnectorsCredentialsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/connectors/credentials/{id}"; }; export type GetAdminConnectorsCredentialsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminConnectorsCredentialsByIdError = GetAdminConnectorsCredentialsByIdErrors[keyof GetAdminConnectorsCredentialsByIdErrors]; export type GetAdminConnectorsCredentialsByIdResponses = { /** * Success */ 200: { data?: Credential; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminConnectorsCredentialsByIdResponse = GetAdminConnectorsCredentialsByIdResponses[keyof GetAdminConnectorsCredentialsByIdResponses]; export type PatchAdminPipelineExecutionsByIdNoteData = { /** * Request body for the /pipeline-executions/:id/note operation on pipeline-execution resource */ body?: { data: { attributes?: { checkpoint_notes?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "pipeline-execution"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pipeline-executions/{id}/note"; }; export type PatchAdminPipelineExecutionsByIdNoteErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPipelineExecutionsByIdNoteError = PatchAdminPipelineExecutionsByIdNoteErrors[keyof PatchAdminPipelineExecutionsByIdNoteErrors]; export type PatchAdminPipelineExecutionsByIdNoteResponses = { /** * Success */ 200: { data?: PipelineExecution; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPipelineExecutionsByIdNoteResponse = PatchAdminPipelineExecutionsByIdNoteResponses[keyof PatchAdminPipelineExecutionsByIdNoteResponses]; export type PostAdminExtractionBatchesData = { /** * Request body for the /extraction/batches operation on extraction-batch resource */ body: { data: { attributes?: { name?: string | null; user_label?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "extraction-batch"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/batches"; }; export type PostAdminExtractionBatchesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminExtractionBatchesError = PostAdminExtractionBatchesErrors[keyof PostAdminExtractionBatchesErrors]; export type PostAdminExtractionBatchesResponses = { /** * Success */ 201: { data?: ExtractionBatch; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminExtractionBatchesResponse = PostAdminExtractionBatchesResponses[keyof PostAdminExtractionBatchesResponses]; export type PostAdminContentRefineData = { /** * Request body for the /content/refine operation on content-generation resource */ body: { data: { instructions: string; text: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/content/refine"; }; export type PostAdminContentRefineErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminContentRefineError = PostAdminContentRefineErrors[keyof PostAdminContentRefineErrors]; export type PostAdminContentRefineResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminContentRefineResponse = PostAdminContentRefineResponses[keyof PostAdminContentRefineResponses]; export type PatchAdminComplianceOfficerDesignationsByIdRevokeData = { /** * Request body for the /compliance-officer-designations/:id/revoke operation on compliance-officer-designation resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "compliance-officer-designation"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/compliance-officer-designations/{id}/revoke"; }; export type PatchAdminComplianceOfficerDesignationsByIdRevokeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminComplianceOfficerDesignationsByIdRevokeError = PatchAdminComplianceOfficerDesignationsByIdRevokeErrors[keyof PatchAdminComplianceOfficerDesignationsByIdRevokeErrors]; export type PatchAdminComplianceOfficerDesignationsByIdRevokeResponses = { /** * Success */ 200: { data?: ComplianceOfficerDesignation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminComplianceOfficerDesignationsByIdRevokeResponse = PatchAdminComplianceOfficerDesignationsByIdRevokeResponses[keyof PatchAdminComplianceOfficerDesignationsByIdRevokeResponses]; export type PatchAdminClinicalClientGoalsByIdApproveData = { /** * Request body for the /clinical/client-goals/:id/approve operation on clinical-client-goal resource */ body: { data: { attributes?: { reviewed_by_id: string; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-client-goal"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-goals/{id}/approve"; }; export type PatchAdminClinicalClientGoalsByIdApproveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalClientGoalsByIdApproveError = PatchAdminClinicalClientGoalsByIdApproveErrors[keyof PatchAdminClinicalClientGoalsByIdApproveErrors]; export type PatchAdminClinicalClientGoalsByIdApproveResponses = { /** * Success */ 200: { data?: ClinicalClientGoal; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalClientGoalsByIdApproveResponse = PatchAdminClinicalClientGoalsByIdApproveResponses[keyof PatchAdminClinicalClientGoalsByIdApproveResponses]; export type PatchAdminExtractionDocumentsByIdReprocessData = { /** * Request body for the /extraction/documents/:id/reprocess operation on extraction-document resource */ body?: { data: { attributes?: { /** * The version of the agent/schema used to process this document */ schema_version?: string | null; schema_version_id?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "extraction-document"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/documents/{id}/reprocess"; }; export type PatchAdminExtractionDocumentsByIdReprocessErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminExtractionDocumentsByIdReprocessError = PatchAdminExtractionDocumentsByIdReprocessErrors[keyof PatchAdminExtractionDocumentsByIdReprocessErrors]; export type PatchAdminExtractionDocumentsByIdReprocessResponses = { /** * Success */ 200: { data?: ExtractionDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminExtractionDocumentsByIdReprocessResponse = PatchAdminExtractionDocumentsByIdReprocessResponses[keyof PatchAdminExtractionDocumentsByIdReprocessResponses]; export type GetAdminClinicalPracticeResourcesCategoriesCatalogData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; application_id?: string; }; url: "/admin/clinical/practice-resources/categories/catalog"; }; export type GetAdminClinicalPracticeResourcesCategoriesCatalogErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPracticeResourcesCategoriesCatalogError = GetAdminClinicalPracticeResourcesCategoriesCatalogErrors[keyof GetAdminClinicalPracticeResourcesCategoriesCatalogErrors]; export type GetAdminClinicalPracticeResourcesCategoriesCatalogResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-practice-resource-category */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPracticeResourcesCategoriesCatalogResponse = GetAdminClinicalPracticeResourcesCategoriesCatalogResponses[keyof GetAdminClinicalPracticeResourcesCategoriesCatalogResponses]; export type GetAdminClinicalGoalTemplatesArchivedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/goal-templates/archived"; }; export type GetAdminClinicalGoalTemplatesArchivedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalGoalTemplatesArchivedError = GetAdminClinicalGoalTemplatesArchivedErrors[keyof GetAdminClinicalGoalTemplatesArchivedErrors]; export type GetAdminClinicalGoalTemplatesArchivedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-goal-template */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalGoalTemplatesArchivedResponse = GetAdminClinicalGoalTemplatesArchivedResponses[keyof GetAdminClinicalGoalTemplatesArchivedResponses]; export type GetAdminComplianceOfficerDesignationsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/compliance-officer-designations"; }; export type GetAdminComplianceOfficerDesignationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminComplianceOfficerDesignationsError = GetAdminComplianceOfficerDesignationsErrors[keyof GetAdminComplianceOfficerDesignationsErrors]; export type GetAdminComplianceOfficerDesignationsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a compliance-officer-designation */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminComplianceOfficerDesignationsResponse = GetAdminComplianceOfficerDesignationsResponses[keyof GetAdminComplianceOfficerDesignationsResponses]; export type PostAdminComplianceOfficerDesignationsData = { /** * Request body for the /compliance-officer-designations operation on compliance-officer-designation resource */ body: { data: { attributes?: { application_id: string; designated_at: unknown; designated_by_id: string; role: "security_officer" | "privacy_officer" | "compliance_officer"; user_id: string; }; relationships?: { [key: string]: never; }; type?: "compliance-officer-designation"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/compliance-officer-designations"; }; export type PostAdminComplianceOfficerDesignationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminComplianceOfficerDesignationsError = PostAdminComplianceOfficerDesignationsErrors[keyof PostAdminComplianceOfficerDesignationsErrors]; export type PostAdminComplianceOfficerDesignationsResponses = { /** * Success */ 201: { data?: ComplianceOfficerDesignation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminComplianceOfficerDesignationsResponse = PostAdminComplianceOfficerDesignationsResponses[keyof PostAdminComplianceOfficerDesignationsResponses]; export type DeleteAdminWorkspaceAgentConfigsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspace-agent-configs/{id}"; }; export type DeleteAdminWorkspaceAgentConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminWorkspaceAgentConfigsByIdError = DeleteAdminWorkspaceAgentConfigsByIdErrors[keyof DeleteAdminWorkspaceAgentConfigsByIdErrors]; export type DeleteAdminWorkspaceAgentConfigsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminWorkspaceAgentConfigsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspace-agent-configs/{id}"; }; export type GetAdminWorkspaceAgentConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWorkspaceAgentConfigsByIdError = GetAdminWorkspaceAgentConfigsByIdErrors[keyof GetAdminWorkspaceAgentConfigsByIdErrors]; export type GetAdminWorkspaceAgentConfigsByIdResponses = { /** * Success */ 200: { data?: WorkspaceAgentConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWorkspaceAgentConfigsByIdResponse = GetAdminWorkspaceAgentConfigsByIdResponses[keyof GetAdminWorkspaceAgentConfigsByIdResponses]; export type PatchAdminWorkspaceAgentConfigsByIdData = { /** * Request body for the /workspace-agent-configs/:id operation on workspace-agent-config resource */ body?: { data: { attributes?: { overrides?: { [key: string]: unknown; } | null; schema_overrides?: { [key: string]: unknown; } | null; }; id: string; relationships?: { [key: string]: never; }; type?: "workspace-agent-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspace-agent-configs/{id}"; }; export type PatchAdminWorkspaceAgentConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminWorkspaceAgentConfigsByIdError = PatchAdminWorkspaceAgentConfigsByIdErrors[keyof PatchAdminWorkspaceAgentConfigsByIdErrors]; export type PatchAdminWorkspaceAgentConfigsByIdResponses = { /** * Success */ 200: { data?: WorkspaceAgentConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminWorkspaceAgentConfigsByIdResponse = PatchAdminWorkspaceAgentConfigsByIdResponses[keyof PatchAdminWorkspaceAgentConfigsByIdResponses]; export type PostAdminCrmSyncConfigsData = { /** * Request body for the /crm/sync-configs operation on crm-sync-config resource */ body: { data: { attributes?: { application_id: string; auto_create_contacts?: boolean | null; connector_instance_id: string; enabled?: boolean | null; entity_type_filters?: Array | null; pii_scan_enabled?: boolean | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "crm-sync-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/sync-configs"; }; export type PostAdminCrmSyncConfigsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrmSyncConfigsError = PostAdminCrmSyncConfigsErrors[keyof PostAdminCrmSyncConfigsErrors]; export type PostAdminCrmSyncConfigsResponses = { /** * Success */ 201: { data?: CrmSyncConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrmSyncConfigsResponse = PostAdminCrmSyncConfigsResponses[keyof PostAdminCrmSyncConfigsResponses]; export type PatchAdminClaimedDomainsByIdVerifyData = { /** * Request body for the /claimed-domains/:id/verify operation on claimed-domain resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "claimed-domain"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/claimed-domains/{id}/verify"; }; export type PatchAdminClaimedDomainsByIdVerifyErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClaimedDomainsByIdVerifyError = PatchAdminClaimedDomainsByIdVerifyErrors[keyof PatchAdminClaimedDomainsByIdVerifyErrors]; export type PatchAdminClaimedDomainsByIdVerifyResponses = { /** * Success */ 200: { data?: ClaimedDomain; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClaimedDomainsByIdVerifyResponse = PatchAdminClaimedDomainsByIdVerifyResponses[keyof PatchAdminClaimedDomainsByIdVerifyResponses]; export type PatchAdminReviewsByIdClaimData = { /** * Request body for the /reviews/:id/claim operation on review resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "review"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/reviews/{id}/claim"; }; export type PatchAdminReviewsByIdClaimErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminReviewsByIdClaimError = PatchAdminReviewsByIdClaimErrors[keyof PatchAdminReviewsByIdClaimErrors]; export type PatchAdminReviewsByIdClaimResponses = { /** * Success */ 200: { data?: Review; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminReviewsByIdClaimResponse = PatchAdminReviewsByIdClaimResponses[keyof PatchAdminReviewsByIdClaimResponses]; export type PatchAdminStorageRecommendationsByIdDismissData = { /** * Request body for the /storage-recommendations/:id/dismiss operation on storage-recommendation resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "storage-recommendation"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/storage-recommendations/{id}/dismiss"; }; export type PatchAdminStorageRecommendationsByIdDismissErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminStorageRecommendationsByIdDismissError = PatchAdminStorageRecommendationsByIdDismissErrors[keyof PatchAdminStorageRecommendationsByIdDismissErrors]; export type PatchAdminStorageRecommendationsByIdDismissResponses = { /** * Success */ 200: { data?: StorageRecommendation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminStorageRecommendationsByIdDismissResponse = PatchAdminStorageRecommendationsByIdDismissResponses[keyof PatchAdminStorageRecommendationsByIdDismissResponses]; export type GetAdminSupportTicketsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; status?: string; priority?: string; queue_id?: string; assigned_agent_id?: string; owner_id?: string; }; url: "/admin/support/tickets/workspace/{workspace_id}"; }; export type GetAdminSupportTicketsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSupportTicketsWorkspaceByWorkspaceIdError = GetAdminSupportTicketsWorkspaceByWorkspaceIdErrors[keyof GetAdminSupportTicketsWorkspaceByWorkspaceIdErrors]; export type GetAdminSupportTicketsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a support-ticket */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSupportTicketsWorkspaceByWorkspaceIdResponse = GetAdminSupportTicketsWorkspaceByWorkspaceIdResponses[keyof GetAdminSupportTicketsWorkspaceByWorkspaceIdResponses]; export type PostAdminAgentsByIdExportData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { /** * Agent ID (from URL path parameter) */ id: string; }; query?: never; url: "/admin/agents/{id}/export"; }; export type PostAdminAgentsByIdExportErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAgentsByIdExportError = PostAdminAgentsByIdExportErrors[keyof PostAdminAgentsByIdExportErrors]; export type PostAdminAgentsByIdExportResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminAgentsByIdExportResponse = PostAdminAgentsByIdExportResponses[keyof PostAdminAgentsByIdExportResponses]; export type PatchAdminSettlementsByIdMarkCalculatedData = { /** * Request body for the /settlements/:id/mark-calculated operation on settlement resource */ body?: { data: { attributes?: { /** * Per-operation and per-tenant breakdown for ISV visibility */ breakdown?: { [key: string]: unknown; } | null; net_settlement_usd?: string | number | unknown; retail_revenue_usd?: string | number | unknown; wholesale_cost_usd?: string | number | unknown; }; id: string; relationships?: { [key: string]: never; }; type?: "settlement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/settlements/{id}/mark-calculated"; }; export type PatchAdminSettlementsByIdMarkCalculatedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSettlementsByIdMarkCalculatedError = PatchAdminSettlementsByIdMarkCalculatedErrors[keyof PatchAdminSettlementsByIdMarkCalculatedErrors]; export type PatchAdminSettlementsByIdMarkCalculatedResponses = { /** * Success */ 200: { data?: Settlement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSettlementsByIdMarkCalculatedResponse = PatchAdminSettlementsByIdMarkCalculatedResponses[keyof PatchAdminSettlementsByIdMarkCalculatedResponses]; export type GetAdminSocialMetricsPostBySocialPostIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { social_post_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/metrics/post/{social_post_id}"; }; export type GetAdminSocialMetricsPostBySocialPostIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialMetricsPostBySocialPostIdError = GetAdminSocialMetricsPostBySocialPostIdErrors[keyof GetAdminSocialMetricsPostBySocialPostIdErrors]; export type GetAdminSocialMetricsPostBySocialPostIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a post-metric */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialMetricsPostBySocialPostIdResponse = GetAdminSocialMetricsPostBySocialPostIdResponses[keyof GetAdminSocialMetricsPostBySocialPostIdResponses]; export type DeleteAdminSearchSavedByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/search/saved/{id}"; }; export type DeleteAdminSearchSavedByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminSearchSavedByIdError = DeleteAdminSearchSavedByIdErrors[keyof DeleteAdminSearchSavedByIdErrors]; export type DeleteAdminSearchSavedByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type PatchAdminSearchSavedByIdData = { /** * Request body for the /search/saved/:id operation on saved-search resource */ body?: { data: { attributes?: { filters?: { [key: string]: unknown; } | null; is_shared?: boolean | null; name?: string | null; query?: string | null; search_type?: "keyword" | "semantic"; }; id: string; relationships?: { [key: string]: never; }; type?: "saved-search"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/search/saved/{id}"; }; export type PatchAdminSearchSavedByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSearchSavedByIdError = PatchAdminSearchSavedByIdErrors[keyof PatchAdminSearchSavedByIdErrors]; export type PatchAdminSearchSavedByIdResponses = { /** * Success */ 200: { data?: SavedSearch; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSearchSavedByIdResponse = PatchAdminSearchSavedByIdResponses[keyof PatchAdminSearchSavedByIdResponses]; export type PostAdminContentSuggestTopicsData = { /** * Request body for the /content/suggest-topics operation on content-generation resource */ body: { data: { brand_identity_id?: string | null; count?: number | null; industry?: string | null; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/content/suggest-topics"; }; export type PostAdminContentSuggestTopicsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminContentSuggestTopicsError = PostAdminContentSuggestTopicsErrors[keyof PostAdminContentSuggestTopicsErrors]; export type PostAdminContentSuggestTopicsResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminContentSuggestTopicsResponse = PostAdminContentSuggestTopicsResponses[keyof PostAdminContentSuggestTopicsResponses]; export type GetAdminPipelineExecutionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pipeline-executions/{id}"; }; export type GetAdminPipelineExecutionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPipelineExecutionsByIdError = GetAdminPipelineExecutionsByIdErrors[keyof GetAdminPipelineExecutionsByIdErrors]; export type GetAdminPipelineExecutionsByIdResponses = { /** * Success */ 200: { data?: PipelineExecution; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPipelineExecutionsByIdResponse = GetAdminPipelineExecutionsByIdResponses[keyof GetAdminPipelineExecutionsByIdResponses]; export type PatchAdminApplicationsByIdGrantCreditsData = { /** * Request body for the /applications/:id/grant-credits operation on application resource */ body: { data: { attributes?: { amount: number; description?: string | null; tenant_id: string; }; id: string; relationships?: { [key: string]: never; }; type?: "application"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/applications/{id}/grant-credits"; }; export type PatchAdminApplicationsByIdGrantCreditsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminApplicationsByIdGrantCreditsError = PatchAdminApplicationsByIdGrantCreditsErrors[keyof PatchAdminApplicationsByIdGrantCreditsErrors]; export type PatchAdminApplicationsByIdGrantCreditsResponses = { /** * Success */ 200: { data?: Application; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminApplicationsByIdGrantCreditsResponse = PatchAdminApplicationsByIdGrantCreditsResponses[keyof PatchAdminApplicationsByIdGrantCreditsResponses]; export type PatchAdminStorageFilesByIdConfirmUploadData = { /** * Request body for the /storage-files/:id/confirm-upload operation on storage-file resource */ body?: { data: { attributes?: { checksum?: string | null; size_bytes?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "storage-file"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/storage-files/{id}/confirm-upload"; }; export type PatchAdminStorageFilesByIdConfirmUploadErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminStorageFilesByIdConfirmUploadError = PatchAdminStorageFilesByIdConfirmUploadErrors[keyof PatchAdminStorageFilesByIdConfirmUploadErrors]; export type PatchAdminStorageFilesByIdConfirmUploadResponses = { /** * Success */ 200: { data?: StorageFile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminStorageFilesByIdConfirmUploadResponse = PatchAdminStorageFilesByIdConfirmUploadResponses[keyof PatchAdminStorageFilesByIdConfirmUploadResponses]; export type GetAdminTransfersByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/transfers/{id}"; }; export type GetAdminTransfersByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminTransfersByIdError = GetAdminTransfersByIdErrors[keyof GetAdminTransfersByIdErrors]; export type GetAdminTransfersByIdResponses = { /** * Success */ 200: { data?: Transfer; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminTransfersByIdResponse = GetAdminTransfersByIdResponses[keyof GetAdminTransfersByIdResponses]; export type GetAdminFormVersionsByIdProtectionClassData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query: { field_path: string; }; url: "/admin/form-versions/{id}/protection-class"; }; export type GetAdminFormVersionsByIdProtectionClassErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminFormVersionsByIdProtectionClassError = GetAdminFormVersionsByIdProtectionClassErrors[keyof GetAdminFormVersionsByIdProtectionClassErrors]; export type GetAdminFormVersionsByIdProtectionClassResponses = { /** * Success */ 200: { [key: string]: unknown; }; }; export type GetAdminFormVersionsByIdProtectionClassResponse = GetAdminFormVersionsByIdProtectionClassResponses[keyof GetAdminFormVersionsByIdProtectionClassResponses]; export type GetAdminPlatformPricingConfigsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/platform-pricing-configs"; }; export type GetAdminPlatformPricingConfigsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPlatformPricingConfigsError = GetAdminPlatformPricingConfigsErrors[keyof GetAdminPlatformPricingConfigsErrors]; export type GetAdminPlatformPricingConfigsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a platform-pricing-config */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPlatformPricingConfigsResponse = GetAdminPlatformPricingConfigsResponses[keyof GetAdminPlatformPricingConfigsResponses]; export type PostAdminPlatformPricingConfigsData = { /** * Request body for the /platform-pricing-configs operation on platform-pricing-config resource */ body: { data: { attributes?: { /** * Schedule A category (e.g., 'llm', 'agent', 'extraction', 'communication') */ category?: string | null; /** * Pricing model: 'fixed' (credit rate) or 'passthrough' (provider cost + margin) */ cost_model?: string | null; /** * Default credit rate for this operation. NULL for passthrough (LLM). */ default_rate_credits?: number | null; /** * Human-readable description of this service */ description?: string | null; /** * Human-readable name for admin UI (e.g., 'LLM Input Tokens') */ display_name?: string | null; /** * Minimum price ISVs can charge. NULL means no configured floor. */ floor_price?: { amount: string; currency: string; } | unknown; /** * Platform COGS for this service (e.g., $0.002 per page for OCR) */ hard_cost?: { amount: string; currency: string; } | unknown; /** * Whether this operation incurs charges. False = metered only. */ is_billable?: boolean | null; /** * Minimum margin percentage. NULL means no configured margin. */ margin_percent?: number | null; /** * Additional configuration metadata (e.g., metric unit, operation type) */ metadata?: { [key: string]: unknown; } | null; /** * Schedule A operation key (e.g., 'llm_input_tokens', 'agent_execution_step') */ operation_key?: string | null; /** * Service identifier (e.g., 'doc_extraction_base', 'llm_usage') */ service_id: string; /** * Billing unit (e.g., 'per 1K tokens', 'per page', 'per email') */ unit?: string | null; }; relationships?: { [key: string]: never; }; type?: "platform-pricing-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/platform-pricing-configs"; }; export type PostAdminPlatformPricingConfigsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminPlatformPricingConfigsError = PostAdminPlatformPricingConfigsErrors[keyof PostAdminPlatformPricingConfigsErrors]; export type PostAdminPlatformPricingConfigsResponses = { /** * Success */ 201: { data?: PlatformPricingConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminPlatformPricingConfigsResponse = PostAdminPlatformPricingConfigsResponses[keyof PostAdminPlatformPricingConfigsResponses]; export type GetAdminClinicalGoalTemplatesCatalogData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-templates/catalog"; }; export type GetAdminClinicalGoalTemplatesCatalogErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalGoalTemplatesCatalogError = GetAdminClinicalGoalTemplatesCatalogErrors[keyof GetAdminClinicalGoalTemplatesCatalogErrors]; export type GetAdminClinicalGoalTemplatesCatalogResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-goal-template */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalGoalTemplatesCatalogResponse = GetAdminClinicalGoalTemplatesCatalogResponses[keyof GetAdminClinicalGoalTemplatesCatalogResponses]; export type PostAdminClinicalGoalTemplatesCatalogData = { /** * Request body for the /clinical/goal-templates/catalog operation on clinical-goal-template resource */ body: { data: { attributes?: { action_steps?: Array | null; age_groups?: Array | null; applicable_conditions?: Array | null; category?: string | null; description?: string | null; difficulty?: "beginner" | "intermediate" | "advanced"; evidence_base?: string | null; frequency?: "daily" | "weekly"; goal_type: string; instructions?: string | null; linked_metric_type?: string | null; metadata?: { [key: string]: unknown; } | null; priority?: "high" | "medium" | "low"; source_reference?: string | null; suggested_duration_days?: number | null; tags?: Array | null; target_value?: string | number | unknown; timeframe?: string | null; title: string; tool_ids?: Array | null; unit?: string | null; }; relationships?: { [key: string]: never; }; type?: "clinical-goal-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-templates/catalog"; }; export type PostAdminClinicalGoalTemplatesCatalogErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalGoalTemplatesCatalogError = PostAdminClinicalGoalTemplatesCatalogErrors[keyof PostAdminClinicalGoalTemplatesCatalogErrors]; export type PostAdminClinicalGoalTemplatesCatalogResponses = { /** * Success */ 201: { data?: ClinicalGoalTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalGoalTemplatesCatalogResponse = PostAdminClinicalGoalTemplatesCatalogResponses[keyof PostAdminClinicalGoalTemplatesCatalogResponses]; export type PatchAdminPolicyReviewSchedulesByIdCompleteReviewData = { /** * Request body for the /policy-review-schedules/:id/complete-review operation on policy-review-schedule resource */ body?: { data: { attributes?: { last_reviewed_by_id?: string | null; review_notes?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "policy-review-schedule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/policy-review-schedules/{id}/complete-review"; }; export type PatchAdminPolicyReviewSchedulesByIdCompleteReviewErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPolicyReviewSchedulesByIdCompleteReviewError = PatchAdminPolicyReviewSchedulesByIdCompleteReviewErrors[keyof PatchAdminPolicyReviewSchedulesByIdCompleteReviewErrors]; export type PatchAdminPolicyReviewSchedulesByIdCompleteReviewResponses = { /** * Success */ 200: { data?: PolicyReviewSchedule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPolicyReviewSchedulesByIdCompleteReviewResponse = PatchAdminPolicyReviewSchedulesByIdCompleteReviewResponses[keyof PatchAdminPolicyReviewSchedulesByIdCompleteReviewResponses]; export type PatchAdminWalletAddonsByAddonSlugCancelData = { /** * Request body for the /wallet/addons/:addon_slug/cancel operation on wallet resource */ body?: { data: { attributes?: { quantity?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "wallet"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { addon_slug: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/wallet/addons/{addon_slug}/cancel"; }; export type PatchAdminWalletAddonsByAddonSlugCancelErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminWalletAddonsByAddonSlugCancelError = PatchAdminWalletAddonsByAddonSlugCancelErrors[keyof PatchAdminWalletAddonsByAddonSlugCancelErrors]; export type PatchAdminWalletAddonsByAddonSlugCancelResponses = { /** * Success */ 200: { data?: Wallet; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminWalletAddonsByAddonSlugCancelResponse = PatchAdminWalletAddonsByAddonSlugCancelResponses[keyof PatchAdminWalletAddonsByAddonSlugCancelResponses]; export type GetAdminCampaignsSequencesWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/campaigns/sequences/workspace/{workspace_id}"; }; export type GetAdminCampaignsSequencesWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCampaignsSequencesWorkspaceByWorkspaceIdError = GetAdminCampaignsSequencesWorkspaceByWorkspaceIdErrors[keyof GetAdminCampaignsSequencesWorkspaceByWorkspaceIdErrors]; export type GetAdminCampaignsSequencesWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a email-marketing-sequence */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCampaignsSequencesWorkspaceByWorkspaceIdResponse = GetAdminCampaignsSequencesWorkspaceByWorkspaceIdResponses[keyof GetAdminCampaignsSequencesWorkspaceByWorkspaceIdResponses]; export type PostAdminEmailInboundAddressesData = { /** * Request body for the /email/inbound-addresses operation on email-inbound-address resource */ body: { data: { attributes?: { allowed_mime_types?: Array | null; daily_receive_limit?: number | null; handler_config?: { [key: string]: unknown; } | null; max_attachment_size_mb?: number | null; name: string; routing_target: "extraction" | "agent" | "invoices" | "crm"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "email-inbound-address"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/inbound-addresses"; }; export type PostAdminEmailInboundAddressesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminEmailInboundAddressesError = PostAdminEmailInboundAddressesErrors[keyof PostAdminEmailInboundAddressesErrors]; export type PostAdminEmailInboundAddressesResponses = { /** * Success */ 201: { data?: EmailInboundAddress; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminEmailInboundAddressesResponse = PostAdminEmailInboundAddressesResponses[keyof PostAdminEmailInboundAddressesResponses]; export type GetAdminSchedulingEventsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/events/{id}"; }; export type GetAdminSchedulingEventsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingEventsByIdError = GetAdminSchedulingEventsByIdErrors[keyof GetAdminSchedulingEventsByIdErrors]; export type GetAdminSchedulingEventsByIdResponses = { /** * Success */ 200: { data?: SchedulingEvent; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingEventsByIdResponse = GetAdminSchedulingEventsByIdResponses[keyof GetAdminSchedulingEventsByIdResponses]; export type PatchAdminSchedulingEventsByIdData = { /** * Request body for the /scheduling/events/:id operation on scheduling-event resource */ body?: { data: { attributes?: { description?: string | null; location?: SchedulingEventLocationInputUpdateType; location_id?: string | null; location_type?: "in_person" | "video" | "phone" | "custom_url"; metadata?: { [key: string]: unknown; } | null; notes?: string | null; timezone?: string | null; title?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "scheduling-event"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/events/{id}"; }; export type PatchAdminSchedulingEventsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSchedulingEventsByIdError = PatchAdminSchedulingEventsByIdErrors[keyof PatchAdminSchedulingEventsByIdErrors]; export type PatchAdminSchedulingEventsByIdResponses = { /** * Success */ 200: { data?: SchedulingEvent; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSchedulingEventsByIdResponse = PatchAdminSchedulingEventsByIdResponses[keyof PatchAdminSchedulingEventsByIdResponses]; export type PatchAdminCrawlerSchedulesByIdTriggerData = { /** * Request body for the /crawler/schedules/:id/trigger operation on crawler-schedule resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "crawler-schedule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/schedules/{id}/trigger"; }; export type PatchAdminCrawlerSchedulesByIdTriggerErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrawlerSchedulesByIdTriggerError = PatchAdminCrawlerSchedulesByIdTriggerErrors[keyof PatchAdminCrawlerSchedulesByIdTriggerErrors]; export type PatchAdminCrawlerSchedulesByIdTriggerResponses = { /** * Success */ 200: { data?: CrawlerSchedule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrawlerSchedulesByIdTriggerResponse = PatchAdminCrawlerSchedulesByIdTriggerResponses[keyof PatchAdminCrawlerSchedulesByIdTriggerResponses]; export type GetAdminLlmAnalyticsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/llm-analytics"; }; export type GetAdminLlmAnalyticsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminLlmAnalyticsError = GetAdminLlmAnalyticsErrors[keyof GetAdminLlmAnalyticsErrors]; export type GetAdminLlmAnalyticsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a llm-analytics */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminLlmAnalyticsResponse = GetAdminLlmAnalyticsResponses[keyof GetAdminLlmAnalyticsResponses]; export type PostAdminLlmAnalyticsData = { /** * Request body for the /llm-analytics operation on llm-analytics resource */ body: { data: { attributes?: { agent_id?: string | null; audio_seconds?: string | number | unknown; character_count?: number | null; confidence_score?: number | null; cost_usd?: string | number | unknown; image_pages?: number | null; image_tokens?: number | null; input_tokens?: number | null; latency_ms?: number | null; metadata?: { [key: string]: unknown; } | null; model_id: string; output_tokens?: number | null; provider?: string | null; task?: string | null; tenant_id?: string | null; total_tokens?: number | null; /** * Correlation ID to the unified UsageEvent record */ usage_event_id?: string | null; user_id?: string | null; wholesale_cost_usd?: string | number | unknown; workload?: string | null; workspace_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "llm-analytics"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/llm-analytics"; }; export type PostAdminLlmAnalyticsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminLlmAnalyticsError = PostAdminLlmAnalyticsErrors[keyof PostAdminLlmAnalyticsErrors]; export type PostAdminLlmAnalyticsResponses = { /** * Success */ 201: { data?: LlmAnalytics; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminLlmAnalyticsResponse = PostAdminLlmAnalyticsResponses[keyof PostAdminLlmAnalyticsResponses]; export type GetAdminRecipesTagsApplicationByApplicationIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { application_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; category?: "cuisine" | "diet" | "health" | "course" | "technique" | "custom"; }; url: "/admin/recipes/tags/application/{application_id}"; }; export type GetAdminRecipesTagsApplicationByApplicationIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesTagsApplicationByApplicationIdError = GetAdminRecipesTagsApplicationByApplicationIdErrors[keyof GetAdminRecipesTagsApplicationByApplicationIdErrors]; export type GetAdminRecipesTagsApplicationByApplicationIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a recipes-tag */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesTagsApplicationByApplicationIdResponse = GetAdminRecipesTagsApplicationByApplicationIdResponses[keyof GetAdminRecipesTagsApplicationByApplicationIdResponses]; export type GetAdminClinicalPracticeToolsCatalogByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-tools/catalog/{id}"; }; export type GetAdminClinicalPracticeToolsCatalogByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPracticeToolsCatalogByIdError = GetAdminClinicalPracticeToolsCatalogByIdErrors[keyof GetAdminClinicalPracticeToolsCatalogByIdErrors]; export type GetAdminClinicalPracticeToolsCatalogByIdResponses = { /** * Success */ 200: { data?: ClinicalPracticeTool; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPracticeToolsCatalogByIdResponse = GetAdminClinicalPracticeToolsCatalogByIdResponses[keyof GetAdminClinicalPracticeToolsCatalogByIdResponses]; export type PatchAdminClinicalPracticeToolsCatalogByIdData = { /** * Request body for the /clinical/practice-tools/catalog/:id operation on clinical-practice-tool resource */ body?: { data: { attributes?: { app_store_url?: string | null; category?: string | null; description?: string | null; icon_url?: string | null; integrations?: Array | null; is_active?: boolean | null; logo_url?: string | null; metadata?: { [key: string]: unknown; } | null; name?: string | null; platform?: string | null; play_store_url?: string | null; pricing_model?: "free" | "freemium" | "paid" | "prescription"; privacy_rating?: "hipaa_compliant" | "hipaa_partial" | "standard" | "unknown"; rating?: string | number | unknown; supported_platforms?: Array | null; tags?: Array | null; tool_type?: string | null; url?: string | null; website_url?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-practice-tool"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-tools/catalog/{id}"; }; export type PatchAdminClinicalPracticeToolsCatalogByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalPracticeToolsCatalogByIdError = PatchAdminClinicalPracticeToolsCatalogByIdErrors[keyof PatchAdminClinicalPracticeToolsCatalogByIdErrors]; export type PatchAdminClinicalPracticeToolsCatalogByIdResponses = { /** * Success */ 200: { data?: ClinicalPracticeTool; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalPracticeToolsCatalogByIdResponse = PatchAdminClinicalPracticeToolsCatalogByIdResponses[keyof PatchAdminClinicalPracticeToolsCatalogByIdResponses]; export type PostAdminCatalogTaxonomyNodesData = { /** * Request body for the /catalog/taxonomy-nodes operation on catalog-taxonomy-node resource */ body: { data: { attributes?: { description?: string | null; name: string; parent_id?: string | null; position?: number | null; slug: string; taxonomy_id: string; }; relationships?: { [key: string]: never; }; type?: "catalog-taxonomy-node"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/taxonomy-nodes"; }; export type PostAdminCatalogTaxonomyNodesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCatalogTaxonomyNodesError = PostAdminCatalogTaxonomyNodesErrors[keyof PostAdminCatalogTaxonomyNodesErrors]; export type PostAdminCatalogTaxonomyNodesResponses = { /** * Success */ 201: { data?: CatalogTaxonomyNode; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCatalogTaxonomyNodesResponse = PostAdminCatalogTaxonomyNodesResponses[keyof PostAdminCatalogTaxonomyNodesResponses]; export type GetAdminSchedulingEventsByParticipantData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; email: string; workspace_id: string; }; url: "/admin/scheduling/events/by_participant"; }; export type GetAdminSchedulingEventsByParticipantErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingEventsByParticipantError = GetAdminSchedulingEventsByParticipantErrors[keyof GetAdminSchedulingEventsByParticipantErrors]; export type GetAdminSchedulingEventsByParticipantResponses = { /** * Success */ 200: { /** * An array of resource objects representing a scheduling-event */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingEventsByParticipantResponse = GetAdminSchedulingEventsByParticipantResponses[keyof GetAdminSchedulingEventsByParticipantResponses]; export type GetAdminSettlementsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/settlements/{id}"; }; export type GetAdminSettlementsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSettlementsByIdError = GetAdminSettlementsByIdErrors[keyof GetAdminSettlementsByIdErrors]; export type GetAdminSettlementsByIdResponses = { /** * Success */ 200: { data?: Settlement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSettlementsByIdResponse = GetAdminSettlementsByIdResponses[keyof GetAdminSettlementsByIdResponses]; export type PatchAdminSettlementsByIdData = { /** * Request body for the /settlements/:id operation on settlement resource */ body?: { data: { attributes?: { /** * Per-operation and per-tenant breakdown for ISV visibility */ breakdown?: { [key: string]: unknown; } | null; /** * Error message if settlement failed */ error_message?: string | null; /** * Date when funds can be released from hold */ hold_until?: unknown; net_settlement_usd?: string | number | unknown; /** * When settlement was paid out */ paid_at?: unknown; /** * QorPay ACH transaction ID for payout */ qorpay_transaction_id?: string | null; retail_revenue_usd?: string | number | unknown; status?: "pending" | "calculated" | "held" | "released" | "paid" | "failed"; wholesale_cost_usd?: string | number | unknown; }; id: string; relationships?: { [key: string]: never; }; type?: "settlement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/settlements/{id}"; }; export type PatchAdminSettlementsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSettlementsByIdError = PatchAdminSettlementsByIdErrors[keyof PatchAdminSettlementsByIdErrors]; export type PatchAdminSettlementsByIdResponses = { /** * Success */ 200: { data?: Settlement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSettlementsByIdResponse = PatchAdminSettlementsByIdResponses[keyof PatchAdminSettlementsByIdResponses]; export type PostAdminAgentsByIdRestoreVersionData = { /** * Request body for the /agents/:id/restore-version operation on agent resource */ body: { data: { version_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { /** * Agent ID (from URL path parameter) */ id: string; }; query?: never; url: "/admin/agents/{id}/restore-version"; }; export type PostAdminAgentsByIdRestoreVersionErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAgentsByIdRestoreVersionError = PostAdminAgentsByIdRestoreVersionErrors[keyof PostAdminAgentsByIdRestoreVersionErrors]; export type PostAdminAgentsByIdRestoreVersionResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminAgentsByIdRestoreVersionResponse = PostAdminAgentsByIdRestoreVersionResponses[keyof PostAdminAgentsByIdRestoreVersionResponses]; export type PostAdminClinicalSupplementTemplatesFromExistingData = { /** * Request body for the /clinical/supplement-templates/from-existing operation on clinical-supplement-template resource */ body: { data: { attributes?: { source_template_id: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-supplement-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-templates/from-existing"; }; export type PostAdminClinicalSupplementTemplatesFromExistingErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalSupplementTemplatesFromExistingError = PostAdminClinicalSupplementTemplatesFromExistingErrors[keyof PostAdminClinicalSupplementTemplatesFromExistingErrors]; export type PostAdminClinicalSupplementTemplatesFromExistingResponses = { /** * Success */ 201: { data?: ClinicalSupplementTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalSupplementTemplatesFromExistingResponse = PostAdminClinicalSupplementTemplatesFromExistingResponses[keyof PostAdminClinicalSupplementTemplatesFromExistingResponses]; export type GetAdminThreadsSearchData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; query: string; }; url: "/admin/threads/search"; }; export type GetAdminThreadsSearchErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminThreadsSearchError = GetAdminThreadsSearchErrors[keyof GetAdminThreadsSearchErrors]; export type GetAdminThreadsSearchResponses = { /** * Success */ 200: { /** * An array of resource objects representing a chat-thread */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminThreadsSearchResponse = GetAdminThreadsSearchResponses[keyof GetAdminThreadsSearchResponses]; export type GetAdminClinicalPracticeResourcesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-resources/{id}"; }; export type GetAdminClinicalPracticeResourcesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPracticeResourcesByIdError = GetAdminClinicalPracticeResourcesByIdErrors[keyof GetAdminClinicalPracticeResourcesByIdErrors]; export type GetAdminClinicalPracticeResourcesByIdResponses = { /** * Success */ 200: { data?: ClinicalPracticeResource; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPracticeResourcesByIdResponse = GetAdminClinicalPracticeResourcesByIdResponses[keyof GetAdminClinicalPracticeResourcesByIdResponses]; export type PatchAdminClinicalPracticeResourcesByIdData = { /** * Request body for the /clinical/practice-resources/:id operation on clinical-practice-resource resource */ body?: { data: { attributes?: { applicable_conditions?: Array | null; audience?: "patient" | "practitioner" | "both"; author?: string | null; category?: string | null; condition_tags?: Array | null; content_format?: "pdf" | "html" | "video_embed" | "external_link" | "interactive"; description?: string | null; estimated_duration_minutes?: number | null; icon_url?: string | null; is_active?: boolean | null; language?: string | null; license?: string | null; metadata?: { [key: string]: unknown; } | null; preview_url?: string | null; reading_level?: "basic" | "intermediate" | "advanced" | "clinical"; related_goal_types?: Array | null; resource_type?: "article" | "video" | "handout" | "worksheet" | "tool_link" | "infographic" | "audio" | "recipe" | "checklist" | "protocol" | "assessment" | "exercise" | "template" | "presentation" | "ebook" | "other"; storage_key?: string | null; tags?: Array | null; title?: string | null; url?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-practice-resource"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-resources/{id}"; }; export type PatchAdminClinicalPracticeResourcesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalPracticeResourcesByIdError = PatchAdminClinicalPracticeResourcesByIdErrors[keyof PatchAdminClinicalPracticeResourcesByIdErrors]; export type PatchAdminClinicalPracticeResourcesByIdResponses = { /** * Success */ 200: { data?: ClinicalPracticeResource; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalPracticeResourcesByIdResponse = PatchAdminClinicalPracticeResourcesByIdResponses[keyof PatchAdminClinicalPracticeResourcesByIdResponses]; export type GetAdminAgentsByIdTrainingExamplesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { /** * Agent ID (from URL path parameter) */ id: string; }; query?: never; url: "/admin/agents/{id}/training-examples"; }; export type GetAdminAgentsByIdTrainingExamplesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentsByIdTrainingExamplesError = GetAdminAgentsByIdTrainingExamplesErrors[keyof GetAdminAgentsByIdTrainingExamplesErrors]; export type GetAdminAgentsByIdTrainingExamplesResponses = { /** * Success */ 200: { result: { [key: string]: unknown; }; }; }; export type GetAdminAgentsByIdTrainingExamplesResponse = GetAdminAgentsByIdTrainingExamplesResponses[keyof GetAdminAgentsByIdTrainingExamplesResponses]; export type PostAdminRecipesScheduledMealsData = { /** * Request body for the /recipes/scheduled-meals operation on recipes-scheduled-meal resource */ body: { data: { attributes?: { date: string; meal_schedule_id: string; meal_type: "breakfast" | "lunch" | "dinner" | "snack"; recipe_id: string; servings?: number | null; }; relationships?: { [key: string]: never; }; type?: "recipes-scheduled-meal"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/scheduled-meals"; }; export type PostAdminRecipesScheduledMealsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminRecipesScheduledMealsError = PostAdminRecipesScheduledMealsErrors[keyof PostAdminRecipesScheduledMealsErrors]; export type PostAdminRecipesScheduledMealsResponses = { /** * Success */ 201: { data?: RecipesScheduledMeal; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminRecipesScheduledMealsResponse = PostAdminRecipesScheduledMealsResponses[keyof PostAdminRecipesScheduledMealsResponses]; export type GetAdminRecipesFavoritesWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/favorites/workspace/{workspace_id}"; }; export type GetAdminRecipesFavoritesWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesFavoritesWorkspaceByWorkspaceIdError = GetAdminRecipesFavoritesWorkspaceByWorkspaceIdErrors[keyof GetAdminRecipesFavoritesWorkspaceByWorkspaceIdErrors]; export type GetAdminRecipesFavoritesWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a recipes-recipe-favorite */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesFavoritesWorkspaceByWorkspaceIdResponse = GetAdminRecipesFavoritesWorkspaceByWorkspaceIdResponses[keyof GetAdminRecipesFavoritesWorkspaceByWorkspaceIdResponses]; export type PatchAdminUsersAuthPasswordChangeData = { /** * Request body for the /users/auth/password/change operation on user resource */ body: { data: { attributes?: { current_jti?: string | null; current_password: string; password: string; password_confirmation: string; revoke_other_sessions: boolean; }; id: string; relationships?: { [key: string]: never; }; type?: "user"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/users/auth/password/change"; }; export type PatchAdminUsersAuthPasswordChangeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminUsersAuthPasswordChangeError = PatchAdminUsersAuthPasswordChangeErrors[keyof PatchAdminUsersAuthPasswordChangeErrors]; export type PatchAdminUsersAuthPasswordChangeResponses = { /** * Success */ 200: { data?: User; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminUsersAuthPasswordChangeResponse = PatchAdminUsersAuthPasswordChangeResponses[keyof PatchAdminUsersAuthPasswordChangeResponses]; export type DeleteAdminCatalogViewsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/views/{id}"; }; export type DeleteAdminCatalogViewsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCatalogViewsByIdError = DeleteAdminCatalogViewsByIdErrors[keyof DeleteAdminCatalogViewsByIdErrors]; export type DeleteAdminCatalogViewsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCatalogViewsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/views/{id}"; }; export type GetAdminCatalogViewsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogViewsByIdError = GetAdminCatalogViewsByIdErrors[keyof GetAdminCatalogViewsByIdErrors]; export type GetAdminCatalogViewsByIdResponses = { /** * Success */ 200: { data?: CatalogView; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogViewsByIdResponse = GetAdminCatalogViewsByIdResponses[keyof GetAdminCatalogViewsByIdResponses]; export type PatchAdminCatalogViewsByIdData = { /** * Request body for the /catalog/views/:id operation on catalog-view resource */ body?: { data: { attributes?: { channel_target?: string | null; default_sort?: "name" | "newest" | "price_asc" | "price_desc"; description?: string | null; locale?: string | null; max_items?: number | null; name?: string | null; price_list_id?: string | null; slug?: string | null; status?: "draft" | "active" | "archived"; visibility?: "public" | "private" | "restricted"; }; id: string; relationships?: { [key: string]: never; }; type?: "catalog-view"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/views/{id}"; }; export type PatchAdminCatalogViewsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCatalogViewsByIdError = PatchAdminCatalogViewsByIdErrors[keyof PatchAdminCatalogViewsByIdErrors]; export type PatchAdminCatalogViewsByIdResponses = { /** * Success */ 200: { data?: CatalogView; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCatalogViewsByIdResponse = PatchAdminCatalogViewsByIdResponses[keyof PatchAdminCatalogViewsByIdResponses]; export type PatchAdminCrmWebsitesByIdSetPrimaryData = { /** * Request body for the /crm/websites/:id/set-primary operation on crm-website resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-website"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/websites/{id}/set-primary"; }; export type PatchAdminCrmWebsitesByIdSetPrimaryErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmWebsitesByIdSetPrimaryError = PatchAdminCrmWebsitesByIdSetPrimaryErrors[keyof PatchAdminCrmWebsitesByIdSetPrimaryErrors]; export type PatchAdminCrmWebsitesByIdSetPrimaryResponses = { /** * Success */ 200: { data?: CrmWebsite; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmWebsitesByIdSetPrimaryResponse = PatchAdminCrmWebsitesByIdSetPrimaryResponses[keyof PatchAdminCrmWebsitesByIdSetPrimaryResponses]; export type DeleteAdminCatalogProductVariantsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/product-variants/{id}"; }; export type DeleteAdminCatalogProductVariantsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCatalogProductVariantsByIdError = DeleteAdminCatalogProductVariantsByIdErrors[keyof DeleteAdminCatalogProductVariantsByIdErrors]; export type DeleteAdminCatalogProductVariantsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCatalogProductVariantsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/product-variants/{id}"; }; export type GetAdminCatalogProductVariantsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogProductVariantsByIdError = GetAdminCatalogProductVariantsByIdErrors[keyof GetAdminCatalogProductVariantsByIdErrors]; export type GetAdminCatalogProductVariantsByIdResponses = { /** * Success */ 200: { data?: CatalogProductVariant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogProductVariantsByIdResponse = GetAdminCatalogProductVariantsByIdResponses[keyof GetAdminCatalogProductVariantsByIdResponses]; export type PatchAdminCatalogProductVariantsByIdData = { /** * Request body for the /catalog/product-variants/:id operation on catalog-product-variant resource */ body?: { data: { attributes?: { media?: Array<{ [key: string]: unknown; }> | null; position?: number | null; price_override?: string | number | unknown; properties?: { [key: string]: unknown; } | null; sku?: string | null; status?: "active" | "archived"; }; id: string; relationships?: { [key: string]: never; }; type?: "catalog-product-variant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/product-variants/{id}"; }; export type PatchAdminCatalogProductVariantsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCatalogProductVariantsByIdError = PatchAdminCatalogProductVariantsByIdErrors[keyof PatchAdminCatalogProductVariantsByIdErrors]; export type PatchAdminCatalogProductVariantsByIdResponses = { /** * Success */ 200: { data?: CatalogProductVariant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCatalogProductVariantsByIdResponse = PatchAdminCatalogProductVariantsByIdResponses[keyof PatchAdminCatalogProductVariantsByIdResponses]; export type DeleteAdminTenantPricingOverridesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenant-pricing-overrides/{id}"; }; export type DeleteAdminTenantPricingOverridesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminTenantPricingOverridesByIdError = DeleteAdminTenantPricingOverridesByIdErrors[keyof DeleteAdminTenantPricingOverridesByIdErrors]; export type DeleteAdminTenantPricingOverridesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminTenantPricingOverridesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenant-pricing-overrides/{id}"; }; export type GetAdminTenantPricingOverridesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminTenantPricingOverridesByIdError = GetAdminTenantPricingOverridesByIdErrors[keyof GetAdminTenantPricingOverridesByIdErrors]; export type GetAdminTenantPricingOverridesByIdResponses = { /** * Success */ 200: { data?: TenantPricingOverride; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminTenantPricingOverridesByIdResponse = GetAdminTenantPricingOverridesByIdResponses[keyof GetAdminTenantPricingOverridesByIdResponses]; export type PatchAdminTenantPricingOverridesByIdData = { /** * Request body for the /tenant-pricing-overrides/:id operation on tenant-pricing-override resource */ body?: { data: { attributes?: { /** * When this override expires. NULL means no expiration. */ expires_at?: unknown; floor_price?: { amount: string; currency: string; } | unknown; margin_percent?: number | null; /** * Audit trail: why this override was created (e.g., 'Volume discount', 'Promotional pricing') */ reason?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "tenant-pricing-override"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenant-pricing-overrides/{id}"; }; export type PatchAdminTenantPricingOverridesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminTenantPricingOverridesByIdError = PatchAdminTenantPricingOverridesByIdErrors[keyof PatchAdminTenantPricingOverridesByIdErrors]; export type PatchAdminTenantPricingOverridesByIdResponses = { /** * Success */ 200: { data?: TenantPricingOverride; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminTenantPricingOverridesByIdResponse = PatchAdminTenantPricingOverridesByIdResponses[keyof PatchAdminTenantPricingOverridesByIdResponses]; export type DeleteAdminEmailMarketingCampaignsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/campaigns/{id}"; }; export type DeleteAdminEmailMarketingCampaignsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminEmailMarketingCampaignsByIdError = DeleteAdminEmailMarketingCampaignsByIdErrors[keyof DeleteAdminEmailMarketingCampaignsByIdErrors]; export type DeleteAdminEmailMarketingCampaignsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminEmailMarketingCampaignsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/campaigns/{id}"; }; export type GetAdminEmailMarketingCampaignsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailMarketingCampaignsByIdError = GetAdminEmailMarketingCampaignsByIdErrors[keyof GetAdminEmailMarketingCampaignsByIdErrors]; export type GetAdminEmailMarketingCampaignsByIdResponses = { /** * Success */ 200: { data?: Campaign; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailMarketingCampaignsByIdResponse = GetAdminEmailMarketingCampaignsByIdResponses[keyof GetAdminEmailMarketingCampaignsByIdResponses]; export type PatchAdminEmailMarketingCampaignsByIdData = { /** * Request body for the /email-marketing/campaigns/:id operation on campaign resource */ body?: { data: { attributes?: { description?: string | null; include_tracking_pixel?: boolean | null; include_unsubscribe_link?: boolean | null; name?: string | null; sender_email?: string | null; sender_name?: string | null; sender_signature?: string | null; unsubscribe_message?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "campaign"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/campaigns/{id}"; }; export type PatchAdminEmailMarketingCampaignsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailMarketingCampaignsByIdError = PatchAdminEmailMarketingCampaignsByIdErrors[keyof PatchAdminEmailMarketingCampaignsByIdErrors]; export type PatchAdminEmailMarketingCampaignsByIdResponses = { /** * Success */ 200: { data?: Campaign; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailMarketingCampaignsByIdResponse = PatchAdminEmailMarketingCampaignsByIdResponses[keyof PatchAdminEmailMarketingCampaignsByIdResponses]; export type GetAdminSupportSlaPoliciesApplicationByApplicationIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { application_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/sla-policies/application/{application_id}"; }; export type GetAdminSupportSlaPoliciesApplicationByApplicationIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSupportSlaPoliciesApplicationByApplicationIdError = GetAdminSupportSlaPoliciesApplicationByApplicationIdErrors[keyof GetAdminSupportSlaPoliciesApplicationByApplicationIdErrors]; export type GetAdminSupportSlaPoliciesApplicationByApplicationIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a support-sla-policy */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSupportSlaPoliciesApplicationByApplicationIdResponse = GetAdminSupportSlaPoliciesApplicationByApplicationIdResponses[keyof GetAdminSupportSlaPoliciesApplicationByApplicationIdResponses]; export type DeleteAdminCatalogVariantOptionValuesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/variant-option-values/{id}"; }; export type DeleteAdminCatalogVariantOptionValuesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCatalogVariantOptionValuesByIdError = DeleteAdminCatalogVariantOptionValuesByIdErrors[keyof DeleteAdminCatalogVariantOptionValuesByIdErrors]; export type DeleteAdminCatalogVariantOptionValuesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminClinicalPatientInsuranceData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; patient_id: string; }; url: "/admin/clinical/patient-insurance"; }; export type GetAdminClinicalPatientInsuranceErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPatientInsuranceError = GetAdminClinicalPatientInsuranceErrors[keyof GetAdminClinicalPatientInsuranceErrors]; export type GetAdminClinicalPatientInsuranceResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-patient-insurance */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPatientInsuranceResponse = GetAdminClinicalPatientInsuranceResponses[keyof GetAdminClinicalPatientInsuranceResponses]; export type PostAdminClinicalPatientInsuranceData = { /** * Request body for the /clinical/patient-insurance operation on clinical-patient-insurance resource */ body: { data: { attributes?: { authorization_number?: string | null; carrier_name?: string | null; copay_amount?: string | number | unknown; coverage_end?: string | null; coverage_start?: string | null; group_number?: string | null; member_id?: string | null; metadata?: { [key: string]: unknown; } | null; patient_id: string; payer_id?: string | null; plan_name?: string | null; plan_type?: "ppo" | "hmo" | "epo" | "pos" | "hdhp" | "medicaid" | "medicare" | "tricare" | "other"; rank: "primary" | "secondary" | "tertiary"; status?: "active" | "inactive" | "pending_verification"; subscriber_name?: string | null; subscriber_relationship?: "self" | "spouse" | "child" | "other"; }; relationships?: { [key: string]: never; }; type?: "clinical-patient-insurance"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/patient-insurance"; }; export type PostAdminClinicalPatientInsuranceErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalPatientInsuranceError = PostAdminClinicalPatientInsuranceErrors[keyof PostAdminClinicalPatientInsuranceErrors]; export type PostAdminClinicalPatientInsuranceResponses = { /** * Success */ 201: { data?: ClinicalPatientInsurance; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalPatientInsuranceResponse = PostAdminClinicalPatientInsuranceResponses[keyof PostAdminClinicalPatientInsuranceResponses]; export type PostAdminUsersAuthRegisterData = { /** * Request body for the /users/auth/register operation on user resource */ body: { data: { attributes?: { /** * Per-call override of the Application's `system_email_method` for this * single register call. When omitted, the resolved method falls back to * the Application's `system_email_method` (default `:link`). * */ confirmation_method?: "link" | "code"; email: string; first_name?: string | null; last_name?: string | null; legal_documents_accepted?: Array<{ [key: string]: unknown; }> | null; password: string; password_confirmation: string; tenant_name: string; tos_version?: string | null; }; relationships?: { [key: string]: never; }; type?: "user"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/users/auth/register"; }; export type PostAdminUsersAuthRegisterErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminUsersAuthRegisterError = PostAdminUsersAuthRegisterErrors[keyof PostAdminUsersAuthRegisterErrors]; export type PostAdminUsersAuthRegisterResponses = { /** * Success */ 201: { data?: User; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminUsersAuthRegisterResponse = PostAdminUsersAuthRegisterResponses[keyof PostAdminUsersAuthRegisterResponses]; export type GetAdminWebhookDeliveriesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/webhook-deliveries/{id}"; }; export type GetAdminWebhookDeliveriesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWebhookDeliveriesByIdError = GetAdminWebhookDeliveriesByIdErrors[keyof GetAdminWebhookDeliveriesByIdErrors]; export type GetAdminWebhookDeliveriesByIdResponses = { /** * Success */ 200: { data?: WebhookDelivery; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWebhookDeliveriesByIdResponse = GetAdminWebhookDeliveriesByIdResponses[keyof GetAdminWebhookDeliveriesByIdResponses]; export type PatchAdminClinicalPracticeResourcesByIdRestoreData = { /** * Request body for the /clinical/practice-resources/:id/restore operation on clinical-practice-resource resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-practice-resource"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-resources/{id}/restore"; }; export type PatchAdminClinicalPracticeResourcesByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalPracticeResourcesByIdRestoreError = PatchAdminClinicalPracticeResourcesByIdRestoreErrors[keyof PatchAdminClinicalPracticeResourcesByIdRestoreErrors]; export type PatchAdminClinicalPracticeResourcesByIdRestoreResponses = { /** * Success */ 200: { data?: ClinicalPracticeResource; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalPracticeResourcesByIdRestoreResponse = PatchAdminClinicalPracticeResourcesByIdRestoreResponses[keyof PatchAdminClinicalPracticeResourcesByIdRestoreResponses]; export type PostAdminCrmSocialProfilesData = { /** * Request body for the /crm/social-profiles operation on crm-social-profile resource */ body: { data: { attributes?: { entity_id: string; entity_type: "contact" | "company"; handle?: string | null; platform: "linkedin" | "twitter" | "facebook" | "instagram" | "github" | "youtube" | "tiktok" | "other"; url?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "crm-social-profile"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/social-profiles"; }; export type PostAdminCrmSocialProfilesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrmSocialProfilesError = PostAdminCrmSocialProfilesErrors[keyof PostAdminCrmSocialProfilesErrors]; export type PostAdminCrmSocialProfilesResponses = { /** * Success */ 201: { data?: CrmSocialProfile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrmSocialProfilesResponse = PostAdminCrmSocialProfilesResponses[keyof PostAdminCrmSocialProfilesResponses]; export type GetAdminClinicalGoalTemplatesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; /** * Filter by frequency (daily or weekly) */ frequency?: "daily" | "weekly"; }; url: "/admin/clinical/goal-templates"; }; export type GetAdminClinicalGoalTemplatesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalGoalTemplatesError = GetAdminClinicalGoalTemplatesErrors[keyof GetAdminClinicalGoalTemplatesErrors]; export type GetAdminClinicalGoalTemplatesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-goal-template */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalGoalTemplatesResponse = GetAdminClinicalGoalTemplatesResponses[keyof GetAdminClinicalGoalTemplatesResponses]; export type PostAdminClinicalGoalTemplatesData = { /** * Request body for the /clinical/goal-templates operation on clinical-goal-template resource */ body: { data: { attributes?: { action_steps?: Array | null; age_groups?: Array | null; applicable_conditions?: Array | null; category?: string | null; description?: string | null; difficulty?: "beginner" | "intermediate" | "advanced"; evidence_base?: string | null; frequency?: "daily" | "weekly"; goal_type: string; instructions?: string | null; linked_metric_type?: string | null; metadata?: { [key: string]: unknown; } | null; priority?: "high" | "medium" | "low"; source_catalog_id?: string | null; source_reference?: string | null; suggested_duration_days?: number | null; tags?: Array | null; target_value?: string | number | unknown; timeframe?: string | null; title: string; tool_ids?: Array | null; unit?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-goal-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-templates"; }; export type PostAdminClinicalGoalTemplatesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalGoalTemplatesError = PostAdminClinicalGoalTemplatesErrors[keyof PostAdminClinicalGoalTemplatesErrors]; export type PostAdminClinicalGoalTemplatesResponses = { /** * Success */ 201: { data?: ClinicalGoalTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalGoalTemplatesResponse = PostAdminClinicalGoalTemplatesResponses[keyof PostAdminClinicalGoalTemplatesResponses]; export type GetAdminWholesaleAgreementsByIdSignupGrantStatusData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/wholesale-agreements/{id}/signup-grant-status"; }; export type GetAdminWholesaleAgreementsByIdSignupGrantStatusErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWholesaleAgreementsByIdSignupGrantStatusError = GetAdminWholesaleAgreementsByIdSignupGrantStatusErrors[keyof GetAdminWholesaleAgreementsByIdSignupGrantStatusErrors]; export type GetAdminWholesaleAgreementsByIdSignupGrantStatusResponses = { /** * Success */ 200: { result: { [key: string]: unknown; }; }; }; export type GetAdminWholesaleAgreementsByIdSignupGrantStatusResponse = GetAdminWholesaleAgreementsByIdSignupGrantStatusResponses[keyof GetAdminWholesaleAgreementsByIdSignupGrantStatusResponses]; export type PatchAdminThreadsByIdUnarchiveData = { /** * Request body for the /threads/:id/unarchive operation on chat-thread resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "chat-thread"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/threads/{id}/unarchive"; }; export type PatchAdminThreadsByIdUnarchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminThreadsByIdUnarchiveError = PatchAdminThreadsByIdUnarchiveErrors[keyof PatchAdminThreadsByIdUnarchiveErrors]; export type PatchAdminThreadsByIdUnarchiveResponses = { /** * Success */ 200: { data?: ChatThread; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminThreadsByIdUnarchiveResponse = PatchAdminThreadsByIdUnarchiveResponses[keyof PatchAdminThreadsByIdUnarchiveResponses]; export type PostAdminConnectorsFullscriptTreatmentPlansListData = { /** * Request body for the /connectors/fullscript/treatment-plans/list operation on connector-instance resource */ body: { data: { connector_id: string; patient_id: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/connectors/fullscript/treatment-plans/list"; }; export type PostAdminConnectorsFullscriptTreatmentPlansListErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsFullscriptTreatmentPlansListError = PostAdminConnectorsFullscriptTreatmentPlansListErrors[keyof PostAdminConnectorsFullscriptTreatmentPlansListErrors]; export type PostAdminConnectorsFullscriptTreatmentPlansListResponses = { /** * Success */ 201: Array<{ [key: string]: unknown; }>; }; export type PostAdminConnectorsFullscriptTreatmentPlansListResponse = PostAdminConnectorsFullscriptTreatmentPlansListResponses[keyof PostAdminConnectorsFullscriptTreatmentPlansListResponses]; export type PostAdminAgentsByIdSchemaVersionsByVersionIdActivateData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { version_id: string; /** * Agent ID (automatically mapped from route) */ id: string; }; query?: never; url: "/admin/agents/{id}/schema-versions/{version_id}/activate"; }; export type PostAdminAgentsByIdSchemaVersionsByVersionIdActivateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAgentsByIdSchemaVersionsByVersionIdActivateError = PostAdminAgentsByIdSchemaVersionsByVersionIdActivateErrors[keyof PostAdminAgentsByIdSchemaVersionsByVersionIdActivateErrors]; export type PostAdminAgentsByIdSchemaVersionsByVersionIdActivateResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminAgentsByIdSchemaVersionsByVersionIdActivateResponse = PostAdminAgentsByIdSchemaVersionsByVersionIdActivateResponses[keyof PostAdminAgentsByIdSchemaVersionsByVersionIdActivateResponses]; export type GetAdminSchedulingLocationsByTypeData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; type: "venue" | "room" | "virtual" | "resource"; }; url: "/admin/scheduling/locations/by-type"; }; export type GetAdminSchedulingLocationsByTypeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingLocationsByTypeError = GetAdminSchedulingLocationsByTypeErrors[keyof GetAdminSchedulingLocationsByTypeErrors]; export type GetAdminSchedulingLocationsByTypeResponses = { /** * Success */ 200: { /** * An array of resource objects representing a scheduling-location */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingLocationsByTypeResponse = GetAdminSchedulingLocationsByTypeResponses[keyof GetAdminSchedulingLocationsByTypeResponses]; export type GetAdminSchedulingLocationsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/scheduling/locations"; }; export type GetAdminSchedulingLocationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingLocationsError = GetAdminSchedulingLocationsErrors[keyof GetAdminSchedulingLocationsErrors]; export type GetAdminSchedulingLocationsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a scheduling-location */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingLocationsResponse = GetAdminSchedulingLocationsResponses[keyof GetAdminSchedulingLocationsResponses]; export type PostAdminSchedulingLocationsData = { /** * Request body for the /scheduling/locations operation on scheduling-location resource */ body: { data: { attributes?: { address?: string | null; application_id?: string | null; capacity?: number | null; city?: string | null; country?: string | null; instructions?: string | null; is_active?: boolean | null; latitude?: number | null; longitude?: number | null; metadata?: { [key: string]: unknown; } | null; name: string; postal_code?: string | null; state?: string | null; type: "venue" | "room" | "virtual" | "resource"; url?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "scheduling-location"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/locations"; }; export type PostAdminSchedulingLocationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSchedulingLocationsError = PostAdminSchedulingLocationsErrors[keyof PostAdminSchedulingLocationsErrors]; export type PostAdminSchedulingLocationsResponses = { /** * Success */ 201: { data?: SchedulingLocation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSchedulingLocationsResponse = PostAdminSchedulingLocationsResponses[keyof PostAdminSchedulingLocationsResponses]; export type GetAdminContractClausesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/contract-clauses/{id}"; }; export type GetAdminContractClausesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminContractClausesByIdError = GetAdminContractClausesByIdErrors[keyof GetAdminContractClausesByIdErrors]; export type GetAdminContractClausesByIdResponses = { /** * Success */ 200: { data?: ContractClause; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminContractClausesByIdResponse = GetAdminContractClausesByIdResponses[keyof GetAdminContractClausesByIdResponses]; export type GetAdminClinicalNoteTemplatesCatalogArchivedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/note-templates/catalog/archived"; }; export type GetAdminClinicalNoteTemplatesCatalogArchivedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalNoteTemplatesCatalogArchivedError = GetAdminClinicalNoteTemplatesCatalogArchivedErrors[keyof GetAdminClinicalNoteTemplatesCatalogArchivedErrors]; export type GetAdminClinicalNoteTemplatesCatalogArchivedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-note-template */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalNoteTemplatesCatalogArchivedResponse = GetAdminClinicalNoteTemplatesCatalogArchivedResponses[keyof GetAdminClinicalNoteTemplatesCatalogArchivedResponses]; export type DeleteAdminRecipesMealSchedulesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/meal-schedules/{id}"; }; export type DeleteAdminRecipesMealSchedulesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminRecipesMealSchedulesByIdError = DeleteAdminRecipesMealSchedulesByIdErrors[keyof DeleteAdminRecipesMealSchedulesByIdErrors]; export type DeleteAdminRecipesMealSchedulesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminRecipesMealSchedulesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/meal-schedules/{id}"; }; export type GetAdminRecipesMealSchedulesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesMealSchedulesByIdError = GetAdminRecipesMealSchedulesByIdErrors[keyof GetAdminRecipesMealSchedulesByIdErrors]; export type GetAdminRecipesMealSchedulesByIdResponses = { /** * Success */ 200: { data?: RecipesMealSchedule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesMealSchedulesByIdResponse = GetAdminRecipesMealSchedulesByIdResponses[keyof GetAdminRecipesMealSchedulesByIdResponses]; export type PatchAdminRecipesMealSchedulesByIdData = { /** * Request body for the /recipes/meal-schedules/:id operation on recipes-meal-schedule resource */ body?: { data: { attributes?: { end_date?: string | null; name?: string | null; start_date?: string | null; status?: "draft" | "active" | "completed"; }; id: string; relationships?: { [key: string]: never; }; type?: "recipes-meal-schedule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/meal-schedules/{id}"; }; export type PatchAdminRecipesMealSchedulesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminRecipesMealSchedulesByIdError = PatchAdminRecipesMealSchedulesByIdErrors[keyof PatchAdminRecipesMealSchedulesByIdErrors]; export type PatchAdminRecipesMealSchedulesByIdResponses = { /** * Success */ 200: { data?: RecipesMealSchedule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminRecipesMealSchedulesByIdResponse = PatchAdminRecipesMealSchedulesByIdResponses[keyof PatchAdminRecipesMealSchedulesByIdResponses]; export type GetAdminExtractionSchemaDiscoveriesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/schema-discoveries/{id}"; }; export type GetAdminExtractionSchemaDiscoveriesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionSchemaDiscoveriesByIdError = GetAdminExtractionSchemaDiscoveriesByIdErrors[keyof GetAdminExtractionSchemaDiscoveriesByIdErrors]; export type GetAdminExtractionSchemaDiscoveriesByIdResponses = { /** * Success */ 200: { data?: SchemaDiscovery; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionSchemaDiscoveriesByIdResponse = GetAdminExtractionSchemaDiscoveriesByIdResponses[keyof GetAdminExtractionSchemaDiscoveriesByIdResponses]; export type DeleteAdminSchedulingCalendarSyncsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/calendar-syncs/{id}"; }; export type DeleteAdminSchedulingCalendarSyncsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminSchedulingCalendarSyncsByIdError = DeleteAdminSchedulingCalendarSyncsByIdErrors[keyof DeleteAdminSchedulingCalendarSyncsByIdErrors]; export type DeleteAdminSchedulingCalendarSyncsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminSchedulingCalendarSyncsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/calendar-syncs/{id}"; }; export type GetAdminSchedulingCalendarSyncsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingCalendarSyncsByIdError = GetAdminSchedulingCalendarSyncsByIdErrors[keyof GetAdminSchedulingCalendarSyncsByIdErrors]; export type GetAdminSchedulingCalendarSyncsByIdResponses = { /** * Success */ 200: { data?: SchedulingCalendarSync; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingCalendarSyncsByIdResponse = GetAdminSchedulingCalendarSyncsByIdResponses[keyof GetAdminSchedulingCalendarSyncsByIdResponses]; export type PatchAdminSchedulingCalendarSyncsByIdData = { /** * Request body for the /scheduling/calendar-syncs/:id operation on scheduling-calendar-sync resource */ body?: { data: { attributes?: { calendar_name?: string | null; metadata?: { [key: string]: unknown; } | null; poll_interval_minutes?: number | null; role?: "conflict_check" | "add_events" | "both"; settings?: { [key: string]: unknown; } | null; sync_direction?: "push" | "pull" | "bidirectional"; sync_method?: "poll"; }; id: string; relationships?: { [key: string]: never; }; type?: "scheduling-calendar-sync"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/calendar-syncs/{id}"; }; export type PatchAdminSchedulingCalendarSyncsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSchedulingCalendarSyncsByIdError = PatchAdminSchedulingCalendarSyncsByIdErrors[keyof PatchAdminSchedulingCalendarSyncsByIdErrors]; export type PatchAdminSchedulingCalendarSyncsByIdResponses = { /** * Success */ 200: { data?: SchedulingCalendarSync; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSchedulingCalendarSyncsByIdResponse = PatchAdminSchedulingCalendarSyncsByIdResponses[keyof PatchAdminSchedulingCalendarSyncsByIdResponses]; export type PatchAdminInvoicesByIdSchedulePaymentData = { /** * Request body for the /invoices/:id/schedule-payment operation on invoices-invoice resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "invoices-invoice"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/{id}/schedule-payment"; }; export type PatchAdminInvoicesByIdSchedulePaymentErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvoicesByIdSchedulePaymentError = PatchAdminInvoicesByIdSchedulePaymentErrors[keyof PatchAdminInvoicesByIdSchedulePaymentErrors]; export type PatchAdminInvoicesByIdSchedulePaymentResponses = { /** * Success */ 200: { data?: InvoicesInvoice; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvoicesByIdSchedulePaymentResponse = PatchAdminInvoicesByIdSchedulePaymentResponses[keyof PatchAdminInvoicesByIdSchedulePaymentResponses]; export type GetAdminCaseDocumentLinksData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/case-document-links"; }; export type GetAdminCaseDocumentLinksErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCaseDocumentLinksError = GetAdminCaseDocumentLinksErrors[keyof GetAdminCaseDocumentLinksErrors]; export type GetAdminCaseDocumentLinksResponses = { /** * Success */ 200: { /** * An array of resource objects representing a case-document-link */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCaseDocumentLinksResponse = GetAdminCaseDocumentLinksResponses[keyof GetAdminCaseDocumentLinksResponses]; export type PostAdminCaseDocumentLinksData = { /** * Request body for the /case-document-links operation on case-document-link resource */ body: { data: { attributes?: { attached_at?: unknown; auto_attached?: boolean | null; case_id: string; document_id: string; role?: "primary" | "evidence" | "supporting"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "case-document-link"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/case-document-links"; }; export type PostAdminCaseDocumentLinksErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCaseDocumentLinksError = PostAdminCaseDocumentLinksErrors[keyof PostAdminCaseDocumentLinksErrors]; export type PostAdminCaseDocumentLinksResponses = { /** * Success */ 201: { data?: CaseDocumentLink; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCaseDocumentLinksResponse = PostAdminCaseDocumentLinksResponses[keyof PostAdminCaseDocumentLinksResponses]; export type GetAdminDisclosureLogsBySubjectData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; subject_type: string; subject_id: string; }; url: "/admin/disclosure-logs/by-subject"; }; export type GetAdminDisclosureLogsBySubjectErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminDisclosureLogsBySubjectError = GetAdminDisclosureLogsBySubjectErrors[keyof GetAdminDisclosureLogsBySubjectErrors]; export type GetAdminDisclosureLogsBySubjectResponses = { /** * Success */ 200: { /** * An array of resource objects representing a disclosure-log */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminDisclosureLogsBySubjectResponse = GetAdminDisclosureLogsBySubjectResponses[keyof GetAdminDisclosureLogsBySubjectResponses]; export type GetAdminCrawlerResultsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/results"; }; export type GetAdminCrawlerResultsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrawlerResultsError = GetAdminCrawlerResultsErrors[keyof GetAdminCrawlerResultsErrors]; export type GetAdminCrawlerResultsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crawler-result */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrawlerResultsResponse = GetAdminCrawlerResultsResponses[keyof GetAdminCrawlerResultsResponses]; export type GetAdminPermissionsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; app?: string; context?: string; category?: string; }; url: "/admin/permissions"; }; export type GetAdminPermissionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPermissionsError = GetAdminPermissionsErrors[keyof GetAdminPermissionsErrors]; export type GetAdminPermissionsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a permission */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPermissionsResponse = GetAdminPermissionsResponses[keyof GetAdminPermissionsResponses]; export type PatchAdminStorageFilesByIdRestoreData = { /** * Request body for the /storage-files/:id/restore operation on storage-file resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "storage-file"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/storage-files/{id}/restore"; }; export type PatchAdminStorageFilesByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminStorageFilesByIdRestoreError = PatchAdminStorageFilesByIdRestoreErrors[keyof PatchAdminStorageFilesByIdRestoreErrors]; export type PatchAdminStorageFilesByIdRestoreResponses = { /** * Success */ 200: { data?: StorageFile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminStorageFilesByIdRestoreResponse = PatchAdminStorageFilesByIdRestoreResponses[keyof PatchAdminStorageFilesByIdRestoreResponses]; export type GetAdminClinicalNotesByPatientData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; patient_id: string; }; url: "/admin/clinical/notes/by-patient"; }; export type GetAdminClinicalNotesByPatientErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalNotesByPatientError = GetAdminClinicalNotesByPatientErrors[keyof GetAdminClinicalNotesByPatientErrors]; export type GetAdminClinicalNotesByPatientResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-note */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalNotesByPatientResponse = GetAdminClinicalNotesByPatientResponses[keyof GetAdminClinicalNotesByPatientResponses]; export type GetAdminEmailSendLimitsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/send-limits/{id}"; }; export type GetAdminEmailSendLimitsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailSendLimitsByIdError = GetAdminEmailSendLimitsByIdErrors[keyof GetAdminEmailSendLimitsByIdErrors]; export type GetAdminEmailSendLimitsByIdResponses = { /** * Success */ 200: { data?: EmailSendLimit; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailSendLimitsByIdResponse = GetAdminEmailSendLimitsByIdResponses[keyof GetAdminEmailSendLimitsByIdResponses]; export type PatchAdminCrawlerSchedulesByIdDisableData = { /** * Request body for the /crawler/schedules/:id/disable operation on crawler-schedule resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "crawler-schedule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/schedules/{id}/disable"; }; export type PatchAdminCrawlerSchedulesByIdDisableErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrawlerSchedulesByIdDisableError = PatchAdminCrawlerSchedulesByIdDisableErrors[keyof PatchAdminCrawlerSchedulesByIdDisableErrors]; export type PatchAdminCrawlerSchedulesByIdDisableResponses = { /** * Success */ 200: { data?: CrawlerSchedule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrawlerSchedulesByIdDisableResponse = PatchAdminCrawlerSchedulesByIdDisableResponses[keyof PatchAdminCrawlerSchedulesByIdDisableResponses]; export type PatchAdminClinicalSupplementTemplatesByIdRestoreData = { /** * Request body for the /clinical/supplement-templates/:id/restore operation on clinical-supplement-template resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-supplement-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-templates/{id}/restore"; }; export type PatchAdminClinicalSupplementTemplatesByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalSupplementTemplatesByIdRestoreError = PatchAdminClinicalSupplementTemplatesByIdRestoreErrors[keyof PatchAdminClinicalSupplementTemplatesByIdRestoreErrors]; export type PatchAdminClinicalSupplementTemplatesByIdRestoreResponses = { /** * Success */ 200: { data?: ClinicalSupplementTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalSupplementTemplatesByIdRestoreResponse = PatchAdminClinicalSupplementTemplatesByIdRestoreResponses[keyof PatchAdminClinicalSupplementTemplatesByIdRestoreResponses]; export type PatchAdminClinicalClientSupplementsByIdRestoreData = { /** * Request body for the /clinical/client-supplements/:id/restore operation on clinical-client-supplement resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-client-supplement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-supplements/{id}/restore"; }; export type PatchAdminClinicalClientSupplementsByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalClientSupplementsByIdRestoreError = PatchAdminClinicalClientSupplementsByIdRestoreErrors[keyof PatchAdminClinicalClientSupplementsByIdRestoreErrors]; export type PatchAdminClinicalClientSupplementsByIdRestoreResponses = { /** * Success */ 200: { data?: ClinicalClientSupplement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalClientSupplementsByIdRestoreResponse = PatchAdminClinicalClientSupplementsByIdRestoreResponses[keyof PatchAdminClinicalClientSupplementsByIdRestoreResponses]; export type PatchAdminClinicalPracticeToolsByIdRestoreData = { /** * Request body for the /clinical/practice-tools/:id/restore operation on clinical-practice-tool resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-practice-tool"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-tools/{id}/restore"; }; export type PatchAdminClinicalPracticeToolsByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalPracticeToolsByIdRestoreError = PatchAdminClinicalPracticeToolsByIdRestoreErrors[keyof PatchAdminClinicalPracticeToolsByIdRestoreErrors]; export type PatchAdminClinicalPracticeToolsByIdRestoreResponses = { /** * Success */ 200: { data?: ClinicalPracticeTool; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalPracticeToolsByIdRestoreResponse = PatchAdminClinicalPracticeToolsByIdRestoreResponses[keyof PatchAdminClinicalPracticeToolsByIdRestoreResponses]; export type DeleteAdminApiKeysByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/api-keys/{id}"; }; export type DeleteAdminApiKeysByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminApiKeysByIdError = DeleteAdminApiKeysByIdErrors[keyof DeleteAdminApiKeysByIdErrors]; export type DeleteAdminApiKeysByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminApiKeysByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/api-keys/{id}"; }; export type GetAdminApiKeysByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminApiKeysByIdError = GetAdminApiKeysByIdErrors[keyof GetAdminApiKeysByIdErrors]; export type GetAdminApiKeysByIdResponses = { /** * Success */ 200: { data?: ApiKey; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminApiKeysByIdResponse = GetAdminApiKeysByIdResponses[keyof GetAdminApiKeysByIdResponses]; export type PatchAdminApiKeysByIdData = { /** * Request body for the /api-keys/:id operation on api-key resource */ body?: { data: { attributes?: { /** * Maximum credits allowed per period (null = unlimited) */ credit_limit?: number | null; /** * Budget reset period */ credit_limit_period?: "daily" | "weekly" | "monthly" | "yearly" | "lifetime"; name?: string | null; /** * Rate limit period in seconds */ rate_limit_period_seconds?: number | null; /** * Maximum requests allowed per period */ rate_limit_requests?: number | null; scopes?: Array | null; }; id: string; relationships?: { [key: string]: never; }; type?: "api-key"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/api-keys/{id}"; }; export type PatchAdminApiKeysByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminApiKeysByIdError = PatchAdminApiKeysByIdErrors[keyof PatchAdminApiKeysByIdErrors]; export type PatchAdminApiKeysByIdResponses = { /** * Success */ 200: { data?: ApiKey; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminApiKeysByIdResponse = PatchAdminApiKeysByIdResponses[keyof PatchAdminApiKeysByIdResponses]; export type PostAdminCrmContactsByIdUnarchiveData = { /** * Request body for the /crm/contacts/:id/unarchive operation on crm-contact resource */ body: { data: { workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/crm/contacts/{id}/unarchive"; }; export type PostAdminCrmContactsByIdUnarchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrmContactsByIdUnarchiveError = PostAdminCrmContactsByIdUnarchiveErrors[keyof PostAdminCrmContactsByIdUnarchiveErrors]; export type PostAdminCrmContactsByIdUnarchiveResponses = { /** * Success */ 201: CrmContactType; }; export type PostAdminCrmContactsByIdUnarchiveResponse = PostAdminCrmContactsByIdUnarchiveResponses[keyof PostAdminCrmContactsByIdUnarchiveResponses]; export type GetAdminEphiDataFlowsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ephi-data-flows/{id}"; }; export type GetAdminEphiDataFlowsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEphiDataFlowsByIdError = GetAdminEphiDataFlowsByIdErrors[keyof GetAdminEphiDataFlowsByIdErrors]; export type GetAdminEphiDataFlowsByIdResponses = { /** * Success */ 200: { data?: EphiDataFlow; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEphiDataFlowsByIdResponse = GetAdminEphiDataFlowsByIdResponses[keyof GetAdminEphiDataFlowsByIdResponses]; export type PatchAdminEphiDataFlowsByIdData = { /** * Request body for the /ephi-data-flows/:id operation on ephi-data-flow resource */ body?: { data: { attributes?: { /** * Categories of PHI flowing between assets */ data_categories?: Array | null; description?: string | null; /** * Soft ref to destination EphiAsset — NOT a DB FK */ destination_asset_id?: string | null; encryption?: "encrypted" | "unencrypted" | "partial"; flow_type?: "api_call" | "database_replication" | "file_transfer" | "event_stream" | "user_access"; frequency?: "real_time" | "batch_daily" | "on_demand" | "scheduled"; is_active?: boolean | null; metadata?: { [key: string]: unknown; } | null; /** * Transport protocol (e.g., HTTPS/TLS 1.3) */ protocol?: string | null; /** * Soft ref to source EphiAsset — NOT a DB FK */ source_asset_id?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "ephi-data-flow"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ephi-data-flows/{id}"; }; export type PatchAdminEphiDataFlowsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEphiDataFlowsByIdError = PatchAdminEphiDataFlowsByIdErrors[keyof PatchAdminEphiDataFlowsByIdErrors]; export type PatchAdminEphiDataFlowsByIdResponses = { /** * Success */ 200: { data?: EphiDataFlow; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEphiDataFlowsByIdResponse = PatchAdminEphiDataFlowsByIdResponses[keyof PatchAdminEphiDataFlowsByIdResponses]; export type GetAdminClinicalPracticeToolsArchivedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/practice-tools/archived"; }; export type GetAdminClinicalPracticeToolsArchivedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPracticeToolsArchivedError = GetAdminClinicalPracticeToolsArchivedErrors[keyof GetAdminClinicalPracticeToolsArchivedErrors]; export type GetAdminClinicalPracticeToolsArchivedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-practice-tool */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPracticeToolsArchivedResponse = GetAdminClinicalPracticeToolsArchivedResponses[keyof GetAdminClinicalPracticeToolsArchivedResponses]; export type PatchAdminRiskAssessmentsByIdStatusData = { /** * Request body for the /risk-assessments/:id/status operation on risk-assessment resource */ body?: { data: { attributes?: { approved_at?: unknown; expires_at?: unknown; reviewer_id?: string | null; status?: "draft" | "in_review" | "approved" | "expired"; }; id: string; relationships?: { [key: string]: never; }; type?: "risk-assessment"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/risk-assessments/{id}/status"; }; export type PatchAdminRiskAssessmentsByIdStatusErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminRiskAssessmentsByIdStatusError = PatchAdminRiskAssessmentsByIdStatusErrors[keyof PatchAdminRiskAssessmentsByIdStatusErrors]; export type PatchAdminRiskAssessmentsByIdStatusResponses = { /** * Success */ 200: { data?: RiskAssessment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminRiskAssessmentsByIdStatusResponse = PatchAdminRiskAssessmentsByIdStatusResponses[keyof PatchAdminRiskAssessmentsByIdStatusResponses]; export type DeleteAdminRecipesShoppingListItemsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/shopping-list-items/{id}"; }; export type DeleteAdminRecipesShoppingListItemsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminRecipesShoppingListItemsByIdError = DeleteAdminRecipesShoppingListItemsByIdErrors[keyof DeleteAdminRecipesShoppingListItemsByIdErrors]; export type DeleteAdminRecipesShoppingListItemsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminRecipesShoppingListItemsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/shopping-list-items/{id}"; }; export type GetAdminRecipesShoppingListItemsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesShoppingListItemsByIdError = GetAdminRecipesShoppingListItemsByIdErrors[keyof GetAdminRecipesShoppingListItemsByIdErrors]; export type GetAdminRecipesShoppingListItemsByIdResponses = { /** * Success */ 200: { data?: RecipesShoppingListItem; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesShoppingListItemsByIdResponse = GetAdminRecipesShoppingListItemsByIdResponses[keyof GetAdminRecipesShoppingListItemsByIdResponses]; export type PatchAdminRecipesShoppingListItemsByIdData = { /** * Request body for the /recipes/shopping-list-items/:id operation on recipes-shopping-list-item resource */ body?: { data: { attributes?: { checked?: boolean | null; food_group?: string | null; name?: string | null; total_quantity?: number | null; unit?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "recipes-shopping-list-item"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/shopping-list-items/{id}"; }; export type PatchAdminRecipesShoppingListItemsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminRecipesShoppingListItemsByIdError = PatchAdminRecipesShoppingListItemsByIdErrors[keyof PatchAdminRecipesShoppingListItemsByIdErrors]; export type PatchAdminRecipesShoppingListItemsByIdResponses = { /** * Success */ 200: { data?: RecipesShoppingListItem; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminRecipesShoppingListItemsByIdResponse = PatchAdminRecipesShoppingListItemsByIdResponses[keyof PatchAdminRecipesShoppingListItemsByIdResponses]; export type DeleteAdminRolesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/roles/{id}"; }; export type DeleteAdminRolesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminRolesByIdError = DeleteAdminRolesByIdErrors[keyof DeleteAdminRolesByIdErrors]; export type DeleteAdminRolesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminRolesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/roles/{id}"; }; export type GetAdminRolesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRolesByIdError = GetAdminRolesByIdErrors[keyof GetAdminRolesByIdErrors]; export type GetAdminRolesByIdResponses = { /** * Success */ 200: { data?: Role; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRolesByIdResponse = GetAdminRolesByIdResponses[keyof GetAdminRolesByIdResponses]; export type PatchAdminRolesByIdData = { /** * Request body for the /roles/:id operation on role resource */ body?: { data: { attributes?: { description?: string | null; name?: string | null; permissions?: Array | null; }; id: string; relationships?: { [key: string]: never; }; type?: "role"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/roles/{id}"; }; export type PatchAdminRolesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminRolesByIdError = PatchAdminRolesByIdErrors[keyof PatchAdminRolesByIdErrors]; export type PatchAdminRolesByIdResponses = { /** * Success */ 200: { data?: Role; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminRolesByIdResponse = PatchAdminRolesByIdResponses[keyof PatchAdminRolesByIdResponses]; export type GetAdminClinicalPracticeToolsCatalogArchivedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-tools/catalog/archived"; }; export type GetAdminClinicalPracticeToolsCatalogArchivedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPracticeToolsCatalogArchivedError = GetAdminClinicalPracticeToolsCatalogArchivedErrors[keyof GetAdminClinicalPracticeToolsCatalogArchivedErrors]; export type GetAdminClinicalPracticeToolsCatalogArchivedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-practice-tool */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPracticeToolsCatalogArchivedResponse = GetAdminClinicalPracticeToolsCatalogArchivedResponses[keyof GetAdminClinicalPracticeToolsCatalogArchivedResponses]; export type DeleteAdminPostProcessingHooksByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/post-processing-hooks/{id}"; }; export type DeleteAdminPostProcessingHooksByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminPostProcessingHooksByIdError = DeleteAdminPostProcessingHooksByIdErrors[keyof DeleteAdminPostProcessingHooksByIdErrors]; export type DeleteAdminPostProcessingHooksByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminPostProcessingHooksByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/post-processing-hooks/{id}"; }; export type GetAdminPostProcessingHooksByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPostProcessingHooksByIdError = GetAdminPostProcessingHooksByIdErrors[keyof GetAdminPostProcessingHooksByIdErrors]; export type GetAdminPostProcessingHooksByIdResponses = { /** * Success */ 200: { data?: PostProcessingHook; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPostProcessingHooksByIdResponse = GetAdminPostProcessingHooksByIdResponses[keyof GetAdminPostProcessingHooksByIdResponses]; export type PatchAdminPostProcessingHooksByIdData = { /** * Request body for the /post-processing-hooks/:id operation on post-processing-hook resource */ body?: { data: { attributes?: { /** * Whether webhook response can modify extracted fields (webhook type only) */ can_modify?: boolean | null; /** * Type-specific configuration: * webhook: %{"url" => string, "timeout_ms" => integer, "retry_count" => integer, "headers" => map, "signing_secret" => string} * oban_worker: %{"worker" => string, "queue" => string, "args" => map} * reactor_step: %{"module" => string, "opts" => map} * */ config?: { [key: string]: unknown; } | null; enabled?: boolean | null; /** * Glob patterns for fields that trigger this hook. Empty = all fields. Max 20. */ field_filter?: Array | null; /** * Human-readable hook name */ name?: string | null; /** * Execution order (ascending). Hooks at same order run sequentially. */ order?: number | null; /** * When this hook fires in the extraction lifecycle */ trigger?: "after_extraction" | "after_validation" | "before_downstream"; /** * Execution type: webhook, oban_worker, or reactor_step */ type?: "webhook" | "oban_worker" | "reactor_step"; }; id: string; relationships?: { [key: string]: never; }; type?: "post-processing-hook"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/post-processing-hooks/{id}"; }; export type PatchAdminPostProcessingHooksByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPostProcessingHooksByIdError = PatchAdminPostProcessingHooksByIdErrors[keyof PatchAdminPostProcessingHooksByIdErrors]; export type PatchAdminPostProcessingHooksByIdResponses = { /** * Success */ 200: { data?: PostProcessingHook; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPostProcessingHooksByIdResponse = PatchAdminPostProcessingHooksByIdResponses[keyof PatchAdminPostProcessingHooksByIdResponses]; export type PostAdminSearchSavedByIdRunData = { /** * Request body for the /search/saved/:id/run operation on saved-search resource */ body?: { data: { attributes?: { [key: string]: never; }; relationships?: { [key: string]: never; }; type?: "saved-search"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/search/saved/{id}/run"; }; export type PostAdminSearchSavedByIdRunErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSearchSavedByIdRunError = PostAdminSearchSavedByIdRunErrors[keyof PostAdminSearchSavedByIdRunErrors]; export type PostAdminSearchSavedByIdRunResponses = { /** * Success */ 201: { data?: SavedSearch; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSearchSavedByIdRunResponse = PostAdminSearchSavedByIdRunResponses[keyof PostAdminSearchSavedByIdRunResponses]; export type GetAdminVoiceRecordingsSessionBySessionIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { session_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/voice/recordings/session/{session_id}"; }; export type GetAdminVoiceRecordingsSessionBySessionIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminVoiceRecordingsSessionBySessionIdError = GetAdminVoiceRecordingsSessionBySessionIdErrors[keyof GetAdminVoiceRecordingsSessionBySessionIdErrors]; export type GetAdminVoiceRecordingsSessionBySessionIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a voice-recording */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminVoiceRecordingsSessionBySessionIdResponse = GetAdminVoiceRecordingsSessionBySessionIdResponses[keyof GetAdminVoiceRecordingsSessionBySessionIdResponses]; export type GetAdminInvitationsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invitations"; }; export type GetAdminInvitationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminInvitationsError = GetAdminInvitationsErrors[keyof GetAdminInvitationsErrors]; export type GetAdminInvitationsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a invitation */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminInvitationsResponse = GetAdminInvitationsResponses[keyof GetAdminInvitationsResponses]; export type PostAdminInvitationsData = { /** * Request body for the /invitations operation on invitation resource */ body: { data: { attributes?: { application_id?: string | null; custom_message?: string | null; email: string; /** * Per-call override of the Application's `system_email_method` for the * invitation email this call sends. When omitted, the resolved method * falls back to the Application's `system_email_method` (default `:link`). * */ email_method?: "link" | "code"; inviter_id?: string | null; permissions?: Array | null; role: "admin" | "member" | "editor" | "viewer"; scope_id: string; scope_type: "tenant" | "workspace"; }; relationships?: { [key: string]: never; }; type?: "invitation"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invitations"; }; export type PostAdminInvitationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminInvitationsError = PostAdminInvitationsErrors[keyof PostAdminInvitationsErrors]; export type PostAdminInvitationsResponses = { /** * Success */ 201: { data?: Invitation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminInvitationsResponse = PostAdminInvitationsResponses[keyof PostAdminInvitationsResponses]; export type GetAdminEmailTrackingEventsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/tracking-events/workspace/{workspace_id}"; }; export type GetAdminEmailTrackingEventsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailTrackingEventsWorkspaceByWorkspaceIdError = GetAdminEmailTrackingEventsWorkspaceByWorkspaceIdErrors[keyof GetAdminEmailTrackingEventsWorkspaceByWorkspaceIdErrors]; export type GetAdminEmailTrackingEventsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a email-tracking-event */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailTrackingEventsWorkspaceByWorkspaceIdResponse = GetAdminEmailTrackingEventsWorkspaceByWorkspaceIdResponses[keyof GetAdminEmailTrackingEventsWorkspaceByWorkspaceIdResponses]; export type PostAdminAiGraphRelationshipsData = { /** * Request body for the /ai/graph/relationships operation on graph-node resource */ body: { data: { from_node_id: string; properties?: { [key: string]: unknown; } | null; relationship_type: string; to_node_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/ai/graph/relationships"; }; export type PostAdminAiGraphRelationshipsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAiGraphRelationshipsError = PostAdminAiGraphRelationshipsErrors[keyof PostAdminAiGraphRelationshipsErrors]; export type PostAdminAiGraphRelationshipsResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminAiGraphRelationshipsResponse = PostAdminAiGraphRelationshipsResponses[keyof PostAdminAiGraphRelationshipsResponses]; export type GetAdminRecipesRecipeNutritionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/recipe-nutritions/{id}"; }; export type GetAdminRecipesRecipeNutritionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesRecipeNutritionsByIdError = GetAdminRecipesRecipeNutritionsByIdErrors[keyof GetAdminRecipesRecipeNutritionsByIdErrors]; export type GetAdminRecipesRecipeNutritionsByIdResponses = { /** * Success */ 200: { data?: RecipesRecipeNutrition; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesRecipeNutritionsByIdResponse = GetAdminRecipesRecipeNutritionsByIdResponses[keyof GetAdminRecipesRecipeNutritionsByIdResponses]; export type PatchAdminRecipesRecipeNutritionsByIdData = { /** * Request body for the /recipes/recipe-nutritions/:id operation on recipes-recipe-nutrition resource */ body?: { data: { attributes?: { calories?: number | null; carbs_g?: number | null; fat_g?: number | null; fiber_g?: number | null; full_nutrients?: { [key: string]: unknown; } | null; protein_g?: number | null; sodium_mg?: number | null; source?: "computed" | "external" | "manual"; sugar_g?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "recipes-recipe-nutrition"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/recipe-nutritions/{id}"; }; export type PatchAdminRecipesRecipeNutritionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminRecipesRecipeNutritionsByIdError = PatchAdminRecipesRecipeNutritionsByIdErrors[keyof PatchAdminRecipesRecipeNutritionsByIdErrors]; export type PatchAdminRecipesRecipeNutritionsByIdResponses = { /** * Success */ 200: { data?: RecipesRecipeNutrition; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminRecipesRecipeNutritionsByIdResponse = PatchAdminRecipesRecipeNutritionsByIdResponses[keyof PatchAdminRecipesRecipeNutritionsByIdResponses]; export type GetAdminCatalogClassificationSuggestionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/classification-suggestions/{id}"; }; export type GetAdminCatalogClassificationSuggestionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogClassificationSuggestionsByIdError = GetAdminCatalogClassificationSuggestionsByIdErrors[keyof GetAdminCatalogClassificationSuggestionsByIdErrors]; export type GetAdminCatalogClassificationSuggestionsByIdResponses = { /** * Success */ 200: { data?: CatalogClassificationSuggestion; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogClassificationSuggestionsByIdResponse = GetAdminCatalogClassificationSuggestionsByIdResponses[keyof GetAdminCatalogClassificationSuggestionsByIdResponses]; export type GetAdminWalletStorageBreakdownData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; tenant_id?: string; }; url: "/admin/wallet/storage-breakdown"; }; export type GetAdminWalletStorageBreakdownErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWalletStorageBreakdownError = GetAdminWalletStorageBreakdownErrors[keyof GetAdminWalletStorageBreakdownErrors]; export type GetAdminWalletStorageBreakdownResponses = { /** * Success */ 200: { data?: Wallet; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWalletStorageBreakdownResponse = GetAdminWalletStorageBreakdownResponses[keyof GetAdminWalletStorageBreakdownResponses]; export type DeleteAdminCaseEntityLinksByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/case-entity-links/{id}"; }; export type DeleteAdminCaseEntityLinksByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCaseEntityLinksByIdError = DeleteAdminCaseEntityLinksByIdErrors[keyof DeleteAdminCaseEntityLinksByIdErrors]; export type DeleteAdminCaseEntityLinksByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCaseEntityLinksByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/case-entity-links/{id}"; }; export type GetAdminCaseEntityLinksByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCaseEntityLinksByIdError = GetAdminCaseEntityLinksByIdErrors[keyof GetAdminCaseEntityLinksByIdErrors]; export type GetAdminCaseEntityLinksByIdResponses = { /** * Success */ 200: { data?: CaseEntityLink; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCaseEntityLinksByIdResponse = GetAdminCaseEntityLinksByIdResponses[keyof GetAdminCaseEntityLinksByIdResponses]; export type PatchAdminStorageFilesByIdUpdateMetadataData = { /** * Request body for the /storage-files/:id/update-metadata operation on storage-file resource */ body: { data: { attributes?: { new_metadata: { [key: string]: unknown; }; }; id: string; relationships?: { [key: string]: never; }; type?: "storage-file"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/storage-files/{id}/update-metadata"; }; export type PatchAdminStorageFilesByIdUpdateMetadataErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminStorageFilesByIdUpdateMetadataError = PatchAdminStorageFilesByIdUpdateMetadataErrors[keyof PatchAdminStorageFilesByIdUpdateMetadataErrors]; export type PatchAdminStorageFilesByIdUpdateMetadataResponses = { /** * Success */ 200: { data?: StorageFile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminStorageFilesByIdUpdateMetadataResponse = PatchAdminStorageFilesByIdUpdateMetadataResponses[keyof PatchAdminStorageFilesByIdUpdateMetadataResponses]; export type GetAdminClinicalDeliveriesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; patient_id: string; }; url: "/admin/clinical/deliveries"; }; export type GetAdminClinicalDeliveriesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalDeliveriesError = GetAdminClinicalDeliveriesErrors[keyof GetAdminClinicalDeliveriesErrors]; export type GetAdminClinicalDeliveriesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-delivery */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalDeliveriesResponse = GetAdminClinicalDeliveriesResponses[keyof GetAdminClinicalDeliveriesResponses]; export type PostAdminClinicalDeliveriesData = { /** * Request body for the /clinical/deliveries operation on clinical-delivery resource */ body: { data: { attributes?: { delivered_at?: unknown; delivery_type?: "summary_email" | "goal_report" | "meal_plan" | "supplement_list"; email_message_id?: string | null; included_goal_ids?: Array | null; included_resource_ids?: Array | null; included_supplement_ids?: Array | null; metadata?: { [key: string]: unknown; } | null; patient_id: string; session_id?: string | null; status?: "sent" | "delivered" | "failed" | "bounced"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-delivery"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/deliveries"; }; export type PostAdminClinicalDeliveriesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalDeliveriesError = PostAdminClinicalDeliveriesErrors[keyof PostAdminClinicalDeliveriesErrors]; export type PostAdminClinicalDeliveriesResponses = { /** * Success */ 201: { data?: ClinicalDelivery; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalDeliveriesResponse = PostAdminClinicalDeliveriesResponses[keyof PostAdminClinicalDeliveriesResponses]; export type GetAdminClinicalPatientInsuranceByWorkspaceData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/patient-insurance/by-workspace"; }; export type GetAdminClinicalPatientInsuranceByWorkspaceErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPatientInsuranceByWorkspaceError = GetAdminClinicalPatientInsuranceByWorkspaceErrors[keyof GetAdminClinicalPatientInsuranceByWorkspaceErrors]; export type GetAdminClinicalPatientInsuranceByWorkspaceResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-patient-insurance */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPatientInsuranceByWorkspaceResponse = GetAdminClinicalPatientInsuranceByWorkspaceResponses[keyof GetAdminClinicalPatientInsuranceByWorkspaceResponses]; export type GetAdminThreadsByIdMessagesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/threads/{id}/messages"; }; export type GetAdminThreadsByIdMessagesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminThreadsByIdMessagesError = GetAdminThreadsByIdMessagesErrors[keyof GetAdminThreadsByIdMessagesErrors]; export type GetAdminThreadsByIdMessagesResponses = { /** * Success */ 200: { data?: ChatMessage; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminThreadsByIdMessagesResponse = GetAdminThreadsByIdMessagesResponses[keyof GetAdminThreadsByIdMessagesResponses]; export type PostAdminThreadsByIdMessagesData = { /** * Request body for the /threads/:id/messages operation on chat-thread resource */ body: { data: { attributes?: { content: string; metadata?: { [key: string]: unknown; } | null; }; relationships?: { [key: string]: never; }; type?: "chat-thread"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/threads/{id}/messages"; }; export type PostAdminThreadsByIdMessagesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminThreadsByIdMessagesError = PostAdminThreadsByIdMessagesErrors[keyof PostAdminThreadsByIdMessagesErrors]; export type PostAdminThreadsByIdMessagesResponses = { /** * Success */ 201: { data?: ChatThread; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminThreadsByIdMessagesResponse = PostAdminThreadsByIdMessagesResponses[keyof PostAdminThreadsByIdMessagesResponses]; export type GetAdminSocialTrendingHistoryRangeData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; from: unknown; to: unknown; }; url: "/admin/social/trending/history/range"; }; export type GetAdminSocialTrendingHistoryRangeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialTrendingHistoryRangeError = GetAdminSocialTrendingHistoryRangeErrors[keyof GetAdminSocialTrendingHistoryRangeErrors]; export type GetAdminSocialTrendingHistoryRangeResponses = { /** * Success */ 200: { /** * An array of resource objects representing a trending-snapshot */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialTrendingHistoryRangeResponse = GetAdminSocialTrendingHistoryRangeResponses[keyof GetAdminSocialTrendingHistoryRangeResponses]; export type PostAdminApplicationsProvisionData = { /** * Request body for the /applications/provision operation on application resource */ body: { data: { spec: { [key: string]: unknown; }; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/applications/provision"; }; export type PostAdminApplicationsProvisionErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminApplicationsProvisionError = PostAdminApplicationsProvisionErrors[keyof PostAdminApplicationsProvisionErrors]; export type PostAdminApplicationsProvisionResponses = { /** * Success */ 201: { result: { [key: string]: unknown; }; }; }; export type PostAdminApplicationsProvisionResponse = PostAdminApplicationsProvisionResponses[keyof PostAdminApplicationsProvisionResponses]; export type GetAdminSchedulingParticipantsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; event_id: string; }; url: "/admin/scheduling/participants"; }; export type GetAdminSchedulingParticipantsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingParticipantsError = GetAdminSchedulingParticipantsErrors[keyof GetAdminSchedulingParticipantsErrors]; export type GetAdminSchedulingParticipantsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a scheduling-participant */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingParticipantsResponse = GetAdminSchedulingParticipantsResponses[keyof GetAdminSchedulingParticipantsResponses]; export type PostAdminSchedulingParticipantsData = { /** * Request body for the /scheduling/participants operation on scheduling-participant resource */ body: { data: { attributes?: { contact_id?: string | null; email: string; event_id: string; metadata?: { [key: string]: unknown; } | null; name?: string | null; phone?: string | null; role?: "organizer" | "attendee" | "optional"; status?: "invited" | "accepted" | "declined" | "tentative" | "no_response"; user_id?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "scheduling-participant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/participants"; }; export type PostAdminSchedulingParticipantsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSchedulingParticipantsError = PostAdminSchedulingParticipantsErrors[keyof PostAdminSchedulingParticipantsErrors]; export type PostAdminSchedulingParticipantsResponses = { /** * Success */ 201: { data?: SchedulingParticipant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSchedulingParticipantsResponse = PostAdminSchedulingParticipantsResponses[keyof PostAdminSchedulingParticipantsResponses]; export type DeleteAdminSupportTagsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/tags/{id}"; }; export type DeleteAdminSupportTagsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminSupportTagsByIdError = DeleteAdminSupportTagsByIdErrors[keyof DeleteAdminSupportTagsByIdErrors]; export type DeleteAdminSupportTagsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminTenantsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants"; }; export type GetAdminTenantsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminTenantsError = GetAdminTenantsErrors[keyof GetAdminTenantsErrors]; export type GetAdminTenantsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a tenant */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminTenantsResponse = GetAdminTenantsResponses[keyof GetAdminTenantsResponses]; export type PostAdminTenantsData = { /** * Request body for the /tenants operation on tenant resource */ body: { data: { attributes?: { application_id?: string | null; badge_url?: string | null; /** * True for auto-created personal tenants, false for organizations */ is_personal?: boolean | null; kind?: "platform" | "isv" | "tenant"; logo_url?: string | null; name: string; owner_id: string; parent_id?: string | null; /** * Subscription tier that gates feature access */ plan_tier?: "free" | "pro" | "business" | "enterprise"; /** * Tenant-specific portal configuration overrides (merged over Application portal_defaults) */ portal_overrides?: { [key: string]: unknown; } | null; slug: string; /** * Cost in credits for training on a single document */ training_price_credits?: number | null; /** * Memorable slug for vanity URLs */ vanity_slug?: string | null; }; relationships?: { [key: string]: never; }; type?: "tenant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants"; }; export type PostAdminTenantsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminTenantsError = PostAdminTenantsErrors[keyof PostAdminTenantsErrors]; export type PostAdminTenantsResponses = { /** * Success */ 201: { data?: Tenant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminTenantsResponse = PostAdminTenantsResponses[keyof PostAdminTenantsResponses]; export type DeleteAdminCatalogTaxonomyNodesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/taxonomy-nodes/{id}"; }; export type DeleteAdminCatalogTaxonomyNodesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCatalogTaxonomyNodesByIdError = DeleteAdminCatalogTaxonomyNodesByIdErrors[keyof DeleteAdminCatalogTaxonomyNodesByIdErrors]; export type DeleteAdminCatalogTaxonomyNodesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCatalogTaxonomyNodesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/taxonomy-nodes/{id}"; }; export type GetAdminCatalogTaxonomyNodesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogTaxonomyNodesByIdError = GetAdminCatalogTaxonomyNodesByIdErrors[keyof GetAdminCatalogTaxonomyNodesByIdErrors]; export type GetAdminCatalogTaxonomyNodesByIdResponses = { /** * Success */ 200: { data?: CatalogTaxonomyNode; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogTaxonomyNodesByIdResponse = GetAdminCatalogTaxonomyNodesByIdResponses[keyof GetAdminCatalogTaxonomyNodesByIdResponses]; export type PatchAdminCatalogTaxonomyNodesByIdData = { /** * Request body for the /catalog/taxonomy-nodes/:id operation on catalog-taxonomy-node resource */ body?: { data: { attributes?: { description?: string | null; name?: string | null; parent_id?: string | null; position?: number | null; slug?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "catalog-taxonomy-node"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/taxonomy-nodes/{id}"; }; export type PatchAdminCatalogTaxonomyNodesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCatalogTaxonomyNodesByIdError = PatchAdminCatalogTaxonomyNodesByIdErrors[keyof PatchAdminCatalogTaxonomyNodesByIdErrors]; export type PatchAdminCatalogTaxonomyNodesByIdResponses = { /** * Success */ 200: { data?: CatalogTaxonomyNode; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCatalogTaxonomyNodesByIdResponse = PatchAdminCatalogTaxonomyNodesByIdResponses[keyof PatchAdminCatalogTaxonomyNodesByIdResponses]; export type DeleteAdminTrainingExamplesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/training-examples/{id}"; }; export type DeleteAdminTrainingExamplesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminTrainingExamplesByIdError = DeleteAdminTrainingExamplesByIdErrors[keyof DeleteAdminTrainingExamplesByIdErrors]; export type DeleteAdminTrainingExamplesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminTrainingExamplesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/training-examples/{id}"; }; export type GetAdminTrainingExamplesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminTrainingExamplesByIdError = GetAdminTrainingExamplesByIdErrors[keyof GetAdminTrainingExamplesByIdErrors]; export type GetAdminTrainingExamplesByIdResponses = { /** * Success */ 200: { data?: TrainingExample; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminTrainingExamplesByIdResponse = GetAdminTrainingExamplesByIdResponses[keyof GetAdminTrainingExamplesByIdResponses]; export type PatchAdminTrainingExamplesByIdData = { /** * Request body for the /training-examples/:id operation on training-example resource */ body?: { data: { attributes?: { /** * Structured correction data: fields_changed, reason, original_confidence */ correction_metadata?: { [key: string]: unknown; } | null; /** * Per-field correction reasons: %{field_name => reason_string} */ correction_reasons?: { [key: string]: unknown; } | null; /** * S3 path to the original document image for visual RAG retrieval */ input_image_ref?: string | null; input_text?: string | null; output_json?: { [key: string]: unknown; } | null; /** * General note about these corrections (e.g., 'Poor OCR quality', 'Non-standard date format') */ training_note?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "training-example"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/training-examples/{id}"; }; export type PatchAdminTrainingExamplesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminTrainingExamplesByIdError = PatchAdminTrainingExamplesByIdErrors[keyof PatchAdminTrainingExamplesByIdErrors]; export type PatchAdminTrainingExamplesByIdResponses = { /** * Success */ 200: { data?: TrainingExample; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminTrainingExamplesByIdResponse = PatchAdminTrainingExamplesByIdResponses[keyof PatchAdminTrainingExamplesByIdResponses]; export type PostAdminCrmContactsData = { /** * Request body for the /crm/contacts operation on crm-contact resource */ body: { data: { attributes?: { application_id?: string | null; avatar_url?: string | null; date_of_birth?: string | null; email?: string | null; external_ids?: { [key: string]: unknown; } | null; external_owner_id?: string | null; first_name: string; last_name: string; lifecycle_stage?: "lead" | "marketing_qualified" | "sales_qualified" | "opportunity" | "customer" | "evangelist" | "churned" | "discharged"; /** * BCP 47 language tag (e.g., en-US) */ locale?: string | null; middle_name?: string | null; owner_id?: string | null; phone?: string | null; portal_user_id?: string | null; prefix?: string | null; properties?: { [key: string]: unknown; } | null; sex?: "male" | "female" | "other"; source?: "manual" | "import" | "channel" | "connector" | "ai_extracted" | "api" | "portal"; suffix?: string | null; tags?: Array | null; /** * IANA timezone (e.g., America/New_York) */ timezone?: string | null; title?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "crm-contact"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/contacts"; }; export type PostAdminCrmContactsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrmContactsError = PostAdminCrmContactsErrors[keyof PostAdminCrmContactsErrors]; export type PostAdminCrmContactsResponses = { /** * Success */ 201: { data?: CrmContact; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrmContactsResponse = PostAdminCrmContactsResponses[keyof PostAdminCrmContactsResponses]; export type PostAdminIsvCrmChannelCaptureConfigData = { /** * Request body for the /isv/crm/channel-capture-config operation on crm-channel-capture-config resource */ body: { data: { attributes?: { application_id: string; auto_create_contacts?: boolean | null; channel_types?: Array | null; content_retention_days?: number | null; enabled?: boolean | null; pii_scan_enabled?: boolean | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "crm-channel-capture-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/isv/crm/channel-capture-config"; }; export type PostAdminIsvCrmChannelCaptureConfigErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminIsvCrmChannelCaptureConfigError = PostAdminIsvCrmChannelCaptureConfigErrors[keyof PostAdminIsvCrmChannelCaptureConfigErrors]; export type PostAdminIsvCrmChannelCaptureConfigResponses = { /** * Success */ 201: { data?: CrmChannelCaptureConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminIsvCrmChannelCaptureConfigResponse = PostAdminIsvCrmChannelCaptureConfigResponses[keyof PostAdminIsvCrmChannelCaptureConfigResponses]; export type GetAdminCrmPipelinesWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/pipelines/workspace/{workspace_id}"; }; export type GetAdminCrmPipelinesWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmPipelinesWorkspaceByWorkspaceIdError = GetAdminCrmPipelinesWorkspaceByWorkspaceIdErrors[keyof GetAdminCrmPipelinesWorkspaceByWorkspaceIdErrors]; export type GetAdminCrmPipelinesWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crm-pipeline */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmPipelinesWorkspaceByWorkspaceIdResponse = GetAdminCrmPipelinesWorkspaceByWorkspaceIdResponses[keyof GetAdminCrmPipelinesWorkspaceByWorkspaceIdResponses]; export type GetAdminContractRenewalAlertsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/contract-renewal-alerts/{id}"; }; export type GetAdminContractRenewalAlertsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminContractRenewalAlertsByIdError = GetAdminContractRenewalAlertsByIdErrors[keyof GetAdminContractRenewalAlertsByIdErrors]; export type GetAdminContractRenewalAlertsByIdResponses = { /** * Success */ 200: { data?: ContractRenewalAlert; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminContractRenewalAlertsByIdResponse = GetAdminContractRenewalAlertsByIdResponses[keyof GetAdminContractRenewalAlertsByIdResponses]; export type DeleteAdminExtractionResultsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/results/{id}"; }; export type DeleteAdminExtractionResultsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminExtractionResultsByIdError = DeleteAdminExtractionResultsByIdErrors[keyof DeleteAdminExtractionResultsByIdErrors]; export type DeleteAdminExtractionResultsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminExtractionResultsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/results/{id}"; }; export type GetAdminExtractionResultsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionResultsByIdError = GetAdminExtractionResultsByIdErrors[keyof GetAdminExtractionResultsByIdErrors]; export type GetAdminExtractionResultsByIdResponses = { /** * Success */ 200: { data?: ExtractionResult; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionResultsByIdResponse = GetAdminExtractionResultsByIdResponses[keyof GetAdminExtractionResultsByIdResponses]; export type PatchAdminExtractionResultsByIdData = { /** * Request body for the /extraction/results/:id operation on extraction-result resource */ body?: { data: { attributes?: { /** * Classification confidence score */ classification_confidence?: number | null; credits_used?: string | number | unknown; /** * Specific document type classification */ document_type?: string | null; /** * Document domain classification */ domain?: string | null; extracted_fields?: { [key: string]: unknown; } | null; /** * Municipality extracted from document */ municipality?: string | null; processing_time_ms?: number | null; /** * State/province code */ state?: string | null; status?: "pending" | "completed" | "failed"; }; id: string; relationships?: { [key: string]: never; }; type?: "extraction-result"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/results/{id}"; }; export type PatchAdminExtractionResultsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminExtractionResultsByIdError = PatchAdminExtractionResultsByIdErrors[keyof PatchAdminExtractionResultsByIdErrors]; export type PatchAdminExtractionResultsByIdResponses = { /** * Success */ 200: { data?: ExtractionResult; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminExtractionResultsByIdResponse = PatchAdminExtractionResultsByIdResponses[keyof PatchAdminExtractionResultsByIdResponses]; export type PatchAdminSchedulingLocationsByIdDeactivateData = { /** * Request body for the /scheduling/locations/:id/deactivate operation on scheduling-location resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "scheduling-location"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/locations/{id}/deactivate"; }; export type PatchAdminSchedulingLocationsByIdDeactivateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSchedulingLocationsByIdDeactivateError = PatchAdminSchedulingLocationsByIdDeactivateErrors[keyof PatchAdminSchedulingLocationsByIdDeactivateErrors]; export type PatchAdminSchedulingLocationsByIdDeactivateResponses = { /** * Success */ 200: { data?: SchedulingLocation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSchedulingLocationsByIdDeactivateResponse = PatchAdminSchedulingLocationsByIdDeactivateResponses[keyof PatchAdminSchedulingLocationsByIdDeactivateResponses]; export type GetAdminCrawlerJobsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/jobs"; }; export type GetAdminCrawlerJobsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrawlerJobsError = GetAdminCrawlerJobsErrors[keyof GetAdminCrawlerJobsErrors]; export type GetAdminCrawlerJobsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crawler-job */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrawlerJobsResponse = GetAdminCrawlerJobsResponses[keyof GetAdminCrawlerJobsResponses]; export type PostAdminCrawlerJobsData = { /** * Request body for the /crawler/jobs operation on crawler-job resource */ body: { data: { attributes?: { browser_steps?: Array<{ [key: string]: unknown; }> | null; callback_url?: string | null; depth?: number | null; exclude_patterns?: Array | null; include_patterns?: Array | null; max_pages?: number | null; metadata?: { [key: string]: unknown; } | null; mode?: "single" | "site" | "sitemap"; output_format?: "markdown" | "html" | "text" | "snapshot"; schedule_id?: string | null; strategy?: "native" | "sidecar" | "auto"; url: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "crawler-job"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/jobs"; }; export type PostAdminCrawlerJobsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrawlerJobsError = PostAdminCrawlerJobsErrors[keyof PostAdminCrawlerJobsErrors]; export type PostAdminCrawlerJobsResponses = { /** * Success */ 201: { data?: CrawlerJob; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrawlerJobsResponse = PostAdminCrawlerJobsResponses[keyof PostAdminCrawlerJobsResponses]; export type GetAdminPipelinesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pipelines"; }; export type GetAdminPipelinesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPipelinesError = GetAdminPipelinesErrors[keyof GetAdminPipelinesErrors]; export type GetAdminPipelinesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a pipeline */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPipelinesResponse = GetAdminPipelinesResponses[keyof GetAdminPipelinesResponses]; export type PostAdminPipelinesData = { /** * Request body for the /pipelines operation on pipeline resource */ body: { data: { attributes?: { /** * When set, pipeline belongs to an ISV Application. Null = workspace-owned. */ application_id?: string | null; chat_agent_id?: string | null; cloned_from_pipeline_id?: string | null; description?: string | null; is_active?: boolean | null; name: string; /** * Reactor-compatible node graph definition. Each entry: * "node_id" => %{ * "agent_id" => "uuid", * "inputs" => %{"arg" => "source_node.output"}, * "depends_on" => ["source_node"] * } * */ nodes?: { [key: string]: unknown; } | null; /** * Stable identifier that survives database resets. Immutable after creation. Unique per application. */ system_slug?: string | null; /** * How the pipeline is triggered. */ trigger_type?: "manual" | "event" | "schedule"; /** * Human-readable workflow label for display. */ workflow_label?: string | null; /** * Workflow classification for ISV portal routing. */ workflow_type?: "build" | "troubleshoot" | "security_scan" | "analyze" | "evaluate" | "custom" | "clinical_session" | "clinical_intake"; /** * When set, pipeline is scoped to this workspace. */ workspace_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "pipeline"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pipelines"; }; export type PostAdminPipelinesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminPipelinesError = PostAdminPipelinesErrors[keyof PostAdminPipelinesErrors]; export type PostAdminPipelinesResponses = { /** * Success */ 201: { data?: Pipeline; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminPipelinesResponse = PostAdminPipelinesResponses[keyof PostAdminPipelinesResponses]; export type GetAdminBrandIdentitiesDefaultTenantByTenantIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { tenant_id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/brand-identities/default/tenant/{tenant_id}"; }; export type GetAdminBrandIdentitiesDefaultTenantByTenantIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminBrandIdentitiesDefaultTenantByTenantIdError = GetAdminBrandIdentitiesDefaultTenantByTenantIdErrors[keyof GetAdminBrandIdentitiesDefaultTenantByTenantIdErrors]; export type GetAdminBrandIdentitiesDefaultTenantByTenantIdResponses = { /** * Success */ 200: { data?: BrandIdentity; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminBrandIdentitiesDefaultTenantByTenantIdResponse = GetAdminBrandIdentitiesDefaultTenantByTenantIdResponses[keyof GetAdminBrandIdentitiesDefaultTenantByTenantIdResponses]; export type DeleteAdminCrmContactsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/contacts/{id}"; }; export type DeleteAdminCrmContactsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrmContactsByIdError = DeleteAdminCrmContactsByIdErrors[keyof DeleteAdminCrmContactsByIdErrors]; export type DeleteAdminCrmContactsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCrmContactsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/contacts/{id}"; }; export type GetAdminCrmContactsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmContactsByIdError = GetAdminCrmContactsByIdErrors[keyof GetAdminCrmContactsByIdErrors]; export type GetAdminCrmContactsByIdResponses = { /** * Success */ 200: { data?: CrmContact; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmContactsByIdResponse = GetAdminCrmContactsByIdResponses[keyof GetAdminCrmContactsByIdResponses]; export type PatchAdminCrmContactsByIdData = { /** * Request body for the /crm/contacts/:id operation on crm-contact resource */ body?: { data: { attributes?: { ai_score?: number | null; ai_score_reasons?: { [key: string]: unknown; } | null; avatar_url?: string | null; date_of_birth?: string | null; email?: string | null; external_ids?: { [key: string]: unknown; } | null; external_owner_id?: string | null; first_name?: string | null; last_name?: string | null; lifecycle_stage?: "lead" | "marketing_qualified" | "sales_qualified" | "opportunity" | "customer" | "evangelist" | "churned" | "discharged"; /** * BCP 47 language tag (e.g., en-US) */ locale?: string | null; middle_name?: string | null; owner_id?: string | null; phone?: string | null; portal_user_id?: string | null; prefix?: string | null; properties?: { [key: string]: unknown; } | null; sex?: "male" | "female" | "other"; suffix?: string | null; tags?: Array | null; /** * IANA timezone (e.g., America/New_York) */ timezone?: string | null; title?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-contact"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/contacts/{id}"; }; export type PatchAdminCrmContactsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmContactsByIdError = PatchAdminCrmContactsByIdErrors[keyof PatchAdminCrmContactsByIdErrors]; export type PatchAdminCrmContactsByIdResponses = { /** * Success */ 200: { data?: CrmContact; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmContactsByIdResponse = PatchAdminCrmContactsByIdResponses[keyof PatchAdminCrmContactsByIdResponses]; export type PostAdminUsersAuthConfirmData = { /** * Request body for the /users/auth/confirm operation on user resource */ body: { data: { attributes?: { /** * F-A4-R2: scope the short-code lookup to a specific application. Threaded by ConfirmProxyController from the API key's application context. */ application_id?: string | null; confirmation_token: string; email: string; }; relationships?: { [key: string]: never; }; type?: "user"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/users/auth/confirm"; }; export type PostAdminUsersAuthConfirmErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminUsersAuthConfirmError = PostAdminUsersAuthConfirmErrors[keyof PostAdminUsersAuthConfirmErrors]; export type PostAdminUsersAuthConfirmResponses = { /** * Success */ 201: { data?: User; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminUsersAuthConfirmResponse = PostAdminUsersAuthConfirmResponses[keyof PostAdminUsersAuthConfirmResponses]; export type PostAdminSupportTagsData = { /** * Request body for the /support/tags operation on support-tag resource */ body: { data: { attributes?: { color?: string | null; name: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "support-tag"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/tags"; }; export type PostAdminSupportTagsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSupportTagsError = PostAdminSupportTagsErrors[keyof PostAdminSupportTagsErrors]; export type PostAdminSupportTagsResponses = { /** * Success */ 201: { data?: SupportTag; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSupportTagsResponse = PostAdminSupportTagsResponses[keyof PostAdminSupportTagsResponses]; export type GetAdminClinicalNotesByWorkspaceData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/notes/by-workspace"; }; export type GetAdminClinicalNotesByWorkspaceErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalNotesByWorkspaceError = GetAdminClinicalNotesByWorkspaceErrors[keyof GetAdminClinicalNotesByWorkspaceErrors]; export type GetAdminClinicalNotesByWorkspaceResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-note */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalNotesByWorkspaceResponse = GetAdminClinicalNotesByWorkspaceResponses[keyof GetAdminClinicalNotesByWorkspaceResponses]; export type GetAdminClinicalClientMedicationsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; patient_id: string; }; url: "/admin/clinical/client-medications"; }; export type GetAdminClinicalClientMedicationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalClientMedicationsError = GetAdminClinicalClientMedicationsErrors[keyof GetAdminClinicalClientMedicationsErrors]; export type GetAdminClinicalClientMedicationsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-client-medication */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalClientMedicationsResponse = GetAdminClinicalClientMedicationsResponses[keyof GetAdminClinicalClientMedicationsResponses]; export type PostAdminClinicalClientMedicationsData = { /** * Request body for the /clinical/client-medications operation on clinical-client-medication resource */ body: { data: { attributes?: { clinical_notes?: string | null; dosage?: string | null; end_date?: unknown; external_ids?: { [key: string]: unknown; } | null; frequency?: string | null; generic_name?: string | null; indication?: string | null; instructions?: string | null; interaction_flags?: Array | null; metadata?: { [key: string]: unknown; } | null; name: string; ndc_code?: string | null; patient_id: string; pharmacy_name?: string | null; pharmacy_phone?: string | null; prescribed_at?: unknown; prescriber_name?: string | null; prescriber_npi?: string | null; refill_date?: unknown; refills_remaining?: number | null; route?: string | null; source?: string | null; start_date?: unknown; status?: "active" | "discontinued" | "on_hold" | "pending_review"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-client-medication"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-medications"; }; export type PostAdminClinicalClientMedicationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalClientMedicationsError = PostAdminClinicalClientMedicationsErrors[keyof PostAdminClinicalClientMedicationsErrors]; export type PostAdminClinicalClientMedicationsResponses = { /** * Success */ 201: { data?: ClinicalClientMedication; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalClientMedicationsResponse = PostAdminClinicalClientMedicationsResponses[keyof PostAdminClinicalClientMedicationsResponses]; export type PostAdminAuditLogsExportData = { /** * Request body for the /audit-logs/export operation on audit-log resource */ body: { data: { format: "csv" | "json"; from_date?: unknown; tenant_id: string; to_date?: unknown; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/audit-logs/export"; }; export type PostAdminAuditLogsExportErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAuditLogsExportError = PostAdminAuditLogsExportErrors[keyof PostAdminAuditLogsExportErrors]; export type PostAdminAuditLogsExportResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminAuditLogsExportResponse = PostAdminAuditLogsExportResponses[keyof PostAdminAuditLogsExportResponses]; export type DeleteAdminCrmCustomEntitiesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/custom-entities/{id}"; }; export type DeleteAdminCrmCustomEntitiesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrmCustomEntitiesByIdError = DeleteAdminCrmCustomEntitiesByIdErrors[keyof DeleteAdminCrmCustomEntitiesByIdErrors]; export type DeleteAdminCrmCustomEntitiesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCrmCustomEntitiesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/custom-entities/{id}"; }; export type GetAdminCrmCustomEntitiesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmCustomEntitiesByIdError = GetAdminCrmCustomEntitiesByIdErrors[keyof GetAdminCrmCustomEntitiesByIdErrors]; export type GetAdminCrmCustomEntitiesByIdResponses = { /** * Success */ 200: { data?: CrmCustomEntity; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmCustomEntitiesByIdResponse = GetAdminCrmCustomEntitiesByIdResponses[keyof GetAdminCrmCustomEntitiesByIdResponses]; export type PatchAdminCrmCustomEntitiesByIdData = { /** * Request body for the /crm/custom-entities/:id operation on crm-custom-entity resource */ body?: { data: { attributes?: { external_owner_id?: string | null; name?: string | null; owner_id?: string | null; pipeline_id?: string | null; pipeline_stage_id?: string | null; properties?: { [key: string]: unknown; } | null; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-custom-entity"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/custom-entities/{id}"; }; export type PatchAdminCrmCustomEntitiesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmCustomEntitiesByIdError = PatchAdminCrmCustomEntitiesByIdErrors[keyof PatchAdminCrmCustomEntitiesByIdErrors]; export type PatchAdminCrmCustomEntitiesByIdResponses = { /** * Success */ 200: { data?: CrmCustomEntity; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmCustomEntitiesByIdResponse = PatchAdminCrmCustomEntitiesByIdResponses[keyof PatchAdminCrmCustomEntitiesByIdResponses]; export type PostAdminRecipesShoppingListsData = { /** * Request body for the /recipes/shopping-lists operation on recipes-shopping-list resource */ body: { data: { attributes?: { contact_id?: string | null; meal_schedule_id?: string | null; name: string; status?: "draft" | "active" | "completed"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "recipes-shopping-list"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/shopping-lists"; }; export type PostAdminRecipesShoppingListsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminRecipesShoppingListsError = PostAdminRecipesShoppingListsErrors[keyof PostAdminRecipesShoppingListsErrors]; export type PostAdminRecipesShoppingListsResponses = { /** * Success */ 201: { data?: RecipesShoppingList; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminRecipesShoppingListsResponse = PostAdminRecipesShoppingListsResponses[keyof PostAdminRecipesShoppingListsResponses]; export type PostAdminFeatureUsagesIncrementData = { /** * Request body for the /feature-usages/increment operation on feature-usage resource */ body: { data: { feature_key: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/feature-usages/increment"; }; export type PostAdminFeatureUsagesIncrementErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminFeatureUsagesIncrementError = PostAdminFeatureUsagesIncrementErrors[keyof PostAdminFeatureUsagesIncrementErrors]; export type PostAdminFeatureUsagesIncrementResponses = { /** * Success */ 201: { result: { [key: string]: unknown; }; }; }; export type PostAdminFeatureUsagesIncrementResponse = PostAdminFeatureUsagesIncrementResponses[keyof PostAdminFeatureUsagesIncrementResponses]; export type GetAdminNotificationPreferencesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/notification-preferences"; }; export type GetAdminNotificationPreferencesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminNotificationPreferencesError = GetAdminNotificationPreferencesErrors[keyof GetAdminNotificationPreferencesErrors]; export type GetAdminNotificationPreferencesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a notification-preference */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminNotificationPreferencesResponse = GetAdminNotificationPreferencesResponses[keyof GetAdminNotificationPreferencesResponses]; export type PostAdminNotificationPreferencesData = { /** * Request body for the /notification-preferences operation on notification-preference resource */ body: { data: { attributes?: { channels?: Array | null; preferences?: { [key: string]: unknown; } | null; user_id: string; }; relationships?: { [key: string]: never; }; type?: "notification-preference"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/notification-preferences"; }; export type PostAdminNotificationPreferencesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminNotificationPreferencesError = PostAdminNotificationPreferencesErrors[keyof PostAdminNotificationPreferencesErrors]; export type PostAdminNotificationPreferencesResponses = { /** * Success */ 201: { data?: NotificationPreference; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminNotificationPreferencesResponse = PostAdminNotificationPreferencesResponses[keyof PostAdminNotificationPreferencesResponses]; export type GetAdminBusinessAssociateAgreementsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/business-associate-agreements/{id}"; }; export type GetAdminBusinessAssociateAgreementsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminBusinessAssociateAgreementsByIdError = GetAdminBusinessAssociateAgreementsByIdErrors[keyof GetAdminBusinessAssociateAgreementsByIdErrors]; export type GetAdminBusinessAssociateAgreementsByIdResponses = { /** * Success */ 200: { data?: BusinessAssociateAgreement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminBusinessAssociateAgreementsByIdResponse = GetAdminBusinessAssociateAgreementsByIdResponses[keyof GetAdminBusinessAssociateAgreementsByIdResponses]; export type PatchAdminBusinessAssociateAgreementsByIdData = { /** * Request body for the /business-associate-agreements/:id operation on business-associate-agreement resource */ body?: { data: { attributes?: { counterparty_name?: string | null; counterparty_signatory?: string | null; counterparty_type?: "covered_entity" | "business_associate" | "subcontractor"; direction?: "upstream" | "downstream"; effective_date?: string | null; expiration_date?: string | null; legal_document_id?: string | null; phi_scope?: Array | null; renewal_reminder_days?: number | null; renewal_type?: "auto_renew" | "manual_renew" | "fixed_term"; }; id: string; relationships?: { [key: string]: never; }; type?: "business-associate-agreement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/business-associate-agreements/{id}"; }; export type PatchAdminBusinessAssociateAgreementsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminBusinessAssociateAgreementsByIdError = PatchAdminBusinessAssociateAgreementsByIdErrors[keyof PatchAdminBusinessAssociateAgreementsByIdErrors]; export type PatchAdminBusinessAssociateAgreementsByIdResponses = { /** * Success */ 200: { data?: BusinessAssociateAgreement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminBusinessAssociateAgreementsByIdResponse = PatchAdminBusinessAssociateAgreementsByIdResponses[keyof PatchAdminBusinessAssociateAgreementsByIdResponses]; export type PostAdminTrainingExamplesBulkDeleteData = { /** * Request body for the /training-examples/bulk-delete operation on training-example resource */ body: { data: { agent_id: string; ids: Array; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/training-examples/bulk-delete"; }; export type PostAdminTrainingExamplesBulkDeleteErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminTrainingExamplesBulkDeleteError = PostAdminTrainingExamplesBulkDeleteErrors[keyof PostAdminTrainingExamplesBulkDeleteErrors]; export type PostAdminTrainingExamplesBulkDeleteResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminTrainingExamplesBulkDeleteResponse = PostAdminTrainingExamplesBulkDeleteResponses[keyof PostAdminTrainingExamplesBulkDeleteResponses]; export type GetAdminLlmAnalyticsPlatformData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/llm-analytics/platform"; }; export type GetAdminLlmAnalyticsPlatformErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminLlmAnalyticsPlatformError = GetAdminLlmAnalyticsPlatformErrors[keyof GetAdminLlmAnalyticsPlatformErrors]; export type GetAdminLlmAnalyticsPlatformResponses = { /** * Success */ 200: { data?: LlmAnalytics; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminLlmAnalyticsPlatformResponse = GetAdminLlmAnalyticsPlatformResponses[keyof GetAdminLlmAnalyticsPlatformResponses]; export type DeleteAdminCreditPackagesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/credit-packages/{id}"; }; export type DeleteAdminCreditPackagesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCreditPackagesByIdError = DeleteAdminCreditPackagesByIdErrors[keyof DeleteAdminCreditPackagesByIdErrors]; export type DeleteAdminCreditPackagesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCreditPackagesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/credit-packages/{id}"; }; export type GetAdminCreditPackagesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCreditPackagesByIdError = GetAdminCreditPackagesByIdErrors[keyof GetAdminCreditPackagesByIdErrors]; export type GetAdminCreditPackagesByIdResponses = { /** * Success */ 200: { data?: CreditPackage; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCreditPackagesByIdResponse = GetAdminCreditPackagesByIdResponses[keyof GetAdminCreditPackagesByIdResponses]; export type PatchAdminCreditPackagesByIdData = { /** * Request body for the /credit-packages/:id operation on credit-package resource */ body?: { data: { attributes?: { credits?: number | null; name?: string | null; price?: { amount: string; currency: string; } | unknown; }; id: string; relationships?: { [key: string]: never; }; type?: "credit-package"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/credit-packages/{id}"; }; export type PatchAdminCreditPackagesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCreditPackagesByIdError = PatchAdminCreditPackagesByIdErrors[keyof PatchAdminCreditPackagesByIdErrors]; export type PatchAdminCreditPackagesByIdResponses = { /** * Success */ 200: { data?: CreditPackage; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCreditPackagesByIdResponse = PatchAdminCreditPackagesByIdResponses[keyof PatchAdminCreditPackagesByIdResponses]; export type PostAdminRecipesCollectionRecipesData = { /** * Request body for the /recipes/collection-recipes operation on recipes-collection-recipe resource */ body: { data: { attributes?: { collection_id: string; recipe_id: string; sort_order?: number | null; }; relationships?: { [key: string]: never; }; type?: "recipes-collection-recipe"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/collection-recipes"; }; export type PostAdminRecipesCollectionRecipesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminRecipesCollectionRecipesError = PostAdminRecipesCollectionRecipesErrors[keyof PostAdminRecipesCollectionRecipesErrors]; export type PostAdminRecipesCollectionRecipesResponses = { /** * Success */ 201: { data?: RecipesCollectionRecipe; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminRecipesCollectionRecipesResponse = PostAdminRecipesCollectionRecipesResponses[keyof PostAdminRecipesCollectionRecipesResponses]; export type DeleteAdminClinicalClientSupplementsByIdPermanentData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-supplements/{id}/permanent"; }; export type DeleteAdminClinicalClientSupplementsByIdPermanentErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalClientSupplementsByIdPermanentError = DeleteAdminClinicalClientSupplementsByIdPermanentErrors[keyof DeleteAdminClinicalClientSupplementsByIdPermanentErrors]; export type DeleteAdminClinicalClientSupplementsByIdPermanentResponses = { /** * Deleted successfully */ 200: unknown; }; export type DeleteAdminExtractionWorkflowsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction-workflows/{id}"; }; export type DeleteAdminExtractionWorkflowsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminExtractionWorkflowsByIdError = DeleteAdminExtractionWorkflowsByIdErrors[keyof DeleteAdminExtractionWorkflowsByIdErrors]; export type DeleteAdminExtractionWorkflowsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminExtractionWorkflowsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction-workflows/{id}"; }; export type GetAdminExtractionWorkflowsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionWorkflowsByIdError = GetAdminExtractionWorkflowsByIdErrors[keyof GetAdminExtractionWorkflowsByIdErrors]; export type GetAdminExtractionWorkflowsByIdResponses = { /** * Success */ 200: { data?: ExtractionWorkflow; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionWorkflowsByIdResponse = GetAdminExtractionWorkflowsByIdResponses[keyof GetAdminExtractionWorkflowsByIdResponses]; export type PatchAdminExtractionWorkflowsByIdData = { /** * Request body for the /extraction-workflows/:id operation on extraction-workflow resource */ body?: { data: { attributes?: { /** * Optional description of the workflow purpose and behavior */ description?: string | null; enabled?: boolean | null; /** * Human-readable workflow name */ name?: string | null; /** * Ordered list of workflow steps */ steps?: Array | null; /** * When this workflow is triggered */ trigger?: "on_upload" | "on_schedule" | "manual"; }; id: string; relationships?: { [key: string]: never; }; type?: "extraction-workflow"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction-workflows/{id}"; }; export type PatchAdminExtractionWorkflowsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminExtractionWorkflowsByIdError = PatchAdminExtractionWorkflowsByIdErrors[keyof PatchAdminExtractionWorkflowsByIdErrors]; export type PatchAdminExtractionWorkflowsByIdResponses = { /** * Success */ 200: { data?: ExtractionWorkflow; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminExtractionWorkflowsByIdResponse = PatchAdminExtractionWorkflowsByIdResponses[keyof PatchAdminExtractionWorkflowsByIdResponses]; export type PostAdminExtractionSchemaDiscoveriesData = { /** * Request body for the /extraction/schema-discoveries operation on schema-discovery resource */ body: { data: { attributes?: { advanced_mode?: boolean | null; agent_id?: string | null; document_id: string; source?: "manual" | "ai_suggestions"; }; relationships?: { [key: string]: never; }; type?: "schema-discovery"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/schema-discoveries"; }; export type PostAdminExtractionSchemaDiscoveriesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminExtractionSchemaDiscoveriesError = PostAdminExtractionSchemaDiscoveriesErrors[keyof PostAdminExtractionSchemaDiscoveriesErrors]; export type PostAdminExtractionSchemaDiscoveriesResponses = { /** * Success */ 201: { data?: SchemaDiscovery; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminExtractionSchemaDiscoveriesResponse = PostAdminExtractionSchemaDiscoveriesResponses[keyof PostAdminExtractionSchemaDiscoveriesResponses]; export type GetAdminComplianceDocumentTemplatesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/compliance-document-templates"; }; export type GetAdminComplianceDocumentTemplatesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminComplianceDocumentTemplatesError = GetAdminComplianceDocumentTemplatesErrors[keyof GetAdminComplianceDocumentTemplatesErrors]; export type GetAdminComplianceDocumentTemplatesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a compliance-document-template */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminComplianceDocumentTemplatesResponse = GetAdminComplianceDocumentTemplatesResponses[keyof GetAdminComplianceDocumentTemplatesResponses]; export type PostAdminComplianceDocumentTemplatesData = { /** * Request body for the /compliance-document-templates operation on compliance-document-template resource */ body: { data: { attributes?: { application_id?: string | null; /** * Markdown/Mustache template with {{variables}} */ content_template: string; is_platform_managed?: boolean | null; regulatory_framework: "hipaa" | "gdpr" | "pci_dss" | "sox"; required_variables?: Array | null; template_type: "baa" | "npp" | "privacy_policy" | "security_policy" | "incident_response_plan" | "contingency_plan" | "access_control_policy" | "risk_management_plan" | "training_policy" | "sanction_policy" | "breach_notification_policy" | "system_activity_review" | "data_retention_policy" | "minimum_necessary_policy" | "authorization_form" | "dpa"; title: string; version: string; }; relationships?: { [key: string]: never; }; type?: "compliance-document-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/compliance-document-templates"; }; export type PostAdminComplianceDocumentTemplatesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminComplianceDocumentTemplatesError = PostAdminComplianceDocumentTemplatesErrors[keyof PostAdminComplianceDocumentTemplatesErrors]; export type PostAdminComplianceDocumentTemplatesResponses = { /** * Success */ 201: { data?: ComplianceDocumentTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminComplianceDocumentTemplatesResponse = PostAdminComplianceDocumentTemplatesResponses[keyof PostAdminComplianceDocumentTemplatesResponses]; export type PatchAdminClinicalPracticeToolsCatalogByIdRestoreData = { /** * Request body for the /clinical/practice-tools/catalog/:id/restore operation on clinical-practice-tool resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-practice-tool"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-tools/catalog/{id}/restore"; }; export type PatchAdminClinicalPracticeToolsCatalogByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalPracticeToolsCatalogByIdRestoreError = PatchAdminClinicalPracticeToolsCatalogByIdRestoreErrors[keyof PatchAdminClinicalPracticeToolsCatalogByIdRestoreErrors]; export type PatchAdminClinicalPracticeToolsCatalogByIdRestoreResponses = { /** * Success */ 200: { data?: ClinicalPracticeTool; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalPracticeToolsCatalogByIdRestoreResponse = PatchAdminClinicalPracticeToolsCatalogByIdRestoreResponses[keyof PatchAdminClinicalPracticeToolsCatalogByIdRestoreResponses]; export type PostAdminCatalogProductClassificationsData = { /** * Request body for the /catalog/product-classifications operation on catalog-product-classification resource */ body: { data: { attributes?: { confidence?: number | null; position?: number | null; product_id: string; source?: "manual" | "ai_suggested" | "ai_auto"; taxonomy_node_id: string; }; relationships?: { [key: string]: never; }; type?: "catalog-product-classification"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/product-classifications"; }; export type PostAdminCatalogProductClassificationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCatalogProductClassificationsError = PostAdminCatalogProductClassificationsErrors[keyof PostAdminCatalogProductClassificationsErrors]; export type PostAdminCatalogProductClassificationsResponses = { /** * Success */ 201: { data?: CatalogProductClassification; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCatalogProductClassificationsResponse = PostAdminCatalogProductClassificationsResponses[keyof PostAdminCatalogProductClassificationsResponses]; export type PatchAdminCampaignsSequencesByIdPauseData = { /** * Request body for the /campaigns/sequences/:id/pause operation on email-marketing-sequence resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "email-marketing-sequence"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/campaigns/sequences/{id}/pause"; }; export type PatchAdminCampaignsSequencesByIdPauseErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCampaignsSequencesByIdPauseError = PatchAdminCampaignsSequencesByIdPauseErrors[keyof PatchAdminCampaignsSequencesByIdPauseErrors]; export type PatchAdminCampaignsSequencesByIdPauseResponses = { /** * Success */ 200: { data?: EmailMarketingSequence; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCampaignsSequencesByIdPauseResponse = PatchAdminCampaignsSequencesByIdPauseResponses[keyof PatchAdminCampaignsSequencesByIdPauseResponses]; export type GetAdminVoiceSessionsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; status?: "active" | "ended" | "failed" | "timed_out"; inserted_after?: unknown; inserted_before?: unknown; }; url: "/admin/voice/sessions"; }; export type GetAdminVoiceSessionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminVoiceSessionsError = GetAdminVoiceSessionsErrors[keyof GetAdminVoiceSessionsErrors]; export type GetAdminVoiceSessionsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a voice-session */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminVoiceSessionsResponse = GetAdminVoiceSessionsResponses[keyof GetAdminVoiceSessionsResponses]; export type PostAdminVoiceSessionsData = { /** * Request body for the /voice/sessions operation on voice-session resource */ body?: { data: { attributes?: { blueprint_id?: string | null; blueprint_mode?: "chat" | "extraction" | "both"; patient_id?: string | null; pii_key?: string | null; pii_mode?: "none" | "tokenize" | "tokenize_encrypt"; thread_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "voice-session"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/voice/sessions"; }; export type PostAdminVoiceSessionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminVoiceSessionsError = PostAdminVoiceSessionsErrors[keyof PostAdminVoiceSessionsErrors]; export type PostAdminVoiceSessionsResponses = { /** * Success */ 201: { data?: VoiceSession; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminVoiceSessionsResponse = PostAdminVoiceSessionsResponses[keyof PostAdminVoiceSessionsResponses]; export type PatchAdminInvoicesByIdMarkPaidData = { /** * Request body for the /invoices/:id/mark-paid operation on invoices-invoice resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "invoices-invoice"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/{id}/mark-paid"; }; export type PatchAdminInvoicesByIdMarkPaidErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvoicesByIdMarkPaidError = PatchAdminInvoicesByIdMarkPaidErrors[keyof PatchAdminInvoicesByIdMarkPaidErrors]; export type PatchAdminInvoicesByIdMarkPaidResponses = { /** * Success */ 200: { data?: InvoicesInvoice; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvoicesByIdMarkPaidResponse = PatchAdminInvoicesByIdMarkPaidResponses[keyof PatchAdminInvoicesByIdMarkPaidResponses]; export type PatchAdminClinicalNotesByIdArchiveData = { /** * Request body for the /clinical/notes/:id/archive operation on clinical-note resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-note"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/notes/{id}/archive"; }; export type PatchAdminClinicalNotesByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalNotesByIdArchiveError = PatchAdminClinicalNotesByIdArchiveErrors[keyof PatchAdminClinicalNotesByIdArchiveErrors]; export type PatchAdminClinicalNotesByIdArchiveResponses = { /** * Success */ 200: { data?: ClinicalNote; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalNotesByIdArchiveResponse = PatchAdminClinicalNotesByIdArchiveResponses[keyof PatchAdminClinicalNotesByIdArchiveResponses]; export type GetAdminAiChunksDocumentByDocumentIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { document_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ai/chunks/document/{document_id}"; }; export type GetAdminAiChunksDocumentByDocumentIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAiChunksDocumentByDocumentIdError = GetAdminAiChunksDocumentByDocumentIdErrors[keyof GetAdminAiChunksDocumentByDocumentIdErrors]; export type GetAdminAiChunksDocumentByDocumentIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a document-chunk */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAiChunksDocumentByDocumentIdResponse = GetAdminAiChunksDocumentByDocumentIdResponses[keyof GetAdminAiChunksDocumentByDocumentIdResponses]; export type GetAdminClinicalNoteTemplatesArchivedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/note-templates/archived"; }; export type GetAdminClinicalNoteTemplatesArchivedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalNoteTemplatesArchivedError = GetAdminClinicalNoteTemplatesArchivedErrors[keyof GetAdminClinicalNoteTemplatesArchivedErrors]; export type GetAdminClinicalNoteTemplatesArchivedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-note-template */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalNoteTemplatesArchivedResponse = GetAdminClinicalNoteTemplatesArchivedResponses[keyof GetAdminClinicalNoteTemplatesArchivedResponses]; export type PatchAdminInvoicesByIdMarkViewedData = { /** * Request body for the /invoices/:id/mark-viewed operation on invoices-invoice resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "invoices-invoice"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/{id}/mark-viewed"; }; export type PatchAdminInvoicesByIdMarkViewedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvoicesByIdMarkViewedError = PatchAdminInvoicesByIdMarkViewedErrors[keyof PatchAdminInvoicesByIdMarkViewedErrors]; export type PatchAdminInvoicesByIdMarkViewedResponses = { /** * Success */ 200: { data?: InvoicesInvoice; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvoicesByIdMarkViewedResponse = PatchAdminInvoicesByIdMarkViewedResponses[keyof PatchAdminInvoicesByIdMarkViewedResponses]; export type DeleteAdminClinicalNoteTemplatesCatalogByIdPermanentData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/note-templates/catalog/{id}/permanent"; }; export type DeleteAdminClinicalNoteTemplatesCatalogByIdPermanentErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalNoteTemplatesCatalogByIdPermanentError = DeleteAdminClinicalNoteTemplatesCatalogByIdPermanentErrors[keyof DeleteAdminClinicalNoteTemplatesCatalogByIdPermanentErrors]; export type DeleteAdminClinicalNoteTemplatesCatalogByIdPermanentResponses = { /** * Deleted successfully */ 200: unknown; }; export type PatchAdminSystemMessagesByIdPublishData = { /** * Request body for the /system-messages/:id/publish operation on system-message resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "system-message"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/system-messages/{id}/publish"; }; export type PatchAdminSystemMessagesByIdPublishErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSystemMessagesByIdPublishError = PatchAdminSystemMessagesByIdPublishErrors[keyof PatchAdminSystemMessagesByIdPublishErrors]; export type PatchAdminSystemMessagesByIdPublishResponses = { /** * Success */ 200: { data?: SystemMessage; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSystemMessagesByIdPublishResponse = PatchAdminSystemMessagesByIdPublishResponses[keyof PatchAdminSystemMessagesByIdPublishResponses]; export type PostAdminEmailMarketingCampaignsByIdOptimizeSubjectsData = { /** * Request body for the /email-marketing/campaigns/:id/optimize-subjects operation on campaign resource */ body: { data: { audience_description: string; campaign_description: string; original_subject: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/email-marketing/campaigns/{id}/optimize-subjects"; }; export type PostAdminEmailMarketingCampaignsByIdOptimizeSubjectsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminEmailMarketingCampaignsByIdOptimizeSubjectsError = PostAdminEmailMarketingCampaignsByIdOptimizeSubjectsErrors[keyof PostAdminEmailMarketingCampaignsByIdOptimizeSubjectsErrors]; export type PostAdminEmailMarketingCampaignsByIdOptimizeSubjectsResponses = { /** * Success */ 201: { result: { [key: string]: unknown; }; }; }; export type PostAdminEmailMarketingCampaignsByIdOptimizeSubjectsResponse = PostAdminEmailMarketingCampaignsByIdOptimizeSubjectsResponses[keyof PostAdminEmailMarketingCampaignsByIdOptimizeSubjectsResponses]; export type GetAdminCrmActivitiesWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/activities/workspace/{workspace_id}"; }; export type GetAdminCrmActivitiesWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmActivitiesWorkspaceByWorkspaceIdError = GetAdminCrmActivitiesWorkspaceByWorkspaceIdErrors[keyof GetAdminCrmActivitiesWorkspaceByWorkspaceIdErrors]; export type GetAdminCrmActivitiesWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crm-activity */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmActivitiesWorkspaceByWorkspaceIdResponse = GetAdminCrmActivitiesWorkspaceByWorkspaceIdResponses[keyof GetAdminCrmActivitiesWorkspaceByWorkspaceIdResponses]; export type PostAdminTenantsOrgData = { /** * Request body for the /tenants/org operation on tenant resource */ body: { data: { attributes?: { application_id?: string | null; name: string; slug: string; }; relationships?: { [key: string]: never; }; type?: "tenant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants/org"; }; export type PostAdminTenantsOrgErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminTenantsOrgError = PostAdminTenantsOrgErrors[keyof PostAdminTenantsOrgErrors]; export type PostAdminTenantsOrgResponses = { /** * Success */ 201: { data?: Tenant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminTenantsOrgResponse = PostAdminTenantsOrgResponses[keyof PostAdminTenantsOrgResponses]; export type PatchAdminBrandIdentitiesByIdUnsetDefaultData = { /** * Request body for the /brand-identities/:id/unset-default operation on brand-identity resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "brand-identity"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/brand-identities/{id}/unset-default"; }; export type PatchAdminBrandIdentitiesByIdUnsetDefaultErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminBrandIdentitiesByIdUnsetDefaultError = PatchAdminBrandIdentitiesByIdUnsetDefaultErrors[keyof PatchAdminBrandIdentitiesByIdUnsetDefaultErrors]; export type PatchAdminBrandIdentitiesByIdUnsetDefaultResponses = { /** * Success */ 200: { data?: BrandIdentity; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminBrandIdentitiesByIdUnsetDefaultResponse = PatchAdminBrandIdentitiesByIdUnsetDefaultResponses[keyof PatchAdminBrandIdentitiesByIdUnsetDefaultResponses]; export type GetAdminWebhookConfigsStatsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/webhook-configs/stats"; }; export type GetAdminWebhookConfigsStatsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWebhookConfigsStatsError = GetAdminWebhookConfigsStatsErrors[keyof GetAdminWebhookConfigsStatsErrors]; export type GetAdminWebhookConfigsStatsResponses = { /** * Success */ 200: { result: { [key: string]: unknown; }; }; }; export type GetAdminWebhookConfigsStatsResponse = GetAdminWebhookConfigsStatsResponses[keyof GetAdminWebhookConfigsStatsResponses]; export type DeleteAdminClinicalGoalTemplatesByIdPermanentData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-templates/{id}/permanent"; }; export type DeleteAdminClinicalGoalTemplatesByIdPermanentErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalGoalTemplatesByIdPermanentError = DeleteAdminClinicalGoalTemplatesByIdPermanentErrors[keyof DeleteAdminClinicalGoalTemplatesByIdPermanentErrors]; export type DeleteAdminClinicalGoalTemplatesByIdPermanentResponses = { /** * Deleted successfully */ 200: unknown; }; export type DeleteAdminEmailRecipientsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/recipients/{id}"; }; export type DeleteAdminEmailRecipientsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminEmailRecipientsByIdError = DeleteAdminEmailRecipientsByIdErrors[keyof DeleteAdminEmailRecipientsByIdErrors]; export type DeleteAdminEmailRecipientsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminEmailRecipientsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/recipients/{id}"; }; export type GetAdminEmailRecipientsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailRecipientsByIdError = GetAdminEmailRecipientsByIdErrors[keyof GetAdminEmailRecipientsByIdErrors]; export type GetAdminEmailRecipientsByIdResponses = { /** * Success */ 200: { data?: EmailRecipient; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailRecipientsByIdResponse = GetAdminEmailRecipientsByIdResponses[keyof GetAdminEmailRecipientsByIdResponses]; export type GetAdminVoiceTranscriptionResultsSessionBySessionIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { session_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/voice/transcription-results/session/{session_id}"; }; export type GetAdminVoiceTranscriptionResultsSessionBySessionIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminVoiceTranscriptionResultsSessionBySessionIdError = GetAdminVoiceTranscriptionResultsSessionBySessionIdErrors[keyof GetAdminVoiceTranscriptionResultsSessionBySessionIdErrors]; export type GetAdminVoiceTranscriptionResultsSessionBySessionIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a voice-transcription-result */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminVoiceTranscriptionResultsSessionBySessionIdResponse = GetAdminVoiceTranscriptionResultsSessionBySessionIdResponses[keyof GetAdminVoiceTranscriptionResultsSessionBySessionIdResponses]; export type GetAdminPermissionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/permissions/{id}"; }; export type GetAdminPermissionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPermissionsByIdError = GetAdminPermissionsByIdErrors[keyof GetAdminPermissionsByIdErrors]; export type GetAdminPermissionsByIdResponses = { /** * Success */ 200: { data?: Permission; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPermissionsByIdResponse = GetAdminPermissionsByIdResponses[keyof GetAdminPermissionsByIdResponses]; export type PatchAdminSupportTicketsByIdReopenData = { /** * Request body for the /support/tickets/:id/reopen operation on support-ticket resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "support-ticket"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/tickets/{id}/reopen"; }; export type PatchAdminSupportTicketsByIdReopenErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSupportTicketsByIdReopenError = PatchAdminSupportTicketsByIdReopenErrors[keyof PatchAdminSupportTicketsByIdReopenErrors]; export type PatchAdminSupportTicketsByIdReopenResponses = { /** * Success */ 200: { data?: SupportTicket; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSupportTicketsByIdReopenResponse = PatchAdminSupportTicketsByIdReopenResponses[keyof PatchAdminSupportTicketsByIdReopenResponses]; export type GetAdminBrandIdentitiesDefaultWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/brand-identities/default/workspace/{workspace_id}"; }; export type GetAdminBrandIdentitiesDefaultWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminBrandIdentitiesDefaultWorkspaceByWorkspaceIdError = GetAdminBrandIdentitiesDefaultWorkspaceByWorkspaceIdErrors[keyof GetAdminBrandIdentitiesDefaultWorkspaceByWorkspaceIdErrors]; export type GetAdminBrandIdentitiesDefaultWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { data?: BrandIdentity; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminBrandIdentitiesDefaultWorkspaceByWorkspaceIdResponse = GetAdminBrandIdentitiesDefaultWorkspaceByWorkspaceIdResponses[keyof GetAdminBrandIdentitiesDefaultWorkspaceByWorkspaceIdResponses]; export type GetAdminPortalChangeRequestsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/portal-change-requests"; }; export type GetAdminPortalChangeRequestsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPortalChangeRequestsError = GetAdminPortalChangeRequestsErrors[keyof GetAdminPortalChangeRequestsErrors]; export type GetAdminPortalChangeRequestsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a portal-change-request */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPortalChangeRequestsResponse = GetAdminPortalChangeRequestsResponses[keyof GetAdminPortalChangeRequestsResponses]; export type GetAdminIsvCrmChannelCaptureConfigByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/isv/crm/channel-capture-config/{id}"; }; export type GetAdminIsvCrmChannelCaptureConfigByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminIsvCrmChannelCaptureConfigByIdError = GetAdminIsvCrmChannelCaptureConfigByIdErrors[keyof GetAdminIsvCrmChannelCaptureConfigByIdErrors]; export type GetAdminIsvCrmChannelCaptureConfigByIdResponses = { /** * Success */ 200: { data?: CrmChannelCaptureConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminIsvCrmChannelCaptureConfigByIdResponse = GetAdminIsvCrmChannelCaptureConfigByIdResponses[keyof GetAdminIsvCrmChannelCaptureConfigByIdResponses]; export type PatchAdminIsvCrmChannelCaptureConfigByIdData = { /** * Request body for the /isv/crm/channel-capture-config/:id operation on crm-channel-capture-config resource */ body?: { data: { attributes?: { auto_create_contacts?: boolean | null; channel_types?: Array | null; content_retention_days?: number | null; enabled?: boolean | null; pii_scan_enabled?: boolean | null; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-channel-capture-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/isv/crm/channel-capture-config/{id}"; }; export type PatchAdminIsvCrmChannelCaptureConfigByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminIsvCrmChannelCaptureConfigByIdError = PatchAdminIsvCrmChannelCaptureConfigByIdErrors[keyof PatchAdminIsvCrmChannelCaptureConfigByIdErrors]; export type PatchAdminIsvCrmChannelCaptureConfigByIdResponses = { /** * Success */ 200: { data?: CrmChannelCaptureConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminIsvCrmChannelCaptureConfigByIdResponse = PatchAdminIsvCrmChannelCaptureConfigByIdResponses[keyof PatchAdminIsvCrmChannelCaptureConfigByIdResponses]; export type GetAdminCatalogStockMovementsTransactionByTransactionIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { transaction_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/stock-movements/transaction/{transaction_id}"; }; export type GetAdminCatalogStockMovementsTransactionByTransactionIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogStockMovementsTransactionByTransactionIdError = GetAdminCatalogStockMovementsTransactionByTransactionIdErrors[keyof GetAdminCatalogStockMovementsTransactionByTransactionIdErrors]; export type GetAdminCatalogStockMovementsTransactionByTransactionIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a catalog-stock-movement */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogStockMovementsTransactionByTransactionIdResponse = GetAdminCatalogStockMovementsTransactionByTransactionIdResponses[keyof GetAdminCatalogStockMovementsTransactionByTransactionIdResponses]; export type PatchAdminNotificationMethodsByIdVerifyData = { /** * Request body for the /notification-methods/:id/verify operation on notification-method resource */ body: { data: { attributes?: { token: string; }; id: string; relationships?: { [key: string]: never; }; type?: "notification-method"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/notification-methods/{id}/verify"; }; export type PatchAdminNotificationMethodsByIdVerifyErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminNotificationMethodsByIdVerifyError = PatchAdminNotificationMethodsByIdVerifyErrors[keyof PatchAdminNotificationMethodsByIdVerifyErrors]; export type PatchAdminNotificationMethodsByIdVerifyResponses = { /** * Success */ 200: { data?: NotificationMethod; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminNotificationMethodsByIdVerifyResponse = PatchAdminNotificationMethodsByIdVerifyResponses[keyof PatchAdminNotificationMethodsByIdVerifyResponses]; export type GetAdminUsersData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/users"; }; export type GetAdminUsersErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminUsersError = GetAdminUsersErrors[keyof GetAdminUsersErrors]; export type GetAdminUsersResponses = { /** * Success */ 200: { /** * An array of resource objects representing a user */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminUsersResponse = GetAdminUsersResponses[keyof GetAdminUsersResponses]; export type PostAdminThreadsByIdExportData = { /** * Request body for the /threads/:id/export operation on chat-thread resource */ body?: { data: { format?: string | null; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/threads/{id}/export"; }; export type PostAdminThreadsByIdExportErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminThreadsByIdExportError = PostAdminThreadsByIdExportErrors[keyof PostAdminThreadsByIdExportErrors]; export type PostAdminThreadsByIdExportResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminThreadsByIdExportResponse = PostAdminThreadsByIdExportResponses[keyof PostAdminThreadsByIdExportResponses]; export type PatchAdminThreadsByIdArchiveData = { /** * Request body for the /threads/:id/archive operation on chat-thread resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "chat-thread"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/threads/{id}/archive"; }; export type PatchAdminThreadsByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminThreadsByIdArchiveError = PatchAdminThreadsByIdArchiveErrors[keyof PatchAdminThreadsByIdArchiveErrors]; export type PatchAdminThreadsByIdArchiveResponses = { /** * Success */ 200: { data?: ChatThread; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminThreadsByIdArchiveResponse = PatchAdminThreadsByIdArchiveResponses[keyof PatchAdminThreadsByIdArchiveResponses]; export type GetAdminSearchSemanticData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; query: string; }; url: "/admin/search/semantic"; }; export type GetAdminSearchSemanticErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSearchSemanticError = GetAdminSearchSemanticErrors[keyof GetAdminSearchSemanticErrors]; export type GetAdminSearchSemanticResponses = { /** * Success */ 200: { /** * An array of resource objects representing a search */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSearchSemanticResponse = GetAdminSearchSemanticResponses[keyof GetAdminSearchSemanticResponses]; export type PatchAdminInvoicesRecurringSchedulesByIdPauseData = { /** * Request body for the /invoices/recurring-schedules/:id/pause operation on invoices-recurring-schedule resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "invoices-recurring-schedule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/recurring-schedules/{id}/pause"; }; export type PatchAdminInvoicesRecurringSchedulesByIdPauseErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvoicesRecurringSchedulesByIdPauseError = PatchAdminInvoicesRecurringSchedulesByIdPauseErrors[keyof PatchAdminInvoicesRecurringSchedulesByIdPauseErrors]; export type PatchAdminInvoicesRecurringSchedulesByIdPauseResponses = { /** * Success */ 200: { data?: InvoicesRecurringSchedule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvoicesRecurringSchedulesByIdPauseResponse = PatchAdminInvoicesRecurringSchedulesByIdPauseResponses[keyof PatchAdminInvoicesRecurringSchedulesByIdPauseResponses]; export type GetAdminClinicalGoalTemplateCollectionMembershipsCollectionByCollectionIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { collection_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-template-collection-memberships/collection/{collection_id}"; }; export type GetAdminClinicalGoalTemplateCollectionMembershipsCollectionByCollectionIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalGoalTemplateCollectionMembershipsCollectionByCollectionIdError = GetAdminClinicalGoalTemplateCollectionMembershipsCollectionByCollectionIdErrors[keyof GetAdminClinicalGoalTemplateCollectionMembershipsCollectionByCollectionIdErrors]; export type GetAdminClinicalGoalTemplateCollectionMembershipsCollectionByCollectionIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-goal-template-collection-membership */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalGoalTemplateCollectionMembershipsCollectionByCollectionIdResponse = GetAdminClinicalGoalTemplateCollectionMembershipsCollectionByCollectionIdResponses[keyof GetAdminClinicalGoalTemplateCollectionMembershipsCollectionByCollectionIdResponses]; export type GetAdminEmailInboundReceivedByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/inbound/received/{id}"; }; export type GetAdminEmailInboundReceivedByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailInboundReceivedByIdError = GetAdminEmailInboundReceivedByIdErrors[keyof GetAdminEmailInboundReceivedByIdErrors]; export type GetAdminEmailInboundReceivedByIdResponses = { /** * Success */ 200: { data?: EmailInboundEmail; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailInboundReceivedByIdResponse = GetAdminEmailInboundReceivedByIdResponses[keyof GetAdminEmailInboundReceivedByIdResponses]; export type GetAdminTransactionsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/transactions"; }; export type GetAdminTransactionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminTransactionsError = GetAdminTransactionsErrors[keyof GetAdminTransactionsErrors]; export type GetAdminTransactionsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a transaction */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminTransactionsResponse = GetAdminTransactionsResponses[keyof GetAdminTransactionsResponses]; export type GetAdminWalletUsageBreakdownData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; tenant_id?: string; }; url: "/admin/wallet/usage-breakdown"; }; export type GetAdminWalletUsageBreakdownErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWalletUsageBreakdownError = GetAdminWalletUsageBreakdownErrors[keyof GetAdminWalletUsageBreakdownErrors]; export type GetAdminWalletUsageBreakdownResponses = { /** * Success */ 200: { data?: Wallet; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWalletUsageBreakdownResponse = GetAdminWalletUsageBreakdownResponses[keyof GetAdminWalletUsageBreakdownResponses]; export type GetAdminUsersMeDashboardData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Optional tenant ID. Defaults to user's own tenant. */ tenant_id?: string; }; url: "/admin/users/me/dashboard"; }; export type GetAdminUsersMeDashboardErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminUsersMeDashboardError = GetAdminUsersMeDashboardErrors[keyof GetAdminUsersMeDashboardErrors]; export type GetAdminUsersMeDashboardResponses = { /** * Success */ 200: { result: { /** * Field included by default. */ allowed_actions?: Array | null; /** * Field included by default. */ is_own?: boolean | null; /** * Field included by default. */ stats?: { [key: string]: unknown; } | null; /** * Field included by default. */ tenant?: { [key: string]: unknown; } | null; /** * Field included by default. */ workspaces?: Array<{ [key: string]: unknown; }> | null; }; }; }; export type GetAdminUsersMeDashboardResponse = GetAdminUsersMeDashboardResponses[keyof GetAdminUsersMeDashboardResponses]; export type PatchAdminBusinessAssociateAgreementsByIdTerminateData = { /** * Request body for the /business-associate-agreements/:id/terminate operation on business-associate-agreement resource */ body?: { data: { attributes?: { termination_reason?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "business-associate-agreement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/business-associate-agreements/{id}/terminate"; }; export type PatchAdminBusinessAssociateAgreementsByIdTerminateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminBusinessAssociateAgreementsByIdTerminateError = PatchAdminBusinessAssociateAgreementsByIdTerminateErrors[keyof PatchAdminBusinessAssociateAgreementsByIdTerminateErrors]; export type PatchAdminBusinessAssociateAgreementsByIdTerminateResponses = { /** * Success */ 200: { data?: BusinessAssociateAgreement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminBusinessAssociateAgreementsByIdTerminateResponse = PatchAdminBusinessAssociateAgreementsByIdTerminateResponses[keyof PatchAdminBusinessAssociateAgreementsByIdTerminateResponses]; export type GetAdminAgentVersionsByIdMetricsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { date_range_end?: unknown; date_range_start?: unknown; }; url: "/admin/agent-versions/{id}/metrics"; }; export type GetAdminAgentVersionsByIdMetricsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentVersionsByIdMetricsError = GetAdminAgentVersionsByIdMetricsErrors[keyof GetAdminAgentVersionsByIdMetricsErrors]; export type GetAdminAgentVersionsByIdMetricsResponses = { /** * Success */ 200: { [key: string]: unknown; }; }; export type GetAdminAgentVersionsByIdMetricsResponse = GetAdminAgentVersionsByIdMetricsResponses[keyof GetAdminAgentVersionsByIdMetricsResponses]; export type PatchAdminCatalogClassificationSuggestionsByIdRejectData = { /** * Request body for the /catalog/classification-suggestions/:id/reject operation on catalog-classification-suggestion resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "catalog-classification-suggestion"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/classification-suggestions/{id}/reject"; }; export type PatchAdminCatalogClassificationSuggestionsByIdRejectErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCatalogClassificationSuggestionsByIdRejectError = PatchAdminCatalogClassificationSuggestionsByIdRejectErrors[keyof PatchAdminCatalogClassificationSuggestionsByIdRejectErrors]; export type PatchAdminCatalogClassificationSuggestionsByIdRejectResponses = { /** * Success */ 200: { data?: CatalogClassificationSuggestion; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCatalogClassificationSuggestionsByIdRejectResponse = PatchAdminCatalogClassificationSuggestionsByIdRejectResponses[keyof PatchAdminCatalogClassificationSuggestionsByIdRejectResponses]; export type PostAdminAgentVersionsByIdSetSystemFieldsData = { /** * Request body for the /agent-versions/:id/set-system-fields operation on agent-version resource */ body: { data: { system_field_names: Array; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/agent-versions/{id}/set-system-fields"; }; export type PostAdminAgentVersionsByIdSetSystemFieldsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAgentVersionsByIdSetSystemFieldsError = PostAdminAgentVersionsByIdSetSystemFieldsErrors[keyof PostAdminAgentVersionsByIdSetSystemFieldsErrors]; export type PostAdminAgentVersionsByIdSetSystemFieldsResponses = { /** * Success */ 201: unknown; }; export type GetAdminClinicalSupplementTemplatesCatalogArchivedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-templates/catalog/archived"; }; export type GetAdminClinicalSupplementTemplatesCatalogArchivedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalSupplementTemplatesCatalogArchivedError = GetAdminClinicalSupplementTemplatesCatalogArchivedErrors[keyof GetAdminClinicalSupplementTemplatesCatalogArchivedErrors]; export type GetAdminClinicalSupplementTemplatesCatalogArchivedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-supplement-template */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalSupplementTemplatesCatalogArchivedResponse = GetAdminClinicalSupplementTemplatesCatalogArchivedResponses[keyof GetAdminClinicalSupplementTemplatesCatalogArchivedResponses]; export type GetAdminComplianceRequirementsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/compliance-requirements"; }; export type GetAdminComplianceRequirementsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminComplianceRequirementsError = GetAdminComplianceRequirementsErrors[keyof GetAdminComplianceRequirementsErrors]; export type GetAdminComplianceRequirementsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a compliance-requirement */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminComplianceRequirementsResponse = GetAdminComplianceRequirementsResponses[keyof GetAdminComplianceRequirementsResponses]; export type PostAdminComplianceRequirementsData = { /** * Request body for the /compliance-requirements operation on compliance-requirement resource */ body: { data: { attributes?: { application_id: string; deadline?: unknown; description?: string | null; /** * Regulatory framework: gdpr, hipaa, pci_dss, etc. */ framework?: string | null; is_blocking?: boolean | null; legal_document_id?: string | null; recurrence_days?: number | null; recurring?: boolean | null; required_for_roles?: Array | null; requirement_type: "training" | "policy_acknowledgement" | "background_check" | "certification" | "attestation"; title: string; }; relationships?: { [key: string]: never; }; type?: "compliance-requirement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/compliance-requirements"; }; export type PostAdminComplianceRequirementsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminComplianceRequirementsError = PostAdminComplianceRequirementsErrors[keyof PostAdminComplianceRequirementsErrors]; export type PostAdminComplianceRequirementsResponses = { /** * Success */ 201: { data?: ComplianceRequirement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminComplianceRequirementsResponse = PostAdminComplianceRequirementsResponses[keyof PostAdminComplianceRequirementsResponses]; export type PatchAdminSocialAccountsByIdEnablePostingData = { /** * Request body for the /social/accounts/:id/enable-posting operation on social-account resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "social-account"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/accounts/{id}/enable-posting"; }; export type PatchAdminSocialAccountsByIdEnablePostingErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSocialAccountsByIdEnablePostingError = PatchAdminSocialAccountsByIdEnablePostingErrors[keyof PatchAdminSocialAccountsByIdEnablePostingErrors]; export type PatchAdminSocialAccountsByIdEnablePostingResponses = { /** * Success */ 200: { data?: SocialAccount; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSocialAccountsByIdEnablePostingResponse = PatchAdminSocialAccountsByIdEnablePostingResponses[keyof PatchAdminSocialAccountsByIdEnablePostingResponses]; export type GetAdminConsentRecordsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/consent-records"; }; export type GetAdminConsentRecordsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminConsentRecordsError = GetAdminConsentRecordsErrors[keyof GetAdminConsentRecordsErrors]; export type GetAdminConsentRecordsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a consent-record */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminConsentRecordsResponse = GetAdminConsentRecordsResponses[keyof GetAdminConsentRecordsResponses]; export type PostAdminConsentRecordsData = { /** * Request body for the /consent-records operation on consent-record resource */ body: { data: { attributes?: { /** * Human-readable description of what was consented to */ description?: string | null; ip_address?: string | null; purpose: "ai_document_processing" | "data_analytics" | "marketing_communications" | "third_party_sharing" | "session_recording"; user_agent?: string | null; user_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "consent-record"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/consent-records"; }; export type PostAdminConsentRecordsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConsentRecordsError = PostAdminConsentRecordsErrors[keyof PostAdminConsentRecordsErrors]; export type PostAdminConsentRecordsResponses = { /** * Success */ 201: { data?: ConsentRecord; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminConsentRecordsResponse = PostAdminConsentRecordsResponses[keyof PostAdminConsentRecordsResponses]; export type PostAdminEmailMarketingCampaignsData = { /** * Request body for the /email-marketing/campaigns operation on campaign resource */ body: { data: { attributes?: { description?: string | null; include_tracking_pixel?: boolean | null; include_unsubscribe_link?: boolean | null; name: string; sender_profile_id?: string | null; template_id: string; unsubscribe_message?: string | null; }; relationships?: { [key: string]: never; }; type?: "campaign"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/campaigns"; }; export type PostAdminEmailMarketingCampaignsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminEmailMarketingCampaignsError = PostAdminEmailMarketingCampaignsErrors[keyof PostAdminEmailMarketingCampaignsErrors]; export type PostAdminEmailMarketingCampaignsResponses = { /** * Success */ 201: { data?: Campaign; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminEmailMarketingCampaignsResponse = PostAdminEmailMarketingCampaignsResponses[keyof PostAdminEmailMarketingCampaignsResponses]; export type PatchAdminReviewsByIdApproveData = { /** * Request body for the /reviews/:id/approve operation on review resource */ body?: { data: { attributes?: { decision_payload?: { [key: string]: unknown; } | null; notes?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "review"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/reviews/{id}/approve"; }; export type PatchAdminReviewsByIdApproveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminReviewsByIdApproveError = PatchAdminReviewsByIdApproveErrors[keyof PatchAdminReviewsByIdApproveErrors]; export type PatchAdminReviewsByIdApproveResponses = { /** * Success */ 200: { data?: Review; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminReviewsByIdApproveResponse = PatchAdminReviewsByIdApproveResponses[keyof PatchAdminReviewsByIdApproveResponses]; export type GetAdminCrmCustomEntitiesByEntityIdVersionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { entity_id: string; id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/custom-entities/{entity_id}/versions/{id}"; }; export type GetAdminCrmCustomEntitiesByEntityIdVersionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmCustomEntitiesByEntityIdVersionsByIdError = GetAdminCrmCustomEntitiesByEntityIdVersionsByIdErrors[keyof GetAdminCrmCustomEntitiesByEntityIdVersionsByIdErrors]; export type GetAdminCrmCustomEntitiesByEntityIdVersionsByIdResponses = { /** * Success */ 200: { data?: CrmCustomEntityVersion; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmCustomEntitiesByEntityIdVersionsByIdResponse = GetAdminCrmCustomEntitiesByEntityIdVersionsByIdResponses[keyof GetAdminCrmCustomEntitiesByEntityIdVersionsByIdResponses]; export type PatchAdminTenantsByIdArchiveData = { /** * Request body for the /tenants/:id/archive operation on tenant resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "tenant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants/{id}/archive"; }; export type PatchAdminTenantsByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminTenantsByIdArchiveError = PatchAdminTenantsByIdArchiveErrors[keyof PatchAdminTenantsByIdArchiveErrors]; export type PatchAdminTenantsByIdArchiveResponses = { /** * Success */ 200: { data?: Tenant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminTenantsByIdArchiveResponse = PatchAdminTenantsByIdArchiveResponses[keyof PatchAdminTenantsByIdArchiveResponses]; export type GetAdminSupportQueueMembersApplicationByApplicationIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { application_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/queue-members/application/{application_id}"; }; export type GetAdminSupportQueueMembersApplicationByApplicationIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSupportQueueMembersApplicationByApplicationIdError = GetAdminSupportQueueMembersApplicationByApplicationIdErrors[keyof GetAdminSupportQueueMembersApplicationByApplicationIdErrors]; export type GetAdminSupportQueueMembersApplicationByApplicationIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a support-queue-member */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSupportQueueMembersApplicationByApplicationIdResponse = GetAdminSupportQueueMembersApplicationByApplicationIdResponses[keyof GetAdminSupportQueueMembersApplicationByApplicationIdResponses]; export type DeleteAdminEmailInboundAddressesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/inbound-addresses/{id}"; }; export type DeleteAdminEmailInboundAddressesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminEmailInboundAddressesByIdError = DeleteAdminEmailInboundAddressesByIdErrors[keyof DeleteAdminEmailInboundAddressesByIdErrors]; export type DeleteAdminEmailInboundAddressesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminEmailInboundAddressesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/inbound-addresses/{id}"; }; export type GetAdminEmailInboundAddressesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailInboundAddressesByIdError = GetAdminEmailInboundAddressesByIdErrors[keyof GetAdminEmailInboundAddressesByIdErrors]; export type GetAdminEmailInboundAddressesByIdResponses = { /** * Success */ 200: { data?: EmailInboundAddress; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailInboundAddressesByIdResponse = GetAdminEmailInboundAddressesByIdResponses[keyof GetAdminEmailInboundAddressesByIdResponses]; export type PatchAdminEmailInboundAddressesByIdData = { /** * Request body for the /email/inbound-addresses/:id operation on email-inbound-address resource */ body?: { data: { attributes?: { allowed_mime_types?: Array | null; daily_receive_limit?: number | null; handler_config?: { [key: string]: unknown; } | null; max_attachment_size_mb?: number | null; name?: string | null; routing_target?: "extraction" | "agent" | "invoices" | "crm"; }; id: string; relationships?: { [key: string]: never; }; type?: "email-inbound-address"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/inbound-addresses/{id}"; }; export type PatchAdminEmailInboundAddressesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailInboundAddressesByIdError = PatchAdminEmailInboundAddressesByIdErrors[keyof PatchAdminEmailInboundAddressesByIdErrors]; export type PatchAdminEmailInboundAddressesByIdResponses = { /** * Success */ 200: { data?: EmailInboundAddress; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailInboundAddressesByIdResponse = PatchAdminEmailInboundAddressesByIdResponses[keyof PatchAdminEmailInboundAddressesByIdResponses]; export type GetAdminMessagesSemanticSearchData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; query: string; limit?: number; thread_id?: string; }; url: "/admin/messages/semantic-search"; }; export type GetAdminMessagesSemanticSearchErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminMessagesSemanticSearchError = GetAdminMessagesSemanticSearchErrors[keyof GetAdminMessagesSemanticSearchErrors]; export type GetAdminMessagesSemanticSearchResponses = { /** * Success */ 200: { /** * An array of resource objects representing a chat-message */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminMessagesSemanticSearchResponse = GetAdminMessagesSemanticSearchResponses[keyof GetAdminMessagesSemanticSearchResponses]; export type PatchAdminClinicalHealthMetricsByIdRestoreData = { /** * Request body for the /clinical/health-metrics/:id/restore operation on clinical-health-metric resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-health-metric"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/health-metrics/{id}/restore"; }; export type PatchAdminClinicalHealthMetricsByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalHealthMetricsByIdRestoreError = PatchAdminClinicalHealthMetricsByIdRestoreErrors[keyof PatchAdminClinicalHealthMetricsByIdRestoreErrors]; export type PatchAdminClinicalHealthMetricsByIdRestoreResponses = { /** * Success */ 200: { data?: ClinicalHealthMetric; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalHealthMetricsByIdRestoreResponse = PatchAdminClinicalHealthMetricsByIdRestoreResponses[keyof PatchAdminClinicalHealthMetricsByIdRestoreResponses]; export type GetAdminSettlementStatementsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/settlement-statements"; }; export type GetAdminSettlementStatementsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSettlementStatementsError = GetAdminSettlementStatementsErrors[keyof GetAdminSettlementStatementsErrors]; export type GetAdminSettlementStatementsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a settlement-statement */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSettlementStatementsResponse = GetAdminSettlementStatementsResponses[keyof GetAdminSettlementStatementsResponses]; export type GetAdminConnectorsOauthAppConfigsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/connectors/oauth-app-configs"; }; export type GetAdminConnectorsOauthAppConfigsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminConnectorsOauthAppConfigsError = GetAdminConnectorsOauthAppConfigsErrors[keyof GetAdminConnectorsOauthAppConfigsErrors]; export type GetAdminConnectorsOauthAppConfigsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a oauth-app-config */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminConnectorsOauthAppConfigsResponse = GetAdminConnectorsOauthAppConfigsResponses[keyof GetAdminConnectorsOauthAppConfigsResponses]; export type PostAdminConnectorsOauthAppConfigsData = { /** * Request body for the /connectors/oauth-app-configs operation on oauth-app-config resource */ body: { data: { attributes?: { application_id?: string | null; client_id: string; client_secret: string; platform: "facebook" | "instagram" | "threads" | "twitter" | "linkedin" | "reddit" | "bluesky"; scope_type: "application" | "tenant"; scopes?: Array | null; tenant_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "oauth-app-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/connectors/oauth-app-configs"; }; export type PostAdminConnectorsOauthAppConfigsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsOauthAppConfigsError = PostAdminConnectorsOauthAppConfigsErrors[keyof PostAdminConnectorsOauthAppConfigsErrors]; export type PostAdminConnectorsOauthAppConfigsResponses = { /** * Success */ 201: { data?: OauthAppConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminConnectorsOauthAppConfigsResponse = PostAdminConnectorsOauthAppConfigsResponses[keyof PostAdminConnectorsOauthAppConfigsResponses]; export type GetAdminCampaignsSequenceStepsSequenceBySequenceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { sequence_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/campaigns/sequence-steps/sequence/{sequence_id}"; }; export type GetAdminCampaignsSequenceStepsSequenceBySequenceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCampaignsSequenceStepsSequenceBySequenceIdError = GetAdminCampaignsSequenceStepsSequenceBySequenceIdErrors[keyof GetAdminCampaignsSequenceStepsSequenceBySequenceIdErrors]; export type GetAdminCampaignsSequenceStepsSequenceBySequenceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a email-marketing-sequence-step */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCampaignsSequenceStepsSequenceBySequenceIdResponse = GetAdminCampaignsSequenceStepsSequenceBySequenceIdResponses[keyof GetAdminCampaignsSequenceStepsSequenceBySequenceIdResponses]; export type DeleteAdminClinicalPracticeResourcesByIdPermanentData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-resources/{id}/permanent"; }; export type DeleteAdminClinicalPracticeResourcesByIdPermanentErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalPracticeResourcesByIdPermanentError = DeleteAdminClinicalPracticeResourcesByIdPermanentErrors[keyof DeleteAdminClinicalPracticeResourcesByIdPermanentErrors]; export type DeleteAdminClinicalPracticeResourcesByIdPermanentResponses = { /** * Deleted successfully */ 200: unknown; }; export type DeleteAdminClinicalSessionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/sessions/{id}"; }; export type DeleteAdminClinicalSessionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalSessionsByIdError = DeleteAdminClinicalSessionsByIdErrors[keyof DeleteAdminClinicalSessionsByIdErrors]; export type DeleteAdminClinicalSessionsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminClinicalSessionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/sessions/{id}"; }; export type GetAdminClinicalSessionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalSessionsByIdError = GetAdminClinicalSessionsByIdErrors[keyof GetAdminClinicalSessionsByIdErrors]; export type GetAdminClinicalSessionsByIdResponses = { /** * Success */ 200: { data?: ClinicalSession; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalSessionsByIdResponse = GetAdminClinicalSessionsByIdResponses[keyof GetAdminClinicalSessionsByIdResponses]; export type PatchAdminClinicalSessionsByIdData = { /** * Request body for the /clinical/sessions/:id operation on clinical-session resource */ body?: { data: { attributes?: { duration_minutes?: number | null; event_id?: string | null; external_ids?: { [key: string]: unknown; } | null; external_owner_id?: string | null; metadata?: { [key: string]: unknown; } | null; notes?: string | null; owner_id?: string | null; pipeline_execution_id?: string | null; prep_execution_id?: string | null; session_date?: unknown; session_format?: "in_person" | "telehealth" | "phone" | "async"; session_status?: "scheduled" | "in_progress" | "completed" | "cancelled" | "no_show"; session_summary?: string | null; session_type?: "initial" | "followup" | "discharge" | "emergency" | "group" | "phone_encounter" | "coordination" | "administrative"; transcript?: string | null; transcript_storage_key?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-session"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/sessions/{id}"; }; export type PatchAdminClinicalSessionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalSessionsByIdError = PatchAdminClinicalSessionsByIdErrors[keyof PatchAdminClinicalSessionsByIdErrors]; export type PatchAdminClinicalSessionsByIdResponses = { /** * Success */ 200: { data?: ClinicalSession; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalSessionsByIdResponse = PatchAdminClinicalSessionsByIdResponses[keyof PatchAdminClinicalSessionsByIdResponses]; export type GetAdminSearchStatsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/search/stats"; }; export type GetAdminSearchStatsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSearchStatsError = GetAdminSearchStatsErrors[keyof GetAdminSearchStatsErrors]; export type GetAdminSearchStatsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a search */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSearchStatsResponse = GetAdminSearchStatsResponses[keyof GetAdminSearchStatsResponses]; export type GetAdminPreferencesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; /** * Optional prefix filter on context_key */ prefix?: string; }; url: "/admin/preferences"; }; export type GetAdminPreferencesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPreferencesError = GetAdminPreferencesErrors[keyof GetAdminPreferencesErrors]; export type GetAdminPreferencesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a user-preference */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPreferencesResponse = GetAdminPreferencesResponses[keyof GetAdminPreferencesResponses]; export type GetAdminConsentRecordsActiveData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; user_id: string; }; url: "/admin/consent-records/active"; }; export type GetAdminConsentRecordsActiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminConsentRecordsActiveError = GetAdminConsentRecordsActiveErrors[keyof GetAdminConsentRecordsActiveErrors]; export type GetAdminConsentRecordsActiveResponses = { /** * Success */ 200: { /** * An array of resource objects representing a consent-record */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminConsentRecordsActiveResponse = GetAdminConsentRecordsActiveResponses[keyof GetAdminConsentRecordsActiveResponses]; export type GetAdminConnectorsSyncLogsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/connectors/sync-logs"; }; export type GetAdminConnectorsSyncLogsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminConnectorsSyncLogsError = GetAdminConnectorsSyncLogsErrors[keyof GetAdminConnectorsSyncLogsErrors]; export type GetAdminConnectorsSyncLogsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a sync-log */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminConnectorsSyncLogsResponse = GetAdminConnectorsSyncLogsResponses[keyof GetAdminConnectorsSyncLogsResponses]; export type DeleteAdminPlatformTonesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/platform-tones/{id}"; }; export type DeleteAdminPlatformTonesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminPlatformTonesByIdError = DeleteAdminPlatformTonesByIdErrors[keyof DeleteAdminPlatformTonesByIdErrors]; export type DeleteAdminPlatformTonesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminPlatformTonesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/platform-tones/{id}"; }; export type GetAdminPlatformTonesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPlatformTonesByIdError = GetAdminPlatformTonesByIdErrors[keyof GetAdminPlatformTonesByIdErrors]; export type GetAdminPlatformTonesByIdResponses = { /** * Success */ 200: { data?: PlatformTone; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPlatformTonesByIdResponse = GetAdminPlatformTonesByIdResponses[keyof GetAdminPlatformTonesByIdResponses]; export type PatchAdminPlatformTonesByIdData = { /** * Request body for the /platform-tones/:id operation on platform-tone resource */ body?: { data: { attributes?: { call_to_action?: string | null; custom_instructions?: string | null; emoji_policy?: "none" | "minimal" | "moderate" | "heavy"; hashtag_count?: number | null; max_length?: number | null; tone?: "casual" | "professional" | "humorous" | "inspirational" | "educational" | "promotional"; }; id: string; relationships?: { [key: string]: never; }; type?: "platform-tone"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/platform-tones/{id}"; }; export type PatchAdminPlatformTonesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPlatformTonesByIdError = PatchAdminPlatformTonesByIdErrors[keyof PatchAdminPlatformTonesByIdErrors]; export type PatchAdminPlatformTonesByIdResponses = { /** * Success */ 200: { data?: PlatformTone; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPlatformTonesByIdResponse = PatchAdminPlatformTonesByIdResponses[keyof PatchAdminPlatformTonesByIdResponses]; export type PostAdminCrmEmailAddressesData = { /** * Request body for the /crm/email-addresses operation on crm-email-address resource */ body: { data: { attributes?: { email: string; entity_id: string; entity_type: "contact" | "company"; is_primary?: boolean | null; is_verified?: boolean | null; label?: "work" | "personal" | "billing" | "support" | "other"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "crm-email-address"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/email-addresses"; }; export type PostAdminCrmEmailAddressesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrmEmailAddressesError = PostAdminCrmEmailAddressesErrors[keyof PostAdminCrmEmailAddressesErrors]; export type PostAdminCrmEmailAddressesResponses = { /** * Success */ 201: { data?: CrmEmailAddress; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrmEmailAddressesResponse = PostAdminCrmEmailAddressesResponses[keyof PostAdminCrmEmailAddressesResponses]; export type PostAdminCrmPipelineStagesData = { /** * Request body for the /crm/pipeline-stages operation on crm-pipeline-stage resource */ body: { data: { attributes?: { automation_trigger?: string | null; forecast_category?: "pipeline" | "best_case" | "commit" | "closed_won" | "closed_lost"; is_closed?: boolean | null; name: string; order: number; pipeline_id: string; probability?: number | null; }; relationships?: { [key: string]: never; }; type?: "crm-pipeline-stage"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/pipeline-stages"; }; export type PostAdminCrmPipelineStagesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrmPipelineStagesError = PostAdminCrmPipelineStagesErrors[keyof PostAdminCrmPipelineStagesErrors]; export type PostAdminCrmPipelineStagesResponses = { /** * Success */ 201: { data?: CrmPipelineStage; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrmPipelineStagesResponse = PostAdminCrmPipelineStagesResponses[keyof PostAdminCrmPipelineStagesResponses]; export type PostAdminAgentVersionsByIdAddSystemFieldData = { /** * Request body for the /agent-versions/:id/add-system-field operation on agent-version resource */ body: { data: { system_field_name: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/agent-versions/{id}/add-system-field"; }; export type PostAdminAgentVersionsByIdAddSystemFieldErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAgentVersionsByIdAddSystemFieldError = PostAdminAgentVersionsByIdAddSystemFieldErrors[keyof PostAdminAgentVersionsByIdAddSystemFieldErrors]; export type PostAdminAgentVersionsByIdAddSystemFieldResponses = { /** * Success */ 201: unknown; }; export type GetAdminWorkspacesMineData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspaces/mine"; }; export type GetAdminWorkspacesMineErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWorkspacesMineError = GetAdminWorkspacesMineErrors[keyof GetAdminWorkspacesMineErrors]; export type GetAdminWorkspacesMineResponses = { /** * Success */ 200: { /** * An array of resource objects representing a workspace */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWorkspacesMineResponse = GetAdminWorkspacesMineResponses[keyof GetAdminWorkspacesMineResponses]; export type GetAdminSocialTrendingItemsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/trending/items/{id}"; }; export type GetAdminSocialTrendingItemsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialTrendingItemsByIdError = GetAdminSocialTrendingItemsByIdErrors[keyof GetAdminSocialTrendingItemsByIdErrors]; export type GetAdminSocialTrendingItemsByIdResponses = { /** * Success */ 200: { data?: TrendingSnapshotItem; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialTrendingItemsByIdResponse = GetAdminSocialTrendingItemsByIdResponses[keyof GetAdminSocialTrendingItemsByIdResponses]; export type DeleteAdminFieldTemplatesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/field-templates/{id}"; }; export type DeleteAdminFieldTemplatesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminFieldTemplatesByIdError = DeleteAdminFieldTemplatesByIdErrors[keyof DeleteAdminFieldTemplatesByIdErrors]; export type DeleteAdminFieldTemplatesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminFieldTemplatesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/field-templates/{id}"; }; export type GetAdminFieldTemplatesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminFieldTemplatesByIdError = GetAdminFieldTemplatesByIdErrors[keyof GetAdminFieldTemplatesByIdErrors]; export type GetAdminFieldTemplatesByIdResponses = { /** * Success */ 200: { data?: FieldTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminFieldTemplatesByIdResponse = GetAdminFieldTemplatesByIdResponses[keyof GetAdminFieldTemplatesByIdResponses]; export type DeleteAdminSchedulingAvailabilityRulesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/availability-rules/{id}"; }; export type DeleteAdminSchedulingAvailabilityRulesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminSchedulingAvailabilityRulesByIdError = DeleteAdminSchedulingAvailabilityRulesByIdErrors[keyof DeleteAdminSchedulingAvailabilityRulesByIdErrors]; export type DeleteAdminSchedulingAvailabilityRulesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminSchedulingAvailabilityRulesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/availability-rules/{id}"; }; export type GetAdminSchedulingAvailabilityRulesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingAvailabilityRulesByIdError = GetAdminSchedulingAvailabilityRulesByIdErrors[keyof GetAdminSchedulingAvailabilityRulesByIdErrors]; export type GetAdminSchedulingAvailabilityRulesByIdResponses = { /** * Success */ 200: { data?: SchedulingAvailabilityRule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingAvailabilityRulesByIdResponse = GetAdminSchedulingAvailabilityRulesByIdResponses[keyof GetAdminSchedulingAvailabilityRulesByIdResponses]; export type PatchAdminSchedulingAvailabilityRulesByIdData = { /** * Request body for the /scheduling/availability-rules/:id operation on scheduling-availability-rule resource */ body?: { data: { attributes?: { date_overrides?: Array | null; effective_from?: string | null; effective_until?: string | null; is_active?: boolean | null; metadata?: { [key: string]: unknown; } | null; name?: string | null; priority?: number | null; timezone?: string | null; type?: "recurring" | "override"; weekly_schedule?: SchedulingAvailabilityRuleWeeklyScheduleInputUpdateType; }; id: string; relationships?: { [key: string]: never; }; type?: "scheduling-availability-rule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/availability-rules/{id}"; }; export type PatchAdminSchedulingAvailabilityRulesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSchedulingAvailabilityRulesByIdError = PatchAdminSchedulingAvailabilityRulesByIdErrors[keyof PatchAdminSchedulingAvailabilityRulesByIdErrors]; export type PatchAdminSchedulingAvailabilityRulesByIdResponses = { /** * Success */ 200: { data?: SchedulingAvailabilityRule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSchedulingAvailabilityRulesByIdResponse = PatchAdminSchedulingAvailabilityRulesByIdResponses[keyof PatchAdminSchedulingAvailabilityRulesByIdResponses]; export type GetAdminPlansData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/plans"; }; export type GetAdminPlansErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPlansError = GetAdminPlansErrors[keyof GetAdminPlansErrors]; export type GetAdminPlansResponses = { /** * Success */ 200: { /** * An array of resource objects representing a plan */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPlansResponse = GetAdminPlansResponses[keyof GetAdminPlansResponses]; export type PostAdminPlansData = { /** * Request body for the /plans operation on plan resource */ body: { data: { attributes?: { /** * Optional - inferred from x-application-key header when not provided */ application_id?: string | null; billing_interval?: number | null; /** * Capability tiers this plan entitles subscribers to */ capability_tiers?: Array<"core" | "standard" | "premium"> | null; /** * Maximum number of concurrent long-running operations a tenant may have * in-flight under this plan (e.g. extraction jobs, batch agent runs). * `nil` means no plan-level limit. When set, must be > 0. * */ concurrent_operations_limit?: number | null; /** * Credits allocated per seat at renewal. nil = falls back to monthly_credits. */ credits_per_seat?: number | null; /** * Optional ISV-configurable Layer 2 dunning cadence override. Nil falls * back to platform defaults. Supported keys: * "retry_days", "soft_suspend_day", "hard_cancel_day", "purge_day", * and "hard_purge_day". * */ dunning_config?: { [key: string]: unknown; } | null; /** * One-time credits granted upon first subscription (Welcome Bonus) */ initial_credits?: number | null; /** * Distinguishes base plans from add-ons */ is_addon?: boolean | null; /** * Maximum number of renewals for free trial (nil = unlimited) */ max_renewals?: number | null; /** * Hard cap on seats before overage. nil = unlimited seats */ max_seats?: number | null; /** * Seats included in the bundle (for display/marketing) */ min_seats?: number | null; monthly_credits: number; monthly_price: { amount: string; currency: string; }; name: string; /** * Per-seat price beyond max_seats. nil = overage not allowed (hard cap) */ overage_seat_price?: { amount: string; currency: string; } | unknown; /** * Platform tier this plan maps to. Controls platform-level feature gating. */ plan_tier?: "free" | "pro" | "business" | "enterprise"; /** * Window size in seconds for `rate_limit_requests`. `nil` means no * plan-level rate limit. When set, must be > 0. * */ rate_limit_period_seconds?: number | null; /** * Maximum number of API requests allowed per `rate_limit_period_seconds` * window for tenants subscribed to this plan. `nil` means no plan-level * rate limit (falls back to global default). When set, must be > 0. * * Free-tier plans (`monthly_price` = 0) cannot exceed the platform-wide * ceiling configured via `:platform_free_tier_max_rpm`. * */ rate_limit_requests?: number | null; slug: string; /** * Storage included in plan (bytes). Free=1GB, Pro=10GB, Business=50GB, Enterprise=500GB */ storage_included_bytes?: number | null; /** * Hard ceiling in bytes. Prevents runaway bills. nil = unlimited */ storage_max_bytes?: number | null; /** * Cents per GB-month overage. Free=0 (hard cap), Pro=25, Business=20, Enterprise=15 */ storage_overage_rate_cents?: number | null; type?: "credits" | "storage" | "credits_storage" | "compute" | "seats" | "agents" | "support"; }; relationships?: { [key: string]: never; }; type?: "plan"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/plans"; }; export type PostAdminPlansErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminPlansError = PostAdminPlansErrors[keyof PostAdminPlansErrors]; export type PostAdminPlansResponses = { /** * Success */ 201: { data?: Plan; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminPlansResponse = PostAdminPlansResponses[keyof PostAdminPlansResponses]; export type GetAdminClinicalIntakeTargetsArchivedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/intake-targets/archived"; }; export type GetAdminClinicalIntakeTargetsArchivedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalIntakeTargetsArchivedError = GetAdminClinicalIntakeTargetsArchivedErrors[keyof GetAdminClinicalIntakeTargetsArchivedErrors]; export type GetAdminClinicalIntakeTargetsArchivedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-intake-target */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalIntakeTargetsArchivedResponse = GetAdminClinicalIntakeTargetsArchivedResponses[keyof GetAdminClinicalIntakeTargetsArchivedResponses]; export type PatchAdminClinicalNoteTemplatesByIdArchiveData = { /** * Request body for the /clinical/note-templates/:id/archive operation on clinical-note-template resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-note-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/note-templates/{id}/archive"; }; export type PatchAdminClinicalNoteTemplatesByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalNoteTemplatesByIdArchiveError = PatchAdminClinicalNoteTemplatesByIdArchiveErrors[keyof PatchAdminClinicalNoteTemplatesByIdArchiveErrors]; export type PatchAdminClinicalNoteTemplatesByIdArchiveResponses = { /** * Success */ 200: { data?: ClinicalNoteTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalNoteTemplatesByIdArchiveResponse = PatchAdminClinicalNoteTemplatesByIdArchiveResponses[keyof PatchAdminClinicalNoteTemplatesByIdArchiveResponses]; export type PostAdminExtractionDocumentsBeginUploadData = { /** * Request body for the /extraction/documents/begin-upload operation on extraction-document resource */ body: { data: { attributes?: { batch_id?: string | null; content_type?: string | null; /** * Content hash for deduplication (blake3: or sha256: prefix + 64 hex characters) */ file_hash?: string | null; file_size_bytes?: number | null; file_type: "pdf" | "docx" | "image" | "zip" | "audio" | "video"; filename: string; parent_document_id?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "extraction-document"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/documents/begin-upload"; }; export type PostAdminExtractionDocumentsBeginUploadErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminExtractionDocumentsBeginUploadError = PostAdminExtractionDocumentsBeginUploadErrors[keyof PostAdminExtractionDocumentsBeginUploadErrors]; export type PostAdminExtractionDocumentsBeginUploadResponses = { /** * Success */ 201: { data?: ExtractionDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminExtractionDocumentsBeginUploadResponse = PostAdminExtractionDocumentsBeginUploadResponses[keyof PostAdminExtractionDocumentsBeginUploadResponses]; export type PostAdminInvoicesRulesData = { /** * Request body for the /invoices/rules operation on invoices-rule resource */ body: { data: { attributes?: { actions?: { [key: string]: unknown; } | null; active?: boolean | null; conditions?: { [key: string]: unknown; } | null; confidence?: string | number | unknown; metadata?: { [key: string]: unknown; } | null; name: string; rule_type: "gl_mapping" | "categorization" | "approval_routing" | "anomaly_threshold" | "payment_terms"; source?: "ai_learned" | "user_defined"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "invoices-rule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/rules"; }; export type PostAdminInvoicesRulesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminInvoicesRulesError = PostAdminInvoicesRulesErrors[keyof PostAdminInvoicesRulesErrors]; export type PostAdminInvoicesRulesResponses = { /** * Success */ 201: { data?: InvoicesRule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminInvoicesRulesResponse = PostAdminInvoicesRulesResponses[keyof PostAdminInvoicesRulesResponses]; export type GetAdminClinicalSessionsByIdSessionNotesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/sessions/{id}/session_notes"; }; export type GetAdminClinicalSessionsByIdSessionNotesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalSessionsByIdSessionNotesError = GetAdminClinicalSessionsByIdSessionNotesErrors[keyof GetAdminClinicalSessionsByIdSessionNotesErrors]; export type GetAdminClinicalSessionsByIdSessionNotesResponses = { /** * Success */ 200: { data?: ClinicalNote; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalSessionsByIdSessionNotesResponse = GetAdminClinicalSessionsByIdSessionNotesResponses[keyof GetAdminClinicalSessionsByIdSessionNotesResponses]; export type PostAdminConnectorsOauthInitiateData = { /** * Request body for the /connectors/oauth/initiate operation on connector-instance resource */ body: { data: { connector_type: string; redirect_uri?: string | null; scope_tier?: string | null; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/connectors/oauth/initiate"; }; export type PostAdminConnectorsOauthInitiateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsOauthInitiateError = PostAdminConnectorsOauthInitiateErrors[keyof PostAdminConnectorsOauthInitiateErrors]; export type PostAdminConnectorsOauthInitiateResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminConnectorsOauthInitiateResponse = PostAdminConnectorsOauthInitiateResponses[keyof PostAdminConnectorsOauthInitiateResponses]; export type GetAdminCampaignsRecipientsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/campaigns/recipients/{id}"; }; export type GetAdminCampaignsRecipientsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCampaignsRecipientsByIdError = GetAdminCampaignsRecipientsByIdErrors[keyof GetAdminCampaignsRecipientsByIdErrors]; export type GetAdminCampaignsRecipientsByIdResponses = { /** * Success */ 200: { data?: EmailMarketingRecipient; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCampaignsRecipientsByIdResponse = GetAdminCampaignsRecipientsByIdResponses[keyof GetAdminCampaignsRecipientsByIdResponses]; export type GetAdminConnectorsSyncLogsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/connectors/sync-logs/{id}"; }; export type GetAdminConnectorsSyncLogsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminConnectorsSyncLogsByIdError = GetAdminConnectorsSyncLogsByIdErrors[keyof GetAdminConnectorsSyncLogsByIdErrors]; export type GetAdminConnectorsSyncLogsByIdResponses = { /** * Success */ 200: { data?: SyncLog; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminConnectorsSyncLogsByIdResponse = GetAdminConnectorsSyncLogsByIdResponses[keyof GetAdminConnectorsSyncLogsByIdResponses]; export type DeleteAdminVoiceSessionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/voice/sessions/{id}"; }; export type DeleteAdminVoiceSessionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminVoiceSessionsByIdError = DeleteAdminVoiceSessionsByIdErrors[keyof DeleteAdminVoiceSessionsByIdErrors]; export type DeleteAdminVoiceSessionsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminVoiceSessionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; status?: "active" | "ended" | "failed" | "timed_out"; inserted_after?: unknown; inserted_before?: unknown; }; url: "/admin/voice/sessions/{id}"; }; export type GetAdminVoiceSessionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminVoiceSessionsByIdError = GetAdminVoiceSessionsByIdErrors[keyof GetAdminVoiceSessionsByIdErrors]; export type GetAdminVoiceSessionsByIdResponses = { /** * Success */ 200: { data?: VoiceSession; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminVoiceSessionsByIdResponse = GetAdminVoiceSessionsByIdResponses[keyof GetAdminVoiceSessionsByIdResponses]; export type PatchAdminClinicalClientMedicationsByIdRestoreData = { /** * Request body for the /clinical/client-medications/:id/restore operation on clinical-client-medication resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-client-medication"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-medications/{id}/restore"; }; export type PatchAdminClinicalClientMedicationsByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalClientMedicationsByIdRestoreError = PatchAdminClinicalClientMedicationsByIdRestoreErrors[keyof PatchAdminClinicalClientMedicationsByIdRestoreErrors]; export type PatchAdminClinicalClientMedicationsByIdRestoreResponses = { /** * Success */ 200: { data?: ClinicalClientMedication; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalClientMedicationsByIdRestoreResponse = PatchAdminClinicalClientMedicationsByIdRestoreResponses[keyof PatchAdminClinicalClientMedicationsByIdRestoreResponses]; export type PostAdminSearchReindexData = { /** * Request body for the /search/reindex operation on search resource */ body?: { data: { attributes?: { scope?: "all" | "users" | "tenants" | "documents"; }; relationships?: { [key: string]: never; }; type?: "search"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/search/reindex"; }; export type PostAdminSearchReindexErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSearchReindexError = PostAdminSearchReindexErrors[keyof PostAdminSearchReindexErrors]; export type PostAdminSearchReindexResponses = { /** * Success */ 201: { data?: Search; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSearchReindexResponse = PostAdminSearchReindexResponses[keyof PostAdminSearchReindexResponses]; export type PatchAdminInvoicesByIdApproveData = { /** * Request body for the /invoices/:id/approve operation on invoices-invoice resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "invoices-invoice"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/{id}/approve"; }; export type PatchAdminInvoicesByIdApproveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvoicesByIdApproveError = PatchAdminInvoicesByIdApproveErrors[keyof PatchAdminInvoicesByIdApproveErrors]; export type PatchAdminInvoicesByIdApproveResponses = { /** * Success */ 200: { data?: InvoicesInvoice; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvoicesByIdApproveResponse = PatchAdminInvoicesByIdApproveResponses[keyof PatchAdminInvoicesByIdApproveResponses]; export type DeleteAdminWebhookConfigsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/webhook-configs/{id}"; }; export type DeleteAdminWebhookConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminWebhookConfigsByIdError = DeleteAdminWebhookConfigsByIdErrors[keyof DeleteAdminWebhookConfigsByIdErrors]; export type DeleteAdminWebhookConfigsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminWebhookConfigsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/webhook-configs/{id}"; }; export type GetAdminWebhookConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWebhookConfigsByIdError = GetAdminWebhookConfigsByIdErrors[keyof GetAdminWebhookConfigsByIdErrors]; export type GetAdminWebhookConfigsByIdResponses = { /** * Success */ 200: { data?: WebhookConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWebhookConfigsByIdResponse = GetAdminWebhookConfigsByIdResponses[keyof GetAdminWebhookConfigsByIdResponses]; export type PatchAdminWebhookConfigsByIdData = { /** * Request body for the /webhook-configs/:id operation on webhook-config resource */ body?: { data: { attributes?: { enabled?: boolean | null; events?: Array | null; /** * Optional payload filter applied before dispatching. When nil, all matching events are * delivered. When set, the expression is evaluated against the event payload and the webhook * is only delivered if it matches. Fails open — malformed expressions pass all events. * * Supported operators: "eq", "not_eq", "contains", "in", "not_null". * * Example: {"path": "data.status", "op": "eq", "value": "completed"} * */ filter_expression?: { [key: string]: unknown; } | null; name?: string | null; /** * ISV filter: specific tenant UUIDs to receive events from (null = all) */ tenant_ids?: Array | null; url?: string | null; /** * Tenant filter: specific workspace UUIDs to receive events from (null = all) */ workspace_ids?: Array | null; }; id: string; relationships?: { [key: string]: never; }; type?: "webhook-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/webhook-configs/{id}"; }; export type PatchAdminWebhookConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminWebhookConfigsByIdError = PatchAdminWebhookConfigsByIdErrors[keyof PatchAdminWebhookConfigsByIdErrors]; export type PatchAdminWebhookConfigsByIdResponses = { /** * Success */ 200: { data?: WebhookConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminWebhookConfigsByIdResponse = PatchAdminWebhookConfigsByIdResponses[keyof PatchAdminWebhookConfigsByIdResponses]; export type DeleteAdminSupportSyncConfigsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/sync-configs/{id}"; }; export type DeleteAdminSupportSyncConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminSupportSyncConfigsByIdError = DeleteAdminSupportSyncConfigsByIdErrors[keyof DeleteAdminSupportSyncConfigsByIdErrors]; export type DeleteAdminSupportSyncConfigsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type PatchAdminSupportSyncConfigsByIdData = { /** * Request body for the /support/sync-configs/:id operation on support-sync-config resource */ body?: { data: { attributes?: { direction?: "bidirectional" | "inbound" | "outbound"; enabled?: boolean | null; last_synced_at?: unknown; status_mapping?: { [key: string]: unknown; } | null; sync_interval_minutes?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "support-sync-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/sync-configs/{id}"; }; export type PatchAdminSupportSyncConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSupportSyncConfigsByIdError = PatchAdminSupportSyncConfigsByIdErrors[keyof PatchAdminSupportSyncConfigsByIdErrors]; export type PatchAdminSupportSyncConfigsByIdResponses = { /** * Success */ 200: { data?: SupportSyncConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSupportSyncConfigsByIdResponse = PatchAdminSupportSyncConfigsByIdResponses[keyof PatchAdminSupportSyncConfigsByIdResponses]; export type GetAdminPipelineNodeExecutionsByExecutionByPipelineExecutionIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { pipeline_execution_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pipeline-node-executions/by-execution/{pipeline_execution_id}"; }; export type GetAdminPipelineNodeExecutionsByExecutionByPipelineExecutionIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPipelineNodeExecutionsByExecutionByPipelineExecutionIdError = GetAdminPipelineNodeExecutionsByExecutionByPipelineExecutionIdErrors[keyof GetAdminPipelineNodeExecutionsByExecutionByPipelineExecutionIdErrors]; export type GetAdminPipelineNodeExecutionsByExecutionByPipelineExecutionIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a pipeline-node-execution */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPipelineNodeExecutionsByExecutionByPipelineExecutionIdResponse = GetAdminPipelineNodeExecutionsByExecutionByPipelineExecutionIdResponses[keyof GetAdminPipelineNodeExecutionsByExecutionByPipelineExecutionIdResponses]; export type PostAdminCatalogVariantOptionValuesData = { /** * Request body for the /catalog/variant-option-values operation on catalog-variant-option-value resource */ body: { data: { attributes?: { option_value_id: string; variant_id: string; }; relationships?: { [key: string]: never; }; type?: "catalog-variant-option-value"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/variant-option-values"; }; export type PostAdminCatalogVariantOptionValuesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCatalogVariantOptionValuesError = PostAdminCatalogVariantOptionValuesErrors[keyof PostAdminCatalogVariantOptionValuesErrors]; export type PostAdminCatalogVariantOptionValuesResponses = { /** * Success */ 201: { data?: CatalogVariantOptionValue; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCatalogVariantOptionValuesResponse = PostAdminCatalogVariantOptionValuesResponses[keyof PostAdminCatalogVariantOptionValuesResponses]; export type PatchAdminUsersAuthSessionsRevokeAllData = { /** * Request body for the /users/auth/sessions/revoke-all operation on user resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "user"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/users/auth/sessions/revoke-all"; }; export type PatchAdminUsersAuthSessionsRevokeAllErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminUsersAuthSessionsRevokeAllError = PatchAdminUsersAuthSessionsRevokeAllErrors[keyof PatchAdminUsersAuthSessionsRevokeAllErrors]; export type PatchAdminUsersAuthSessionsRevokeAllResponses = { /** * Success */ 200: { data?: User; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminUsersAuthSessionsRevokeAllResponse = PatchAdminUsersAuthSessionsRevokeAllResponses[keyof PatchAdminUsersAuthSessionsRevokeAllResponses]; export type GetAdminSchedulingRemindersData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; /** * Filter reminders by event ID */ event_id?: string; }; url: "/admin/scheduling/reminders"; }; export type GetAdminSchedulingRemindersErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingRemindersError = GetAdminSchedulingRemindersErrors[keyof GetAdminSchedulingRemindersErrors]; export type GetAdminSchedulingRemindersResponses = { /** * Success */ 200: { /** * An array of resource objects representing a scheduling-reminder */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingRemindersResponse = GetAdminSchedulingRemindersResponses[keyof GetAdminSchedulingRemindersResponses]; export type PostAdminSchedulingRemindersData = { /** * Request body for the /scheduling/reminders operation on scheduling-reminder resource */ body: { data: { attributes?: { channel?: "email" | "webhook" | "sms" | "whatsapp" | "slack"; event_id: string; metadata?: { [key: string]: unknown; } | null; minutes_before: number; recipient_participant_id?: string | null; scheduled_at: unknown; status?: "pending" | "sent" | "failed" | "cancelled"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "scheduling-reminder"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/reminders"; }; export type PostAdminSchedulingRemindersErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSchedulingRemindersError = PostAdminSchedulingRemindersErrors[keyof PostAdminSchedulingRemindersErrors]; export type PostAdminSchedulingRemindersResponses = { /** * Success */ 201: { data?: SchedulingReminder; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSchedulingRemindersResponse = PostAdminSchedulingRemindersResponses[keyof PostAdminSchedulingRemindersResponses]; export type PatchAdminUsersByIdAdminEmailData = { /** * Request body for the /users/:id/admin/email operation on user resource */ body: { data: { attributes?: { new_email: string; }; id: string; relationships?: { [key: string]: never; }; type?: "user"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/users/{id}/admin/email"; }; export type PatchAdminUsersByIdAdminEmailErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminUsersByIdAdminEmailError = PatchAdminUsersByIdAdminEmailErrors[keyof PatchAdminUsersByIdAdminEmailErrors]; export type PatchAdminUsersByIdAdminEmailResponses = { /** * Success */ 200: { data?: User; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminUsersByIdAdminEmailResponse = PatchAdminUsersByIdAdminEmailResponses[keyof PatchAdminUsersByIdAdminEmailResponses]; export type PostAdminTrainingExamplesSearchData = { /** * Request body for the /training-examples/search operation on training-example resource */ body: { data: { agent_id: string; limit?: number | null; query: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/training-examples/search"; }; export type PostAdminTrainingExamplesSearchErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminTrainingExamplesSearchError = PostAdminTrainingExamplesSearchErrors[keyof PostAdminTrainingExamplesSearchErrors]; export type PostAdminTrainingExamplesSearchResponses = { /** * Success */ 201: Array; }; export type PostAdminTrainingExamplesSearchResponse = PostAdminTrainingExamplesSearchResponses[keyof PostAdminTrainingExamplesSearchResponses]; export type PatchAdminInvoicesByIdResolveDisputeData = { /** * Request body for the /invoices/:id/resolve-dispute operation on invoices-invoice resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "invoices-invoice"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/{id}/resolve-dispute"; }; export type PatchAdminInvoicesByIdResolveDisputeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvoicesByIdResolveDisputeError = PatchAdminInvoicesByIdResolveDisputeErrors[keyof PatchAdminInvoicesByIdResolveDisputeErrors]; export type PatchAdminInvoicesByIdResolveDisputeResponses = { /** * Success */ 200: { data?: InvoicesInvoice; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvoicesByIdResolveDisputeResponse = PatchAdminInvoicesByIdResolveDisputeResponses[keyof PatchAdminInvoicesByIdResolveDisputeResponses]; export type GetAdminClinicalMealPlansByWorkspaceData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/meal-plans/by-workspace"; }; export type GetAdminClinicalMealPlansByWorkspaceErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalMealPlansByWorkspaceError = GetAdminClinicalMealPlansByWorkspaceErrors[keyof GetAdminClinicalMealPlansByWorkspaceErrors]; export type GetAdminClinicalMealPlansByWorkspaceResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-meal-plan */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalMealPlansByWorkspaceResponse = GetAdminClinicalMealPlansByWorkspaceResponses[keyof GetAdminClinicalMealPlansByWorkspaceResponses]; export type PatchAdminAccountsByIdDebitData = { /** * Request body for the /accounts/:id/debit operation on account resource */ body: { data: { attributes?: { amount: number; description?: string | null; operation?: "usage" | "expiry" | "adjustment" | "wholesale_royalty" | "general" | "conversational" | "rag" | "training" | "field_mapping" | "extraction" | "ephemeral_extraction_base" | "analysis" | "communication" | "social" | "voice_transcription" | "voice_synthesis" | "invoicing" | "connector_tool_execution" | "email_inbound" | "agent_execution_step" | "agent_tool_call" | "agent_delegation" | "crm_data_export" | "knowledge_file_ingest" | "knowledge_chunk_embed" | "forms_generation" | "crawler" | "platform_metering"; }; id: string; relationships?: { [key: string]: never; }; type?: "account"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/accounts/{id}/debit"; }; export type PatchAdminAccountsByIdDebitErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminAccountsByIdDebitError = PatchAdminAccountsByIdDebitErrors[keyof PatchAdminAccountsByIdDebitErrors]; export type PatchAdminAccountsByIdDebitResponses = { /** * Success */ 200: { data?: Account; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminAccountsByIdDebitResponse = PatchAdminAccountsByIdDebitResponses[keyof PatchAdminAccountsByIdDebitResponses]; export type GetAdminCatalogPriceSuggestionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/price-suggestions/{id}"; }; export type GetAdminCatalogPriceSuggestionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogPriceSuggestionsByIdError = GetAdminCatalogPriceSuggestionsByIdErrors[keyof GetAdminCatalogPriceSuggestionsByIdErrors]; export type GetAdminCatalogPriceSuggestionsByIdResponses = { /** * Success */ 200: { data?: CatalogPriceSuggestion; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogPriceSuggestionsByIdResponse = GetAdminCatalogPriceSuggestionsByIdResponses[keyof GetAdminCatalogPriceSuggestionsByIdResponses]; export type DeleteAdminPaymentMethodsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/payment-methods/{id}"; }; export type DeleteAdminPaymentMethodsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminPaymentMethodsByIdError = DeleteAdminPaymentMethodsByIdErrors[keyof DeleteAdminPaymentMethodsByIdErrors]; export type DeleteAdminPaymentMethodsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminPaymentMethodsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/payment-methods/{id}"; }; export type GetAdminPaymentMethodsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPaymentMethodsByIdError = GetAdminPaymentMethodsByIdErrors[keyof GetAdminPaymentMethodsByIdErrors]; export type GetAdminPaymentMethodsByIdResponses = { /** * Success */ 200: { data?: PaymentMethod; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPaymentMethodsByIdResponse = GetAdminPaymentMethodsByIdResponses[keyof GetAdminPaymentMethodsByIdResponses]; export type PatchAdminPaymentMethodsByIdData = { /** * Request body for the /payment-methods/:id operation on payment-method resource */ body?: { data: { attributes?: { is_default?: boolean | null; nickname?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "payment-method"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/payment-methods/{id}"; }; export type PatchAdminPaymentMethodsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPaymentMethodsByIdError = PatchAdminPaymentMethodsByIdErrors[keyof PatchAdminPaymentMethodsByIdErrors]; export type PatchAdminPaymentMethodsByIdResponses = { /** * Success */ 200: { data?: PaymentMethod; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPaymentMethodsByIdResponse = PatchAdminPaymentMethodsByIdResponses[keyof PatchAdminPaymentMethodsByIdResponses]; export type GetAdminClinicalInsuranceAuthorizationsByWorkspaceData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/insurance-authorizations/by-workspace"; }; export type GetAdminClinicalInsuranceAuthorizationsByWorkspaceErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalInsuranceAuthorizationsByWorkspaceError = GetAdminClinicalInsuranceAuthorizationsByWorkspaceErrors[keyof GetAdminClinicalInsuranceAuthorizationsByWorkspaceErrors]; export type GetAdminClinicalInsuranceAuthorizationsByWorkspaceResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-insurance-authorization */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalInsuranceAuthorizationsByWorkspaceResponse = GetAdminClinicalInsuranceAuthorizationsByWorkspaceResponses[keyof GetAdminClinicalInsuranceAuthorizationsByWorkspaceResponses]; export type GetAdminClinicalPracticeResourcesCatalogData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-resources/catalog"; }; export type GetAdminClinicalPracticeResourcesCatalogErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPracticeResourcesCatalogError = GetAdminClinicalPracticeResourcesCatalogErrors[keyof GetAdminClinicalPracticeResourcesCatalogErrors]; export type GetAdminClinicalPracticeResourcesCatalogResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-practice-resource */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPracticeResourcesCatalogResponse = GetAdminClinicalPracticeResourcesCatalogResponses[keyof GetAdminClinicalPracticeResourcesCatalogResponses]; export type PostAdminClinicalPracticeResourcesCatalogData = { /** * Request body for the /clinical/practice-resources/catalog operation on clinical-practice-resource resource */ body: { data: { attributes?: { applicable_conditions?: Array | null; audience?: "patient" | "practitioner" | "both"; author?: string | null; category?: string | null; condition_tags?: Array | null; content_format?: "pdf" | "html" | "video_embed" | "external_link" | "interactive"; description?: string | null; estimated_duration_minutes?: number | null; icon_url?: string | null; is_active?: boolean | null; language?: string | null; license?: string | null; metadata?: { [key: string]: unknown; } | null; preview_url?: string | null; reading_level?: "basic" | "intermediate" | "advanced" | "clinical"; related_goal_types?: Array | null; resource_type?: "article" | "video" | "handout" | "worksheet" | "tool_link" | "infographic" | "audio" | "recipe" | "checklist" | "protocol" | "assessment" | "exercise" | "template" | "presentation" | "ebook" | "other"; tags?: Array | null; title: string; url?: string | null; }; relationships?: { [key: string]: never; }; type?: "clinical-practice-resource"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-resources/catalog"; }; export type PostAdminClinicalPracticeResourcesCatalogErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalPracticeResourcesCatalogError = PostAdminClinicalPracticeResourcesCatalogErrors[keyof PostAdminClinicalPracticeResourcesCatalogErrors]; export type PostAdminClinicalPracticeResourcesCatalogResponses = { /** * Success */ 201: { data?: ClinicalPracticeResource; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalPracticeResourcesCatalogResponse = PostAdminClinicalPracticeResourcesCatalogResponses[keyof PostAdminClinicalPracticeResourcesCatalogResponses]; export type GetAdminAmendmentRequestsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/amendment-requests"; }; export type GetAdminAmendmentRequestsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAmendmentRequestsError = GetAdminAmendmentRequestsErrors[keyof GetAdminAmendmentRequestsErrors]; export type GetAdminAmendmentRequestsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a amendment-request */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAmendmentRequestsResponse = GetAdminAmendmentRequestsResponses[keyof GetAdminAmendmentRequestsResponses]; export type PostAdminAmendmentRequestsData = { /** * Request body for the /amendment-requests operation on amendment-request resource */ body: { data: { attributes?: { /** * Domain that owns the resource to amend. Validated against AmendableResource registry. */ domain: string; request_reason: string; requested_changes: { [key: string]: unknown; }; resource_id: string; /** * Type of resource to amend (e.g., clinical_note) */ resource_type: string; subject_id: string; /** * Type of requesting subject (e.g., patient) */ subject_type: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "amendment-request"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/amendment-requests"; }; export type PostAdminAmendmentRequestsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAmendmentRequestsError = PostAdminAmendmentRequestsErrors[keyof PostAdminAmendmentRequestsErrors]; export type PostAdminAmendmentRequestsResponses = { /** * Success */ 201: { data?: AmendmentRequest; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAmendmentRequestsResponse = PostAdminAmendmentRequestsResponses[keyof PostAdminAmendmentRequestsResponses]; export type PatchAdminClinicalPracticeToolsByIdArchiveData = { /** * Request body for the /clinical/practice-tools/:id/archive operation on clinical-practice-tool resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-practice-tool"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-tools/{id}/archive"; }; export type PatchAdminClinicalPracticeToolsByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalPracticeToolsByIdArchiveError = PatchAdminClinicalPracticeToolsByIdArchiveErrors[keyof PatchAdminClinicalPracticeToolsByIdArchiveErrors]; export type PatchAdminClinicalPracticeToolsByIdArchiveResponses = { /** * Success */ 200: { data?: ClinicalPracticeTool; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalPracticeToolsByIdArchiveResponse = PatchAdminClinicalPracticeToolsByIdArchiveResponses[keyof PatchAdminClinicalPracticeToolsByIdArchiveResponses]; export type PostAdminTransactionsByIdVoidData = { /** * Request body for the /transactions/:id/void operation on transaction resource */ body: { data: { attributes?: { description?: string | null; tenant_id?: string | null; transaction_id: string; }; relationships?: { [key: string]: never; }; type?: "transaction"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/transactions/{id}/void"; }; export type PostAdminTransactionsByIdVoidErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminTransactionsByIdVoidError = PostAdminTransactionsByIdVoidErrors[keyof PostAdminTransactionsByIdVoidErrors]; export type PostAdminTransactionsByIdVoidResponses = { /** * Success */ 201: { data?: Transaction; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminTransactionsByIdVoidResponse = PostAdminTransactionsByIdVoidResponses[keyof PostAdminTransactionsByIdVoidResponses]; export type PostAdminCatalogOptionTypesData = { /** * Request body for the /catalog/option-types operation on catalog-option-type resource */ body: { data: { attributes?: { application_id: string; name: string; position?: number | null; slug: string; }; relationships?: { [key: string]: never; }; type?: "catalog-option-type"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/option-types"; }; export type PostAdminCatalogOptionTypesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCatalogOptionTypesError = PostAdminCatalogOptionTypesErrors[keyof PostAdminCatalogOptionTypesErrors]; export type PostAdminCatalogOptionTypesResponses = { /** * Success */ 201: { data?: CatalogOptionType; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCatalogOptionTypesResponse = PostAdminCatalogOptionTypesResponses[keyof PostAdminCatalogOptionTypesResponses]; export type GetAdminMeetingActionItemsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/meeting-action-items/{id}"; }; export type GetAdminMeetingActionItemsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminMeetingActionItemsByIdError = GetAdminMeetingActionItemsByIdErrors[keyof GetAdminMeetingActionItemsByIdErrors]; export type GetAdminMeetingActionItemsByIdResponses = { /** * Success */ 200: { data?: MeetingActionItem; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminMeetingActionItemsByIdResponse = GetAdminMeetingActionItemsByIdResponses[keyof GetAdminMeetingActionItemsByIdResponses]; export type GetAdminRecipesEnrichmentJobsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/enrichment-jobs/{id}"; }; export type GetAdminRecipesEnrichmentJobsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesEnrichmentJobsByIdError = GetAdminRecipesEnrichmentJobsByIdErrors[keyof GetAdminRecipesEnrichmentJobsByIdErrors]; export type GetAdminRecipesEnrichmentJobsByIdResponses = { /** * Success */ 200: { data?: RecipesEnrichmentJob; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesEnrichmentJobsByIdResponse = GetAdminRecipesEnrichmentJobsByIdResponses[keyof GetAdminRecipesEnrichmentJobsByIdResponses]; export type DeleteAdminRecipesScheduledMealsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/scheduled-meals/{id}"; }; export type DeleteAdminRecipesScheduledMealsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminRecipesScheduledMealsByIdError = DeleteAdminRecipesScheduledMealsByIdErrors[keyof DeleteAdminRecipesScheduledMealsByIdErrors]; export type DeleteAdminRecipesScheduledMealsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminRecipesScheduledMealsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/scheduled-meals/{id}"; }; export type GetAdminRecipesScheduledMealsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesScheduledMealsByIdError = GetAdminRecipesScheduledMealsByIdErrors[keyof GetAdminRecipesScheduledMealsByIdErrors]; export type GetAdminRecipesScheduledMealsByIdResponses = { /** * Success */ 200: { data?: RecipesScheduledMeal; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesScheduledMealsByIdResponse = GetAdminRecipesScheduledMealsByIdResponses[keyof GetAdminRecipesScheduledMealsByIdResponses]; export type PatchAdminRecipesScheduledMealsByIdData = { /** * Request body for the /recipes/scheduled-meals/:id operation on recipes-scheduled-meal resource */ body?: { data: { attributes?: { date?: string | null; meal_type?: "breakfast" | "lunch" | "dinner" | "snack"; servings?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "recipes-scheduled-meal"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/scheduled-meals/{id}"; }; export type PatchAdminRecipesScheduledMealsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminRecipesScheduledMealsByIdError = PatchAdminRecipesScheduledMealsByIdErrors[keyof PatchAdminRecipesScheduledMealsByIdErrors]; export type PatchAdminRecipesScheduledMealsByIdResponses = { /** * Success */ 200: { data?: RecipesScheduledMeal; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminRecipesScheduledMealsByIdResponse = PatchAdminRecipesScheduledMealsByIdResponses[keyof PatchAdminRecipesScheduledMealsByIdResponses]; export type GetAdminSubscriptionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/subscriptions/{id}"; }; export type GetAdminSubscriptionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSubscriptionsByIdError = GetAdminSubscriptionsByIdErrors[keyof GetAdminSubscriptionsByIdErrors]; export type GetAdminSubscriptionsByIdResponses = { /** * Success */ 200: { data?: Subscription; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSubscriptionsByIdResponse = GetAdminSubscriptionsByIdResponses[keyof GetAdminSubscriptionsByIdResponses]; export type PatchAdminSubscriptionsByIdData = { /** * Request body for the /subscriptions/:id operation on subscription resource */ body?: { data: { attributes?: { billing_interval?: number | null; current_period_end?: unknown; is_addon?: boolean | null; monthly_credits?: number | null; monthly_price?: { amount: string; currency: string; } | unknown; overage_seats?: number | null; pending_plan_id?: string | null; plan_id?: string | null; promotional_months?: number | null; promotional_months_used?: number | null; promotional_price?: { amount: string; currency: string; } | unknown; quantity?: number | null; status?: "active" | "past_due" | "canceled" | "incomplete" | "pending_cancellation" | "downgrade_scheduled" | "capability_revoked_grace" | "canceled_capability_revoked"; type?: "credits" | "storage" | "credits_storage" | "compute" | "seats" | "agents" | "support"; }; id: string; relationships?: { [key: string]: never; }; type?: "subscription"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/subscriptions/{id}"; }; export type PatchAdminSubscriptionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSubscriptionsByIdError = PatchAdminSubscriptionsByIdErrors[keyof PatchAdminSubscriptionsByIdErrors]; export type PatchAdminSubscriptionsByIdResponses = { /** * Success */ 200: { data?: Subscription; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSubscriptionsByIdResponse = PatchAdminSubscriptionsByIdResponses[keyof PatchAdminSubscriptionsByIdResponses]; export type GetAdminClinicalDocumentsPatientsByIdDocumentsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; patient_id: string; }; url: "/admin/clinical/documents/patients/{id}/documents"; }; export type GetAdminClinicalDocumentsPatientsByIdDocumentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalDocumentsPatientsByIdDocumentsError = GetAdminClinicalDocumentsPatientsByIdDocumentsErrors[keyof GetAdminClinicalDocumentsPatientsByIdDocumentsErrors]; export type GetAdminClinicalDocumentsPatientsByIdDocumentsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-document */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalDocumentsPatientsByIdDocumentsResponse = GetAdminClinicalDocumentsPatientsByIdDocumentsResponses[keyof GetAdminClinicalDocumentsPatientsByIdDocumentsResponses]; export type DeleteAdminUserProfilesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/user-profiles/{id}"; }; export type DeleteAdminUserProfilesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminUserProfilesByIdError = DeleteAdminUserProfilesByIdErrors[keyof DeleteAdminUserProfilesByIdErrors]; export type DeleteAdminUserProfilesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminUserProfilesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/user-profiles/{id}"; }; export type GetAdminUserProfilesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminUserProfilesByIdError = GetAdminUserProfilesByIdErrors[keyof GetAdminUserProfilesByIdErrors]; export type GetAdminUserProfilesByIdResponses = { /** * Success */ 200: { data?: UserProfile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminUserProfilesByIdResponse = GetAdminUserProfilesByIdResponses[keyof GetAdminUserProfilesByIdResponses]; export type PatchAdminUserProfilesByIdData = { /** * Request body for the /user-profiles/:id operation on user-profile resource */ body?: { data: { attributes?: { avatar_url?: string | null; bio?: string | null; first_name?: string | null; last_name?: string | null; preferences?: { [key: string]: unknown; } | null; social_links?: { [key: string]: unknown; } | null; }; id: string; relationships?: { [key: string]: never; }; type?: "user-profile"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/user-profiles/{id}"; }; export type PatchAdminUserProfilesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminUserProfilesByIdError = PatchAdminUserProfilesByIdErrors[keyof PatchAdminUserProfilesByIdErrors]; export type PatchAdminUserProfilesByIdResponses = { /** * Success */ 200: { data?: UserProfile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminUserProfilesByIdResponse = PatchAdminUserProfilesByIdResponses[keyof PatchAdminUserProfilesByIdResponses]; export type PostAdminConnectorsByIdEdamamRecipesGetData = { /** * Request body for the /connectors/:id/edamam/recipes/get operation on connector-instance resource */ body: { data: { connector_id: string; params?: { [key: string]: unknown; } | null; recipe_id: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/connectors/{id}/edamam/recipes/get"; }; export type PostAdminConnectorsByIdEdamamRecipesGetErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsByIdEdamamRecipesGetError = PostAdminConnectorsByIdEdamamRecipesGetErrors[keyof PostAdminConnectorsByIdEdamamRecipesGetErrors]; export type PostAdminConnectorsByIdEdamamRecipesGetResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminConnectorsByIdEdamamRecipesGetResponse = PostAdminConnectorsByIdEdamamRecipesGetResponses[keyof PostAdminConnectorsByIdEdamamRecipesGetResponses]; export type DeleteAdminWorkspaceFormConfigsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspace-form-configs/{id}"; }; export type DeleteAdminWorkspaceFormConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminWorkspaceFormConfigsByIdError = DeleteAdminWorkspaceFormConfigsByIdErrors[keyof DeleteAdminWorkspaceFormConfigsByIdErrors]; export type DeleteAdminWorkspaceFormConfigsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminWorkspaceFormConfigsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspace-form-configs/{id}"; }; export type GetAdminWorkspaceFormConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWorkspaceFormConfigsByIdError = GetAdminWorkspaceFormConfigsByIdErrors[keyof GetAdminWorkspaceFormConfigsByIdErrors]; export type GetAdminWorkspaceFormConfigsByIdResponses = { /** * Success */ 200: { data?: WorkspaceFormConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWorkspaceFormConfigsByIdResponse = GetAdminWorkspaceFormConfigsByIdResponses[keyof GetAdminWorkspaceFormConfigsByIdResponses]; export type PatchAdminWorkspaceFormConfigsByIdData = { /** * Request body for the /workspace-form-configs/:id operation on workspace-form-config resource */ body?: { data: { attributes?: { overrides?: { [key: string]: unknown; } | null; schema_overrides?: { [key: string]: unknown; } | null; }; id: string; relationships?: { [key: string]: never; }; type?: "workspace-form-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspace-form-configs/{id}"; }; export type PatchAdminWorkspaceFormConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminWorkspaceFormConfigsByIdError = PatchAdminWorkspaceFormConfigsByIdErrors[keyof PatchAdminWorkspaceFormConfigsByIdErrors]; export type PatchAdminWorkspaceFormConfigsByIdResponses = { /** * Success */ 200: { data?: WorkspaceFormConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminWorkspaceFormConfigsByIdResponse = PatchAdminWorkspaceFormConfigsByIdResponses[keyof PatchAdminWorkspaceFormConfigsByIdResponses]; export type DeleteAdminCaseTypesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/case-types/{id}"; }; export type DeleteAdminCaseTypesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCaseTypesByIdError = DeleteAdminCaseTypesByIdErrors[keyof DeleteAdminCaseTypesByIdErrors]; export type DeleteAdminCaseTypesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCaseTypesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/case-types/{id}"; }; export type GetAdminCaseTypesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCaseTypesByIdError = GetAdminCaseTypesByIdErrors[keyof GetAdminCaseTypesByIdErrors]; export type GetAdminCaseTypesByIdResponses = { /** * Success */ 200: { data?: CaseType; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCaseTypesByIdResponse = GetAdminCaseTypesByIdResponses[keyof GetAdminCaseTypesByIdResponses]; export type PatchAdminCaseTypesByIdData = { /** * Request body for the /case-types/:id operation on case-type resource */ body?: { data: { attributes?: { decision_outcomes?: Array | null; description?: string | null; expected_document_types?: Array | null; grouping_rules?: CaseTypeGroupingRulesInputUpdateType; is_active?: boolean | null; name?: string | null; required_reviews?: CaseTypeRequiredReviewsInputUpdateType; routing_rules?: CaseTypeRoutingRulesInputUpdateType; schema_family_id?: string | null; state_machine?: CaseTypeStateMachineInputUpdateType; }; id: string; relationships?: { [key: string]: never; }; type?: "case-type"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/case-types/{id}"; }; export type PatchAdminCaseTypesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCaseTypesByIdError = PatchAdminCaseTypesByIdErrors[keyof PatchAdminCaseTypesByIdErrors]; export type PatchAdminCaseTypesByIdResponses = { /** * Success */ 200: { data?: CaseType; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCaseTypesByIdResponse = PatchAdminCaseTypesByIdResponses[keyof PatchAdminCaseTypesByIdResponses]; export type GetAdminWalletPlanPreviewData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; plan_slug: string; }; url: "/admin/wallet/plan/preview"; }; export type GetAdminWalletPlanPreviewErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWalletPlanPreviewError = GetAdminWalletPlanPreviewErrors[keyof GetAdminWalletPlanPreviewErrors]; export type GetAdminWalletPlanPreviewResponses = { /** * Success */ 200: { data?: WalletPublic; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWalletPlanPreviewResponse = GetAdminWalletPlanPreviewResponses[keyof GetAdminWalletPlanPreviewResponses]; export type DeleteAdminVoiceTranscriptionResultsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/voice/transcription-results/{id}"; }; export type DeleteAdminVoiceTranscriptionResultsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminVoiceTranscriptionResultsByIdError = DeleteAdminVoiceTranscriptionResultsByIdErrors[keyof DeleteAdminVoiceTranscriptionResultsByIdErrors]; export type DeleteAdminVoiceTranscriptionResultsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminVoiceTranscriptionResultsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/voice/transcription-results/{id}"; }; export type GetAdminVoiceTranscriptionResultsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminVoiceTranscriptionResultsByIdError = GetAdminVoiceTranscriptionResultsByIdErrors[keyof GetAdminVoiceTranscriptionResultsByIdErrors]; export type GetAdminVoiceTranscriptionResultsByIdResponses = { /** * Success */ 200: { data?: VoiceTranscriptionResult; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminVoiceTranscriptionResultsByIdResponse = GetAdminVoiceTranscriptionResultsByIdResponses[keyof GetAdminVoiceTranscriptionResultsByIdResponses]; export type PatchAdminVoiceTranscriptionResultsByIdData = { /** * Request body for the /voice/transcription-results/:id operation on voice-transcription-result resource */ body?: { data: { attributes?: { metadata?: { [key: string]: unknown; } | null; /** * Timestamped segments with confidence */ segments?: Array<{ [key: string]: unknown; }> | null; /** * Full transcript text */ text?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "voice-transcription-result"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/voice/transcription-results/{id}"; }; export type PatchAdminVoiceTranscriptionResultsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminVoiceTranscriptionResultsByIdError = PatchAdminVoiceTranscriptionResultsByIdErrors[keyof PatchAdminVoiceTranscriptionResultsByIdErrors]; export type PatchAdminVoiceTranscriptionResultsByIdResponses = { /** * Success */ 200: { data?: VoiceTranscriptionResult; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminVoiceTranscriptionResultsByIdResponse = PatchAdminVoiceTranscriptionResultsByIdResponses[keyof PatchAdminVoiceTranscriptionResultsByIdResponses]; export type GetAdminPricingStrategiesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pricing-strategies"; }; export type GetAdminPricingStrategiesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPricingStrategiesError = GetAdminPricingStrategiesErrors[keyof GetAdminPricingStrategiesErrors]; export type GetAdminPricingStrategiesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a pricing-strategy */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPricingStrategiesResponse = GetAdminPricingStrategiesResponses[keyof GetAdminPricingStrategiesResponses]; export type PostAdminPricingStrategiesData = { /** * Request body for the /pricing-strategies operation on pricing-strategy resource */ body: { data: { attributes?: { /** * Optional - inferred from x-application-key header when not provided */ application_id?: string | null; /** * The minimum price per unit for this service */ floor_price: { amount: string; currency: string; }; /** * The mandatory margin percentage (default 20%) */ margin_percent?: number | null; /** * The unit of measure (e.g., 'page', 'request', 'second') */ metric: string; /** * Unique identifier for the service (e.g., 'doc_extraction', 'rag_pipeline') */ service_id: string; }; relationships?: { [key: string]: never; }; type?: "pricing-strategy"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pricing-strategies"; }; export type PostAdminPricingStrategiesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminPricingStrategiesError = PostAdminPricingStrategiesErrors[keyof PostAdminPricingStrategiesErrors]; export type PostAdminPricingStrategiesResponses = { /** * Success */ 201: { data?: PricingStrategy; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminPricingStrategiesResponse = PostAdminPricingStrategiesResponses[keyof PostAdminPricingStrategiesResponses]; export type GetAdminClinicalGoalTemplatesCategoriesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/goal-templates/categories"; }; export type GetAdminClinicalGoalTemplatesCategoriesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalGoalTemplatesCategoriesError = GetAdminClinicalGoalTemplatesCategoriesErrors[keyof GetAdminClinicalGoalTemplatesCategoriesErrors]; export type GetAdminClinicalGoalTemplatesCategoriesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-goal-template-category */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalGoalTemplatesCategoriesResponse = GetAdminClinicalGoalTemplatesCategoriesResponses[keyof GetAdminClinicalGoalTemplatesCategoriesResponses]; export type GetAdminExtractionDocumentsByIdViewData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/documents/{id}/view"; }; export type GetAdminExtractionDocumentsByIdViewErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionDocumentsByIdViewError = GetAdminExtractionDocumentsByIdViewErrors[keyof GetAdminExtractionDocumentsByIdViewErrors]; export type GetAdminExtractionDocumentsByIdViewResponses = { /** * Success */ 200: { data?: ExtractionDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionDocumentsByIdViewResponse = GetAdminExtractionDocumentsByIdViewResponses[keyof GetAdminExtractionDocumentsByIdViewResponses]; export type PatchAdminSettlementsByIdMarkPaidData = { /** * Request body for the /settlements/:id/mark-paid operation on settlement resource */ body?: { data: { attributes?: { /** * QorPay ACH transaction ID for payout */ qorpay_transaction_id?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "settlement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/settlements/{id}/mark-paid"; }; export type PatchAdminSettlementsByIdMarkPaidErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSettlementsByIdMarkPaidError = PatchAdminSettlementsByIdMarkPaidErrors[keyof PatchAdminSettlementsByIdMarkPaidErrors]; export type PatchAdminSettlementsByIdMarkPaidResponses = { /** * Success */ 200: { data?: Settlement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSettlementsByIdMarkPaidResponse = PatchAdminSettlementsByIdMarkPaidResponses[keyof PatchAdminSettlementsByIdMarkPaidResponses]; export type GetAdminExtractionChunkEntityLinksByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/chunk-entity-links/{id}"; }; export type GetAdminExtractionChunkEntityLinksByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionChunkEntityLinksByIdError = GetAdminExtractionChunkEntityLinksByIdErrors[keyof GetAdminExtractionChunkEntityLinksByIdErrors]; export type GetAdminExtractionChunkEntityLinksByIdResponses = { /** * Success */ 200: { data?: ChunkEntityLink; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionChunkEntityLinksByIdResponse = GetAdminExtractionChunkEntityLinksByIdResponses[keyof GetAdminExtractionChunkEntityLinksByIdResponses]; export type GetAdminApiKeysData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/api-keys"; }; export type GetAdminApiKeysErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminApiKeysError = GetAdminApiKeysErrors[keyof GetAdminApiKeysErrors]; export type GetAdminApiKeysResponses = { /** * Success */ 200: { /** * An array of resource objects representing a api-key */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminApiKeysResponse = GetAdminApiKeysResponses[keyof GetAdminApiKeysResponses]; export type PostAdminApiKeysData = { /** * Request body for the /api-keys operation on api-key resource */ body?: { data: { attributes?: { application_id?: string | null; /** * Maximum credits allowed per period (null = unlimited) */ credit_limit?: number | null; /** * Budget reset period */ credit_limit_period?: "daily" | "weekly" | "monthly" | "yearly" | "lifetime"; expires_at?: unknown; key_type?: "user" | "application" | "system" | "server"; name?: string | null; /** * Rate limit period in seconds */ rate_limit_period_seconds?: number | null; /** * Maximum requests allowed per period */ rate_limit_requests?: number | null; scopes?: Array | null; tenant_id?: string | null; token?: string | null; user_id?: string | null; workspace_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "api-key"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/api-keys"; }; export type PostAdminApiKeysErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminApiKeysError = PostAdminApiKeysErrors[keyof PostAdminApiKeysErrors]; export type PostAdminApiKeysResponses = { /** * Success */ 201: { data?: ApiKey; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminApiKeysResponse = PostAdminApiKeysResponses[keyof PostAdminApiKeysResponses]; export type GetAdminSearchSuggestData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; query: string; limit?: number; }; url: "/admin/search/suggest"; }; export type GetAdminSearchSuggestErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSearchSuggestError = GetAdminSearchSuggestErrors[keyof GetAdminSearchSuggestErrors]; export type GetAdminSearchSuggestResponses = { /** * Success */ 200: { /** * An array of resource objects representing a search */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSearchSuggestResponse = GetAdminSearchSuggestResponses[keyof GetAdminSearchSuggestResponses]; export type GetAdminExtractionConfigEnumsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/config-enums/{id}"; }; export type GetAdminExtractionConfigEnumsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionConfigEnumsByIdError = GetAdminExtractionConfigEnumsByIdErrors[keyof GetAdminExtractionConfigEnumsByIdErrors]; export type GetAdminExtractionConfigEnumsByIdResponses = { /** * Success */ 200: { data?: ConfigEnum; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionConfigEnumsByIdResponse = GetAdminExtractionConfigEnumsByIdResponses[keyof GetAdminExtractionConfigEnumsByIdResponses]; export type PatchAdminExtractionConfigEnumsByIdData = { /** * Request body for the /extraction/config-enums/:id operation on config-enum resource */ body?: { data: { attributes?: { /** * Optional description of this enum value */ description?: string | null; /** * Whether this enum value is active (inactive values are hidden by default) */ is_active?: boolean | null; /** * Human-readable display label */ label?: string | null; /** * Sort order for display (lower numbers first) */ sort_order?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "config-enum"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/config-enums/{id}"; }; export type PatchAdminExtractionConfigEnumsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminExtractionConfigEnumsByIdError = PatchAdminExtractionConfigEnumsByIdErrors[keyof PatchAdminExtractionConfigEnumsByIdErrors]; export type PatchAdminExtractionConfigEnumsByIdResponses = { /** * Success */ 200: { data?: ConfigEnum; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminExtractionConfigEnumsByIdResponse = PatchAdminExtractionConfigEnumsByIdResponses[keyof PatchAdminExtractionConfigEnumsByIdResponses]; export type DeleteAdminExtractionDocumentsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/documents/{id}"; }; export type DeleteAdminExtractionDocumentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminExtractionDocumentsByIdError = DeleteAdminExtractionDocumentsByIdErrors[keyof DeleteAdminExtractionDocumentsByIdErrors]; export type DeleteAdminExtractionDocumentsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminExtractionDocumentsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/documents/{id}"; }; export type GetAdminExtractionDocumentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionDocumentsByIdError = GetAdminExtractionDocumentsByIdErrors[keyof GetAdminExtractionDocumentsByIdErrors]; export type GetAdminExtractionDocumentsByIdResponses = { /** * Success */ 200: { data?: ExtractionDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionDocumentsByIdResponse = GetAdminExtractionDocumentsByIdResponses[keyof GetAdminExtractionDocumentsByIdResponses]; export type DeleteAdminCatalogProductClassificationsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/product-classifications/{id}"; }; export type DeleteAdminCatalogProductClassificationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCatalogProductClassificationsByIdError = DeleteAdminCatalogProductClassificationsByIdErrors[keyof DeleteAdminCatalogProductClassificationsByIdErrors]; export type DeleteAdminCatalogProductClassificationsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminPolicyReviewSchedulesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/policy-review-schedules"; }; export type GetAdminPolicyReviewSchedulesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPolicyReviewSchedulesError = GetAdminPolicyReviewSchedulesErrors[keyof GetAdminPolicyReviewSchedulesErrors]; export type GetAdminPolicyReviewSchedulesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a policy-review-schedule */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPolicyReviewSchedulesResponse = GetAdminPolicyReviewSchedulesResponses[keyof GetAdminPolicyReviewSchedulesResponses]; export type PostAdminPolicyReviewSchedulesData = { /** * Request body for the /policy-review-schedules operation on policy-review-schedule resource */ body: { data: { attributes?: { application_id: string; last_reviewed_at?: unknown; last_reviewed_by_id?: string | null; legal_document_id: string; next_review_due: string; review_frequency_days?: number | null; review_notes?: string | null; status?: "current" | "review_due" | "overdue"; }; relationships?: { [key: string]: never; }; type?: "policy-review-schedule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/policy-review-schedules"; }; export type PostAdminPolicyReviewSchedulesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminPolicyReviewSchedulesError = PostAdminPolicyReviewSchedulesErrors[keyof PostAdminPolicyReviewSchedulesErrors]; export type PostAdminPolicyReviewSchedulesResponses = { /** * Success */ 201: { data?: PolicyReviewSchedule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminPolicyReviewSchedulesResponse = PostAdminPolicyReviewSchedulesResponses[keyof PostAdminPolicyReviewSchedulesResponses]; export type GetAdminClinicalClientSupplementsArchivedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/client-supplements/archived"; }; export type GetAdminClinicalClientSupplementsArchivedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalClientSupplementsArchivedError = GetAdminClinicalClientSupplementsArchivedErrors[keyof GetAdminClinicalClientSupplementsArchivedErrors]; export type GetAdminClinicalClientSupplementsArchivedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-client-supplement */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalClientSupplementsArchivedResponse = GetAdminClinicalClientSupplementsArchivedResponses[keyof GetAdminClinicalClientSupplementsArchivedResponses]; export type PatchAdminWalletCreditsData = { /** * Request body for the /wallet/credits operation on wallet resource */ body?: { data: { attributes?: { package_id?: string | null; package_slug?: string | null; payment_method_id?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "wallet"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/wallet/credits"; }; export type PatchAdminWalletCreditsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminWalletCreditsError = PatchAdminWalletCreditsErrors[keyof PatchAdminWalletCreditsErrors]; export type PatchAdminWalletCreditsResponses = { /** * Success */ 200: { data?: Wallet; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminWalletCreditsResponse = PatchAdminWalletCreditsResponses[keyof PatchAdminWalletCreditsResponses]; export type GetAdminLegalDocumentsForApplicationData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/legal-documents/for-application"; }; export type GetAdminLegalDocumentsForApplicationErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminLegalDocumentsForApplicationError = GetAdminLegalDocumentsForApplicationErrors[keyof GetAdminLegalDocumentsForApplicationErrors]; export type GetAdminLegalDocumentsForApplicationResponses = { /** * Success */ 200: { /** * An array of resource objects representing a legal-document */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminLegalDocumentsForApplicationResponse = GetAdminLegalDocumentsForApplicationResponses[keyof GetAdminLegalDocumentsForApplicationResponses]; export type GetAdminClinicalMealPlansArchivedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/meal-plans/archived"; }; export type GetAdminClinicalMealPlansArchivedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalMealPlansArchivedError = GetAdminClinicalMealPlansArchivedErrors[keyof GetAdminClinicalMealPlansArchivedErrors]; export type GetAdminClinicalMealPlansArchivedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-meal-plan */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalMealPlansArchivedResponse = GetAdminClinicalMealPlansArchivedResponses[keyof GetAdminClinicalMealPlansArchivedResponses]; export type DeleteAdminRecipesFavoritesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/favorites/{id}"; }; export type DeleteAdminRecipesFavoritesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminRecipesFavoritesByIdError = DeleteAdminRecipesFavoritesByIdErrors[keyof DeleteAdminRecipesFavoritesByIdErrors]; export type DeleteAdminRecipesFavoritesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminRecipesFavoritesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/favorites/{id}"; }; export type GetAdminRecipesFavoritesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesFavoritesByIdError = GetAdminRecipesFavoritesByIdErrors[keyof GetAdminRecipesFavoritesByIdErrors]; export type GetAdminRecipesFavoritesByIdResponses = { /** * Success */ 200: { data?: RecipesRecipeFavorite; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesFavoritesByIdResponse = GetAdminRecipesFavoritesByIdResponses[keyof GetAdminRecipesFavoritesByIdResponses]; export type PatchAdminRecipesFavoritesByIdData = { /** * Request body for the /recipes/favorites/:id operation on recipes-recipe-favorite resource */ body?: { data: { attributes?: { meal_type?: string | null; notes?: string | null; rating?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "recipes-recipe-favorite"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/favorites/{id}"; }; export type PatchAdminRecipesFavoritesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminRecipesFavoritesByIdError = PatchAdminRecipesFavoritesByIdErrors[keyof PatchAdminRecipesFavoritesByIdErrors]; export type PatchAdminRecipesFavoritesByIdResponses = { /** * Success */ 200: { data?: RecipesRecipeFavorite; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminRecipesFavoritesByIdResponse = PatchAdminRecipesFavoritesByIdResponses[keyof PatchAdminRecipesFavoritesByIdResponses]; export type GetAdminCreditPackagesSlugBySlugData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { slug: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/credit-packages/slug/{slug}"; }; export type GetAdminCreditPackagesSlugBySlugErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCreditPackagesSlugBySlugError = GetAdminCreditPackagesSlugBySlugErrors[keyof GetAdminCreditPackagesSlugBySlugErrors]; export type GetAdminCreditPackagesSlugBySlugResponses = { /** * Success */ 200: { data?: CreditPackage; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCreditPackagesSlugBySlugResponse = GetAdminCreditPackagesSlugBySlugResponses[keyof GetAdminCreditPackagesSlugBySlugResponses]; export type GetAdminAccountsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/accounts"; }; export type GetAdminAccountsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAccountsError = GetAdminAccountsErrors[keyof GetAdminAccountsErrors]; export type GetAdminAccountsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a account */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAccountsResponse = GetAdminAccountsResponses[keyof GetAdminAccountsResponses]; export type PostAdminUsersAuthRegisterViaInvitationData = { /** * Request body for the /users/auth/register-via-invitation operation on user resource */ body: { data: { attributes?: { email: string; first_name?: string | null; invitation_token: string; last_name?: string | null; password: string; password_confirmation: string; }; relationships?: { [key: string]: never; }; type?: "user"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/users/auth/register-via-invitation"; }; export type PostAdminUsersAuthRegisterViaInvitationErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminUsersAuthRegisterViaInvitationError = PostAdminUsersAuthRegisterViaInvitationErrors[keyof PostAdminUsersAuthRegisterViaInvitationErrors]; export type PostAdminUsersAuthRegisterViaInvitationResponses = { /** * Success */ 201: { data?: User; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminUsersAuthRegisterViaInvitationResponse = PostAdminUsersAuthRegisterViaInvitationResponses[keyof PostAdminUsersAuthRegisterViaInvitationResponses]; export type GetAdminStorageStatsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/storage/stats"; }; export type GetAdminStorageStatsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminStorageStatsError = GetAdminStorageStatsErrors[keyof GetAdminStorageStatsErrors]; export type GetAdminStorageStatsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a storage-stats */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminStorageStatsResponse = GetAdminStorageStatsResponses[keyof GetAdminStorageStatsResponses]; export type PatchAdminCrawlerJobsByIdCancelData = { /** * Request body for the /crawler/jobs/:id/cancel operation on crawler-job resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "crawler-job"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/jobs/{id}/cancel"; }; export type PatchAdminCrawlerJobsByIdCancelErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrawlerJobsByIdCancelError = PatchAdminCrawlerJobsByIdCancelErrors[keyof PatchAdminCrawlerJobsByIdCancelErrors]; export type PatchAdminCrawlerJobsByIdCancelResponses = { /** * Success */ 200: { data?: CrawlerJob; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrawlerJobsByIdCancelResponse = PatchAdminCrawlerJobsByIdCancelResponses[keyof PatchAdminCrawlerJobsByIdCancelResponses]; export type DeleteAdminClinicalSupplementTemplatesCatalogByIdPermanentData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-templates/catalog/{id}/permanent"; }; export type DeleteAdminClinicalSupplementTemplatesCatalogByIdPermanentErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalSupplementTemplatesCatalogByIdPermanentError = DeleteAdminClinicalSupplementTemplatesCatalogByIdPermanentErrors[keyof DeleteAdminClinicalSupplementTemplatesCatalogByIdPermanentErrors]; export type DeleteAdminClinicalSupplementTemplatesCatalogByIdPermanentResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminConnectorsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/connectors/workspace/{workspace_id}"; }; export type GetAdminConnectorsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminConnectorsWorkspaceByWorkspaceIdError = GetAdminConnectorsWorkspaceByWorkspaceIdErrors[keyof GetAdminConnectorsWorkspaceByWorkspaceIdErrors]; export type GetAdminConnectorsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a connector-instance */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminConnectorsWorkspaceByWorkspaceIdResponse = GetAdminConnectorsWorkspaceByWorkspaceIdResponses[keyof GetAdminConnectorsWorkspaceByWorkspaceIdResponses]; export type PatchAdminCampaignsSequencesByIdCompleteData = { /** * Request body for the /campaigns/sequences/:id/complete operation on email-marketing-sequence resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "email-marketing-sequence"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/campaigns/sequences/{id}/complete"; }; export type PatchAdminCampaignsSequencesByIdCompleteErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCampaignsSequencesByIdCompleteError = PatchAdminCampaignsSequencesByIdCompleteErrors[keyof PatchAdminCampaignsSequencesByIdCompleteErrors]; export type PatchAdminCampaignsSequencesByIdCompleteResponses = { /** * Success */ 200: { data?: EmailMarketingSequence; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCampaignsSequencesByIdCompleteResponse = PatchAdminCampaignsSequencesByIdCompleteResponses[keyof PatchAdminCampaignsSequencesByIdCompleteResponses]; export type GetAdminExtractionResultsDocumentByDocumentIdPartialData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { document_id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/results/document/{document_id}/partial"; }; export type GetAdminExtractionResultsDocumentByDocumentIdPartialErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionResultsDocumentByDocumentIdPartialError = GetAdminExtractionResultsDocumentByDocumentIdPartialErrors[keyof GetAdminExtractionResultsDocumentByDocumentIdPartialErrors]; export type GetAdminExtractionResultsDocumentByDocumentIdPartialResponses = { /** * Success */ 200: { data?: ExtractionResult; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionResultsDocumentByDocumentIdPartialResponse = GetAdminExtractionResultsDocumentByDocumentIdPartialResponses[keyof GetAdminExtractionResultsDocumentByDocumentIdPartialResponses]; export type PostAdminContentGenerateImageData = { /** * Request body for the /content/generate-image operation on content-generation resource */ body: { data: { prompt: string; style?: string | null; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/content/generate-image"; }; export type PostAdminContentGenerateImageErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminContentGenerateImageError = PostAdminContentGenerateImageErrors[keyof PostAdminContentGenerateImageErrors]; export type PostAdminContentGenerateImageResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminContentGenerateImageResponse = PostAdminContentGenerateImageResponses[keyof PostAdminContentGenerateImageResponses]; export type GetAdminBreachIncidentsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/breach-incidents/{id}"; }; export type GetAdminBreachIncidentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminBreachIncidentsByIdError = GetAdminBreachIncidentsByIdErrors[keyof GetAdminBreachIncidentsByIdErrors]; export type GetAdminBreachIncidentsByIdResponses = { /** * Success */ 200: { data?: BreachIncident; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminBreachIncidentsByIdResponse = GetAdminBreachIncidentsByIdResponses[keyof GetAdminBreachIncidentsByIdResponses]; export type GetAdminCrmDealsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; owner_id?: string; }; url: "/admin/crm/deals/workspace/{workspace_id}"; }; export type GetAdminCrmDealsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmDealsWorkspaceByWorkspaceIdError = GetAdminCrmDealsWorkspaceByWorkspaceIdErrors[keyof GetAdminCrmDealsWorkspaceByWorkspaceIdErrors]; export type GetAdminCrmDealsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crm-deal */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmDealsWorkspaceByWorkspaceIdResponse = GetAdminCrmDealsWorkspaceByWorkspaceIdResponses[keyof GetAdminCrmDealsWorkspaceByWorkspaceIdResponses]; export type GetAdminCrmFieldDefinitionsEntityTypeByEntityTypeData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { entity_type: string; }; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; application_id: string; }; url: "/admin/crm/field-definitions/entity-type/{entity_type}"; }; export type GetAdminCrmFieldDefinitionsEntityTypeByEntityTypeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmFieldDefinitionsEntityTypeByEntityTypeError = GetAdminCrmFieldDefinitionsEntityTypeByEntityTypeErrors[keyof GetAdminCrmFieldDefinitionsEntityTypeByEntityTypeErrors]; export type GetAdminCrmFieldDefinitionsEntityTypeByEntityTypeResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crm-custom-field-definition */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmFieldDefinitionsEntityTypeByEntityTypeResponse = GetAdminCrmFieldDefinitionsEntityTypeByEntityTypeResponses[keyof GetAdminCrmFieldDefinitionsEntityTypeByEntityTypeResponses]; export type GetAdminOwnershipTransfersData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; resource_type?: string; from_user_id?: string; to_user_id?: string; }; url: "/admin/ownership-transfers"; }; export type GetAdminOwnershipTransfersErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminOwnershipTransfersError = GetAdminOwnershipTransfersErrors[keyof GetAdminOwnershipTransfersErrors]; export type GetAdminOwnershipTransfersResponses = { /** * Success */ 200: { /** * An array of resource objects representing a ownership-transfer */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminOwnershipTransfersResponse = GetAdminOwnershipTransfersResponses[keyof GetAdminOwnershipTransfersResponses]; export type GetAdminSchedulingEventTypesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/event-types/{id}"; }; export type GetAdminSchedulingEventTypesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingEventTypesByIdError = GetAdminSchedulingEventTypesByIdErrors[keyof GetAdminSchedulingEventTypesByIdErrors]; export type GetAdminSchedulingEventTypesByIdResponses = { /** * Success */ 200: { data?: SchedulingEventType; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingEventTypesByIdResponse = GetAdminSchedulingEventTypesByIdResponses[keyof GetAdminSchedulingEventTypesByIdResponses]; export type PatchAdminSchedulingEventTypesByIdData = { /** * Request body for the /scheduling/event-types/:id operation on scheduling-event-type resource */ body?: { data: { attributes?: { billing_operation?: string | null; booking_cooldown_minutes?: number | null; booking_enabled?: boolean | null; buffer_after_minutes?: number | null; buffer_before_minutes?: number | null; capacity?: number | null; color?: string | null; default_reminder_offsets?: Array | null; description?: string | null; duration_minutes?: number | null; intake_form_schema?: { [key: string]: unknown; } | null; location?: SchedulingEventTypeLocationInputUpdateType; location_id?: string | null; location_type?: "in_person" | "video" | "phone" | "custom_url"; max_advance_days?: number | null; metadata?: { [key: string]: unknown; } | null; min_notice_minutes?: number | null; name?: string | null; owner_user_id?: string | null; requires_approval?: boolean | null; slug?: string | null; status?: "active" | "archived"; }; id: string; relationships?: { [key: string]: never; }; type?: "scheduling-event-type"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/event-types/{id}"; }; export type PatchAdminSchedulingEventTypesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSchedulingEventTypesByIdError = PatchAdminSchedulingEventTypesByIdErrors[keyof PatchAdminSchedulingEventTypesByIdErrors]; export type PatchAdminSchedulingEventTypesByIdResponses = { /** * Success */ 200: { data?: SchedulingEventType; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSchedulingEventTypesByIdResponse = PatchAdminSchedulingEventTypesByIdResponses[keyof PatchAdminSchedulingEventTypesByIdResponses]; export type GetAdminCatalogPriceListsApplicationByApplicationIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { application_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/price-lists/application/{application_id}"; }; export type GetAdminCatalogPriceListsApplicationByApplicationIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogPriceListsApplicationByApplicationIdError = GetAdminCatalogPriceListsApplicationByApplicationIdErrors[keyof GetAdminCatalogPriceListsApplicationByApplicationIdErrors]; export type GetAdminCatalogPriceListsApplicationByApplicationIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a catalog-price-list */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogPriceListsApplicationByApplicationIdResponse = GetAdminCatalogPriceListsApplicationByApplicationIdResponses[keyof GetAdminCatalogPriceListsApplicationByApplicationIdResponses]; export type GetAdminPlanBundlesTemplatesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Optional filter — restrict templates to a specific vertical (e.g. `"vertical-saas"`, `"developer-tools"`). */ vertical?: string; }; url: "/admin/plan-bundles/templates"; }; export type GetAdminPlanBundlesTemplatesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPlanBundlesTemplatesError = GetAdminPlanBundlesTemplatesErrors[keyof GetAdminPlanBundlesTemplatesErrors]; export type GetAdminPlanBundlesTemplatesResponses = { /** * Success */ 200: { result: { [key: string]: unknown; }; }; }; export type GetAdminPlanBundlesTemplatesResponse = GetAdminPlanBundlesTemplatesResponses[keyof GetAdminPlanBundlesTemplatesResponses]; export type GetAdminAgentsByIdStatsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { /** * Agent ID from URL path */ id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agents/{id}/stats"; }; export type GetAdminAgentsByIdStatsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentsByIdStatsError = GetAdminAgentsByIdStatsErrors[keyof GetAdminAgentsByIdStatsErrors]; export type GetAdminAgentsByIdStatsResponses = { /** * Success */ 200: { data?: AgentStats; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAgentsByIdStatsResponse = GetAdminAgentsByIdStatsResponses[keyof GetAdminAgentsByIdStatsResponses]; export type GetAdminCasesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/cases"; }; export type GetAdminCasesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCasesError = GetAdminCasesErrors[keyof GetAdminCasesErrors]; export type GetAdminCasesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a case */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCasesResponse = GetAdminCasesResponses[keyof GetAdminCasesResponses]; export type PostAdminCasesData = { /** * Request body for the /cases operation on case resource */ body: { data: { attributes?: { case_type_id: string; contact_id?: string | null; custom_fields?: { [key: string]: unknown; } | null; deal_id?: string | null; invoice_id?: string | null; opened_at: unknown; owner_id?: string | null; priority?: string | null; sla_due_at?: unknown; state: string; summary?: string | null; title: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "case"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/cases"; }; export type PostAdminCasesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCasesError = PostAdminCasesErrors[keyof PostAdminCasesErrors]; export type PostAdminCasesResponses = { /** * Success */ 201: { data?: Case; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCasesResponse = PostAdminCasesResponses[keyof PostAdminCasesResponses]; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdTrashedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; limit?: number; }; url: "/admin/extraction/documents/workspace/{workspace_id}/trashed"; }; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdTrashedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdTrashedError = GetAdminExtractionDocumentsWorkspaceByWorkspaceIdTrashedErrors[keyof GetAdminExtractionDocumentsWorkspaceByWorkspaceIdTrashedErrors]; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdTrashedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a extraction-document */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdTrashedResponse = GetAdminExtractionDocumentsWorkspaceByWorkspaceIdTrashedResponses[keyof GetAdminExtractionDocumentsWorkspaceByWorkspaceIdTrashedResponses]; export type GetAdminClinicalGoalTemplatesCategoriesCatalogData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; application_id?: string; }; url: "/admin/clinical/goal-templates/categories/catalog"; }; export type GetAdminClinicalGoalTemplatesCategoriesCatalogErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalGoalTemplatesCategoriesCatalogError = GetAdminClinicalGoalTemplatesCategoriesCatalogErrors[keyof GetAdminClinicalGoalTemplatesCategoriesCatalogErrors]; export type GetAdminClinicalGoalTemplatesCategoriesCatalogResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-goal-template-category */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalGoalTemplatesCategoriesCatalogResponse = GetAdminClinicalGoalTemplatesCategoriesCatalogResponses[keyof GetAdminClinicalGoalTemplatesCategoriesCatalogResponses]; export type GetAdminSchedulingAvailabilityRulesByEventTypeData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; event_type_id: string; }; url: "/admin/scheduling/availability-rules/by-event-type"; }; export type GetAdminSchedulingAvailabilityRulesByEventTypeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingAvailabilityRulesByEventTypeError = GetAdminSchedulingAvailabilityRulesByEventTypeErrors[keyof GetAdminSchedulingAvailabilityRulesByEventTypeErrors]; export type GetAdminSchedulingAvailabilityRulesByEventTypeResponses = { /** * Success */ 200: { /** * An array of resource objects representing a scheduling-availability-rule */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingAvailabilityRulesByEventTypeResponse = GetAdminSchedulingAvailabilityRulesByEventTypeResponses[keyof GetAdminSchedulingAvailabilityRulesByEventTypeResponses]; export type GetAdminAiGraphNodesSemanticData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { limit?: number; query: string; threshold?: number; }; url: "/admin/ai/graph/nodes/semantic"; }; export type GetAdminAiGraphNodesSemanticErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAiGraphNodesSemanticError = GetAdminAiGraphNodesSemanticErrors[keyof GetAdminAiGraphNodesSemanticErrors]; export type GetAdminAiGraphNodesSemanticResponses = { /** * Success */ 200: Array<{ [key: string]: unknown; }>; }; export type GetAdminAiGraphNodesSemanticResponse = GetAdminAiGraphNodesSemanticResponses[keyof GetAdminAiGraphNodesSemanticResponses]; export type PatchAdminClinicalNotesByIdRestoreData = { /** * Request body for the /clinical/notes/:id/restore operation on clinical-note resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-note"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/notes/{id}/restore"; }; export type PatchAdminClinicalNotesByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalNotesByIdRestoreError = PatchAdminClinicalNotesByIdRestoreErrors[keyof PatchAdminClinicalNotesByIdRestoreErrors]; export type PatchAdminClinicalNotesByIdRestoreResponses = { /** * Success */ 200: { data?: ClinicalNote; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalNotesByIdRestoreResponse = PatchAdminClinicalNotesByIdRestoreResponses[keyof PatchAdminClinicalNotesByIdRestoreResponses]; export type PatchAdminPortalChangeRequestsByIdApproveData = { /** * Request body for the /portal-change-requests/:id/approve operation on portal-change-request resource */ body?: { data: { attributes?: { reviewed_by_id?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "portal-change-request"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/portal-change-requests/{id}/approve"; }; export type PatchAdminPortalChangeRequestsByIdApproveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPortalChangeRequestsByIdApproveError = PatchAdminPortalChangeRequestsByIdApproveErrors[keyof PatchAdminPortalChangeRequestsByIdApproveErrors]; export type PatchAdminPortalChangeRequestsByIdApproveResponses = { /** * Success */ 200: { data?: PortalChangeRequest; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPortalChangeRequestsByIdApproveResponse = PatchAdminPortalChangeRequestsByIdApproveResponses[keyof PatchAdminPortalChangeRequestsByIdApproveResponses]; export type PatchAdminBrandIdentitiesByIdSetDefaultData = { /** * Request body for the /brand-identities/:id/set-default operation on brand-identity resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "brand-identity"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/brand-identities/{id}/set-default"; }; export type PatchAdminBrandIdentitiesByIdSetDefaultErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminBrandIdentitiesByIdSetDefaultError = PatchAdminBrandIdentitiesByIdSetDefaultErrors[keyof PatchAdminBrandIdentitiesByIdSetDefaultErrors]; export type PatchAdminBrandIdentitiesByIdSetDefaultResponses = { /** * Success */ 200: { data?: BrandIdentity; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminBrandIdentitiesByIdSetDefaultResponse = PatchAdminBrandIdentitiesByIdSetDefaultResponses[keyof PatchAdminBrandIdentitiesByIdSetDefaultResponses]; export type PatchAdminUsersByIdConfirmEmailData = { /** * Request body for the /users/:id/confirm-email operation on user resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "user"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/users/{id}/confirm-email"; }; export type PatchAdminUsersByIdConfirmEmailErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminUsersByIdConfirmEmailError = PatchAdminUsersByIdConfirmEmailErrors[keyof PatchAdminUsersByIdConfirmEmailErrors]; export type PatchAdminUsersByIdConfirmEmailResponses = { /** * Success */ 200: { data?: User; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminUsersByIdConfirmEmailResponse = PatchAdminUsersByIdConfirmEmailResponses[keyof PatchAdminUsersByIdConfirmEmailResponses]; export type PatchAdminClinicalNoteTemplatesByIdRestoreData = { /** * Request body for the /clinical/note-templates/:id/restore operation on clinical-note-template resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-note-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/note-templates/{id}/restore"; }; export type PatchAdminClinicalNoteTemplatesByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalNoteTemplatesByIdRestoreError = PatchAdminClinicalNoteTemplatesByIdRestoreErrors[keyof PatchAdminClinicalNoteTemplatesByIdRestoreErrors]; export type PatchAdminClinicalNoteTemplatesByIdRestoreResponses = { /** * Success */ 200: { data?: ClinicalNoteTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalNoteTemplatesByIdRestoreResponse = PatchAdminClinicalNoteTemplatesByIdRestoreResponses[keyof PatchAdminClinicalNoteTemplatesByIdRestoreResponses]; export type GetAdminWebhookConfigsByIdEventsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/webhook-configs/{id}/events"; }; export type GetAdminWebhookConfigsByIdEventsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWebhookConfigsByIdEventsError = GetAdminWebhookConfigsByIdEventsErrors[keyof GetAdminWebhookConfigsByIdEventsErrors]; export type GetAdminWebhookConfigsByIdEventsResponses = { /** * Success */ 200: { result: { [key: string]: unknown; }; }; }; export type GetAdminWebhookConfigsByIdEventsResponse = GetAdminWebhookConfigsByIdEventsResponses[keyof GetAdminWebhookConfigsByIdEventsResponses]; export type PostAdminEmailMarketingTemplatesData = { /** * Request body for the /email-marketing/templates operation on email-marketing-template resource */ body: { data: { attributes?: { ai_instructions?: string | null; body_mjml?: string | null; body_template?: string | null; name: string; published_body_html?: string | null; subject_template?: string | null; template_format?: string | null; type?: "template" | "prompt"; variables?: Array | null; }; relationships?: { [key: string]: never; }; type?: "email-marketing-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/templates"; }; export type PostAdminEmailMarketingTemplatesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminEmailMarketingTemplatesError = PostAdminEmailMarketingTemplatesErrors[keyof PostAdminEmailMarketingTemplatesErrors]; export type PostAdminEmailMarketingTemplatesResponses = { /** * Success */ 201: { data?: EmailMarketingTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminEmailMarketingTemplatesResponse = PostAdminEmailMarketingTemplatesResponses[keyof PostAdminEmailMarketingTemplatesResponses]; export type GetAdminExtractionResultsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/results/workspace/{workspace_id}"; }; export type GetAdminExtractionResultsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionResultsWorkspaceByWorkspaceIdError = GetAdminExtractionResultsWorkspaceByWorkspaceIdErrors[keyof GetAdminExtractionResultsWorkspaceByWorkspaceIdErrors]; export type GetAdminExtractionResultsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a extraction-result */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionResultsWorkspaceByWorkspaceIdResponse = GetAdminExtractionResultsWorkspaceByWorkspaceIdResponses[keyof GetAdminExtractionResultsWorkspaceByWorkspaceIdResponses]; export type DeleteAdminCrmActivitiesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/activities/{id}"; }; export type DeleteAdminCrmActivitiesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrmActivitiesByIdError = DeleteAdminCrmActivitiesByIdErrors[keyof DeleteAdminCrmActivitiesByIdErrors]; export type DeleteAdminCrmActivitiesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCrmActivitiesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/activities/{id}"; }; export type GetAdminCrmActivitiesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmActivitiesByIdError = GetAdminCrmActivitiesByIdErrors[keyof GetAdminCrmActivitiesByIdErrors]; export type GetAdminCrmActivitiesByIdResponses = { /** * Success */ 200: { data?: CrmActivity; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmActivitiesByIdResponse = GetAdminCrmActivitiesByIdResponses[keyof GetAdminCrmActivitiesByIdResponses]; export type PatchAdminCrmActivitiesByIdData = { /** * Request body for the /crm/activities/:id operation on crm-activity resource */ body?: { data: { attributes?: { ai_action_items?: { [key: string]: unknown; } | null; ai_summary?: string | null; body?: string | null; properties?: { [key: string]: unknown; } | null; sentiment?: "positive" | "neutral" | "negative"; subject?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-activity"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/activities/{id}"; }; export type PatchAdminCrmActivitiesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmActivitiesByIdError = PatchAdminCrmActivitiesByIdErrors[keyof PatchAdminCrmActivitiesByIdErrors]; export type PatchAdminCrmActivitiesByIdResponses = { /** * Success */ 200: { data?: CrmActivity; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmActivitiesByIdResponse = PatchAdminCrmActivitiesByIdResponses[keyof PatchAdminCrmActivitiesByIdResponses]; export type PostAdminWorkspacePreferencesUpsertData = { /** * Request body for the /workspace-preferences/upsert operation on workspace-preference resource */ body: { data: { attributes?: { context_key: string; preferences?: { [key: string]: unknown; } | null; }; relationships?: { [key: string]: never; }; type?: "workspace-preference"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspace-preferences/upsert"; }; export type PostAdminWorkspacePreferencesUpsertErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminWorkspacePreferencesUpsertError = PostAdminWorkspacePreferencesUpsertErrors[keyof PostAdminWorkspacePreferencesUpsertErrors]; export type PostAdminWorkspacePreferencesUpsertResponses = { /** * Success */ 201: { data?: WorkspacePreference; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminWorkspacePreferencesUpsertResponse = PostAdminWorkspacePreferencesUpsertResponses[keyof PostAdminWorkspacePreferencesUpsertResponses]; export type PatchAdminStorageRecommendationsByIdAcceptData = { /** * Request body for the /storage-recommendations/:id/accept operation on storage-recommendation resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "storage-recommendation"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/storage-recommendations/{id}/accept"; }; export type PatchAdminStorageRecommendationsByIdAcceptErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminStorageRecommendationsByIdAcceptError = PatchAdminStorageRecommendationsByIdAcceptErrors[keyof PatchAdminStorageRecommendationsByIdAcceptErrors]; export type PatchAdminStorageRecommendationsByIdAcceptResponses = { /** * Success */ 200: { data?: StorageRecommendation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminStorageRecommendationsByIdAcceptResponse = PatchAdminStorageRecommendationsByIdAcceptResponses[keyof PatchAdminStorageRecommendationsByIdAcceptResponses]; export type DeleteAdminClinicalNotesByIdPermanentData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/notes/{id}/permanent"; }; export type DeleteAdminClinicalNotesByIdPermanentErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalNotesByIdPermanentError = DeleteAdminClinicalNotesByIdPermanentErrors[keyof DeleteAdminClinicalNotesByIdPermanentErrors]; export type DeleteAdminClinicalNotesByIdPermanentResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminPipelinesBySlugBySlugData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { slug: string; }; query: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; application_id: string; }; url: "/admin/pipelines/by-slug/{slug}"; }; export type GetAdminPipelinesBySlugBySlugErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPipelinesBySlugBySlugError = GetAdminPipelinesBySlugBySlugErrors[keyof GetAdminPipelinesBySlugBySlugErrors]; export type GetAdminPipelinesBySlugBySlugResponses = { /** * Success */ 200: { data?: Pipeline; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPipelinesBySlugBySlugResponse = GetAdminPipelinesBySlugBySlugResponses[keyof GetAdminPipelinesBySlugBySlugResponses]; export type GetAdminStorageRecommendationsPendingData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/storage-recommendations/pending"; }; export type GetAdminStorageRecommendationsPendingErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminStorageRecommendationsPendingError = GetAdminStorageRecommendationsPendingErrors[keyof GetAdminStorageRecommendationsPendingErrors]; export type GetAdminStorageRecommendationsPendingResponses = { /** * Success */ 200: { /** * An array of resource objects representing a storage-recommendation */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminStorageRecommendationsPendingResponse = GetAdminStorageRecommendationsPendingResponses[keyof GetAdminStorageRecommendationsPendingResponses]; export type PatchAdminExtractionDocumentsByIdVerificationData = { /** * Request body for the /extraction/documents/:id/verification operation on extraction-document resource */ body?: { data: { attributes?: { /** * Average confidence score across all extracted fields (0.0 to 1.0) */ avg_confidence?: number | null; last_verified_at?: unknown; /** * The review/verification state of the document */ verification_status?: "unverified" | "partially_verified" | "fully_verified"; verified_by_user_id?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "extraction-document"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/documents/{id}/verification"; }; export type PatchAdminExtractionDocumentsByIdVerificationErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminExtractionDocumentsByIdVerificationError = PatchAdminExtractionDocumentsByIdVerificationErrors[keyof PatchAdminExtractionDocumentsByIdVerificationErrors]; export type PatchAdminExtractionDocumentsByIdVerificationResponses = { /** * Success */ 200: { data?: ExtractionDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminExtractionDocumentsByIdVerificationResponse = PatchAdminExtractionDocumentsByIdVerificationResponses[keyof PatchAdminExtractionDocumentsByIdVerificationResponses]; export type PatchAdminApplicationsByIdAllocateCreditsData = { /** * Request body for the /applications/:id/allocate-credits operation on application resource */ body: { data: { attributes?: { amount: number; description?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "application"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/applications/{id}/allocate-credits"; }; export type PatchAdminApplicationsByIdAllocateCreditsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminApplicationsByIdAllocateCreditsError = PatchAdminApplicationsByIdAllocateCreditsErrors[keyof PatchAdminApplicationsByIdAllocateCreditsErrors]; export type PatchAdminApplicationsByIdAllocateCreditsResponses = { /** * Success */ 200: { data?: Application; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminApplicationsByIdAllocateCreditsResponse = PatchAdminApplicationsByIdAllocateCreditsResponses[keyof PatchAdminApplicationsByIdAllocateCreditsResponses]; export type DeleteAdminFormVersionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/form-versions/{id}"; }; export type DeleteAdminFormVersionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminFormVersionsByIdError = DeleteAdminFormVersionsByIdErrors[keyof DeleteAdminFormVersionsByIdErrors]; export type DeleteAdminFormVersionsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminFormVersionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/form-versions/{id}"; }; export type GetAdminFormVersionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminFormVersionsByIdError = GetAdminFormVersionsByIdErrors[keyof GetAdminFormVersionsByIdErrors]; export type GetAdminFormVersionsByIdResponses = { /** * Success */ 200: { data?: FormVersion; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminFormVersionsByIdResponse = GetAdminFormVersionsByIdResponses[keyof GetAdminFormVersionsByIdResponses]; export type PatchAdminFormVersionsByIdData = { /** * Request body for the /form-versions/:id operation on form-version resource */ body?: { data: { attributes?: { assistant_agent_version_id?: string | null; assistant_id?: string | null; changes_summary?: string | null; custom_css?: string | null; layout_tree?: { [key: string]: unknown; } | null; logic_rules?: { [key: string]: unknown; } | null; published_at?: unknown; published_by_id?: string | null; theme_id?: string | null; theme_overrides?: { [key: string]: unknown; } | null; theme_version_pinned?: number | null; tokens_snapshot?: { [key: string]: unknown; } | null; }; id: string; relationships?: { [key: string]: never; }; type?: "form-version"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/form-versions/{id}"; }; export type PatchAdminFormVersionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminFormVersionsByIdError = PatchAdminFormVersionsByIdErrors[keyof PatchAdminFormVersionsByIdErrors]; export type PatchAdminFormVersionsByIdResponses = { /** * Success */ 200: { data?: FormVersion; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminFormVersionsByIdResponse = PatchAdminFormVersionsByIdResponses[keyof PatchAdminFormVersionsByIdResponses]; export type PatchAdminInvitationsByIdAcceptByIdData = { /** * Request body for the /invitations/:id/accept-by-id operation on invitation resource */ body?: { data: { attributes?: { application_id?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "invitation"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invitations/{id}/accept-by-id"; }; export type PatchAdminInvitationsByIdAcceptByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvitationsByIdAcceptByIdError = PatchAdminInvitationsByIdAcceptByIdErrors[keyof PatchAdminInvitationsByIdAcceptByIdErrors]; export type PatchAdminInvitationsByIdAcceptByIdResponses = { /** * Success */ 200: { data?: Invitation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvitationsByIdAcceptByIdResponse = PatchAdminInvitationsByIdAcceptByIdResponses[keyof PatchAdminInvitationsByIdAcceptByIdResponses]; export type PatchAdminSchedulingParticipantsByIdRespondData = { /** * Request body for the /scheduling/participants/:id/respond operation on scheduling-participant resource */ body: { data: { attributes?: { status: "accepted" | "declined" | "tentative"; }; id: string; relationships?: { [key: string]: never; }; type?: "scheduling-participant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/participants/{id}/respond"; }; export type PatchAdminSchedulingParticipantsByIdRespondErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSchedulingParticipantsByIdRespondError = PatchAdminSchedulingParticipantsByIdRespondErrors[keyof PatchAdminSchedulingParticipantsByIdRespondErrors]; export type PatchAdminSchedulingParticipantsByIdRespondResponses = { /** * Success */ 200: { data?: SchedulingParticipant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSchedulingParticipantsByIdRespondResponse = PatchAdminSchedulingParticipantsByIdRespondResponses[keyof PatchAdminSchedulingParticipantsByIdRespondResponses]; export type GetAdminClinicalGoalTemplatesCatalogArchivedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-templates/catalog/archived"; }; export type GetAdminClinicalGoalTemplatesCatalogArchivedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalGoalTemplatesCatalogArchivedError = GetAdminClinicalGoalTemplatesCatalogArchivedErrors[keyof GetAdminClinicalGoalTemplatesCatalogArchivedErrors]; export type GetAdminClinicalGoalTemplatesCatalogArchivedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-goal-template */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalGoalTemplatesCatalogArchivedResponse = GetAdminClinicalGoalTemplatesCatalogArchivedResponses[keyof GetAdminClinicalGoalTemplatesCatalogArchivedResponses]; export type DeleteAdminRetentionPoliciesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/retention-policies/{id}"; }; export type DeleteAdminRetentionPoliciesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminRetentionPoliciesByIdError = DeleteAdminRetentionPoliciesByIdErrors[keyof DeleteAdminRetentionPoliciesByIdErrors]; export type DeleteAdminRetentionPoliciesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminRetentionPoliciesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/retention-policies/{id}"; }; export type GetAdminRetentionPoliciesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRetentionPoliciesByIdError = GetAdminRetentionPoliciesByIdErrors[keyof GetAdminRetentionPoliciesByIdErrors]; export type GetAdminRetentionPoliciesByIdResponses = { /** * Success */ 200: { data?: RetentionPolicy; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRetentionPoliciesByIdResponse = GetAdminRetentionPoliciesByIdResponses[keyof GetAdminRetentionPoliciesByIdResponses]; export type PatchAdminRetentionPoliciesByIdData = { /** * Request body for the /retention-policies/:id operation on retention-policy resource */ body?: { data: { attributes?: { action_on_expiry?: "delete" | "archive" | "anonymize"; enabled?: boolean | null; retention_days?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "retention-policy"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/retention-policies/{id}"; }; export type PatchAdminRetentionPoliciesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminRetentionPoliciesByIdError = PatchAdminRetentionPoliciesByIdErrors[keyof PatchAdminRetentionPoliciesByIdErrors]; export type PatchAdminRetentionPoliciesByIdResponses = { /** * Success */ 200: { data?: RetentionPolicy; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminRetentionPoliciesByIdResponse = PatchAdminRetentionPoliciesByIdResponses[keyof PatchAdminRetentionPoliciesByIdResponses]; export type GetAdminEmailMarketingSenderProfilesWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/sender-profiles/workspace/{workspace_id}"; }; export type GetAdminEmailMarketingSenderProfilesWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailMarketingSenderProfilesWorkspaceByWorkspaceIdError = GetAdminEmailMarketingSenderProfilesWorkspaceByWorkspaceIdErrors[keyof GetAdminEmailMarketingSenderProfilesWorkspaceByWorkspaceIdErrors]; export type GetAdminEmailMarketingSenderProfilesWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a email-marketing-sender-profile */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailMarketingSenderProfilesWorkspaceByWorkspaceIdResponse = GetAdminEmailMarketingSenderProfilesWorkspaceByWorkspaceIdResponses[keyof GetAdminEmailMarketingSenderProfilesWorkspaceByWorkspaceIdResponses]; export type GetAdminCrmContactsWorkspaceByWorkspaceIdArchivedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/contacts/workspace/{workspace_id}/archived"; }; export type GetAdminCrmContactsWorkspaceByWorkspaceIdArchivedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmContactsWorkspaceByWorkspaceIdArchivedError = GetAdminCrmContactsWorkspaceByWorkspaceIdArchivedErrors[keyof GetAdminCrmContactsWorkspaceByWorkspaceIdArchivedErrors]; export type GetAdminCrmContactsWorkspaceByWorkspaceIdArchivedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crm-contact */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmContactsWorkspaceByWorkspaceIdArchivedResponse = GetAdminCrmContactsWorkspaceByWorkspaceIdArchivedResponses[keyof GetAdminCrmContactsWorkspaceByWorkspaceIdArchivedResponses]; export type GetAdminClinicalPracticeToolsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/practice-tools"; }; export type GetAdminClinicalPracticeToolsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPracticeToolsError = GetAdminClinicalPracticeToolsErrors[keyof GetAdminClinicalPracticeToolsErrors]; export type GetAdminClinicalPracticeToolsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-practice-tool */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPracticeToolsResponse = GetAdminClinicalPracticeToolsResponses[keyof GetAdminClinicalPracticeToolsResponses]; export type PostAdminClinicalPracticeToolsData = { /** * Request body for the /clinical/practice-tools operation on clinical-practice-tool resource */ body: { data: { attributes?: { app_store_url?: string | null; category?: string | null; description?: string | null; icon_url?: string | null; integrations?: Array | null; is_active?: boolean | null; logo_url?: string | null; metadata?: { [key: string]: unknown; } | null; name: string; platform?: string | null; play_store_url?: string | null; pricing_model?: "free" | "freemium" | "paid" | "prescription"; privacy_rating?: "hipaa_compliant" | "hipaa_partial" | "standard" | "unknown"; rating?: string | number | unknown; source_catalog_id?: string | null; supported_platforms?: Array | null; tags?: Array | null; tool_type?: string | null; url?: string | null; website_url?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-practice-tool"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-tools"; }; export type PostAdminClinicalPracticeToolsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalPracticeToolsError = PostAdminClinicalPracticeToolsErrors[keyof PostAdminClinicalPracticeToolsErrors]; export type PostAdminClinicalPracticeToolsResponses = { /** * Success */ 201: { data?: ClinicalPracticeTool; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalPracticeToolsResponse = PostAdminClinicalPracticeToolsResponses[keyof PostAdminClinicalPracticeToolsResponses]; export type PatchAdminSocialPostsByIdRetryData = { /** * Request body for the /social/posts/:id/retry operation on social-post resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "social-post"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/posts/{id}/retry"; }; export type PatchAdminSocialPostsByIdRetryErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSocialPostsByIdRetryError = PatchAdminSocialPostsByIdRetryErrors[keyof PatchAdminSocialPostsByIdRetryErrors]; export type PatchAdminSocialPostsByIdRetryResponses = { /** * Success */ 200: { data?: SocialPost; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSocialPostsByIdRetryResponse = PatchAdminSocialPostsByIdRetryResponses[keyof PatchAdminSocialPostsByIdRetryResponses]; export type GetAdminClinicalSupplementRecCacheData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; patient_id: string; }; url: "/admin/clinical/supplement-rec-cache"; }; export type GetAdminClinicalSupplementRecCacheErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalSupplementRecCacheError = GetAdminClinicalSupplementRecCacheErrors[keyof GetAdminClinicalSupplementRecCacheErrors]; export type GetAdminClinicalSupplementRecCacheResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-supplement-rec-cache */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalSupplementRecCacheResponse = GetAdminClinicalSupplementRecCacheResponses[keyof GetAdminClinicalSupplementRecCacheResponses]; export type GetAdminEmailMarketingCampaignsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/campaigns/workspace/{workspace_id}"; }; export type GetAdminEmailMarketingCampaignsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailMarketingCampaignsWorkspaceByWorkspaceIdError = GetAdminEmailMarketingCampaignsWorkspaceByWorkspaceIdErrors[keyof GetAdminEmailMarketingCampaignsWorkspaceByWorkspaceIdErrors]; export type GetAdminEmailMarketingCampaignsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a campaign */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailMarketingCampaignsWorkspaceByWorkspaceIdResponse = GetAdminEmailMarketingCampaignsWorkspaceByWorkspaceIdResponses[keyof GetAdminEmailMarketingCampaignsWorkspaceByWorkspaceIdResponses]; export type GetAdminAccessGrantsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/access-grants"; }; export type GetAdminAccessGrantsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAccessGrantsError = GetAdminAccessGrantsErrors[keyof GetAdminAccessGrantsErrors]; export type GetAdminAccessGrantsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a access-grant */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAccessGrantsResponse = GetAdminAccessGrantsResponses[keyof GetAdminAccessGrantsResponses]; export type PostAdminAccessGrantsData = { /** * Request body for the /access-grants operation on access-grant resource */ body: { data: { attributes?: { /** * Permissions granted by this relation. Auto-populated from PermissionRegistry unless overridden. */ custom_permissions?: Array | null; expires_at?: unknown; granted_by_id?: string | null; join_source?: "manual" | "invitation" | "domain_whitelist" | "sso_oidc" | "sso_saml" | "scim"; object_id: string; object_type: "tenant" | "workspace"; relation: "tenant_admin" | "tenant_member" | "workspace_admin" | "workspace_editor" | "workspace_viewer"; subject_id: string; subject_type: "user" | "application"; }; relationships?: { [key: string]: never; }; type?: "access-grant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/access-grants"; }; export type PostAdminAccessGrantsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAccessGrantsError = PostAdminAccessGrantsErrors[keyof PostAdminAccessGrantsErrors]; export type PostAdminAccessGrantsResponses = { /** * Success */ 201: { data?: AccessGrant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAccessGrantsResponse = PostAdminAccessGrantsResponses[keyof PostAdminAccessGrantsResponses]; export type PatchAdminInvitationsByIdAcceptByUserData = { /** * Request body for the /invitations/:id/accept-by-user operation on invitation resource */ body: { data: { attributes?: { user_id: string; }; id: string; relationships?: { [key: string]: never; }; type?: "invitation"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invitations/{id}/accept-by-user"; }; export type PatchAdminInvitationsByIdAcceptByUserErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvitationsByIdAcceptByUserError = PatchAdminInvitationsByIdAcceptByUserErrors[keyof PatchAdminInvitationsByIdAcceptByUserErrors]; export type PatchAdminInvitationsByIdAcceptByUserResponses = { /** * Success */ 200: { data?: Invitation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvitationsByIdAcceptByUserResponse = PatchAdminInvitationsByIdAcceptByUserResponses[keyof PatchAdminInvitationsByIdAcceptByUserResponses]; export type PatchAdminSystemMessagesByIdUnpublishData = { /** * Request body for the /system-messages/:id/unpublish operation on system-message resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "system-message"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/system-messages/{id}/unpublish"; }; export type PatchAdminSystemMessagesByIdUnpublishErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSystemMessagesByIdUnpublishError = PatchAdminSystemMessagesByIdUnpublishErrors[keyof PatchAdminSystemMessagesByIdUnpublishErrors]; export type PatchAdminSystemMessagesByIdUnpublishResponses = { /** * Success */ 200: { data?: SystemMessage; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSystemMessagesByIdUnpublishResponse = PatchAdminSystemMessagesByIdUnpublishResponses[keyof PatchAdminSystemMessagesByIdUnpublishResponses]; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdByStatusByStatusData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; status: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/documents/workspace/{workspace_id}/by-status/{status}"; }; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdByStatusByStatusErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdByStatusByStatusError = GetAdminExtractionDocumentsWorkspaceByWorkspaceIdByStatusByStatusErrors[keyof GetAdminExtractionDocumentsWorkspaceByWorkspaceIdByStatusByStatusErrors]; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdByStatusByStatusResponses = { /** * Success */ 200: { /** * An array of resource objects representing a extraction-document */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdByStatusByStatusResponse = GetAdminExtractionDocumentsWorkspaceByWorkspaceIdByStatusByStatusResponses[keyof GetAdminExtractionDocumentsWorkspaceByWorkspaceIdByStatusByStatusResponses]; export type GetAdminThreadsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/threads"; }; export type GetAdminThreadsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminThreadsError = GetAdminThreadsErrors[keyof GetAdminThreadsErrors]; export type GetAdminThreadsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a chat-thread */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminThreadsResponse = GetAdminThreadsResponses[keyof GetAdminThreadsResponses]; export type PostAdminThreadsData = { /** * Request body for the /threads operation on chat-thread resource */ body: { data: { attributes?: { agent_id?: string | null; context_summary?: string | null; metadata?: { [key: string]: unknown; } | null; portal_user_id?: string | null; previous_thread_id?: string | null; tenant_id: string; title?: string | null; user_id?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "chat-thread"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/threads"; }; export type PostAdminThreadsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminThreadsError = PostAdminThreadsErrors[keyof PostAdminThreadsErrors]; export type PostAdminThreadsResponses = { /** * Success */ 201: { data?: ChatThread; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminThreadsResponse = PostAdminThreadsResponses[keyof PostAdminThreadsResponses]; export type PostAdminConnectorsCredentialsUpsertData = { /** * Request body for the /connectors/credentials/upsert operation on credential resource */ body: { data: { auth_data: { [key: string]: unknown; }; auth_type: "oauth2" | "api_key" | "basic_auth" | "client_credentials"; connector_type: "salesforce" | "hubspot" | "slack" | "notion" | "sharepoint" | "gmail" | "outlook" | "microsoft_365" | "practice_better" | "jira" | "confluence" | "fullscript" | "fhir_r4" | "github" | "gitlab" | "google_calendar" | "google_chat" | "custom" | "edamam" | "facebook" | "instagram" | "threads" | "twitter" | "linkedin" | "reddit" | "bluesky" | "newsapi" | "gnews" | "bing_news" | "corehealth" | "healthie"; scope_level: "workspace" | "tenant" | "application"; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/connectors/credentials/upsert"; }; export type PostAdminConnectorsCredentialsUpsertErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsCredentialsUpsertError = PostAdminConnectorsCredentialsUpsertErrors[keyof PostAdminConnectorsCredentialsUpsertErrors]; export type PostAdminConnectorsCredentialsUpsertResponses = { /** * Success */ 201: CredentialType; }; export type PostAdminConnectorsCredentialsUpsertResponse = PostAdminConnectorsCredentialsUpsertResponses[keyof PostAdminConnectorsCredentialsUpsertResponses]; export type GetAdminRecipesCollectionRecipesCollectionByCollectionIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { collection_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/collection-recipes/collection/{collection_id}"; }; export type GetAdminRecipesCollectionRecipesCollectionByCollectionIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesCollectionRecipesCollectionByCollectionIdError = GetAdminRecipesCollectionRecipesCollectionByCollectionIdErrors[keyof GetAdminRecipesCollectionRecipesCollectionByCollectionIdErrors]; export type GetAdminRecipesCollectionRecipesCollectionByCollectionIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a recipes-collection-recipe */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesCollectionRecipesCollectionByCollectionIdResponse = GetAdminRecipesCollectionRecipesCollectionByCollectionIdResponses[keyof GetAdminRecipesCollectionRecipesCollectionByCollectionIdResponses]; export type GetAdminIsvCrmEntityTypesApplicationByApplicationIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { application_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/isv/crm/entity-types/application/{application_id}"; }; export type GetAdminIsvCrmEntityTypesApplicationByApplicationIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminIsvCrmEntityTypesApplicationByApplicationIdError = GetAdminIsvCrmEntityTypesApplicationByApplicationIdErrors[keyof GetAdminIsvCrmEntityTypesApplicationByApplicationIdErrors]; export type GetAdminIsvCrmEntityTypesApplicationByApplicationIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crm-custom-entity-type */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminIsvCrmEntityTypesApplicationByApplicationIdResponse = GetAdminIsvCrmEntityTypesApplicationByApplicationIdResponses[keyof GetAdminIsvCrmEntityTypesApplicationByApplicationIdResponses]; export type PostAdminConnectorsFullscriptProductsSimilarData = { /** * Request body for the /connectors/fullscript/products/similar operation on connector-instance resource */ body: { data: { connector_id: string; product_id: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/connectors/fullscript/products/similar"; }; export type PostAdminConnectorsFullscriptProductsSimilarErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsFullscriptProductsSimilarError = PostAdminConnectorsFullscriptProductsSimilarErrors[keyof PostAdminConnectorsFullscriptProductsSimilarErrors]; export type PostAdminConnectorsFullscriptProductsSimilarResponses = { /** * Success */ 201: Array<{ [key: string]: unknown; }>; }; export type PostAdminConnectorsFullscriptProductsSimilarResponse = PostAdminConnectorsFullscriptProductsSimilarResponses[keyof PostAdminConnectorsFullscriptProductsSimilarResponses]; export type GetAdminComplianceDocumentTemplatesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/compliance-document-templates/{id}"; }; export type GetAdminComplianceDocumentTemplatesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminComplianceDocumentTemplatesByIdError = GetAdminComplianceDocumentTemplatesByIdErrors[keyof GetAdminComplianceDocumentTemplatesByIdErrors]; export type GetAdminComplianceDocumentTemplatesByIdResponses = { /** * Success */ 200: { data?: ComplianceDocumentTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminComplianceDocumentTemplatesByIdResponse = GetAdminComplianceDocumentTemplatesByIdResponses[keyof GetAdminComplianceDocumentTemplatesByIdResponses]; export type PatchAdminComplianceDocumentTemplatesByIdData = { /** * Request body for the /compliance-document-templates/:id operation on compliance-document-template resource */ body?: { data: { attributes?: { /** * Markdown/Mustache template with {{variables}} */ content_template?: string | null; required_variables?: Array | null; title?: string | null; version?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "compliance-document-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/compliance-document-templates/{id}"; }; export type PatchAdminComplianceDocumentTemplatesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminComplianceDocumentTemplatesByIdError = PatchAdminComplianceDocumentTemplatesByIdErrors[keyof PatchAdminComplianceDocumentTemplatesByIdErrors]; export type PatchAdminComplianceDocumentTemplatesByIdResponses = { /** * Success */ 200: { data?: ComplianceDocumentTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminComplianceDocumentTemplatesByIdResponse = PatchAdminComplianceDocumentTemplatesByIdResponses[keyof PatchAdminComplianceDocumentTemplatesByIdResponses]; export type GetAdminUsersMeActivityData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * Optional activity type to filter by */ activity_type?: string; limit?: number; offset?: number; /** * Tenant ID to get activity for */ tenant_id: string; /** * Optional workspace ID to filter by */ workspace_id?: string; }; url: "/admin/users/me/activity"; }; export type GetAdminUsersMeActivityErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminUsersMeActivityError = GetAdminUsersMeActivityErrors[keyof GetAdminUsersMeActivityErrors]; export type GetAdminUsersMeActivityResponses = { /** * Success */ 200: { result: { [key: string]: unknown; }; }; }; export type GetAdminUsersMeActivityResponse = GetAdminUsersMeActivityResponses[keyof GetAdminUsersMeActivityResponses]; export type GetAdminAccountsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/accounts/{id}"; }; export type GetAdminAccountsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAccountsByIdError = GetAdminAccountsByIdErrors[keyof GetAdminAccountsByIdErrors]; export type GetAdminAccountsByIdResponses = { /** * Success */ 200: { data?: Account; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAccountsByIdResponse = GetAdminAccountsByIdResponses[keyof GetAdminAccountsByIdResponses]; export type DeleteAdminExtractionShadowComparisonsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/shadow-comparisons/{id}"; }; export type DeleteAdminExtractionShadowComparisonsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminExtractionShadowComparisonsByIdError = DeleteAdminExtractionShadowComparisonsByIdErrors[keyof DeleteAdminExtractionShadowComparisonsByIdErrors]; export type DeleteAdminExtractionShadowComparisonsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminExtractionShadowComparisonsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/shadow-comparisons/{id}"; }; export type GetAdminExtractionShadowComparisonsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionShadowComparisonsByIdError = GetAdminExtractionShadowComparisonsByIdErrors[keyof GetAdminExtractionShadowComparisonsByIdErrors]; export type GetAdminExtractionShadowComparisonsByIdResponses = { /** * Success */ 200: { data?: ShadowComparison; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionShadowComparisonsByIdResponse = GetAdminExtractionShadowComparisonsByIdResponses[keyof GetAdminExtractionShadowComparisonsByIdResponses]; export type GetAdminEmailMarketingTemplatesWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/templates/workspace/{workspace_id}"; }; export type GetAdminEmailMarketingTemplatesWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailMarketingTemplatesWorkspaceByWorkspaceIdError = GetAdminEmailMarketingTemplatesWorkspaceByWorkspaceIdErrors[keyof GetAdminEmailMarketingTemplatesWorkspaceByWorkspaceIdErrors]; export type GetAdminEmailMarketingTemplatesWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a email-marketing-template */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailMarketingTemplatesWorkspaceByWorkspaceIdResponse = GetAdminEmailMarketingTemplatesWorkspaceByWorkspaceIdResponses[keyof GetAdminEmailMarketingTemplatesWorkspaceByWorkspaceIdResponses]; export type GetAdminAiMessagesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ai/messages"; }; export type GetAdminAiMessagesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAiMessagesError = GetAdminAiMessagesErrors[keyof GetAdminAiMessagesErrors]; export type GetAdminAiMessagesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a chat-ai-message */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAiMessagesResponse = GetAdminAiMessagesResponses[keyof GetAdminAiMessagesResponses]; export type PostAdminAiMessagesData = { /** * Request body for the /ai/messages operation on chat-ai-message resource */ body: { data: { attributes?: { content: string; conversation_id: string; role: "system" | "user" | "assistant"; }; relationships?: { [key: string]: never; }; type?: "chat-ai-message"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ai/messages"; }; export type PostAdminAiMessagesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAiMessagesError = PostAdminAiMessagesErrors[keyof PostAdminAiMessagesErrors]; export type PostAdminAiMessagesResponses = { /** * Success */ 201: { data?: ChatAiMessage; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAiMessagesResponse = PostAdminAiMessagesResponses[keyof PostAdminAiMessagesResponses]; export type GetAdminInvoicesActivitiesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/activities/{id}"; }; export type GetAdminInvoicesActivitiesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminInvoicesActivitiesByIdError = GetAdminInvoicesActivitiesByIdErrors[keyof GetAdminInvoicesActivitiesByIdErrors]; export type GetAdminInvoicesActivitiesByIdResponses = { /** * Success */ 200: { data?: InvoicesActivity; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminInvoicesActivitiesByIdResponse = GetAdminInvoicesActivitiesByIdResponses[keyof GetAdminInvoicesActivitiesByIdResponses]; export type PostAdminPaymentMethodsTokenizeData = { /** * Request body for the /payment-methods/tokenize operation on payment-method resource */ body: { data: { attributes?: { billing_address: string; billing_city: string; billing_state: string; card_number: string; customer_id?: string | null; cvc: string; exp_month: number; exp_year: number; holder_name: string; nickname?: string | null; phone?: string | null; provider?: "qorpay" | "stripe"; zip_code: string; }; relationships?: { [key: string]: never; }; type?: "payment-method"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/payment-methods/tokenize"; }; export type PostAdminPaymentMethodsTokenizeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminPaymentMethodsTokenizeError = PostAdminPaymentMethodsTokenizeErrors[keyof PostAdminPaymentMethodsTokenizeErrors]; export type PostAdminPaymentMethodsTokenizeResponses = { /** * Success */ 201: { data?: PaymentMethod; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminPaymentMethodsTokenizeResponse = PostAdminPaymentMethodsTokenizeResponses[keyof PostAdminPaymentMethodsTokenizeResponses]; export type PostAdminExtractionAgentsPredictData = { /** * Request body for the /extraction/agents/predict operation on extraction-agent resource */ body?: { data: { description?: string | null; document_id?: string | null; file_content?: string | null; name?: string | null; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/extraction/agents/predict"; }; export type PostAdminExtractionAgentsPredictErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminExtractionAgentsPredictError = PostAdminExtractionAgentsPredictErrors[keyof PostAdminExtractionAgentsPredictErrors]; export type PostAdminExtractionAgentsPredictResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminExtractionAgentsPredictResponse = PostAdminExtractionAgentsPredictResponses[keyof PostAdminExtractionAgentsPredictResponses]; export type PostAdminSocialCampaignsByIdGenerateMasterCopyData = { /** * Request body for the /social/campaigns/:id/generate-master-copy operation on social-campaign resource */ body: { data: { campaign_id: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/social/campaigns/{id}/generate-master-copy"; }; export type PostAdminSocialCampaignsByIdGenerateMasterCopyErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSocialCampaignsByIdGenerateMasterCopyError = PostAdminSocialCampaignsByIdGenerateMasterCopyErrors[keyof PostAdminSocialCampaignsByIdGenerateMasterCopyErrors]; export type PostAdminSocialCampaignsByIdGenerateMasterCopyResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminSocialCampaignsByIdGenerateMasterCopyResponse = PostAdminSocialCampaignsByIdGenerateMasterCopyResponses[keyof PostAdminSocialCampaignsByIdGenerateMasterCopyResponses]; export type GetAdminExtractionShadowComparisonsAnalysisData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; since?: string; }; url: "/admin/extraction/shadow-comparisons/analysis"; }; export type GetAdminExtractionShadowComparisonsAnalysisErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionShadowComparisonsAnalysisError = GetAdminExtractionShadowComparisonsAnalysisErrors[keyof GetAdminExtractionShadowComparisonsAnalysisErrors]; export type GetAdminExtractionShadowComparisonsAnalysisResponses = { /** * Success */ 200: { /** * An array of resource objects representing a shadow-comparison */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionShadowComparisonsAnalysisResponse = GetAdminExtractionShadowComparisonsAnalysisResponses[keyof GetAdminExtractionShadowComparisonsAnalysisResponses]; export type PatchAdminSupportTicketsByIdAssignData = { /** * Request body for the /support/tickets/:id/assign operation on support-ticket resource */ body?: { data: { attributes?: { assigned_agent_id?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "support-ticket"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/tickets/{id}/assign"; }; export type PatchAdminSupportTicketsByIdAssignErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSupportTicketsByIdAssignError = PatchAdminSupportTicketsByIdAssignErrors[keyof PatchAdminSupportTicketsByIdAssignErrors]; export type PatchAdminSupportTicketsByIdAssignResponses = { /** * Success */ 200: { data?: SupportTicket; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSupportTicketsByIdAssignResponse = PatchAdminSupportTicketsByIdAssignResponses[keyof PatchAdminSupportTicketsByIdAssignResponses]; export type PatchAdminPipelineExecutionsByIdRejectData = { /** * Request body for the /pipeline-executions/:id/reject operation on pipeline-execution resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "pipeline-execution"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pipeline-executions/{id}/reject"; }; export type PatchAdminPipelineExecutionsByIdRejectErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPipelineExecutionsByIdRejectError = PatchAdminPipelineExecutionsByIdRejectErrors[keyof PatchAdminPipelineExecutionsByIdRejectErrors]; export type PatchAdminPipelineExecutionsByIdRejectResponses = { /** * Success */ 200: { data?: PipelineExecution; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPipelineExecutionsByIdRejectResponse = PatchAdminPipelineExecutionsByIdRejectResponses[keyof PatchAdminPipelineExecutionsByIdRejectResponses]; export type GetAdminComplianceRequirementCompletionsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/compliance-requirement-completions"; }; export type GetAdminComplianceRequirementCompletionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminComplianceRequirementCompletionsError = GetAdminComplianceRequirementCompletionsErrors[keyof GetAdminComplianceRequirementCompletionsErrors]; export type GetAdminComplianceRequirementCompletionsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a compliance-requirement-completion */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminComplianceRequirementCompletionsResponse = GetAdminComplianceRequirementCompletionsResponses[keyof GetAdminComplianceRequirementCompletionsResponses]; export type PostAdminComplianceRequirementCompletionsData = { /** * Request body for the /compliance-requirement-completions operation on compliance-requirement-completion resource */ body: { data: { attributes?: { completed_at: unknown; evidence?: { [key: string]: unknown; } | null; requirement_id: string; user_id: string; }; relationships?: { [key: string]: never; }; type?: "compliance-requirement-completion"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/compliance-requirement-completions"; }; export type PostAdminComplianceRequirementCompletionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminComplianceRequirementCompletionsError = PostAdminComplianceRequirementCompletionsErrors[keyof PostAdminComplianceRequirementCompletionsErrors]; export type PostAdminComplianceRequirementCompletionsResponses = { /** * Success */ 201: { data?: ComplianceRequirementCompletion; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminComplianceRequirementCompletionsResponse = PostAdminComplianceRequirementCompletionsResponses[keyof PostAdminComplianceRequirementCompletionsResponses]; export type GetAdminSysAiConfigByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/sys/ai-config/{id}"; }; export type GetAdminSysAiConfigByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSysAiConfigByIdError = GetAdminSysAiConfigByIdErrors[keyof GetAdminSysAiConfigByIdErrors]; export type GetAdminSysAiConfigByIdResponses = { /** * Success */ 200: { data?: AiConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSysAiConfigByIdResponse = GetAdminSysAiConfigByIdResponses[keyof GetAdminSysAiConfigByIdResponses]; export type PatchAdminSysAiConfigByIdData = { /** * Request body for the /sys/ai-config/:id operation on ai-config resource */ body?: { data: { attributes?: { cloud_model?: string | null; embedding_model?: string | null; /** * Per-config fallback chains. Map of model_id => [{fallback_model, reason}]. Null = use platform defaults. */ fallback_chains?: { [key: string]: unknown; } | null; model_overrides?: { [key: string]: unknown; } | null; /** * Minimum upcharge percentage on provider costs. Null = use config.exs default (20%). */ pricing_floor_percent?: number | null; vector_dimensions?: number | null; /** * Per-workload AI backend overrides stored as JSON-safe strings. NER is intentionally excluded and remains locked to the local GLiNER backend. */ workload_backends?: { [key: string]: unknown; } | null; }; id: string; relationships?: { [key: string]: never; }; type?: "ai-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/sys/ai-config/{id}"; }; export type PatchAdminSysAiConfigByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSysAiConfigByIdError = PatchAdminSysAiConfigByIdErrors[keyof PatchAdminSysAiConfigByIdErrors]; export type PatchAdminSysAiConfigByIdResponses = { /** * Success */ 200: { data?: AiConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSysAiConfigByIdResponse = PatchAdminSysAiConfigByIdResponses[keyof PatchAdminSysAiConfigByIdResponses]; export type PostAdminRecipesShoppingListItemsData = { /** * Request body for the /recipes/shopping-list-items operation on recipes-shopping-list-item resource */ body: { data: { attributes?: { checked?: boolean | null; food_group?: string | null; name: string; shopping_list_id: string; total_quantity?: number | null; unit?: string | null; }; relationships?: { [key: string]: never; }; type?: "recipes-shopping-list-item"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/shopping-list-items"; }; export type PostAdminRecipesShoppingListItemsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminRecipesShoppingListItemsError = PostAdminRecipesShoppingListItemsErrors[keyof PostAdminRecipesShoppingListItemsErrors]; export type PostAdminRecipesShoppingListItemsResponses = { /** * Success */ 201: { data?: RecipesShoppingListItem; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminRecipesShoppingListItemsResponse = PostAdminRecipesShoppingListItemsResponses[keyof PostAdminRecipesShoppingListItemsResponses]; export type PatchAdminTenantsByIdTransferOwnershipData = { /** * Request body for the /tenants/:id/transfer-ownership operation on tenant resource */ body: { data: { attributes?: { new_owner_id: string; }; id: string; relationships?: { [key: string]: never; }; type?: "tenant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants/{id}/transfer-ownership"; }; export type PatchAdminTenantsByIdTransferOwnershipErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminTenantsByIdTransferOwnershipError = PatchAdminTenantsByIdTransferOwnershipErrors[keyof PatchAdminTenantsByIdTransferOwnershipErrors]; export type PatchAdminTenantsByIdTransferOwnershipResponses = { /** * Success */ 200: { data?: Tenant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminTenantsByIdTransferOwnershipResponse = PatchAdminTenantsByIdTransferOwnershipResponses[keyof PatchAdminTenantsByIdTransferOwnershipResponses]; export type GetAdminClinicalNotesByNoteIdVersionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; note_id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/notes/{note_id}/versions/{id}"; }; export type GetAdminClinicalNotesByNoteIdVersionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalNotesByNoteIdVersionsByIdError = GetAdminClinicalNotesByNoteIdVersionsByIdErrors[keyof GetAdminClinicalNotesByNoteIdVersionsByIdErrors]; export type GetAdminClinicalNotesByNoteIdVersionsByIdResponses = { /** * Success */ 200: { data?: ClinicalNoteVersion; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalNotesByNoteIdVersionsByIdResponse = GetAdminClinicalNotesByNoteIdVersionsByIdResponses[keyof GetAdminClinicalNotesByNoteIdVersionsByIdResponses]; export type PatchAdminClinicalPracticeResourcesCatalogByIdRestoreData = { /** * Request body for the /clinical/practice-resources/catalog/:id/restore operation on clinical-practice-resource resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-practice-resource"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-resources/catalog/{id}/restore"; }; export type PatchAdminClinicalPracticeResourcesCatalogByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalPracticeResourcesCatalogByIdRestoreError = PatchAdminClinicalPracticeResourcesCatalogByIdRestoreErrors[keyof PatchAdminClinicalPracticeResourcesCatalogByIdRestoreErrors]; export type PatchAdminClinicalPracticeResourcesCatalogByIdRestoreResponses = { /** * Success */ 200: { data?: ClinicalPracticeResource; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalPracticeResourcesCatalogByIdRestoreResponse = PatchAdminClinicalPracticeResourcesCatalogByIdRestoreResponses[keyof PatchAdminClinicalPracticeResourcesCatalogByIdRestoreResponses]; export type PatchAdminCaseTypesByIdDeactivateData = { /** * Request body for the /case-types/:id/deactivate operation on case-type resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "case-type"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/case-types/{id}/deactivate"; }; export type PatchAdminCaseTypesByIdDeactivateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCaseTypesByIdDeactivateError = PatchAdminCaseTypesByIdDeactivateErrors[keyof PatchAdminCaseTypesByIdDeactivateErrors]; export type PatchAdminCaseTypesByIdDeactivateResponses = { /** * Success */ 200: { data?: CaseType; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCaseTypesByIdDeactivateResponse = PatchAdminCaseTypesByIdDeactivateResponses[keyof PatchAdminCaseTypesByIdDeactivateResponses]; export type GetAdminAuditLogsActivityData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; tenant_id: string; workspace_id?: string; activity_type?: string; actor_id?: string; from_date?: string; to_date?: string; limit?: number; offset?: number; }; url: "/admin/audit-logs/activity"; }; export type GetAdminAuditLogsActivityErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAuditLogsActivityError = GetAdminAuditLogsActivityErrors[keyof GetAdminAuditLogsActivityErrors]; export type GetAdminAuditLogsActivityResponses = { /** * Success */ 200: { /** * An array of resource objects representing a audit-log */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAuditLogsActivityResponse = GetAdminAuditLogsActivityResponses[keyof GetAdminAuditLogsActivityResponses]; export type DeleteAdminRecipesShoppingListsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/shopping-lists/{id}"; }; export type DeleteAdminRecipesShoppingListsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminRecipesShoppingListsByIdError = DeleteAdminRecipesShoppingListsByIdErrors[keyof DeleteAdminRecipesShoppingListsByIdErrors]; export type DeleteAdminRecipesShoppingListsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminRecipesShoppingListsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/shopping-lists/{id}"; }; export type GetAdminRecipesShoppingListsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesShoppingListsByIdError = GetAdminRecipesShoppingListsByIdErrors[keyof GetAdminRecipesShoppingListsByIdErrors]; export type GetAdminRecipesShoppingListsByIdResponses = { /** * Success */ 200: { data?: RecipesShoppingList; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesShoppingListsByIdResponse = GetAdminRecipesShoppingListsByIdResponses[keyof GetAdminRecipesShoppingListsByIdResponses]; export type PatchAdminRecipesShoppingListsByIdData = { /** * Request body for the /recipes/shopping-lists/:id operation on recipes-shopping-list resource */ body?: { data: { attributes?: { name?: string | null; status?: "draft" | "active" | "completed"; }; id: string; relationships?: { [key: string]: never; }; type?: "recipes-shopping-list"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/shopping-lists/{id}"; }; export type PatchAdminRecipesShoppingListsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminRecipesShoppingListsByIdError = PatchAdminRecipesShoppingListsByIdErrors[keyof PatchAdminRecipesShoppingListsByIdErrors]; export type PatchAdminRecipesShoppingListsByIdResponses = { /** * Success */ 200: { data?: RecipesShoppingList; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminRecipesShoppingListsByIdResponse = PatchAdminRecipesShoppingListsByIdResponses[keyof PatchAdminRecipesShoppingListsByIdResponses]; export type PatchAdminEmailMarketingTemplatesByIdRestoreData = { /** * Request body for the /email-marketing/templates/:id/restore operation on email-marketing-template resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "email-marketing-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/templates/{id}/restore"; }; export type PatchAdminEmailMarketingTemplatesByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailMarketingTemplatesByIdRestoreError = PatchAdminEmailMarketingTemplatesByIdRestoreErrors[keyof PatchAdminEmailMarketingTemplatesByIdRestoreErrors]; export type PatchAdminEmailMarketingTemplatesByIdRestoreResponses = { /** * Success */ 200: { data?: EmailMarketingTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailMarketingTemplatesByIdRestoreResponse = PatchAdminEmailMarketingTemplatesByIdRestoreResponses[keyof PatchAdminEmailMarketingTemplatesByIdRestoreResponses]; export type PatchAdminWalletPlanData = { /** * Request body for the /wallet/plan operation on wallet resource */ body?: { data: { attributes?: { plan_id?: string | null; plan_slug?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "wallet"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/wallet/plan"; }; export type PatchAdminWalletPlanErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminWalletPlanError = PatchAdminWalletPlanErrors[keyof PatchAdminWalletPlanErrors]; export type PatchAdminWalletPlanResponses = { /** * Success */ 200: { data?: Wallet; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminWalletPlanResponse = PatchAdminWalletPlanResponses[keyof PatchAdminWalletPlanResponses]; export type GetAdminUsersMeStatsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { tenant_id?: string; }; url: "/admin/users/me/stats"; }; export type GetAdminUsersMeStatsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminUsersMeStatsError = GetAdminUsersMeStatsErrors[keyof GetAdminUsersMeStatsErrors]; export type GetAdminUsersMeStatsResponses = { /** * Success */ 200: { result: { [key: string]: unknown; }; }; }; export type GetAdminUsersMeStatsResponse = GetAdminUsersMeStatsResponses[keyof GetAdminUsersMeStatsResponses]; export type PatchAdminInvitationsByIdRevokeData = { /** * Request body for the /invitations/:id/revoke operation on invitation resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "invitation"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invitations/{id}/revoke"; }; export type PatchAdminInvitationsByIdRevokeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvitationsByIdRevokeError = PatchAdminInvitationsByIdRevokeErrors[keyof PatchAdminInvitationsByIdRevokeErrors]; export type PatchAdminInvitationsByIdRevokeResponses = { /** * Success */ 200: { data?: Invitation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvitationsByIdRevokeResponse = PatchAdminInvitationsByIdRevokeResponses[keyof PatchAdminInvitationsByIdRevokeResponses]; export type PostAdminEmailRecipientsData = { /** * Request body for the /email/recipients operation on email-recipient resource */ body: { data: { attributes?: { email: string; name?: string | null; outbound_email_id: string; recipient_type?: "bcc" | "cc" | "to"; }; relationships?: { [key: string]: never; }; type?: "email-recipient"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/recipients"; }; export type PostAdminEmailRecipientsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminEmailRecipientsError = PostAdminEmailRecipientsErrors[keyof PostAdminEmailRecipientsErrors]; export type PostAdminEmailRecipientsResponses = { /** * Success */ 201: { data?: EmailRecipient; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminEmailRecipientsResponse = PostAdminEmailRecipientsResponses[keyof PostAdminEmailRecipientsResponses]; export type DeleteAdminUsersByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/users/{id}"; }; export type DeleteAdminUsersByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminUsersByIdError = DeleteAdminUsersByIdErrors[keyof DeleteAdminUsersByIdErrors]; export type DeleteAdminUsersByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminUsersByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/users/{id}"; }; export type GetAdminUsersByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminUsersByIdError = GetAdminUsersByIdErrors[keyof GetAdminUsersByIdErrors]; export type GetAdminUsersByIdResponses = { /** * Success */ 200: { data?: User; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminUsersByIdResponse = GetAdminUsersByIdResponses[keyof GetAdminUsersByIdResponses]; export type PatchAdminUsersByIdData = { /** * Request body for the /users/:id operation on user resource */ body?: { data: { attributes?: { theme_preference?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "user"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/users/{id}"; }; export type PatchAdminUsersByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminUsersByIdError = PatchAdminUsersByIdErrors[keyof PatchAdminUsersByIdErrors]; export type PatchAdminUsersByIdResponses = { /** * Success */ 200: { data?: User; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminUsersByIdResponse = PatchAdminUsersByIdResponses[keyof PatchAdminUsersByIdResponses]; export type DeleteAdminClinicalClientResourceAssignmentsByIdPermanentData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-resource-assignments/{id}/permanent"; }; export type DeleteAdminClinicalClientResourceAssignmentsByIdPermanentErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalClientResourceAssignmentsByIdPermanentError = DeleteAdminClinicalClientResourceAssignmentsByIdPermanentErrors[keyof DeleteAdminClinicalClientResourceAssignmentsByIdPermanentErrors]; export type DeleteAdminClinicalClientResourceAssignmentsByIdPermanentResponses = { /** * Deleted successfully */ 200: unknown; }; export type DeleteAdminClinicalGoalTemplateCollectionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-template-collections/{id}"; }; export type DeleteAdminClinicalGoalTemplateCollectionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalGoalTemplateCollectionsByIdError = DeleteAdminClinicalGoalTemplateCollectionsByIdErrors[keyof DeleteAdminClinicalGoalTemplateCollectionsByIdErrors]; export type DeleteAdminClinicalGoalTemplateCollectionsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminClinicalGoalTemplateCollectionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-template-collections/{id}"; }; export type GetAdminClinicalGoalTemplateCollectionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalGoalTemplateCollectionsByIdError = GetAdminClinicalGoalTemplateCollectionsByIdErrors[keyof GetAdminClinicalGoalTemplateCollectionsByIdErrors]; export type GetAdminClinicalGoalTemplateCollectionsByIdResponses = { /** * Success */ 200: { data?: ClinicalGoalTemplateCollection; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalGoalTemplateCollectionsByIdResponse = GetAdminClinicalGoalTemplateCollectionsByIdResponses[keyof GetAdminClinicalGoalTemplateCollectionsByIdResponses]; export type PatchAdminClinicalGoalTemplateCollectionsByIdData = { /** * Request body for the /clinical/goal-template-collections/:id operation on clinical-goal-template-collection resource */ body?: { data: { attributes?: { description?: string | null; metadata?: { [key: string]: unknown; } | null; name?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-goal-template-collection"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-template-collections/{id}"; }; export type PatchAdminClinicalGoalTemplateCollectionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalGoalTemplateCollectionsByIdError = PatchAdminClinicalGoalTemplateCollectionsByIdErrors[keyof PatchAdminClinicalGoalTemplateCollectionsByIdErrors]; export type PatchAdminClinicalGoalTemplateCollectionsByIdResponses = { /** * Success */ 200: { data?: ClinicalGoalTemplateCollection; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalGoalTemplateCollectionsByIdResponse = PatchAdminClinicalGoalTemplateCollectionsByIdResponses[keyof PatchAdminClinicalGoalTemplateCollectionsByIdResponses]; export type PatchAdminSettlementStatementsByIdMarkDisputedData = { /** * Request body for the /settlement-statements/:id/mark-disputed operation on settlement-statement resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "settlement-statement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/settlement-statements/{id}/mark-disputed"; }; export type PatchAdminSettlementStatementsByIdMarkDisputedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSettlementStatementsByIdMarkDisputedError = PatchAdminSettlementStatementsByIdMarkDisputedErrors[keyof PatchAdminSettlementStatementsByIdMarkDisputedErrors]; export type PatchAdminSettlementStatementsByIdMarkDisputedResponses = { /** * Success */ 200: { data?: SettlementStatement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSettlementStatementsByIdMarkDisputedResponse = PatchAdminSettlementStatementsByIdMarkDisputedResponses[keyof PatchAdminSettlementStatementsByIdMarkDisputedResponses]; export type PostAdminClinicalGoalTemplateCollectionMembershipsData = { /** * Request body for the /clinical/goal-template-collection-memberships operation on clinical-goal-template-collection-membership resource */ body: { data: { attributes?: { collection_id: string; sort_order?: number | null; template_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-goal-template-collection-membership"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-template-collection-memberships"; }; export type PostAdminClinicalGoalTemplateCollectionMembershipsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalGoalTemplateCollectionMembershipsError = PostAdminClinicalGoalTemplateCollectionMembershipsErrors[keyof PostAdminClinicalGoalTemplateCollectionMembershipsErrors]; export type PostAdminClinicalGoalTemplateCollectionMembershipsResponses = { /** * Success */ 201: { data?: ClinicalGoalTemplateCollectionMembership; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalGoalTemplateCollectionMembershipsResponse = PostAdminClinicalGoalTemplateCollectionMembershipsResponses[keyof PostAdminClinicalGoalTemplateCollectionMembershipsResponses]; export type PostAdminWebhookConfigsBulkDisableData = { /** * Request body for the /webhook-configs/bulk-disable operation on webhook-config resource */ body: { data: { ids: Array; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/webhook-configs/bulk-disable"; }; export type PostAdminWebhookConfigsBulkDisableErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminWebhookConfigsBulkDisableError = PostAdminWebhookConfigsBulkDisableErrors[keyof PostAdminWebhookConfigsBulkDisableErrors]; export type PostAdminWebhookConfigsBulkDisableResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminWebhookConfigsBulkDisableResponse = PostAdminWebhookConfigsBulkDisableResponses[keyof PostAdminWebhookConfigsBulkDisableResponses]; export type GetAdminBreachNotificationsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/breach-notifications/{id}"; }; export type GetAdminBreachNotificationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminBreachNotificationsByIdError = GetAdminBreachNotificationsByIdErrors[keyof GetAdminBreachNotificationsByIdErrors]; export type GetAdminBreachNotificationsByIdResponses = { /** * Success */ 200: { data?: BreachNotification; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminBreachNotificationsByIdResponse = GetAdminBreachNotificationsByIdResponses[keyof GetAdminBreachNotificationsByIdResponses]; export type GetAdminLegalDocumentsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/legal-documents"; }; export type GetAdminLegalDocumentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminLegalDocumentsError = GetAdminLegalDocumentsErrors[keyof GetAdminLegalDocumentsErrors]; export type GetAdminLegalDocumentsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a legal-document */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminLegalDocumentsResponse = GetAdminLegalDocumentsResponses[keyof GetAdminLegalDocumentsResponses]; export type PostAdminLegalDocumentsData = { /** * Request body for the /legal-documents operation on legal-document resource */ body: { data: { attributes?: { active_from?: unknown; active_until?: unknown; application_id?: string | null; content: string; document_type: "terms_of_service" | "privacy_policy" | "baa" | "dpa" | "scc" | "npp" | "security_policy" | "incident_response_plan" | "contingency_plan" | "access_control_policy" | "risk_management_plan" | "training_policy" | "sanction_policy" | "breach_notification_policy" | "system_activity_review" | "data_retention_policy" | "minimum_necessary_policy" | "authorization_form"; is_active?: boolean | null; locale?: string | null; region?: string | null; requires_acceptance?: boolean | null; title: string; version: string; }; relationships?: { [key: string]: never; }; type?: "legal-document"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/legal-documents"; }; export type PostAdminLegalDocumentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminLegalDocumentsError = PostAdminLegalDocumentsErrors[keyof PostAdminLegalDocumentsErrors]; export type PostAdminLegalDocumentsResponses = { /** * Success */ 201: { data?: LegalDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminLegalDocumentsResponse = PostAdminLegalDocumentsResponses[keyof PostAdminLegalDocumentsResponses]; export type GetAdminAgentsByIdUsageData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { /** * Agent ID from URL path */ id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agents/{id}/usage"; }; export type GetAdminAgentsByIdUsageErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentsByIdUsageError = GetAdminAgentsByIdUsageErrors[keyof GetAdminAgentsByIdUsageErrors]; export type GetAdminAgentsByIdUsageResponses = { /** * Success */ 200: { data?: AgentUsage; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAgentsByIdUsageResponse = GetAdminAgentsByIdUsageResponses[keyof GetAdminAgentsByIdUsageResponses]; export type PatchAdminEmailMarketingGeneratedEmailsByIdScheduleData = { /** * Request body for the /email-marketing/generated-emails/:id/schedule operation on email-marketing-generated-email resource */ body?: { data: { attributes?: { scheduled_for?: unknown; }; id: string; relationships?: { [key: string]: never; }; type?: "email-marketing-generated-email"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/generated-emails/{id}/schedule"; }; export type PatchAdminEmailMarketingGeneratedEmailsByIdScheduleErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailMarketingGeneratedEmailsByIdScheduleError = PatchAdminEmailMarketingGeneratedEmailsByIdScheduleErrors[keyof PatchAdminEmailMarketingGeneratedEmailsByIdScheduleErrors]; export type PatchAdminEmailMarketingGeneratedEmailsByIdScheduleResponses = { /** * Success */ 200: { data?: EmailMarketingGeneratedEmail; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailMarketingGeneratedEmailsByIdScheduleResponse = PatchAdminEmailMarketingGeneratedEmailsByIdScheduleResponses[keyof PatchAdminEmailMarketingGeneratedEmailsByIdScheduleResponses]; export type DeleteAdminClinicalSupplementTemplateCollectionMembershipsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-template-collection-memberships/{id}"; }; export type DeleteAdminClinicalSupplementTemplateCollectionMembershipsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalSupplementTemplateCollectionMembershipsByIdError = DeleteAdminClinicalSupplementTemplateCollectionMembershipsByIdErrors[keyof DeleteAdminClinicalSupplementTemplateCollectionMembershipsByIdErrors]; export type DeleteAdminClinicalSupplementTemplateCollectionMembershipsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminClinicalSupplementTemplateCollectionMembershipsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-template-collection-memberships/{id}"; }; export type GetAdminClinicalSupplementTemplateCollectionMembershipsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalSupplementTemplateCollectionMembershipsByIdError = GetAdminClinicalSupplementTemplateCollectionMembershipsByIdErrors[keyof GetAdminClinicalSupplementTemplateCollectionMembershipsByIdErrors]; export type GetAdminClinicalSupplementTemplateCollectionMembershipsByIdResponses = { /** * Success */ 200: { data?: ClinicalSupplementTemplateCollectionMembership; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalSupplementTemplateCollectionMembershipsByIdResponse = GetAdminClinicalSupplementTemplateCollectionMembershipsByIdResponses[keyof GetAdminClinicalSupplementTemplateCollectionMembershipsByIdResponses]; export type PatchAdminClinicalSupplementTemplateCollectionMembershipsByIdData = { /** * Request body for the /clinical/supplement-template-collection-memberships/:id operation on clinical-supplement-template-collection-membership resource */ body?: { data: { attributes?: { sort_order?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-supplement-template-collection-membership"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-template-collection-memberships/{id}"; }; export type PatchAdminClinicalSupplementTemplateCollectionMembershipsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalSupplementTemplateCollectionMembershipsByIdError = PatchAdminClinicalSupplementTemplateCollectionMembershipsByIdErrors[keyof PatchAdminClinicalSupplementTemplateCollectionMembershipsByIdErrors]; export type PatchAdminClinicalSupplementTemplateCollectionMembershipsByIdResponses = { /** * Success */ 200: { data?: ClinicalSupplementTemplateCollectionMembership; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalSupplementTemplateCollectionMembershipsByIdResponse = PatchAdminClinicalSupplementTemplateCollectionMembershipsByIdResponses[keyof PatchAdminClinicalSupplementTemplateCollectionMembershipsByIdResponses]; export type GetAdminCatalogStockLocationsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/stock-locations/{id}"; }; export type GetAdminCatalogStockLocationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogStockLocationsByIdError = GetAdminCatalogStockLocationsByIdErrors[keyof GetAdminCatalogStockLocationsByIdErrors]; export type GetAdminCatalogStockLocationsByIdResponses = { /** * Success */ 200: { data?: CatalogStockLocation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogStockLocationsByIdResponse = GetAdminCatalogStockLocationsByIdResponses[keyof GetAdminCatalogStockLocationsByIdResponses]; export type PatchAdminCatalogStockLocationsByIdData = { /** * Request body for the /catalog/stock-locations/:id operation on catalog-stock-location resource */ body?: { data: { attributes?: { address?: { [key: string]: unknown; } | null; is_default?: boolean | null; name?: string | null; status?: "active" | "inactive"; valuation_method?: "weighted_average" | "fifo"; }; id: string; relationships?: { [key: string]: never; }; type?: "catalog-stock-location"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/stock-locations/{id}"; }; export type PatchAdminCatalogStockLocationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCatalogStockLocationsByIdError = PatchAdminCatalogStockLocationsByIdErrors[keyof PatchAdminCatalogStockLocationsByIdErrors]; export type PatchAdminCatalogStockLocationsByIdResponses = { /** * Success */ 200: { data?: CatalogStockLocation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCatalogStockLocationsByIdResponse = PatchAdminCatalogStockLocationsByIdResponses[keyof PatchAdminCatalogStockLocationsByIdResponses]; export type GetAdminEmailTrackingEventsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/tracking-events/{id}"; }; export type GetAdminEmailTrackingEventsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailTrackingEventsByIdError = GetAdminEmailTrackingEventsByIdErrors[keyof GetAdminEmailTrackingEventsByIdErrors]; export type GetAdminEmailTrackingEventsByIdResponses = { /** * Success */ 200: { data?: EmailTrackingEvent; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailTrackingEventsByIdResponse = GetAdminEmailTrackingEventsByIdResponses[keyof GetAdminEmailTrackingEventsByIdResponses]; export type DeleteAdminRecipesIngredientsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/ingredients/{id}"; }; export type DeleteAdminRecipesIngredientsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminRecipesIngredientsByIdError = DeleteAdminRecipesIngredientsByIdErrors[keyof DeleteAdminRecipesIngredientsByIdErrors]; export type DeleteAdminRecipesIngredientsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminRecipesIngredientsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/ingredients/{id}"; }; export type GetAdminRecipesIngredientsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesIngredientsByIdError = GetAdminRecipesIngredientsByIdErrors[keyof GetAdminRecipesIngredientsByIdErrors]; export type GetAdminRecipesIngredientsByIdResponses = { /** * Success */ 200: { data?: RecipesIngredient; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesIngredientsByIdResponse = GetAdminRecipesIngredientsByIdResponses[keyof GetAdminRecipesIngredientsByIdResponses]; export type PatchAdminRecipesIngredientsByIdData = { /** * Request body for the /recipes/ingredients/:id operation on recipes-ingredient resource */ body?: { data: { attributes?: { food_group?: string | null; food_item_id?: string | null; name?: string | null; preparation_note?: string | null; quantity?: number | null; sort_order?: number | null; unit?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "recipes-ingredient"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/ingredients/{id}"; }; export type PatchAdminRecipesIngredientsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminRecipesIngredientsByIdError = PatchAdminRecipesIngredientsByIdErrors[keyof PatchAdminRecipesIngredientsByIdErrors]; export type PatchAdminRecipesIngredientsByIdResponses = { /** * Success */ 200: { data?: RecipesIngredient; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminRecipesIngredientsByIdResponse = PatchAdminRecipesIngredientsByIdResponses[keyof PatchAdminRecipesIngredientsByIdResponses]; export type GetAdminClinicalPatientsByIdResourceAssignmentsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/patients/{id}/resource_assignments"; }; export type GetAdminClinicalPatientsByIdResourceAssignmentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPatientsByIdResourceAssignmentsError = GetAdminClinicalPatientsByIdResourceAssignmentsErrors[keyof GetAdminClinicalPatientsByIdResourceAssignmentsErrors]; export type GetAdminClinicalPatientsByIdResourceAssignmentsResponses = { /** * Success */ 200: { data?: ClinicalClientResourceAssignment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPatientsByIdResourceAssignmentsResponse = GetAdminClinicalPatientsByIdResourceAssignmentsResponses[keyof GetAdminClinicalPatientsByIdResourceAssignmentsResponses]; export type PatchAdminCaseTypesByIdActivateData = { /** * Request body for the /case-types/:id/activate operation on case-type resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "case-type"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/case-types/{id}/activate"; }; export type PatchAdminCaseTypesByIdActivateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCaseTypesByIdActivateError = PatchAdminCaseTypesByIdActivateErrors[keyof PatchAdminCaseTypesByIdActivateErrors]; export type PatchAdminCaseTypesByIdActivateResponses = { /** * Success */ 200: { data?: CaseType; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCaseTypesByIdActivateResponse = PatchAdminCaseTypesByIdActivateResponses[keyof PatchAdminCaseTypesByIdActivateResponses]; export type DeleteAdminEmailMarketingSenderProfilesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/sender-profiles/{id}"; }; export type DeleteAdminEmailMarketingSenderProfilesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminEmailMarketingSenderProfilesByIdError = DeleteAdminEmailMarketingSenderProfilesByIdErrors[keyof DeleteAdminEmailMarketingSenderProfilesByIdErrors]; export type DeleteAdminEmailMarketingSenderProfilesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminEmailMarketingSenderProfilesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/sender-profiles/{id}"; }; export type GetAdminEmailMarketingSenderProfilesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailMarketingSenderProfilesByIdError = GetAdminEmailMarketingSenderProfilesByIdErrors[keyof GetAdminEmailMarketingSenderProfilesByIdErrors]; export type GetAdminEmailMarketingSenderProfilesByIdResponses = { /** * Success */ 200: { data?: EmailMarketingSenderProfile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailMarketingSenderProfilesByIdResponse = GetAdminEmailMarketingSenderProfilesByIdResponses[keyof GetAdminEmailMarketingSenderProfilesByIdResponses]; export type PatchAdminEmailMarketingSenderProfilesByIdData = { /** * Request body for the /email-marketing/sender-profiles/:id operation on email-marketing-sender-profile resource */ body?: { data: { attributes?: { address?: string | null; company?: string | null; dkim_selector?: string | null; is_default?: boolean | null; name?: string | null; phone?: string | null; signature?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "email-marketing-sender-profile"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/sender-profiles/{id}"; }; export type PatchAdminEmailMarketingSenderProfilesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailMarketingSenderProfilesByIdError = PatchAdminEmailMarketingSenderProfilesByIdErrors[keyof PatchAdminEmailMarketingSenderProfilesByIdErrors]; export type PatchAdminEmailMarketingSenderProfilesByIdResponses = { /** * Success */ 200: { data?: EmailMarketingSenderProfile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailMarketingSenderProfilesByIdResponse = PatchAdminEmailMarketingSenderProfilesByIdResponses[keyof PatchAdminEmailMarketingSenderProfilesByIdResponses]; export type GetAdminApplicationsMeData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/applications/me"; }; export type GetAdminApplicationsMeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminApplicationsMeError = GetAdminApplicationsMeErrors[keyof GetAdminApplicationsMeErrors]; export type GetAdminApplicationsMeResponses = { /** * Success */ 200: { result: { [key: string]: unknown; }; }; }; export type GetAdminApplicationsMeResponse = GetAdminApplicationsMeResponses[keyof GetAdminApplicationsMeResponses]; export type GetAdminCatalogStockRecordsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/stock-records/{id}"; }; export type GetAdminCatalogStockRecordsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogStockRecordsByIdError = GetAdminCatalogStockRecordsByIdErrors[keyof GetAdminCatalogStockRecordsByIdErrors]; export type GetAdminCatalogStockRecordsByIdResponses = { /** * Success */ 200: { data?: CatalogStockRecord; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogStockRecordsByIdResponse = GetAdminCatalogStockRecordsByIdResponses[keyof GetAdminCatalogStockRecordsByIdResponses]; export type PatchAdminReviewsByIdRejectData = { /** * Request body for the /reviews/:id/reject operation on review resource */ body?: { data: { attributes?: { decision_payload?: { [key: string]: unknown; } | null; notes?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "review"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/reviews/{id}/reject"; }; export type PatchAdminReviewsByIdRejectErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminReviewsByIdRejectError = PatchAdminReviewsByIdRejectErrors[keyof PatchAdminReviewsByIdRejectErrors]; export type PatchAdminReviewsByIdRejectResponses = { /** * Success */ 200: { data?: Review; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminReviewsByIdRejectResponse = PatchAdminReviewsByIdRejectResponses[keyof PatchAdminReviewsByIdRejectResponses]; export type PatchAdminLegalDocumentsByIdUnpublishData = { /** * Request body for the /legal-documents/:id/unpublish operation on legal-document resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "legal-document"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/legal-documents/{id}/unpublish"; }; export type PatchAdminLegalDocumentsByIdUnpublishErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminLegalDocumentsByIdUnpublishError = PatchAdminLegalDocumentsByIdUnpublishErrors[keyof PatchAdminLegalDocumentsByIdUnpublishErrors]; export type PatchAdminLegalDocumentsByIdUnpublishResponses = { /** * Success */ 200: { data?: LegalDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminLegalDocumentsByIdUnpublishResponse = PatchAdminLegalDocumentsByIdUnpublishResponses[keyof PatchAdminLegalDocumentsByIdUnpublishResponses]; export type GetAdminLegalAcceptancesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/legal-acceptances/{id}"; }; export type GetAdminLegalAcceptancesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminLegalAcceptancesByIdError = GetAdminLegalAcceptancesByIdErrors[keyof GetAdminLegalAcceptancesByIdErrors]; export type GetAdminLegalAcceptancesByIdResponses = { /** * Success */ 200: { data?: LegalAcceptance; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminLegalAcceptancesByIdResponse = GetAdminLegalAcceptancesByIdResponses[keyof GetAdminLegalAcceptancesByIdResponses]; export type GetAdminExtractionAgentsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/agents"; }; export type GetAdminExtractionAgentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionAgentsError = GetAdminExtractionAgentsErrors[keyof GetAdminExtractionAgentsErrors]; export type GetAdminExtractionAgentsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a extraction-agent */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionAgentsResponse = GetAdminExtractionAgentsResponses[keyof GetAdminExtractionAgentsResponses]; export type PostAdminConnectorsFullscriptSessionGrantData = { /** * Request body for the /connectors/fullscript/session-grant operation on connector-instance resource */ body: { data: { connector_id: string; patient_id: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/connectors/fullscript/session-grant"; }; export type PostAdminConnectorsFullscriptSessionGrantErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsFullscriptSessionGrantError = PostAdminConnectorsFullscriptSessionGrantErrors[keyof PostAdminConnectorsFullscriptSessionGrantErrors]; export type PostAdminConnectorsFullscriptSessionGrantResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminConnectorsFullscriptSessionGrantResponse = PostAdminConnectorsFullscriptSessionGrantResponses[keyof PostAdminConnectorsFullscriptSessionGrantResponses]; export type GetAdminClinicalNoteTemplatesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/note-templates"; }; export type GetAdminClinicalNoteTemplatesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalNoteTemplatesError = GetAdminClinicalNoteTemplatesErrors[keyof GetAdminClinicalNoteTemplatesErrors]; export type GetAdminClinicalNoteTemplatesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-note-template */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalNoteTemplatesResponse = GetAdminClinicalNoteTemplatesResponses[keyof GetAdminClinicalNoteTemplatesResponses]; export type PostAdminClinicalNoteTemplatesData = { /** * Request body for the /clinical/note-templates operation on clinical-note-template resource */ body: { data: { attributes?: { category?: string | null; description?: string | null; metadata?: { [key: string]: unknown; } | null; note_type?: "soap" | "adime" | "progress" | "discharge" | "addendum"; sections?: { [key: string]: unknown; } | null; source_catalog_id?: string | null; tags?: Array | null; title: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-note-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/note-templates"; }; export type PostAdminClinicalNoteTemplatesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalNoteTemplatesError = PostAdminClinicalNoteTemplatesErrors[keyof PostAdminClinicalNoteTemplatesErrors]; export type PostAdminClinicalNoteTemplatesResponses = { /** * Success */ 201: { data?: ClinicalNoteTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalNoteTemplatesResponse = PostAdminClinicalNoteTemplatesResponses[keyof PostAdminClinicalNoteTemplatesResponses]; export type GetAdminWalletUsageData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; tenant_id?: string; }; url: "/admin/wallet/usage"; }; export type GetAdminWalletUsageErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWalletUsageError = GetAdminWalletUsageErrors[keyof GetAdminWalletUsageErrors]; export type GetAdminWalletUsageResponses = { /** * Success */ 200: { data?: Wallet; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWalletUsageResponse = GetAdminWalletUsageResponses[keyof GetAdminWalletUsageResponses]; export type PostAdminEmailInclusionsData = { /** * Request body for the /email/inclusions operation on email-inclusion resource */ body: { data: { attributes?: { data?: { [key: string]: unknown; } | null; inclusion_type: "chart" | "custom" | "goal" | "metric" | "resource" | "supplement"; outbound_email_id: string; position?: number | null; ref_id?: string | null; title?: string | null; }; relationships?: { [key: string]: never; }; type?: "email-inclusion"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/inclusions"; }; export type PostAdminEmailInclusionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminEmailInclusionsError = PostAdminEmailInclusionsErrors[keyof PostAdminEmailInclusionsErrors]; export type PostAdminEmailInclusionsResponses = { /** * Success */ 201: { data?: EmailInclusion; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminEmailInclusionsResponse = PostAdminEmailInclusionsResponses[keyof PostAdminEmailInclusionsResponses]; export type DeleteAdminSupportSlaPoliciesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/sla-policies/{id}"; }; export type DeleteAdminSupportSlaPoliciesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminSupportSlaPoliciesByIdError = DeleteAdminSupportSlaPoliciesByIdErrors[keyof DeleteAdminSupportSlaPoliciesByIdErrors]; export type DeleteAdminSupportSlaPoliciesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminSupportSlaPoliciesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/sla-policies/{id}"; }; export type GetAdminSupportSlaPoliciesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSupportSlaPoliciesByIdError = GetAdminSupportSlaPoliciesByIdErrors[keyof GetAdminSupportSlaPoliciesByIdErrors]; export type GetAdminSupportSlaPoliciesByIdResponses = { /** * Success */ 200: { data?: SupportSlaPolicy; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSupportSlaPoliciesByIdResponse = GetAdminSupportSlaPoliciesByIdResponses[keyof GetAdminSupportSlaPoliciesByIdResponses]; export type PatchAdminSupportSlaPoliciesByIdData = { /** * Request body for the /support/sla-policies/:id operation on support-sla-policy resource */ body?: { data: { attributes?: { business_hours_only?: boolean | null; first_response_target?: number | null; name?: string | null; priority_filter?: Array | null; resolution_target?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "support-sla-policy"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/sla-policies/{id}"; }; export type PatchAdminSupportSlaPoliciesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSupportSlaPoliciesByIdError = PatchAdminSupportSlaPoliciesByIdErrors[keyof PatchAdminSupportSlaPoliciesByIdErrors]; export type PatchAdminSupportSlaPoliciesByIdResponses = { /** * Success */ 200: { data?: SupportSlaPolicy; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSupportSlaPoliciesByIdResponse = PatchAdminSupportSlaPoliciesByIdResponses[keyof PatchAdminSupportSlaPoliciesByIdResponses]; export type GetAdminSocialMetricsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/metrics/{id}"; }; export type GetAdminSocialMetricsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialMetricsByIdError = GetAdminSocialMetricsByIdErrors[keyof GetAdminSocialMetricsByIdErrors]; export type GetAdminSocialMetricsByIdResponses = { /** * Success */ 200: { data?: PostMetric; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialMetricsByIdResponse = GetAdminSocialMetricsByIdResponses[keyof GetAdminSocialMetricsByIdResponses]; export type DeleteAdminApplicationsByApplicationIdEmailTemplatesBySlugData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { slug: string; application_id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/applications/{application_id}/email-templates/{slug}"; }; export type DeleteAdminApplicationsByApplicationIdEmailTemplatesBySlugErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminApplicationsByApplicationIdEmailTemplatesBySlugError = DeleteAdminApplicationsByApplicationIdEmailTemplatesBySlugErrors[keyof DeleteAdminApplicationsByApplicationIdEmailTemplatesBySlugErrors]; export type DeleteAdminApplicationsByApplicationIdEmailTemplatesBySlugResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminApplicationsByApplicationIdEmailTemplatesBySlugData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { application_id: string; slug: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/applications/{application_id}/email-templates/{slug}"; }; export type GetAdminApplicationsByApplicationIdEmailTemplatesBySlugErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminApplicationsByApplicationIdEmailTemplatesBySlugError = GetAdminApplicationsByApplicationIdEmailTemplatesBySlugErrors[keyof GetAdminApplicationsByApplicationIdEmailTemplatesBySlugErrors]; export type GetAdminApplicationsByApplicationIdEmailTemplatesBySlugResponses = { /** * Success */ 200: { data?: EmailTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminApplicationsByApplicationIdEmailTemplatesBySlugResponse = GetAdminApplicationsByApplicationIdEmailTemplatesBySlugResponses[keyof GetAdminApplicationsByApplicationIdEmailTemplatesBySlugResponses]; export type PatchAdminApplicationsByApplicationIdEmailTemplatesBySlugData = { /** * Request body for the /applications/:application_id/email-templates/:slug operation on email-template resource */ body?: { data: { attributes?: { /** * Email body in markdown (supports {{variable}} interpolation) */ body_markdown?: string | null; /** * Whether this email is sent */ enabled?: boolean | null; /** * Display name for the template */ name?: string | null; /** * Primary brand color for email styling (hex) */ primary_color?: string | null; /** * Email subject line (supports {{variable}} interpolation) */ subject?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "email-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { slug: string; application_id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/applications/{application_id}/email-templates/{slug}"; }; export type PatchAdminApplicationsByApplicationIdEmailTemplatesBySlugErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminApplicationsByApplicationIdEmailTemplatesBySlugError = PatchAdminApplicationsByApplicationIdEmailTemplatesBySlugErrors[keyof PatchAdminApplicationsByApplicationIdEmailTemplatesBySlugErrors]; export type PatchAdminApplicationsByApplicationIdEmailTemplatesBySlugResponses = { /** * Success */ 200: { data?: EmailTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminApplicationsByApplicationIdEmailTemplatesBySlugResponse = PatchAdminApplicationsByApplicationIdEmailTemplatesBySlugResponses[keyof PatchAdminApplicationsByApplicationIdEmailTemplatesBySlugResponses]; export type DeleteAdminSupportRoutingRulesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/routing-rules/{id}"; }; export type DeleteAdminSupportRoutingRulesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminSupportRoutingRulesByIdError = DeleteAdminSupportRoutingRulesByIdErrors[keyof DeleteAdminSupportRoutingRulesByIdErrors]; export type DeleteAdminSupportRoutingRulesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminSupportRoutingRulesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/routing-rules/{id}"; }; export type GetAdminSupportRoutingRulesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSupportRoutingRulesByIdError = GetAdminSupportRoutingRulesByIdErrors[keyof GetAdminSupportRoutingRulesByIdErrors]; export type GetAdminSupportRoutingRulesByIdResponses = { /** * Success */ 200: { data?: SupportRoutingRule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSupportRoutingRulesByIdResponse = GetAdminSupportRoutingRulesByIdResponses[keyof GetAdminSupportRoutingRulesByIdResponses]; export type PatchAdminSupportRoutingRulesByIdData = { /** * Request body for the /support/routing-rules/:id operation on support-routing-rule resource */ body?: { data: { attributes?: { action?: "assign_queue" | "assign_queue_and_priority" | "assign_queue_and_tag"; /** * Parameters for the action (e.g., priority_override, tag). Separate from conditions. */ action_params?: { [key: string]: unknown; } | null; conditions?: { [key: string]: unknown; } | null; priority?: number | null; queue_id?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "support-routing-rule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/routing-rules/{id}"; }; export type PatchAdminSupportRoutingRulesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSupportRoutingRulesByIdError = PatchAdminSupportRoutingRulesByIdErrors[keyof PatchAdminSupportRoutingRulesByIdErrors]; export type PatchAdminSupportRoutingRulesByIdResponses = { /** * Success */ 200: { data?: SupportRoutingRule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSupportRoutingRulesByIdResponse = PatchAdminSupportRoutingRulesByIdResponses[keyof PatchAdminSupportRoutingRulesByIdResponses]; export type PostAdminAiSearchAdvancedData = { /** * Request body for the /ai/search/advanced operation on search resource */ body: { data: { attributes?: { date_from?: unknown; date_to?: unknown; document_types?: Array | null; query: string; top_k?: number | null; workspace_ids?: Array | null; }; relationships?: { [key: string]: never; }; type?: "search"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ai/search/advanced"; }; export type PostAdminAiSearchAdvancedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAiSearchAdvancedError = PostAdminAiSearchAdvancedErrors[keyof PostAdminAiSearchAdvancedErrors]; export type PostAdminAiSearchAdvancedResponses = { /** * Success */ 201: { data?: Search; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAiSearchAdvancedResponse = PostAdminAiSearchAdvancedResponses[keyof PostAdminAiSearchAdvancedResponses]; export type GetAdminWorkspacePreferencesByKeyData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; context_key: string; }; url: "/admin/workspace-preferences/by_key"; }; export type GetAdminWorkspacePreferencesByKeyErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWorkspacePreferencesByKeyError = GetAdminWorkspacePreferencesByKeyErrors[keyof GetAdminWorkspacePreferencesByKeyErrors]; export type GetAdminWorkspacePreferencesByKeyResponses = { /** * Success */ 200: { data?: WorkspacePreference; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWorkspacePreferencesByKeyResponse = GetAdminWorkspacePreferencesByKeyResponses[keyof GetAdminWorkspacePreferencesByKeyResponses]; export type GetAdminPipelineNodesByPipelineByPipelineIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { pipeline_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pipeline-nodes/by-pipeline/{pipeline_id}"; }; export type GetAdminPipelineNodesByPipelineByPipelineIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPipelineNodesByPipelineByPipelineIdError = GetAdminPipelineNodesByPipelineByPipelineIdErrors[keyof GetAdminPipelineNodesByPipelineByPipelineIdErrors]; export type GetAdminPipelineNodesByPipelineByPipelineIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a pipeline-node */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPipelineNodesByPipelineByPipelineIdResponse = GetAdminPipelineNodesByPipelineByPipelineIdResponses[keyof GetAdminPipelineNodesByPipelineByPipelineIdResponses]; export type GetAdminAuditLogsCountByActionData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { tenant_id: string; workspace_id?: string; }; url: "/admin/audit-logs/count-by-action"; }; export type GetAdminAuditLogsCountByActionErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAuditLogsCountByActionError = GetAdminAuditLogsCountByActionErrors[keyof GetAdminAuditLogsCountByActionErrors]; export type GetAdminAuditLogsCountByActionResponses = { /** * Success */ 200: Array<{ [key: string]: unknown; }>; }; export type GetAdminAuditLogsCountByActionResponse = GetAdminAuditLogsCountByActionResponses[keyof GetAdminAuditLogsCountByActionResponses]; export type PatchAdminWorkspacesByIdStorageSettingsData = { /** * Request body for the /workspaces/:id/storage-settings operation on workspace resource */ body?: { data: { attributes?: { settings?: WorkspaceSettingsInputUpdateType; }; id: string; relationships?: { [key: string]: never; }; type?: "workspace"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspaces/{id}/storage-settings"; }; export type PatchAdminWorkspacesByIdStorageSettingsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminWorkspacesByIdStorageSettingsError = PatchAdminWorkspacesByIdStorageSettingsErrors[keyof PatchAdminWorkspacesByIdStorageSettingsErrors]; export type PatchAdminWorkspacesByIdStorageSettingsResponses = { /** * Success */ 200: { data?: Workspace; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminWorkspacesByIdStorageSettingsResponse = PatchAdminWorkspacesByIdStorageSettingsResponses[keyof PatchAdminWorkspacesByIdStorageSettingsResponses]; export type GetAdminStorageFilesByChecksumData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; checksum: string; }; url: "/admin/storage-files/by-checksum"; }; export type GetAdminStorageFilesByChecksumErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminStorageFilesByChecksumError = GetAdminStorageFilesByChecksumErrors[keyof GetAdminStorageFilesByChecksumErrors]; export type GetAdminStorageFilesByChecksumResponses = { /** * Success */ 200: { data?: StorageFile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminStorageFilesByChecksumResponse = GetAdminStorageFilesByChecksumResponses[keyof GetAdminStorageFilesByChecksumResponses]; export type PatchAdminLegalDocumentsByIdPublishData = { /** * Request body for the /legal-documents/:id/publish operation on legal-document resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "legal-document"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/legal-documents/{id}/publish"; }; export type PatchAdminLegalDocumentsByIdPublishErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminLegalDocumentsByIdPublishError = PatchAdminLegalDocumentsByIdPublishErrors[keyof PatchAdminLegalDocumentsByIdPublishErrors]; export type PatchAdminLegalDocumentsByIdPublishResponses = { /** * Success */ 200: { data?: LegalDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminLegalDocumentsByIdPublishResponse = PatchAdminLegalDocumentsByIdPublishResponses[keyof PatchAdminLegalDocumentsByIdPublishResponses]; export type PatchAdminAmendmentRequestsByIdReviewData = { /** * Request body for the /amendment-requests/:id/review operation on amendment-request resource */ body?: { data: { attributes?: { reviewed_by_id?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "amendment-request"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/amendment-requests/{id}/review"; }; export type PatchAdminAmendmentRequestsByIdReviewErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminAmendmentRequestsByIdReviewError = PatchAdminAmendmentRequestsByIdReviewErrors[keyof PatchAdminAmendmentRequestsByIdReviewErrors]; export type PatchAdminAmendmentRequestsByIdReviewResponses = { /** * Success */ 200: { data?: AmendmentRequest; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminAmendmentRequestsByIdReviewResponse = PatchAdminAmendmentRequestsByIdReviewResponses[keyof PatchAdminAmendmentRequestsByIdReviewResponses]; export type PostAdminSearchBatchData = { /** * Request body for the /search/batch operation on search resource */ body: { data: { attributes?: { queries: Array; }; relationships?: { [key: string]: never; }; type?: "search"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/search/batch"; }; export type PostAdminSearchBatchErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSearchBatchError = PostAdminSearchBatchErrors[keyof PostAdminSearchBatchErrors]; export type PostAdminSearchBatchResponses = { /** * Success */ 201: { data?: Search; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSearchBatchResponse = PostAdminSearchBatchResponses[keyof PostAdminSearchBatchResponses]; export type PostAdminRecipesFavoritesData = { /** * Request body for the /recipes/favorites operation on recipes-recipe-favorite resource */ body: { data: { attributes?: { contact_id?: string | null; meal_type?: string | null; notes?: string | null; rating?: number | null; recipe_id: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "recipes-recipe-favorite"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/favorites"; }; export type PostAdminRecipesFavoritesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminRecipesFavoritesError = PostAdminRecipesFavoritesErrors[keyof PostAdminRecipesFavoritesErrors]; export type PostAdminRecipesFavoritesResponses = { /** * Success */ 201: { data?: RecipesRecipeFavorite; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminRecipesFavoritesResponse = PostAdminRecipesFavoritesResponses[keyof PostAdminRecipesFavoritesResponses]; export type PostAdminCatalogStockLocationsData = { /** * Request body for the /catalog/stock-locations operation on catalog-stock-location resource */ body: { data: { attributes?: { address?: { [key: string]: unknown; } | null; application_id?: string | null; is_default?: boolean | null; name: string; slug: string; status?: "active" | "inactive"; type: "warehouse" | "store" | "virtual" | "drop_ship" | "in_transit"; valuation_method?: "weighted_average" | "fifo"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "catalog-stock-location"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/stock-locations"; }; export type PostAdminCatalogStockLocationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCatalogStockLocationsError = PostAdminCatalogStockLocationsErrors[keyof PostAdminCatalogStockLocationsErrors]; export type PostAdminCatalogStockLocationsResponses = { /** * Success */ 201: { data?: CatalogStockLocation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCatalogStockLocationsResponse = PostAdminCatalogStockLocationsResponses[keyof PostAdminCatalogStockLocationsResponses]; export type GetAdminExtractionBatchesWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/batches/workspace/{workspace_id}"; }; export type GetAdminExtractionBatchesWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionBatchesWorkspaceByWorkspaceIdError = GetAdminExtractionBatchesWorkspaceByWorkspaceIdErrors[keyof GetAdminExtractionBatchesWorkspaceByWorkspaceIdErrors]; export type GetAdminExtractionBatchesWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a extraction-batch */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionBatchesWorkspaceByWorkspaceIdResponse = GetAdminExtractionBatchesWorkspaceByWorkspaceIdResponses[keyof GetAdminExtractionBatchesWorkspaceByWorkspaceIdResponses]; export type GetAdminClinicalClientGoalsArchivedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/client-goals/archived"; }; export type GetAdminClinicalClientGoalsArchivedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalClientGoalsArchivedError = GetAdminClinicalClientGoalsArchivedErrors[keyof GetAdminClinicalClientGoalsArchivedErrors]; export type GetAdminClinicalClientGoalsArchivedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-client-goal */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalClientGoalsArchivedResponse = GetAdminClinicalClientGoalsArchivedResponses[keyof GetAdminClinicalClientGoalsArchivedResponses]; export type PostAdminPlanBundlesPublishData = { /** * Request body for the /plan-bundles/publish operation on plan-bundle resource */ body: { data: { /** * When true (and `reason` is supplied), overrides the hard-block margin gate and records an audit row. */ ack_below_floor?: boolean | null; /** * When true (and `reason` is supplied), proceeds with the Plan upsert even when the Plan has active subscribers and a pricing-relevant attribute is changing. Without it, the publish is rejected with 422 `plan_edit_affects_subscribers`. Records an audit row (`plan_revised_with_active_subscribers`) AFTER commit. */ ack_plan_revision?: boolean | null; /** * Optional — when omitted, resolved from x-application-key header context. Required when calling from a context without an application-scoped key. */ application_id?: string | null; bundle: { [key: string]: unknown; }; /** * When true, run the pre-publish checklist and return the result without persisting anything. */ dry_run?: boolean | null; /** * Required when either `ack_below_floor: true` or `ack_plan_revision: true`. ≤ 280 chars. When both acks are set, the same reason is recorded on both audit rows. */ reason?: string | null; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/plan-bundles/publish"; }; export type PostAdminPlanBundlesPublishErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminPlanBundlesPublishError = PostAdminPlanBundlesPublishErrors[keyof PostAdminPlanBundlesPublishErrors]; export type PostAdminPlanBundlesPublishResponses = { /** * Success */ 201: { result: { [key: string]: unknown; }; }; }; export type PostAdminPlanBundlesPublishResponse = PostAdminPlanBundlesPublishResponses[keyof PostAdminPlanBundlesPublishResponses]; export type PatchAdminSettlementsByIdMarkFailedData = { /** * Request body for the /settlements/:id/mark-failed operation on settlement resource */ body?: { data: { attributes?: { /** * Error message if settlement failed */ error_message?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "settlement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/settlements/{id}/mark-failed"; }; export type PatchAdminSettlementsByIdMarkFailedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSettlementsByIdMarkFailedError = PatchAdminSettlementsByIdMarkFailedErrors[keyof PatchAdminSettlementsByIdMarkFailedErrors]; export type PatchAdminSettlementsByIdMarkFailedResponses = { /** * Success */ 200: { data?: Settlement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSettlementsByIdMarkFailedResponse = PatchAdminSettlementsByIdMarkFailedResponses[keyof PatchAdminSettlementsByIdMarkFailedResponses]; export type GetAdminClinicalInsuranceAuthorizationsExpiringData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; units_threshold?: number; }; url: "/admin/clinical/insurance-authorizations/expiring"; }; export type GetAdminClinicalInsuranceAuthorizationsExpiringErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalInsuranceAuthorizationsExpiringError = GetAdminClinicalInsuranceAuthorizationsExpiringErrors[keyof GetAdminClinicalInsuranceAuthorizationsExpiringErrors]; export type GetAdminClinicalInsuranceAuthorizationsExpiringResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-insurance-authorization */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalInsuranceAuthorizationsExpiringResponse = GetAdminClinicalInsuranceAuthorizationsExpiringResponses[keyof GetAdminClinicalInsuranceAuthorizationsExpiringResponses]; export type GetAdminPlatformTonesByBrandByBrandIdentityIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { brand_identity_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/platform-tones/by-brand/{brand_identity_id}"; }; export type GetAdminPlatformTonesByBrandByBrandIdentityIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPlatformTonesByBrandByBrandIdentityIdError = GetAdminPlatformTonesByBrandByBrandIdentityIdErrors[keyof GetAdminPlatformTonesByBrandByBrandIdentityIdErrors]; export type GetAdminPlatformTonesByBrandByBrandIdentityIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a platform-tone */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPlatformTonesByBrandByBrandIdentityIdResponse = GetAdminPlatformTonesByBrandByBrandIdentityIdResponses[keyof GetAdminPlatformTonesByBrandByBrandIdentityIdResponses]; export type GetAdminClinicalIntakeTargetsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/intake-targets/{id}"; }; export type GetAdminClinicalIntakeTargetsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalIntakeTargetsByIdError = GetAdminClinicalIntakeTargetsByIdErrors[keyof GetAdminClinicalIntakeTargetsByIdErrors]; export type GetAdminClinicalIntakeTargetsByIdResponses = { /** * Success */ 200: { data?: ClinicalIntakeTarget; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalIntakeTargetsByIdResponse = GetAdminClinicalIntakeTargetsByIdResponses[keyof GetAdminClinicalIntakeTargetsByIdResponses]; export type PatchAdminClinicalIntakeTargetsByIdData = { /** * Request body for the /clinical/intake-targets/:id operation on clinical-intake-target resource */ body?: { data: { attributes?: { activity_level?: "sedentary" | "lightly_active" | "moderately_active" | "very_active" | "extremely_active"; age?: number | null; bmr?: string | number | unknown; calorie_adjustment?: number | null; carbs_grams?: string | number | unknown; carbs_pct?: number | null; condition_rules?: Array | null; fat_grams?: string | number | unknown; fat_pct?: number | null; fruit_pct?: number | null; goal_direction?: "lose" | "maintain" | "gain"; height_cm?: string | number | unknown; hydration_ml?: string | number | unknown; macro_mode?: "percentage" | "body_weight_protein" | "hybrid"; meals_per_day?: number | null; metadata?: { [key: string]: unknown; } | null; notes?: string | null; protein_g_per_kg?: string | number | unknown; protein_grams?: string | number | unknown; protein_pct?: number | null; rate_lbs_per_week?: string | number | unknown; sex?: "male" | "female"; simple_carbs_pct?: number | null; snacks_per_day?: number | null; target_calories?: number | null; tdee?: string | number | unknown; vegetables_pct?: number | null; weight_kg?: string | number | unknown; weight_method?: "actual" | "ideal" | "adjusted"; weight_used_kg?: string | number | unknown; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-intake-target"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/intake-targets/{id}"; }; export type PatchAdminClinicalIntakeTargetsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalIntakeTargetsByIdError = PatchAdminClinicalIntakeTargetsByIdErrors[keyof PatchAdminClinicalIntakeTargetsByIdErrors]; export type PatchAdminClinicalIntakeTargetsByIdResponses = { /** * Success */ 200: { data?: ClinicalIntakeTarget; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalIntakeTargetsByIdResponse = PatchAdminClinicalIntakeTargetsByIdResponses[keyof PatchAdminClinicalIntakeTargetsByIdResponses]; export type DeleteAdminInvoicesRulesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/rules/{id}"; }; export type DeleteAdminInvoicesRulesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminInvoicesRulesByIdError = DeleteAdminInvoicesRulesByIdErrors[keyof DeleteAdminInvoicesRulesByIdErrors]; export type DeleteAdminInvoicesRulesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminInvoicesRulesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/rules/{id}"; }; export type GetAdminInvoicesRulesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminInvoicesRulesByIdError = GetAdminInvoicesRulesByIdErrors[keyof GetAdminInvoicesRulesByIdErrors]; export type GetAdminInvoicesRulesByIdResponses = { /** * Success */ 200: { data?: InvoicesRule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminInvoicesRulesByIdResponse = GetAdminInvoicesRulesByIdResponses[keyof GetAdminInvoicesRulesByIdResponses]; export type PatchAdminInvoicesRulesByIdData = { /** * Request body for the /invoices/rules/:id operation on invoices-rule resource */ body?: { data: { attributes?: { actions?: { [key: string]: unknown; } | null; active?: boolean | null; conditions?: { [key: string]: unknown; } | null; confidence?: string | number | unknown; metadata?: { [key: string]: unknown; } | null; name?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "invoices-rule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/rules/{id}"; }; export type PatchAdminInvoicesRulesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvoicesRulesByIdError = PatchAdminInvoicesRulesByIdErrors[keyof PatchAdminInvoicesRulesByIdErrors]; export type PatchAdminInvoicesRulesByIdResponses = { /** * Success */ 200: { data?: InvoicesRule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvoicesRulesByIdResponse = PatchAdminInvoicesRulesByIdResponses[keyof PatchAdminInvoicesRulesByIdResponses]; export type PostAdminThreadsByIdForkData = { /** * Request body for the /threads/:id/fork operation on chat-thread resource */ body?: { data: { attributes?: { title?: string | null; }; relationships?: { [key: string]: never; }; type?: "chat-thread"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/threads/{id}/fork"; }; export type PostAdminThreadsByIdForkErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminThreadsByIdForkError = PostAdminThreadsByIdForkErrors[keyof PostAdminThreadsByIdForkErrors]; export type PostAdminThreadsByIdForkResponses = { /** * Success */ 201: { data?: ChatThread; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminThreadsByIdForkResponse = PostAdminThreadsByIdForkResponses[keyof PostAdminThreadsByIdForkResponses]; export type PatchAdminClinicalClientGoalsByIdRestoreData = { /** * Request body for the /clinical/client-goals/:id/restore operation on clinical-client-goal resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-client-goal"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-goals/{id}/restore"; }; export type PatchAdminClinicalClientGoalsByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalClientGoalsByIdRestoreError = PatchAdminClinicalClientGoalsByIdRestoreErrors[keyof PatchAdminClinicalClientGoalsByIdRestoreErrors]; export type PatchAdminClinicalClientGoalsByIdRestoreResponses = { /** * Success */ 200: { data?: ClinicalClientGoal; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalClientGoalsByIdRestoreResponse = PatchAdminClinicalClientGoalsByIdRestoreResponses[keyof PatchAdminClinicalClientGoalsByIdRestoreResponses]; export type GetAdminEmailMarketingGeneratedEmailsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/generated-emails/{id}"; }; export type GetAdminEmailMarketingGeneratedEmailsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailMarketingGeneratedEmailsByIdError = GetAdminEmailMarketingGeneratedEmailsByIdErrors[keyof GetAdminEmailMarketingGeneratedEmailsByIdErrors]; export type GetAdminEmailMarketingGeneratedEmailsByIdResponses = { /** * Success */ 200: { data?: EmailMarketingGeneratedEmail; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailMarketingGeneratedEmailsByIdResponse = GetAdminEmailMarketingGeneratedEmailsByIdResponses[keyof GetAdminEmailMarketingGeneratedEmailsByIdResponses]; export type PatchAdminEmailMarketingGeneratedEmailsByIdData = { /** * Request body for the /email-marketing/generated-emails/:id operation on email-marketing-generated-email resource */ body?: { data: { attributes?: { body?: string | null; subject?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "email-marketing-generated-email"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/generated-emails/{id}"; }; export type PatchAdminEmailMarketingGeneratedEmailsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailMarketingGeneratedEmailsByIdError = PatchAdminEmailMarketingGeneratedEmailsByIdErrors[keyof PatchAdminEmailMarketingGeneratedEmailsByIdErrors]; export type PatchAdminEmailMarketingGeneratedEmailsByIdResponses = { /** * Success */ 200: { data?: EmailMarketingGeneratedEmail; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailMarketingGeneratedEmailsByIdResponse = PatchAdminEmailMarketingGeneratedEmailsByIdResponses[keyof PatchAdminEmailMarketingGeneratedEmailsByIdResponses]; export type GetAdminWorkspacePreferencesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; /** * Optional prefix filter on context_key */ prefix?: string; }; url: "/admin/workspace-preferences"; }; export type GetAdminWorkspacePreferencesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWorkspacePreferencesError = GetAdminWorkspacePreferencesErrors[keyof GetAdminWorkspacePreferencesErrors]; export type GetAdminWorkspacePreferencesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a workspace-preference */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWorkspacePreferencesResponse = GetAdminWorkspacePreferencesResponses[keyof GetAdminWorkspacePreferencesResponses]; export type GetAdminInvitationsMeData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; /** * Ignored. Scope is always the authenticated actor's identity. The * argument is retained for backwards compatibility with SDK clients * that still send it; supplying a different user_id never widens the * result set. * */ user_id?: string; }; url: "/admin/invitations/me"; }; export type GetAdminInvitationsMeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminInvitationsMeError = GetAdminInvitationsMeErrors[keyof GetAdminInvitationsMeErrors]; export type GetAdminInvitationsMeResponses = { /** * Success */ 200: { /** * An array of resource objects representing a invitation */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminInvitationsMeResponse = GetAdminInvitationsMeResponses[keyof GetAdminInvitationsMeResponses]; export type GetAdminScanResultsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scan-results"; }; export type GetAdminScanResultsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminScanResultsError = GetAdminScanResultsErrors[keyof GetAdminScanResultsErrors]; export type GetAdminScanResultsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a scan-result */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminScanResultsResponse = GetAdminScanResultsResponses[keyof GetAdminScanResultsResponses]; export type DeleteAdminDataTransferRecordsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/data-transfer-records/{id}"; }; export type DeleteAdminDataTransferRecordsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminDataTransferRecordsByIdError = DeleteAdminDataTransferRecordsByIdErrors[keyof DeleteAdminDataTransferRecordsByIdErrors]; export type DeleteAdminDataTransferRecordsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminDataTransferRecordsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/data-transfer-records/{id}"; }; export type GetAdminDataTransferRecordsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminDataTransferRecordsByIdError = GetAdminDataTransferRecordsByIdErrors[keyof GetAdminDataTransferRecordsByIdErrors]; export type GetAdminDataTransferRecordsByIdResponses = { /** * Success */ 200: { data?: DataTransferRecord; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminDataTransferRecordsByIdResponse = GetAdminDataTransferRecordsByIdResponses[keyof GetAdminDataTransferRecordsByIdResponses]; export type GetAdminConnectorsCredentialsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/connectors/credentials"; }; export type GetAdminConnectorsCredentialsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminConnectorsCredentialsError = GetAdminConnectorsCredentialsErrors[keyof GetAdminConnectorsCredentialsErrors]; export type GetAdminConnectorsCredentialsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a credential */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminConnectorsCredentialsResponse = GetAdminConnectorsCredentialsResponses[keyof GetAdminConnectorsCredentialsResponses]; export type PatchAdminSubscriptionsByIdSetRateLimitOverridesData = { /** * Request body for the /subscriptions/:id/set-rate-limit-overrides operation on subscription resource */ body?: { data: { attributes?: { /** * Per-subscription override of `plan.concurrent_operations_limit`. * */ concurrent_operations_limit_override?: number | null; /** * Per-subscription override of `plan.rate_limit_period_seconds`. * */ rate_limit_period_seconds_override?: number | null; /** * Per-subscription override of `plan.rate_limit_requests`. When set, must * be > 0. Settable only via the `:set_rate_limit_overrides` action by * Platform Admin or Application Owner. * */ rate_limit_requests_override?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "subscription"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/subscriptions/{id}/set-rate-limit-overrides"; }; export type PatchAdminSubscriptionsByIdSetRateLimitOverridesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSubscriptionsByIdSetRateLimitOverridesError = PatchAdminSubscriptionsByIdSetRateLimitOverridesErrors[keyof PatchAdminSubscriptionsByIdSetRateLimitOverridesErrors]; export type PatchAdminSubscriptionsByIdSetRateLimitOverridesResponses = { /** * Success */ 200: { data?: Subscription; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSubscriptionsByIdSetRateLimitOverridesResponse = PatchAdminSubscriptionsByIdSetRateLimitOverridesResponses[keyof PatchAdminSubscriptionsByIdSetRateLimitOverridesResponses]; export type GetAdminNotificationLogsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/notification-logs"; }; export type GetAdminNotificationLogsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminNotificationLogsError = GetAdminNotificationLogsErrors[keyof GetAdminNotificationLogsErrors]; export type GetAdminNotificationLogsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a notification-log */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminNotificationLogsResponse = GetAdminNotificationLogsResponses[keyof GetAdminNotificationLogsResponses]; export type GetAdminCatalogOptionTypesApplicationByApplicationIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { application_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/option-types/application/{application_id}"; }; export type GetAdminCatalogOptionTypesApplicationByApplicationIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogOptionTypesApplicationByApplicationIdError = GetAdminCatalogOptionTypesApplicationByApplicationIdErrors[keyof GetAdminCatalogOptionTypesApplicationByApplicationIdErrors]; export type GetAdminCatalogOptionTypesApplicationByApplicationIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a catalog-option-type */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogOptionTypesApplicationByApplicationIdResponse = GetAdminCatalogOptionTypesApplicationByApplicationIdResponses[keyof GetAdminCatalogOptionTypesApplicationByApplicationIdResponses]; export type PatchAdminClinicalGoalTemplatesByIdRestoreData = { /** * Request body for the /clinical/goal-templates/:id/restore operation on clinical-goal-template resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-goal-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-templates/{id}/restore"; }; export type PatchAdminClinicalGoalTemplatesByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalGoalTemplatesByIdRestoreError = PatchAdminClinicalGoalTemplatesByIdRestoreErrors[keyof PatchAdminClinicalGoalTemplatesByIdRestoreErrors]; export type PatchAdminClinicalGoalTemplatesByIdRestoreResponses = { /** * Success */ 200: { data?: ClinicalGoalTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalGoalTemplatesByIdRestoreResponse = PatchAdminClinicalGoalTemplatesByIdRestoreResponses[keyof PatchAdminClinicalGoalTemplatesByIdRestoreResponses]; export type GetAdminClinicalMealPlansByMealScheduleData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; meal_schedule_id: string; }; url: "/admin/clinical/meal-plans/by-meal-schedule"; }; export type GetAdminClinicalMealPlansByMealScheduleErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalMealPlansByMealScheduleError = GetAdminClinicalMealPlansByMealScheduleErrors[keyof GetAdminClinicalMealPlansByMealScheduleErrors]; export type GetAdminClinicalMealPlansByMealScheduleResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-meal-plan */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalMealPlansByMealScheduleResponse = GetAdminClinicalMealPlansByMealScheduleResponses[keyof GetAdminClinicalMealPlansByMealScheduleResponses]; export type GetAdminInvoicesWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; status?: "draft" | "pending_approval" | "approved" | "sent" | "viewed" | "partial" | "paid" | "overdue" | "void" | "disputed" | "collections" | "pending_review" | "matched" | "scheduled"; direction?: "outbound" | "inbound"; }; url: "/admin/invoices/workspace/{workspace_id}"; }; export type GetAdminInvoicesWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminInvoicesWorkspaceByWorkspaceIdError = GetAdminInvoicesWorkspaceByWorkspaceIdErrors[keyof GetAdminInvoicesWorkspaceByWorkspaceIdErrors]; export type GetAdminInvoicesWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a invoices-invoice */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminInvoicesWorkspaceByWorkspaceIdResponse = GetAdminInvoicesWorkspaceByWorkspaceIdResponses[keyof GetAdminInvoicesWorkspaceByWorkspaceIdResponses]; export type GetAdminClinicalSupplementTemplateCollectionMembershipsCollectionByCollectionIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { collection_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-template-collection-memberships/collection/{collection_id}"; }; export type GetAdminClinicalSupplementTemplateCollectionMembershipsCollectionByCollectionIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalSupplementTemplateCollectionMembershipsCollectionByCollectionIdError = GetAdminClinicalSupplementTemplateCollectionMembershipsCollectionByCollectionIdErrors[keyof GetAdminClinicalSupplementTemplateCollectionMembershipsCollectionByCollectionIdErrors]; export type GetAdminClinicalSupplementTemplateCollectionMembershipsCollectionByCollectionIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-supplement-template-collection-membership */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalSupplementTemplateCollectionMembershipsCollectionByCollectionIdResponse = GetAdminClinicalSupplementTemplateCollectionMembershipsCollectionByCollectionIdResponses[keyof GetAdminClinicalSupplementTemplateCollectionMembershipsCollectionByCollectionIdResponses]; export type GetAdminAgentVersionsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; agent_id?: string; }; url: "/admin/agent-versions"; }; export type GetAdminAgentVersionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentVersionsError = GetAdminAgentVersionsErrors[keyof GetAdminAgentVersionsErrors]; export type GetAdminAgentVersionsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a agent-version */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAgentVersionsResponse = GetAdminAgentVersionsResponses[keyof GetAdminAgentVersionsResponses]; export type PostAdminAgentVersionsData = { /** * Request body for the /agent-versions operation on agent-version resource */ body: { data: { attributes?: { agent_id: string; changes_summary?: string | null; /** * Strategy-specific chunking configuration */ chunking_config?: { [key: string]: unknown; } | null; /** * Document chunking strategy for multi-chunk extraction */ chunking_strategy?: "none" | "page_boundary" | "structural" | "sliding_window"; /** * Override default confidence signal weights */ confidence_weights?: { [key: string]: unknown; } | null; /** * When true, delegate_to_agent tool calls require HITL approval before child execution is created */ delegation_requires_approval?: boolean | null; /** * Maximum number of recent messages to include as conversation context. Defaults to 20 if nil. */ history_limit?: number | null; /** * JSON Schema (Draft 7) defining required input fields. nil means no input contract. */ input_schema?: { [key: string]: unknown; } | null; /** * When true, reject inputs that fail input_schema validation. */ input_strict?: boolean | null; /** * Whether this is a draft version being edited (mutually exclusive with is_active) */ is_draft?: boolean | null; max_cost_credits?: string | number | unknown; /** * Maximum number of agent loop iterations per execution */ max_iterations?: number | null; /** * Maximum number of tool calls to execute concurrently */ max_parallel_tools?: number | null; /** * Maximum total tool calls allowed per execution */ max_tool_calls?: number | null; /** * OpenRouter model ID (e.g. 'anthropic/claude-sonnet-4'). Nil = inherit from ProviderConfig. */ model_id?: string | null; /** * JSON Schema (Draft 7) defining the agent's output structure. nil means untyped. */ output_schema?: { [key: string]: unknown; } | null; /** * When true, enforce output schema via API-level structured output if model supports it. */ output_strict?: boolean | null; parent_version_id?: string | null; /** * Ordered extraction pipeline stages. Empty = single default stage. */ pipeline_stages?: Array | null; /** * Structured prompt template with system, sections, and output format. * Nil for clones — base prompt resolved at runtime via PromptResolver from source agent. * */ prompt_template?: unknown; report_delivery?: "email" | "webhook" | "storage_only"; report_format?: "pdf" | "html" | "both"; report_on_completion?: boolean | null; report_template?: string | null; soul_id?: string | null; /** * Layer 1 system core prompt. Platform-locked — only writable by system actors. * Prepended by PromptResolver before all other content (soul, base, instructions). * ISV cannot read, modify, or override this field. * */ system_preamble?: string | null; temperature?: string | number | unknown; /** * List of granted tool names for agentic execution. Stored as strings, validated against ToolRegistry. */ tool_grants?: Array | null; version_number: number; }; relationships?: { [key: string]: never; }; type?: "agent-version"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-versions"; }; export type PostAdminAgentVersionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAgentVersionsError = PostAdminAgentVersionsErrors[keyof PostAdminAgentVersionsErrors]; export type PostAdminAgentVersionsResponses = { /** * Success */ 201: { data?: AgentVersion; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAgentVersionsResponse = PostAdminAgentVersionsResponses[keyof PostAdminAgentVersionsResponses]; export type GetAdminVoiceSessionsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/voice/sessions/workspace/{workspace_id}"; }; export type GetAdminVoiceSessionsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminVoiceSessionsWorkspaceByWorkspaceIdError = GetAdminVoiceSessionsWorkspaceByWorkspaceIdErrors[keyof GetAdminVoiceSessionsWorkspaceByWorkspaceIdErrors]; export type GetAdminVoiceSessionsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a voice-session */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminVoiceSessionsWorkspaceByWorkspaceIdResponse = GetAdminVoiceSessionsWorkspaceByWorkspaceIdResponses[keyof GetAdminVoiceSessionsWorkspaceByWorkspaceIdResponses]; export type PatchAdminClinicalMealPlansByIdApproveData = { /** * Request body for the /clinical/meal-plans/:id/approve operation on clinical-meal-plan resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-meal-plan"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/meal-plans/{id}/approve"; }; export type PatchAdminClinicalMealPlansByIdApproveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalMealPlansByIdApproveError = PatchAdminClinicalMealPlansByIdApproveErrors[keyof PatchAdminClinicalMealPlansByIdApproveErrors]; export type PatchAdminClinicalMealPlansByIdApproveResponses = { /** * Success */ 200: { data?: ClinicalMealPlan; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalMealPlansByIdApproveResponse = PatchAdminClinicalMealPlansByIdApproveResponses[keyof PatchAdminClinicalMealPlansByIdApproveResponses]; export type PatchAdminAmendmentRequestsByIdApproveData = { /** * Request body for the /amendment-requests/:id/approve operation on amendment-request resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "amendment-request"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/amendment-requests/{id}/approve"; }; export type PatchAdminAmendmentRequestsByIdApproveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminAmendmentRequestsByIdApproveError = PatchAdminAmendmentRequestsByIdApproveErrors[keyof PatchAdminAmendmentRequestsByIdApproveErrors]; export type PatchAdminAmendmentRequestsByIdApproveResponses = { /** * Success */ 200: { data?: AmendmentRequest; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminAmendmentRequestsByIdApproveResponse = PatchAdminAmendmentRequestsByIdApproveResponses[keyof PatchAdminAmendmentRequestsByIdApproveResponses]; export type GetAdminPipelineExecutionsByPipelineByPipelineIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { pipeline_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pipeline-executions/by-pipeline/{pipeline_id}"; }; export type GetAdminPipelineExecutionsByPipelineByPipelineIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPipelineExecutionsByPipelineByPipelineIdError = GetAdminPipelineExecutionsByPipelineByPipelineIdErrors[keyof GetAdminPipelineExecutionsByPipelineByPipelineIdErrors]; export type GetAdminPipelineExecutionsByPipelineByPipelineIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a pipeline-execution */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPipelineExecutionsByPipelineByPipelineIdResponse = GetAdminPipelineExecutionsByPipelineByPipelineIdResponses[keyof GetAdminPipelineExecutionsByPipelineByPipelineIdResponses]; export type GetAdminCampaignsRecipientsCampaignByCampaignIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { campaign_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/campaigns/recipients/campaign/{campaign_id}"; }; export type GetAdminCampaignsRecipientsCampaignByCampaignIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCampaignsRecipientsCampaignByCampaignIdError = GetAdminCampaignsRecipientsCampaignByCampaignIdErrors[keyof GetAdminCampaignsRecipientsCampaignByCampaignIdErrors]; export type GetAdminCampaignsRecipientsCampaignByCampaignIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a email-marketing-recipient */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCampaignsRecipientsCampaignByCampaignIdResponse = GetAdminCampaignsRecipientsCampaignByCampaignIdResponses[keyof GetAdminCampaignsRecipientsCampaignByCampaignIdResponses]; export type GetAdminInvitationsConsumeByTokenData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { token: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invitations/consume/{token}"; }; export type GetAdminInvitationsConsumeByTokenErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminInvitationsConsumeByTokenError = GetAdminInvitationsConsumeByTokenErrors[keyof GetAdminInvitationsConsumeByTokenErrors]; export type GetAdminInvitationsConsumeByTokenResponses = { /** * Success */ 200: { data?: Invitation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminInvitationsConsumeByTokenResponse = GetAdminInvitationsConsumeByTokenResponses[keyof GetAdminInvitationsConsumeByTokenResponses]; export type GetAdminSearchData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; query: string; scope?: "global" | "tenant"; }; url: "/admin/search"; }; export type GetAdminSearchErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSearchError = GetAdminSearchErrors[keyof GetAdminSearchErrors]; export type GetAdminSearchResponses = { /** * Success */ 200: { /** * An array of resource objects representing a search */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSearchResponse = GetAdminSearchResponses[keyof GetAdminSearchResponses]; export type PostAdminRecipesCollectionsData = { /** * Request body for the /recipes/collections operation on recipes-recipe-collection resource */ body: { data: { attributes?: { contact_id?: string | null; description?: string | null; metadata?: { [key: string]: unknown; } | null; name: string; scope?: "workspace" | "contact"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "recipes-recipe-collection"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/collections"; }; export type PostAdminRecipesCollectionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminRecipesCollectionsError = PostAdminRecipesCollectionsErrors[keyof PostAdminRecipesCollectionsErrors]; export type PostAdminRecipesCollectionsResponses = { /** * Success */ 201: { data?: RecipesRecipeCollection; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminRecipesCollectionsResponse = PostAdminRecipesCollectionsResponses[keyof PostAdminRecipesCollectionsResponses]; export type PatchAdminCrmDealsByIdMoveStageData = { /** * Request body for the /crm/deals/:id/move-stage operation on crm-deal resource */ body: { data: { attributes?: { stage_id: string; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-deal"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/deals/{id}/move-stage"; }; export type PatchAdminCrmDealsByIdMoveStageErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmDealsByIdMoveStageError = PatchAdminCrmDealsByIdMoveStageErrors[keyof PatchAdminCrmDealsByIdMoveStageErrors]; export type PatchAdminCrmDealsByIdMoveStageResponses = { /** * Success */ 200: { data?: CrmDeal; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmDealsByIdMoveStageResponse = PatchAdminCrmDealsByIdMoveStageResponses[keyof PatchAdminCrmDealsByIdMoveStageResponses]; export type GetAdminBalancesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/balances"; }; export type GetAdminBalancesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminBalancesError = GetAdminBalancesErrors[keyof GetAdminBalancesErrors]; export type GetAdminBalancesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a balance */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminBalancesResponse = GetAdminBalancesResponses[keyof GetAdminBalancesResponses]; export type GetAdminSupportQueuesApplicationByApplicationIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { application_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/queues/application/{application_id}"; }; export type GetAdminSupportQueuesApplicationByApplicationIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSupportQueuesApplicationByApplicationIdError = GetAdminSupportQueuesApplicationByApplicationIdErrors[keyof GetAdminSupportQueuesApplicationByApplicationIdErrors]; export type GetAdminSupportQueuesApplicationByApplicationIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a support-queue */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSupportQueuesApplicationByApplicationIdResponse = GetAdminSupportQueuesApplicationByApplicationIdResponses[keyof GetAdminSupportQueuesApplicationByApplicationIdResponses]; export type PatchAdminClinicalSupplementTemplatesCatalogByIdArchiveData = { /** * Request body for the /clinical/supplement-templates/catalog/:id/archive operation on clinical-supplement-template resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-supplement-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-templates/catalog/{id}/archive"; }; export type PatchAdminClinicalSupplementTemplatesCatalogByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalSupplementTemplatesCatalogByIdArchiveError = PatchAdminClinicalSupplementTemplatesCatalogByIdArchiveErrors[keyof PatchAdminClinicalSupplementTemplatesCatalogByIdArchiveErrors]; export type PatchAdminClinicalSupplementTemplatesCatalogByIdArchiveResponses = { /** * Success */ 200: { data?: ClinicalSupplementTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalSupplementTemplatesCatalogByIdArchiveResponse = PatchAdminClinicalSupplementTemplatesCatalogByIdArchiveResponses[keyof PatchAdminClinicalSupplementTemplatesCatalogByIdArchiveResponses]; export type GetAdminWorkspaceAgentConfigsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspace-agent-configs"; }; export type GetAdminWorkspaceAgentConfigsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWorkspaceAgentConfigsError = GetAdminWorkspaceAgentConfigsErrors[keyof GetAdminWorkspaceAgentConfigsErrors]; export type GetAdminWorkspaceAgentConfigsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a workspace-agent-config */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWorkspaceAgentConfigsResponse = GetAdminWorkspaceAgentConfigsResponses[keyof GetAdminWorkspaceAgentConfigsResponses]; export type PostAdminWorkspaceAgentConfigsData = { /** * Request body for the /workspace-agent-configs operation on workspace-agent-config resource */ body: { data: { attributes?: { agent_deployment_id: string; overrides?: { [key: string]: unknown; } | null; schema_overrides?: { [key: string]: unknown; } | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "workspace-agent-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspace-agent-configs"; }; export type PostAdminWorkspaceAgentConfigsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminWorkspaceAgentConfigsError = PostAdminWorkspaceAgentConfigsErrors[keyof PostAdminWorkspaceAgentConfigsErrors]; export type PostAdminWorkspaceAgentConfigsResponses = { /** * Success */ 201: { data?: WorkspaceAgentConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminWorkspaceAgentConfigsResponse = PostAdminWorkspaceAgentConfigsResponses[keyof PostAdminWorkspaceAgentConfigsResponses]; export type GetAdminEmailMarketingUnsubscribersByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/unsubscribers/{id}"; }; export type GetAdminEmailMarketingUnsubscribersByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailMarketingUnsubscribersByIdError = GetAdminEmailMarketingUnsubscribersByIdErrors[keyof GetAdminEmailMarketingUnsubscribersByIdErrors]; export type GetAdminEmailMarketingUnsubscribersByIdResponses = { /** * Success */ 200: { data?: EmailUnsubscriber; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailMarketingUnsubscribersByIdResponse = GetAdminEmailMarketingUnsubscribersByIdResponses[keyof GetAdminEmailMarketingUnsubscribersByIdResponses]; export type GetAdminNotificationLogsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/notification-logs/{id}"; }; export type GetAdminNotificationLogsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminNotificationLogsByIdError = GetAdminNotificationLogsByIdErrors[keyof GetAdminNotificationLogsByIdErrors]; export type GetAdminNotificationLogsByIdResponses = { /** * Success */ 200: { data?: NotificationLog; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminNotificationLogsByIdResponse = GetAdminNotificationLogsByIdResponses[keyof GetAdminNotificationLogsByIdResponses]; export type GetAdminLedgerByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ledger/{id}"; }; export type GetAdminLedgerByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminLedgerByIdError = GetAdminLedgerByIdErrors[keyof GetAdminLedgerByIdErrors]; export type GetAdminLedgerByIdResponses = { /** * Success */ 200: { data?: Ledger; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminLedgerByIdResponse = GetAdminLedgerByIdResponses[keyof GetAdminLedgerByIdResponses]; export type GetAdminEmailTemplateVersionsByTemplateIdVersionsByVersionNumberData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { template_id: string; version_number: number; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/template-versions/{template_id}/versions/{version_number}"; }; export type GetAdminEmailTemplateVersionsByTemplateIdVersionsByVersionNumberErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailTemplateVersionsByTemplateIdVersionsByVersionNumberError = GetAdminEmailTemplateVersionsByTemplateIdVersionsByVersionNumberErrors[keyof GetAdminEmailTemplateVersionsByTemplateIdVersionsByVersionNumberErrors]; export type GetAdminEmailTemplateVersionsByTemplateIdVersionsByVersionNumberResponses = { /** * Success */ 200: { data?: EmailTemplateVersion; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailTemplateVersionsByTemplateIdVersionsByVersionNumberResponse = GetAdminEmailTemplateVersionsByTemplateIdVersionsByVersionNumberResponses[keyof GetAdminEmailTemplateVersionsByTemplateIdVersionsByVersionNumberResponses]; export type PostAdminEmailMarketingCampaignsByIdOptimizeSendTimesData = { /** * Request body for the /email-marketing/campaigns/:id/optimize-send-times operation on campaign resource */ body: { data: { recipient_emails: Array; timezone_data?: { [key: string]: unknown; } | null; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/email-marketing/campaigns/{id}/optimize-send-times"; }; export type PostAdminEmailMarketingCampaignsByIdOptimizeSendTimesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminEmailMarketingCampaignsByIdOptimizeSendTimesError = PostAdminEmailMarketingCampaignsByIdOptimizeSendTimesErrors[keyof PostAdminEmailMarketingCampaignsByIdOptimizeSendTimesErrors]; export type PostAdminEmailMarketingCampaignsByIdOptimizeSendTimesResponses = { /** * Success */ 201: { result: { [key: string]: unknown; }; }; }; export type PostAdminEmailMarketingCampaignsByIdOptimizeSendTimesResponse = PostAdminEmailMarketingCampaignsByIdOptimizeSendTimesResponses[keyof PostAdminEmailMarketingCampaignsByIdOptimizeSendTimesResponses]; export type GetAdminVoiceTranscriptionJobsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/voice/transcription-jobs/workspace/{workspace_id}"; }; export type GetAdminVoiceTranscriptionJobsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminVoiceTranscriptionJobsWorkspaceByWorkspaceIdError = GetAdminVoiceTranscriptionJobsWorkspaceByWorkspaceIdErrors[keyof GetAdminVoiceTranscriptionJobsWorkspaceByWorkspaceIdErrors]; export type GetAdminVoiceTranscriptionJobsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a transcription-job */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminVoiceTranscriptionJobsWorkspaceByWorkspaceIdResponse = GetAdminVoiceTranscriptionJobsWorkspaceByWorkspaceIdResponses[keyof GetAdminVoiceTranscriptionJobsWorkspaceByWorkspaceIdResponses]; export type GetAdminSocialMetricsPostBySocialPostIdLatestData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { social_post_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/metrics/post/{social_post_id}/latest"; }; export type GetAdminSocialMetricsPostBySocialPostIdLatestErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialMetricsPostBySocialPostIdLatestError = GetAdminSocialMetricsPostBySocialPostIdLatestErrors[keyof GetAdminSocialMetricsPostBySocialPostIdLatestErrors]; export type GetAdminSocialMetricsPostBySocialPostIdLatestResponses = { /** * Success */ 200: { /** * An array of resource objects representing a post-metric */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialMetricsPostBySocialPostIdLatestResponse = GetAdminSocialMetricsPostBySocialPostIdLatestResponses[keyof GetAdminSocialMetricsPostBySocialPostIdLatestResponses]; export type GetAdminClinicalSessionsByIdMealPlansData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/sessions/{id}/meal_plans"; }; export type GetAdminClinicalSessionsByIdMealPlansErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalSessionsByIdMealPlansError = GetAdminClinicalSessionsByIdMealPlansErrors[keyof GetAdminClinicalSessionsByIdMealPlansErrors]; export type GetAdminClinicalSessionsByIdMealPlansResponses = { /** * Success */ 200: { data?: ClinicalMealPlan; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalSessionsByIdMealPlansResponse = GetAdminClinicalSessionsByIdMealPlansResponses[keyof GetAdminClinicalSessionsByIdMealPlansResponses]; export type PostAdminClinicalClientMedicationsBulkData = { /** * Request body for the /clinical/client-medications/bulk operation on clinical-client-medication resource */ body: { data: { medications: Array<{ clinical_notes?: string | null; dosage?: string | null; end_date?: unknown; external_ids?: { [key: string]: unknown; } | null; frequency?: string | null; generic_name?: string | null; indication?: string | null; instructions?: string | null; interaction_flags?: Array | null; metadata?: { [key: string]: unknown; } | null; name: string; ndc_code?: string | null; patient_id: string; pharmacy_name?: string | null; pharmacy_phone?: string | null; prescribed_at?: unknown; prescriber_name?: string | null; prescriber_npi?: string | null; refill_date?: unknown; refills_remaining?: number | null; route?: string | null; source?: string | null; start_date?: unknown; }>; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/clinical/client-medications/bulk"; }; export type PostAdminClinicalClientMedicationsBulkErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalClientMedicationsBulkError = PostAdminClinicalClientMedicationsBulkErrors[keyof PostAdminClinicalClientMedicationsBulkErrors]; export type PostAdminClinicalClientMedicationsBulkResponses = { /** * Success */ 201: Array<{ [key: string]: unknown; }>; }; export type PostAdminClinicalClientMedicationsBulkResponse = PostAdminClinicalClientMedicationsBulkResponses[keyof PostAdminClinicalClientMedicationsBulkResponses]; export type PatchAdminClaimedDomainsByIdRevokeData = { /** * Request body for the /claimed-domains/:id/revoke operation on claimed-domain resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "claimed-domain"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/claimed-domains/{id}/revoke"; }; export type PatchAdminClaimedDomainsByIdRevokeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClaimedDomainsByIdRevokeError = PatchAdminClaimedDomainsByIdRevokeErrors[keyof PatchAdminClaimedDomainsByIdRevokeErrors]; export type PatchAdminClaimedDomainsByIdRevokeResponses = { /** * Success */ 200: { data?: ClaimedDomain; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClaimedDomainsByIdRevokeResponse = PatchAdminClaimedDomainsByIdRevokeResponses[keyof PatchAdminClaimedDomainsByIdRevokeResponses]; export type PostAdminUsersRegisterIsvData = { /** * Request body for the /users/register-isv operation on user resource */ body: { data: { attributes?: { app_description?: string | null; app_name: string; app_slug: string; email: string; initial_credits?: number | null; password: string; tenant_name: string; }; relationships?: { [key: string]: never; }; type?: "user"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/users/register-isv"; }; export type PostAdminUsersRegisterIsvErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminUsersRegisterIsvError = PostAdminUsersRegisterIsvErrors[keyof PostAdminUsersRegisterIsvErrors]; export type PostAdminUsersRegisterIsvResponses = { /** * Success */ 201: { data?: User; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminUsersRegisterIsvResponse = PostAdminUsersRegisterIsvResponses[keyof PostAdminUsersRegisterIsvResponses]; export type GetAdminClinicalClientResourceAssignmentsArchivedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/client-resource-assignments/archived"; }; export type GetAdminClinicalClientResourceAssignmentsArchivedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalClientResourceAssignmentsArchivedError = GetAdminClinicalClientResourceAssignmentsArchivedErrors[keyof GetAdminClinicalClientResourceAssignmentsArchivedErrors]; export type GetAdminClinicalClientResourceAssignmentsArchivedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-client-resource-assignment */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalClientResourceAssignmentsArchivedResponse = GetAdminClinicalClientResourceAssignmentsArchivedResponses[keyof GetAdminClinicalClientResourceAssignmentsArchivedResponses]; export type PatchAdminCatalogPriceSuggestionsByIdRejectData = { /** * Request body for the /catalog/price-suggestions/:id/reject operation on catalog-price-suggestion resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "catalog-price-suggestion"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/price-suggestions/{id}/reject"; }; export type PatchAdminCatalogPriceSuggestionsByIdRejectErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCatalogPriceSuggestionsByIdRejectError = PatchAdminCatalogPriceSuggestionsByIdRejectErrors[keyof PatchAdminCatalogPriceSuggestionsByIdRejectErrors]; export type PatchAdminCatalogPriceSuggestionsByIdRejectResponses = { /** * Success */ 200: { data?: CatalogPriceSuggestion; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCatalogPriceSuggestionsByIdRejectResponse = PatchAdminCatalogPriceSuggestionsByIdRejectResponses[keyof PatchAdminCatalogPriceSuggestionsByIdRejectResponses]; export type PostAdminConnectorsByIdHealthieAppointmentsListData = { /** * Request body for the /connectors/:id/healthie/appointments/list operation on connector-instance resource */ body: { data: { connector_id: string; since?: unknown; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/connectors/{id}/healthie/appointments/list"; }; export type PostAdminConnectorsByIdHealthieAppointmentsListErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsByIdHealthieAppointmentsListError = PostAdminConnectorsByIdHealthieAppointmentsListErrors[keyof PostAdminConnectorsByIdHealthieAppointmentsListErrors]; export type PostAdminConnectorsByIdHealthieAppointmentsListResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminConnectorsByIdHealthieAppointmentsListResponse = PostAdminConnectorsByIdHealthieAppointmentsListResponses[keyof PostAdminConnectorsByIdHealthieAppointmentsListResponses]; export type GetAdminCrmSyncConfigsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/sync-configs/workspace/{workspace_id}"; }; export type GetAdminCrmSyncConfigsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmSyncConfigsWorkspaceByWorkspaceIdError = GetAdminCrmSyncConfigsWorkspaceByWorkspaceIdErrors[keyof GetAdminCrmSyncConfigsWorkspaceByWorkspaceIdErrors]; export type GetAdminCrmSyncConfigsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crm-sync-config */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmSyncConfigsWorkspaceByWorkspaceIdResponse = GetAdminCrmSyncConfigsWorkspaceByWorkspaceIdResponses[keyof GetAdminCrmSyncConfigsWorkspaceByWorkspaceIdResponses]; export type GetAdminAccountsByTenantByTenantIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { tenant_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/accounts/by-tenant/{tenant_id}"; }; export type GetAdminAccountsByTenantByTenantIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAccountsByTenantByTenantIdError = GetAdminAccountsByTenantByTenantIdErrors[keyof GetAdminAccountsByTenantByTenantIdErrors]; export type GetAdminAccountsByTenantByTenantIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a account */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAccountsByTenantByTenantIdResponse = GetAdminAccountsByTenantByTenantIdResponses[keyof GetAdminAccountsByTenantByTenantIdResponses]; export type PostAdminCatalogPriceListsData = { /** * Request body for the /catalog/price-lists operation on catalog-price-list resource */ body: { data: { attributes?: { application_id: string; currency?: string | null; default_modifier?: string | number | unknown; name: string; priority?: number | null; slug: string; status?: "active" | "draft" | "expired"; strategy?: "fixed" | "percentage_discount" | "tiered"; valid_from?: unknown; valid_until?: unknown; workspace_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "catalog-price-list"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/price-lists"; }; export type PostAdminCatalogPriceListsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCatalogPriceListsError = PostAdminCatalogPriceListsErrors[keyof PostAdminCatalogPriceListsErrors]; export type PostAdminCatalogPriceListsResponses = { /** * Success */ 201: { data?: CatalogPriceList; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCatalogPriceListsResponse = PostAdminCatalogPriceListsResponses[keyof PostAdminCatalogPriceListsResponses]; export type PatchAdminTenantsByIdUnsuspendData = { /** * Request body for the /tenants/:id/unsuspend operation on tenant resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "tenant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants/{id}/unsuspend"; }; export type PatchAdminTenantsByIdUnsuspendErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminTenantsByIdUnsuspendError = PatchAdminTenantsByIdUnsuspendErrors[keyof PatchAdminTenantsByIdUnsuspendErrors]; export type PatchAdminTenantsByIdUnsuspendResponses = { /** * Success */ 200: { data?: Tenant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminTenantsByIdUnsuspendResponse = PatchAdminTenantsByIdUnsuspendResponses[keyof PatchAdminTenantsByIdUnsuspendResponses]; export type GetAdminClinicalSupplementTemplatesMineData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; created_by_id: string; }; url: "/admin/clinical/supplement-templates/mine"; }; export type GetAdminClinicalSupplementTemplatesMineErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalSupplementTemplatesMineError = GetAdminClinicalSupplementTemplatesMineErrors[keyof GetAdminClinicalSupplementTemplatesMineErrors]; export type GetAdminClinicalSupplementTemplatesMineResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-supplement-template */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalSupplementTemplatesMineResponse = GetAdminClinicalSupplementTemplatesMineResponses[keyof GetAdminClinicalSupplementTemplatesMineResponses]; export type DeleteAdminPipelineNodesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pipeline-nodes/{id}"; }; export type DeleteAdminPipelineNodesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminPipelineNodesByIdError = DeleteAdminPipelineNodesByIdErrors[keyof DeleteAdminPipelineNodesByIdErrors]; export type DeleteAdminPipelineNodesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminPipelineNodesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pipeline-nodes/{id}"; }; export type GetAdminPipelineNodesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPipelineNodesByIdError = GetAdminPipelineNodesByIdErrors[keyof GetAdminPipelineNodesByIdErrors]; export type GetAdminPipelineNodesByIdResponses = { /** * Success */ 200: { data?: PipelineNode; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPipelineNodesByIdResponse = GetAdminPipelineNodesByIdResponses[keyof GetAdminPipelineNodesByIdResponses]; export type PatchAdminPipelineNodesByIdData = { /** * Request body for the /pipeline-nodes/:id operation on pipeline-node resource */ body?: { data: { attributes?: { acceptance_criteria?: Array<{ [key: string]: unknown; }> | null; action_config?: { [key: string]: unknown; } | null; action_type?: string | null; agent_id?: string | null; approval_message?: string | null; command_template?: string | null; condition?: { [key: string]: unknown; } | null; connector_type?: string | null; depends_on?: Array | null; description?: string | null; feedback_loop_acknowledged?: boolean | null; inputs?: { [key: string]: unknown; } | null; label?: string | null; max_retries?: number | null; model_id?: string | null; order?: number | null; output_schema?: { [key: string]: unknown; } | null; phase?: "define" | "plan" | "build" | "verify" | "review" | "ship"; position_x?: number | null; position_y?: number | null; prompt_template?: string | null; slot_definitions?: { [key: string]: unknown; } | null; timeout_ms?: number | null; tool_grants?: Array | null; }; id: string; relationships?: { [key: string]: never; }; type?: "pipeline-node"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pipeline-nodes/{id}"; }; export type PatchAdminPipelineNodesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPipelineNodesByIdError = PatchAdminPipelineNodesByIdErrors[keyof PatchAdminPipelineNodesByIdErrors]; export type PatchAdminPipelineNodesByIdResponses = { /** * Success */ 200: { data?: PipelineNode; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPipelineNodesByIdResponse = PatchAdminPipelineNodesByIdResponses[keyof PatchAdminPipelineNodesByIdResponses]; export type PostAdminEmailOutboundEmailsData = { /** * Request body for the /email/outbound-emails operation on email-outbound-email resource */ body: { data: { attributes?: { attachments?: Array<{ [key: string]: unknown; }> | null; body_html?: string | null; body_text?: string | null; contact_ref_id?: string | null; context_ref_id?: string | null; context_ref_type?: "custom" | "deal" | "session" | "ticket"; include_unsubscribe_link?: boolean | null; sender_profile_id?: string | null; subject: string; }; relationships?: { [key: string]: never; }; type?: "email-outbound-email"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/outbound-emails"; }; export type PostAdminEmailOutboundEmailsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminEmailOutboundEmailsError = PostAdminEmailOutboundEmailsErrors[keyof PostAdminEmailOutboundEmailsErrors]; export type PostAdminEmailOutboundEmailsResponses = { /** * Success */ 201: { data?: EmailOutboundEmail; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminEmailOutboundEmailsResponse = PostAdminEmailOutboundEmailsResponses[keyof PostAdminEmailOutboundEmailsResponses]; export type PatchAdminTenantsByIdCancelData = { /** * Request body for the /tenants/:id/cancel operation on tenant resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "tenant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants/{id}/cancel"; }; export type PatchAdminTenantsByIdCancelErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminTenantsByIdCancelError = PatchAdminTenantsByIdCancelErrors[keyof PatchAdminTenantsByIdCancelErrors]; export type PatchAdminTenantsByIdCancelResponses = { /** * Success */ 200: { data?: Tenant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminTenantsByIdCancelResponse = PatchAdminTenantsByIdCancelResponses[keyof PatchAdminTenantsByIdCancelResponses]; export type GetAdminWorkspacesByWorkspaceIdExtractionByDocumentIdMappingData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; document_id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; semantic_enabled?: boolean; }; url: "/admin/workspaces/{workspace_id}/extraction/{document_id}/mapping"; }; export type GetAdminWorkspacesByWorkspaceIdExtractionByDocumentIdMappingErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWorkspacesByWorkspaceIdExtractionByDocumentIdMappingError = GetAdminWorkspacesByWorkspaceIdExtractionByDocumentIdMappingErrors[keyof GetAdminWorkspacesByWorkspaceIdExtractionByDocumentIdMappingErrors]; export type GetAdminWorkspacesByWorkspaceIdExtractionByDocumentIdMappingResponses = { /** * Success */ 200: { data?: FieldMappingResult; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWorkspacesByWorkspaceIdExtractionByDocumentIdMappingResponse = GetAdminWorkspacesByWorkspaceIdExtractionByDocumentIdMappingResponses[keyof GetAdminWorkspacesByWorkspaceIdExtractionByDocumentIdMappingResponses]; export type PostAdminWorkspacesByWorkspaceIdExtractionByDocumentIdMappingData = { /** * Request body for the /workspaces/:workspace_id/extraction/:document_id/mapping operation on field-mapping-confirmation resource */ body?: { data: { attributes?: { add_to_schema?: Array<{ [key: string]: unknown; }> | null; confirmed?: boolean | null; ignored_fields?: Array | null; mappings?: Array<{ [key: string]: unknown; }> | null; }; relationships?: { [key: string]: never; }; type?: "field-mapping-confirmation"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { document_id: string; workspace_id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspaces/{workspace_id}/extraction/{document_id}/mapping"; }; export type PostAdminWorkspacesByWorkspaceIdExtractionByDocumentIdMappingErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminWorkspacesByWorkspaceIdExtractionByDocumentIdMappingError = PostAdminWorkspacesByWorkspaceIdExtractionByDocumentIdMappingErrors[keyof PostAdminWorkspacesByWorkspaceIdExtractionByDocumentIdMappingErrors]; export type PostAdminWorkspacesByWorkspaceIdExtractionByDocumentIdMappingResponses = { /** * Success */ 201: { data?: FieldMappingConfirmation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminWorkspacesByWorkspaceIdExtractionByDocumentIdMappingResponse = PostAdminWorkspacesByWorkspaceIdExtractionByDocumentIdMappingResponses[keyof PostAdminWorkspacesByWorkspaceIdExtractionByDocumentIdMappingResponses]; export type DeleteAdminRecipesCollectionRecipesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/collection-recipes/{id}"; }; export type DeleteAdminRecipesCollectionRecipesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminRecipesCollectionRecipesByIdError = DeleteAdminRecipesCollectionRecipesByIdErrors[keyof DeleteAdminRecipesCollectionRecipesByIdErrors]; export type DeleteAdminRecipesCollectionRecipesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminRecipesCollectionRecipesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/collection-recipes/{id}"; }; export type GetAdminRecipesCollectionRecipesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesCollectionRecipesByIdError = GetAdminRecipesCollectionRecipesByIdErrors[keyof GetAdminRecipesCollectionRecipesByIdErrors]; export type GetAdminRecipesCollectionRecipesByIdResponses = { /** * Success */ 200: { data?: RecipesCollectionRecipe; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesCollectionRecipesByIdResponse = GetAdminRecipesCollectionRecipesByIdResponses[keyof GetAdminRecipesCollectionRecipesByIdResponses]; export type PatchAdminRecipesCollectionRecipesByIdData = { /** * Request body for the /recipes/collection-recipes/:id operation on recipes-collection-recipe resource */ body?: { data: { attributes?: { sort_order?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "recipes-collection-recipe"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/collection-recipes/{id}"; }; export type PatchAdminRecipesCollectionRecipesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminRecipesCollectionRecipesByIdError = PatchAdminRecipesCollectionRecipesByIdErrors[keyof PatchAdminRecipesCollectionRecipesByIdErrors]; export type PatchAdminRecipesCollectionRecipesByIdResponses = { /** * Success */ 200: { data?: RecipesCollectionRecipe; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminRecipesCollectionRecipesByIdResponse = PatchAdminRecipesCollectionRecipesByIdResponses[keyof PatchAdminRecipesCollectionRecipesByIdResponses]; export type GetAdminClinicalIntakeTargetsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; patient_id: string; }; url: "/admin/clinical/intake-targets"; }; export type GetAdminClinicalIntakeTargetsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalIntakeTargetsError = GetAdminClinicalIntakeTargetsErrors[keyof GetAdminClinicalIntakeTargetsErrors]; export type GetAdminClinicalIntakeTargetsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-intake-target */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalIntakeTargetsResponse = GetAdminClinicalIntakeTargetsResponses[keyof GetAdminClinicalIntakeTargetsResponses]; export type PostAdminClinicalIntakeTargetsData = { /** * Request body for the /clinical/intake-targets operation on clinical-intake-target resource */ body: { data: { attributes?: { hydration_ml: string | number; sex: "male" | "female"; carbs_pct: number; tdee: string | number; goal_direction: "lose" | "maintain" | "gain"; meals_per_day: number; condition_rules?: Array | null; weight_kg: string | number; fat_grams: string | number; carbs_grams: string | number; rate_lbs_per_week?: string | number | unknown; bmr: string | number; protein_g_per_kg?: string | number | unknown; weight_used_kg: string | number; activity_level: "sedentary" | "lightly_active" | "moderately_active" | "very_active" | "extremely_active"; calorie_adjustment: number; height_cm: string | number; simple_carbs_pct?: number | null; snacks_per_day: number; vegetables_pct?: number | null; weight_method: "actual" | "ideal" | "adjusted"; protein_pct: number; workspace_id: string; protein_grams: string | number; is_active?: boolean | null; patient_id: string; target_calories: number; fruit_pct?: number | null; metadata?: { [key: string]: unknown; } | null; macro_mode: "percentage" | "body_weight_protein" | "hybrid"; fat_pct: number; notes?: string | null; age: number; }; relationships?: { [key: string]: never; }; type?: "clinical-intake-target"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/intake-targets"; }; export type PostAdminClinicalIntakeTargetsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalIntakeTargetsError = PostAdminClinicalIntakeTargetsErrors[keyof PostAdminClinicalIntakeTargetsErrors]; export type PostAdminClinicalIntakeTargetsResponses = { /** * Success */ 201: { data?: ClinicalIntakeTarget; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalIntakeTargetsResponse = PostAdminClinicalIntakeTargetsResponses[keyof PostAdminClinicalIntakeTargetsResponses]; export type GetAdminPipelineNodesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pipeline-nodes"; }; export type GetAdminPipelineNodesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPipelineNodesError = GetAdminPipelineNodesErrors[keyof GetAdminPipelineNodesErrors]; export type GetAdminPipelineNodesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a pipeline-node */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPipelineNodesResponse = GetAdminPipelineNodesResponses[keyof GetAdminPipelineNodesResponses]; export type PostAdminPipelineNodesData = { /** * Request body for the /pipeline-nodes operation on pipeline-node resource */ body: { data: { attributes?: { acceptance_criteria?: Array<{ [key: string]: unknown; }> | null; action_config?: { [key: string]: unknown; } | null; action_type?: string | null; agent_id?: string | null; approval_message?: string | null; command_template?: string | null; condition?: { [key: string]: unknown; } | null; connector_type?: string | null; depends_on?: Array | null; description?: string | null; feedback_loop_acknowledged?: boolean | null; inputs?: { [key: string]: unknown; } | null; label: string; max_retries?: number | null; model_id?: string | null; /** * Stable node identifier within the pipeline DAG. Must match [a-z_][a-z0-9_]{0,63}. */ node_key: string; node_type: "prompt" | "command" | "connector_exec" | "checkpoint"; order?: number | null; output_schema?: { [key: string]: unknown; } | null; phase?: "define" | "plan" | "build" | "verify" | "review" | "ship"; pipeline_id: string; position_x?: number | null; position_y?: number | null; prompt_template?: string | null; slot_definitions?: { [key: string]: unknown; } | null; timeout_ms?: number | null; tool_grants?: Array | null; }; relationships?: { [key: string]: never; }; type?: "pipeline-node"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pipeline-nodes"; }; export type PostAdminPipelineNodesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminPipelineNodesError = PostAdminPipelineNodesErrors[keyof PostAdminPipelineNodesErrors]; export type PostAdminPipelineNodesResponses = { /** * Success */ 201: { data?: PipelineNode; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminPipelineNodesResponse = PostAdminPipelineNodesResponses[keyof PostAdminPipelineNodesResponses]; export type GetAdminQuoteRequestsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; status?: "received" | "under_review" | "quoted" | "rejected" | "accepted" | "expired"; }; url: "/admin/quote-requests/workspace/{workspace_id}"; }; export type GetAdminQuoteRequestsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminQuoteRequestsWorkspaceByWorkspaceIdError = GetAdminQuoteRequestsWorkspaceByWorkspaceIdErrors[keyof GetAdminQuoteRequestsWorkspaceByWorkspaceIdErrors]; export type GetAdminQuoteRequestsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a invoices-quote-request */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminQuoteRequestsWorkspaceByWorkspaceIdResponse = GetAdminQuoteRequestsWorkspaceByWorkspaceIdResponses[keyof GetAdminQuoteRequestsWorkspaceByWorkspaceIdResponses]; export type GetAdminFeatureUsagesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/feature-usages"; }; export type GetAdminFeatureUsagesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminFeatureUsagesError = GetAdminFeatureUsagesErrors[keyof GetAdminFeatureUsagesErrors]; export type GetAdminFeatureUsagesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a feature-usage */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminFeatureUsagesResponse = GetAdminFeatureUsagesResponses[keyof GetAdminFeatureUsagesResponses]; export type DeleteAdminRecipesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/{id}"; }; export type DeleteAdminRecipesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminRecipesByIdError = DeleteAdminRecipesByIdErrors[keyof DeleteAdminRecipesByIdErrors]; export type DeleteAdminRecipesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminRecipesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/{id}"; }; export type GetAdminRecipesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesByIdError = GetAdminRecipesByIdErrors[keyof GetAdminRecipesByIdErrors]; export type GetAdminRecipesByIdResponses = { /** * Success */ 200: { data?: RecipesRecipe; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesByIdResponse = GetAdminRecipesByIdResponses[keyof GetAdminRecipesByIdResponses]; export type PatchAdminRecipesByIdData = { /** * Request body for the /recipes/:id operation on recipes-recipe resource */ body?: { data: { attributes?: { cook_time_minutes?: number | null; cuisine_type?: string | null; description?: string | null; difficulty?: "easy" | "medium" | "hard"; image_url?: string | null; image_urls?: Array | null; instructions?: string | null; metadata?: { [key: string]: unknown; } | null; prep_time_minutes?: number | null; servings?: number | null; title?: string | null; total_time_minutes?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "recipes-recipe"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/{id}"; }; export type PatchAdminRecipesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminRecipesByIdError = PatchAdminRecipesByIdErrors[keyof PatchAdminRecipesByIdErrors]; export type PatchAdminRecipesByIdResponses = { /** * Success */ 200: { data?: RecipesRecipe; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminRecipesByIdResponse = PatchAdminRecipesByIdResponses[keyof PatchAdminRecipesByIdResponses]; export type GetAdminRecipesIngredientsRecipeByRecipeIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { recipe_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/ingredients/recipe/{recipe_id}"; }; export type GetAdminRecipesIngredientsRecipeByRecipeIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesIngredientsRecipeByRecipeIdError = GetAdminRecipesIngredientsRecipeByRecipeIdErrors[keyof GetAdminRecipesIngredientsRecipeByRecipeIdErrors]; export type GetAdminRecipesIngredientsRecipeByRecipeIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a recipes-ingredient */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesIngredientsRecipeByRecipeIdResponse = GetAdminRecipesIngredientsRecipeByRecipeIdResponses[keyof GetAdminRecipesIngredientsRecipeByRecipeIdResponses]; export type DeleteAdminPreferencesByKeyData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/preferences/by_key"; }; export type DeleteAdminPreferencesByKeyErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminPreferencesByKeyError = DeleteAdminPreferencesByKeyErrors[keyof DeleteAdminPreferencesByKeyErrors]; export type DeleteAdminPreferencesByKeyResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminPreferencesByKeyData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; context_key: string; }; url: "/admin/preferences/by_key"; }; export type GetAdminPreferencesByKeyErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPreferencesByKeyError = GetAdminPreferencesByKeyErrors[keyof GetAdminPreferencesByKeyErrors]; export type GetAdminPreferencesByKeyResponses = { /** * Success */ 200: { data?: UserPreference; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPreferencesByKeyResponse = GetAdminPreferencesByKeyResponses[keyof GetAdminPreferencesByKeyResponses]; export type GetAdminAgentsBySlugBySlugData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { slug: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agents/by-slug/{slug}"; }; export type GetAdminAgentsBySlugBySlugErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentsBySlugBySlugError = GetAdminAgentsBySlugBySlugErrors[keyof GetAdminAgentsBySlugBySlugErrors]; export type GetAdminAgentsBySlugBySlugResponses = { /** * Success */ 200: { data?: Agent; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAgentsBySlugBySlugResponse = GetAdminAgentsBySlugBySlugResponses[keyof GetAdminAgentsBySlugBySlugResponses]; export type GetAdminTenantsByTenantIdDocumentStatsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { tenant_id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants/{tenant_id}/document_stats"; }; export type GetAdminTenantsByTenantIdDocumentStatsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminTenantsByTenantIdDocumentStatsError = GetAdminTenantsByTenantIdDocumentStatsErrors[keyof GetAdminTenantsByTenantIdDocumentStatsErrors]; export type GetAdminTenantsByTenantIdDocumentStatsResponses = { /** * Success */ 200: { data?: TenantDocumentStats; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminTenantsByTenantIdDocumentStatsResponse = GetAdminTenantsByTenantIdDocumentStatsResponses[keyof GetAdminTenantsByTenantIdDocumentStatsResponses]; export type DeleteAdminCrmAddressesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/addresses/{id}"; }; export type DeleteAdminCrmAddressesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrmAddressesByIdError = DeleteAdminCrmAddressesByIdErrors[keyof DeleteAdminCrmAddressesByIdErrors]; export type DeleteAdminCrmAddressesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCrmAddressesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/addresses/{id}"; }; export type GetAdminCrmAddressesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmAddressesByIdError = GetAdminCrmAddressesByIdErrors[keyof GetAdminCrmAddressesByIdErrors]; export type GetAdminCrmAddressesByIdResponses = { /** * Success */ 200: { data?: CrmAddress; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmAddressesByIdResponse = GetAdminCrmAddressesByIdResponses[keyof GetAdminCrmAddressesByIdResponses]; export type PatchAdminCrmAddressesByIdData = { /** * Request body for the /crm/addresses/:id operation on crm-address resource */ body?: { data: { attributes?: { city?: string | null; country?: string | null; is_primary?: boolean | null; label?: "home" | "work" | "billing" | "shipping" | "headquarters" | "branch" | "other"; latitude?: number | null; line1?: string | null; line2?: string | null; longitude?: number | null; postal_code?: string | null; state?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-address"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/addresses/{id}"; }; export type PatchAdminCrmAddressesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmAddressesByIdError = PatchAdminCrmAddressesByIdErrors[keyof PatchAdminCrmAddressesByIdErrors]; export type PatchAdminCrmAddressesByIdResponses = { /** * Success */ 200: { data?: CrmAddress; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmAddressesByIdResponse = PatchAdminCrmAddressesByIdResponses[keyof PatchAdminCrmAddressesByIdResponses]; export type GetAdminCatalogStockRecordsLocationByStockLocationIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { stock_location_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/stock-records/location/{stock_location_id}"; }; export type GetAdminCatalogStockRecordsLocationByStockLocationIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogStockRecordsLocationByStockLocationIdError = GetAdminCatalogStockRecordsLocationByStockLocationIdErrors[keyof GetAdminCatalogStockRecordsLocationByStockLocationIdErrors]; export type GetAdminCatalogStockRecordsLocationByStockLocationIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a catalog-stock-record */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogStockRecordsLocationByStockLocationIdResponse = GetAdminCatalogStockRecordsLocationByStockLocationIdResponses[keyof GetAdminCatalogStockRecordsLocationByStockLocationIdResponses]; export type PatchAdminSocialPostsByIdSeoData = { /** * Request body for the /social/posts/:id/seo operation on social-post resource */ body?: { data: { attributes?: { seo_analysis?: { [key: string]: unknown; } | null; seo_score?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "social-post"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/posts/{id}/seo"; }; export type PatchAdminSocialPostsByIdSeoErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSocialPostsByIdSeoError = PatchAdminSocialPostsByIdSeoErrors[keyof PatchAdminSocialPostsByIdSeoErrors]; export type PatchAdminSocialPostsByIdSeoResponses = { /** * Success */ 200: { data?: SocialPost; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSocialPostsByIdSeoResponse = PatchAdminSocialPostsByIdSeoResponses[keyof PatchAdminSocialPostsByIdSeoResponses]; export type PostAdminConnectorsFullscriptOrdersListData = { /** * Request body for the /connectors/fullscript/orders/list operation on connector-instance resource */ body: { data: { connector_id: string; patient_id: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/connectors/fullscript/orders/list"; }; export type PostAdminConnectorsFullscriptOrdersListErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsFullscriptOrdersListError = PostAdminConnectorsFullscriptOrdersListErrors[keyof PostAdminConnectorsFullscriptOrdersListErrors]; export type PostAdminConnectorsFullscriptOrdersListResponses = { /** * Success */ 201: Array<{ [key: string]: unknown; }>; }; export type PostAdminConnectorsFullscriptOrdersListResponse = PostAdminConnectorsFullscriptOrdersListResponses[keyof PostAdminConnectorsFullscriptOrdersListResponses]; export type GetAdminClinicalDeliveriesBySessionData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; session_id: string; }; url: "/admin/clinical/deliveries/by-session"; }; export type GetAdminClinicalDeliveriesBySessionErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalDeliveriesBySessionError = GetAdminClinicalDeliveriesBySessionErrors[keyof GetAdminClinicalDeliveriesBySessionErrors]; export type GetAdminClinicalDeliveriesBySessionResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-delivery */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalDeliveriesBySessionResponse = GetAdminClinicalDeliveriesBySessionResponses[keyof GetAdminClinicalDeliveriesBySessionResponses]; export type DeleteAdminAgentSoulsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-souls/{id}"; }; export type DeleteAdminAgentSoulsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminAgentSoulsByIdError = DeleteAdminAgentSoulsByIdErrors[keyof DeleteAdminAgentSoulsByIdErrors]; export type DeleteAdminAgentSoulsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminAgentSoulsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-souls/{id}"; }; export type GetAdminAgentSoulsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentSoulsByIdError = GetAdminAgentSoulsByIdErrors[keyof GetAdminAgentSoulsByIdErrors]; export type GetAdminAgentSoulsByIdResponses = { /** * Success */ 200: { data?: AgentSoul; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAgentSoulsByIdResponse = GetAdminAgentSoulsByIdResponses[keyof GetAdminAgentSoulsByIdResponses]; export type PatchAdminAgentSoulsByIdData = { /** * Request body for the /agent-souls/:id operation on agent-soul resource */ body?: { data: { attributes?: { content?: string | null; is_default?: boolean | null; name?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "agent-soul"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-souls/{id}"; }; export type PatchAdminAgentSoulsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminAgentSoulsByIdError = PatchAdminAgentSoulsByIdErrors[keyof PatchAdminAgentSoulsByIdErrors]; export type PatchAdminAgentSoulsByIdResponses = { /** * Success */ 200: { data?: AgentSoul; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminAgentSoulsByIdResponse = PatchAdminAgentSoulsByIdResponses[keyof PatchAdminAgentSoulsByIdResponses]; export type PostAdminExtractionDocumentsBulkReprocessData = { /** * Request body for the /extraction/documents/bulk-reprocess operation on bulk-reprocess-result resource */ body: { data: { attributes?: { document_ids: Array; schema_version_id?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "bulk-reprocess-result"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/documents/bulk-reprocess"; }; export type PostAdminExtractionDocumentsBulkReprocessErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminExtractionDocumentsBulkReprocessError = PostAdminExtractionDocumentsBulkReprocessErrors[keyof PostAdminExtractionDocumentsBulkReprocessErrors]; export type PostAdminExtractionDocumentsBulkReprocessResponses = { /** * Success */ 201: { data?: BulkReprocessResult; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminExtractionDocumentsBulkReprocessResponse = PostAdminExtractionDocumentsBulkReprocessResponses[keyof PostAdminExtractionDocumentsBulkReprocessResponses]; export type PatchAdminEmailInboundAddressesByIdRotateTokenData = { /** * Request body for the /email/inbound-addresses/:id/rotate-token operation on email-inbound-address resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "email-inbound-address"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/inbound-addresses/{id}/rotate-token"; }; export type PatchAdminEmailInboundAddressesByIdRotateTokenErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailInboundAddressesByIdRotateTokenError = PatchAdminEmailInboundAddressesByIdRotateTokenErrors[keyof PatchAdminEmailInboundAddressesByIdRotateTokenErrors]; export type PatchAdminEmailInboundAddressesByIdRotateTokenResponses = { /** * Success */ 200: { data?: EmailInboundAddress; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailInboundAddressesByIdRotateTokenResponse = PatchAdminEmailInboundAddressesByIdRotateTokenResponses[keyof PatchAdminEmailInboundAddressesByIdRotateTokenResponses]; export type PostAdminEmailMarketingCampaignsByIdGenerateEmailsData = { /** * Request body for the /email-marketing/campaigns/:id/generate-emails operation on campaign resource */ body: { data: { campaign_id: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/email-marketing/campaigns/{id}/generate-emails"; }; export type PostAdminEmailMarketingCampaignsByIdGenerateEmailsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminEmailMarketingCampaignsByIdGenerateEmailsError = PostAdminEmailMarketingCampaignsByIdGenerateEmailsErrors[keyof PostAdminEmailMarketingCampaignsByIdGenerateEmailsErrors]; export type PostAdminEmailMarketingCampaignsByIdGenerateEmailsResponses = { /** * Success */ 201: { result: { [key: string]: unknown; }; }; }; export type PostAdminEmailMarketingCampaignsByIdGenerateEmailsResponse = PostAdminEmailMarketingCampaignsByIdGenerateEmailsResponses[keyof PostAdminEmailMarketingCampaignsByIdGenerateEmailsResponses]; export type GetAdminWalletInvoicesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/wallet/invoices/{id}"; }; export type GetAdminWalletInvoicesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWalletInvoicesByIdError = GetAdminWalletInvoicesByIdErrors[keyof GetAdminWalletInvoicesByIdErrors]; export type GetAdminWalletInvoicesByIdResponses = { /** * Success */ 200: { data?: Invoice; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWalletInvoicesByIdResponse = GetAdminWalletInvoicesByIdResponses[keyof GetAdminWalletInvoicesByIdResponses]; export type DeleteAdminCdeScopeReportsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/cde-scope-reports/{id}"; }; export type DeleteAdminCdeScopeReportsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCdeScopeReportsByIdError = DeleteAdminCdeScopeReportsByIdErrors[keyof DeleteAdminCdeScopeReportsByIdErrors]; export type DeleteAdminCdeScopeReportsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCdeScopeReportsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/cde-scope-reports/{id}"; }; export type GetAdminCdeScopeReportsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCdeScopeReportsByIdError = GetAdminCdeScopeReportsByIdErrors[keyof GetAdminCdeScopeReportsByIdErrors]; export type GetAdminCdeScopeReportsByIdResponses = { /** * Success */ 200: { data?: CdeScopeReport; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCdeScopeReportsByIdResponse = GetAdminCdeScopeReportsByIdResponses[keyof GetAdminCdeScopeReportsByIdResponses]; export type PostAdminContentEditImageData = { /** * Request body for the /content/edit-image operation on content-generation resource */ body: { data: { image_url: string; instructions: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/content/edit-image"; }; export type PostAdminContentEditImageErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminContentEditImageError = PostAdminContentEditImageErrors[keyof PostAdminContentEditImageErrors]; export type PostAdminContentEditImageResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminContentEditImageResponse = PostAdminContentEditImageResponses[keyof PostAdminContentEditImageResponses]; export type PostAdminInvoicesData = { /** * Request body for the /invoices operation on invoices-invoice resource */ body: { data: { attributes?: { ai_confidence?: string | number | unknown; ai_suggestions?: { [key: string]: unknown; } | null; amount_due?: string | number | unknown; amount_paid?: string | number | unknown; billing_address?: InvoicesInvoiceBillingAddressInputCreateType; contact_id?: string | null; currency?: string | null; direction: "outbound" | "inbound"; due_date?: string | null; extraction_result_id?: string | null; issue_date?: string | null; metadata?: { [key: string]: unknown; } | null; notes?: string | null; payment_terms?: string | null; recurring_schedule_id?: string | null; reference_number?: string | null; shipping_address?: InvoicesInvoiceShippingAddressInputCreateType; source?: "manual" | "ai_generated" | "ai_extracted" | "recurring" | "api"; subtotal?: string | number | unknown; tax_total?: string | number | unknown; template_id?: string | null; total?: string | number | unknown; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "invoices-invoice"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices"; }; export type PostAdminInvoicesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminInvoicesError = PostAdminInvoicesErrors[keyof PostAdminInvoicesErrors]; export type PostAdminInvoicesResponses = { /** * Success */ 201: { data?: InvoicesInvoice; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminInvoicesResponse = PostAdminInvoicesResponses[keyof PostAdminInvoicesResponses]; export type GetAdminClinicalPatientsByIdHealthMetricsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/patients/{id}/health_metrics"; }; export type GetAdminClinicalPatientsByIdHealthMetricsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPatientsByIdHealthMetricsError = GetAdminClinicalPatientsByIdHealthMetricsErrors[keyof GetAdminClinicalPatientsByIdHealthMetricsErrors]; export type GetAdminClinicalPatientsByIdHealthMetricsResponses = { /** * Success */ 200: { data?: ClinicalHealthMetric; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPatientsByIdHealthMetricsResponse = GetAdminClinicalPatientsByIdHealthMetricsResponses[keyof GetAdminClinicalPatientsByIdHealthMetricsResponses]; export type DeleteAdminCaseDocumentLinksByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/case-document-links/{id}"; }; export type DeleteAdminCaseDocumentLinksByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCaseDocumentLinksByIdError = DeleteAdminCaseDocumentLinksByIdErrors[keyof DeleteAdminCaseDocumentLinksByIdErrors]; export type DeleteAdminCaseDocumentLinksByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCaseDocumentLinksByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/case-document-links/{id}"; }; export type GetAdminCaseDocumentLinksByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCaseDocumentLinksByIdError = GetAdminCaseDocumentLinksByIdErrors[keyof GetAdminCaseDocumentLinksByIdErrors]; export type GetAdminCaseDocumentLinksByIdResponses = { /** * Success */ 200: { data?: CaseDocumentLink; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCaseDocumentLinksByIdResponse = GetAdminCaseDocumentLinksByIdResponses[keyof GetAdminCaseDocumentLinksByIdResponses]; export type GetAdminEmailOutboundEmailsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/outbound-emails/workspace/{workspace_id}"; }; export type GetAdminEmailOutboundEmailsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailOutboundEmailsWorkspaceByWorkspaceIdError = GetAdminEmailOutboundEmailsWorkspaceByWorkspaceIdErrors[keyof GetAdminEmailOutboundEmailsWorkspaceByWorkspaceIdErrors]; export type GetAdminEmailOutboundEmailsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a email-outbound-email */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailOutboundEmailsWorkspaceByWorkspaceIdResponse = GetAdminEmailOutboundEmailsWorkspaceByWorkspaceIdResponses[keyof GetAdminEmailOutboundEmailsWorkspaceByWorkspaceIdResponses]; export type GetAdminBucketsByIdStatsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/buckets/{id}/stats"; }; export type GetAdminBucketsByIdStatsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminBucketsByIdStatsError = GetAdminBucketsByIdStatsErrors[keyof GetAdminBucketsByIdStatsErrors]; export type GetAdminBucketsByIdStatsResponses = { /** * Success */ 200: { data?: Bucket; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminBucketsByIdStatsResponse = GetAdminBucketsByIdStatsResponses[keyof GetAdminBucketsByIdStatsResponses]; export type GetAdminClinicalSupplementTemplatesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-templates/{id}"; }; export type GetAdminClinicalSupplementTemplatesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalSupplementTemplatesByIdError = GetAdminClinicalSupplementTemplatesByIdErrors[keyof GetAdminClinicalSupplementTemplatesByIdErrors]; export type GetAdminClinicalSupplementTemplatesByIdResponses = { /** * Success */ 200: { data?: ClinicalSupplementTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalSupplementTemplatesByIdResponse = GetAdminClinicalSupplementTemplatesByIdResponses[keyof GetAdminClinicalSupplementTemplatesByIdResponses]; export type PatchAdminClinicalSupplementTemplatesByIdData = { /** * Request body for the /clinical/supplement-templates/:id operation on clinical-supplement-template resource */ body?: { data: { attributes?: { applicable_conditions?: Array | null; category?: string | null; description?: string | null; is_active?: boolean | null; metadata?: { [key: string]: unknown; } | null; name?: string | null; supplements?: Array<{ [key: string]: unknown; }> | null; tags?: Array | null; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-supplement-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-templates/{id}"; }; export type PatchAdminClinicalSupplementTemplatesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalSupplementTemplatesByIdError = PatchAdminClinicalSupplementTemplatesByIdErrors[keyof PatchAdminClinicalSupplementTemplatesByIdErrors]; export type PatchAdminClinicalSupplementTemplatesByIdResponses = { /** * Success */ 200: { data?: ClinicalSupplementTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalSupplementTemplatesByIdResponse = PatchAdminClinicalSupplementTemplatesByIdResponses[keyof PatchAdminClinicalSupplementTemplatesByIdResponses]; export type GetAdminCasePipelineLinksByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/case-pipeline-links/{id}"; }; export type GetAdminCasePipelineLinksByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCasePipelineLinksByIdError = GetAdminCasePipelineLinksByIdErrors[keyof GetAdminCasePipelineLinksByIdErrors]; export type GetAdminCasePipelineLinksByIdResponses = { /** * Success */ 200: { data?: CasePipelineLink; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCasePipelineLinksByIdResponse = GetAdminCasePipelineLinksByIdResponses[keyof GetAdminCasePipelineLinksByIdResponses]; export type GetAdminClinicalClientResourceAssignmentsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-resource-assignments/{id}"; }; export type GetAdminClinicalClientResourceAssignmentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalClientResourceAssignmentsByIdError = GetAdminClinicalClientResourceAssignmentsByIdErrors[keyof GetAdminClinicalClientResourceAssignmentsByIdErrors]; export type GetAdminClinicalClientResourceAssignmentsByIdResponses = { /** * Success */ 200: { data?: ClinicalClientResourceAssignment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalClientResourceAssignmentsByIdResponse = GetAdminClinicalClientResourceAssignmentsByIdResponses[keyof GetAdminClinicalClientResourceAssignmentsByIdResponses]; export type PatchAdminClinicalClientResourceAssignmentsByIdData = { /** * Request body for the /clinical/client-resource-assignments/:id operation on clinical-client-resource-assignment resource */ body?: { data: { attributes?: { completed_at?: unknown; metadata?: { [key: string]: unknown; } | null; notes?: string | null; status?: "assigned" | "in_progress" | "completed" | "dismissed"; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-client-resource-assignment"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-resource-assignments/{id}"; }; export type PatchAdminClinicalClientResourceAssignmentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalClientResourceAssignmentsByIdError = PatchAdminClinicalClientResourceAssignmentsByIdErrors[keyof PatchAdminClinicalClientResourceAssignmentsByIdErrors]; export type PatchAdminClinicalClientResourceAssignmentsByIdResponses = { /** * Success */ 200: { data?: ClinicalClientResourceAssignment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalClientResourceAssignmentsByIdResponse = PatchAdminClinicalClientResourceAssignmentsByIdResponses[keyof PatchAdminClinicalClientResourceAssignmentsByIdResponses]; export type GetAdminUsersByEmailData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; email: string; }; url: "/admin/users/by-email"; }; export type GetAdminUsersByEmailErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminUsersByEmailError = GetAdminUsersByEmailErrors[keyof GetAdminUsersByEmailErrors]; export type GetAdminUsersByEmailResponses = { /** * Success */ 200: { data?: User; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminUsersByEmailResponse = GetAdminUsersByEmailResponses[keyof GetAdminUsersByEmailResponses]; export type GetAdminRecipesMealSchedulesWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/meal-schedules/workspace/{workspace_id}"; }; export type GetAdminRecipesMealSchedulesWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesMealSchedulesWorkspaceByWorkspaceIdError = GetAdminRecipesMealSchedulesWorkspaceByWorkspaceIdErrors[keyof GetAdminRecipesMealSchedulesWorkspaceByWorkspaceIdErrors]; export type GetAdminRecipesMealSchedulesWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a recipes-meal-schedule */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesMealSchedulesWorkspaceByWorkspaceIdResponse = GetAdminRecipesMealSchedulesWorkspaceByWorkspaceIdResponses[keyof GetAdminRecipesMealSchedulesWorkspaceByWorkspaceIdResponses]; export type GetAdminBreachNotificationArtifactsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/breach-notification-artifacts/{id}"; }; export type GetAdminBreachNotificationArtifactsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminBreachNotificationArtifactsByIdError = GetAdminBreachNotificationArtifactsByIdErrors[keyof GetAdminBreachNotificationArtifactsByIdErrors]; export type GetAdminBreachNotificationArtifactsByIdResponses = { /** * Success */ 200: { data?: BreachNotificationArtifact; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminBreachNotificationArtifactsByIdResponse = GetAdminBreachNotificationArtifactsByIdResponses[keyof GetAdminBreachNotificationArtifactsByIdResponses]; export type PatchAdminBreachNotificationArtifactsByIdData = { /** * Request body for the /breach-notification-artifacts/:id operation on breach-notification-artifact resource */ body?: { data: { attributes?: { /** * Generated notification text */ content?: string | null; metadata?: { [key: string]: unknown; } | null; /** * Number of recipients for individual notifications */ recipient_count?: number | null; status?: "draft" | "reviewed" | "sent"; }; id: string; relationships?: { [key: string]: never; }; type?: "breach-notification-artifact"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/breach-notification-artifacts/{id}"; }; export type PatchAdminBreachNotificationArtifactsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminBreachNotificationArtifactsByIdError = PatchAdminBreachNotificationArtifactsByIdErrors[keyof PatchAdminBreachNotificationArtifactsByIdErrors]; export type PatchAdminBreachNotificationArtifactsByIdResponses = { /** * Success */ 200: { data?: BreachNotificationArtifact; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminBreachNotificationArtifactsByIdResponse = PatchAdminBreachNotificationArtifactsByIdResponses[keyof PatchAdminBreachNotificationArtifactsByIdResponses]; export type GetAdminCrawlerNewsSummariesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/news-summaries/{id}"; }; export type GetAdminCrawlerNewsSummariesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrawlerNewsSummariesByIdError = GetAdminCrawlerNewsSummariesByIdErrors[keyof GetAdminCrawlerNewsSummariesByIdErrors]; export type GetAdminCrawlerNewsSummariesByIdResponses = { /** * Success */ 200: { data?: NewsSummary; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrawlerNewsSummariesByIdResponse = GetAdminCrawlerNewsSummariesByIdResponses[keyof GetAdminCrawlerNewsSummariesByIdResponses]; export type DeleteAdminClinicalPracticeToolsCatalogByIdPermanentData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-tools/catalog/{id}/permanent"; }; export type DeleteAdminClinicalPracticeToolsCatalogByIdPermanentErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalPracticeToolsCatalogByIdPermanentError = DeleteAdminClinicalPracticeToolsCatalogByIdPermanentErrors[keyof DeleteAdminClinicalPracticeToolsCatalogByIdPermanentErrors]; export type DeleteAdminClinicalPracticeToolsCatalogByIdPermanentResponses = { /** * Deleted successfully */ 200: unknown; }; export type DeleteAdminSupportQueuesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/queues/{id}"; }; export type DeleteAdminSupportQueuesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminSupportQueuesByIdError = DeleteAdminSupportQueuesByIdErrors[keyof DeleteAdminSupportQueuesByIdErrors]; export type DeleteAdminSupportQueuesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminSupportQueuesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/queues/{id}"; }; export type GetAdminSupportQueuesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSupportQueuesByIdError = GetAdminSupportQueuesByIdErrors[keyof GetAdminSupportQueuesByIdErrors]; export type GetAdminSupportQueuesByIdResponses = { /** * Success */ 200: { data?: SupportQueue; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSupportQueuesByIdResponse = GetAdminSupportQueuesByIdResponses[keyof GetAdminSupportQueuesByIdResponses]; export type PatchAdminSupportQueuesByIdData = { /** * Request body for the /support/queues/:id operation on support-queue resource */ body?: { data: { attributes?: { ai_agent_id?: string | null; ai_mode?: "ai_first" | "human_first" | "ai_only"; business_hours?: { [key: string]: unknown; } | null; description?: string | null; is_default?: boolean | null; name?: string | null; priority_boost?: number | null; sla_policy_id?: string | null; type?: "external" | "internal" | "mixed"; }; id: string; relationships?: { [key: string]: never; }; type?: "support-queue"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/queues/{id}"; }; export type PatchAdminSupportQueuesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSupportQueuesByIdError = PatchAdminSupportQueuesByIdErrors[keyof PatchAdminSupportQueuesByIdErrors]; export type PatchAdminSupportQueuesByIdResponses = { /** * Success */ 200: { data?: SupportQueue; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSupportQueuesByIdResponse = PatchAdminSupportQueuesByIdResponses[keyof PatchAdminSupportQueuesByIdResponses]; export type GetAdminSearchIndexesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/search/indexes"; }; export type GetAdminSearchIndexesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSearchIndexesError = GetAdminSearchIndexesErrors[keyof GetAdminSearchIndexesErrors]; export type GetAdminSearchIndexesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a search */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSearchIndexesResponse = GetAdminSearchIndexesResponses[keyof GetAdminSearchIndexesResponses]; export type GetAdminFeatureDefinitionsByApplicationByApplicationIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { application_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/feature-definitions/by-application/{application_id}"; }; export type GetAdminFeatureDefinitionsByApplicationByApplicationIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminFeatureDefinitionsByApplicationByApplicationIdError = GetAdminFeatureDefinitionsByApplicationByApplicationIdErrors[keyof GetAdminFeatureDefinitionsByApplicationByApplicationIdErrors]; export type GetAdminFeatureDefinitionsByApplicationByApplicationIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a feature-definition */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminFeatureDefinitionsByApplicationByApplicationIdResponse = GetAdminFeatureDefinitionsByApplicationByApplicationIdResponses[keyof GetAdminFeatureDefinitionsByApplicationByApplicationIdResponses]; export type PostAdminSupportTicketsData = { /** * Request body for the /support/tickets operation on support-ticket resource */ body: { data: { attributes?: { assigned_agent_id?: string | null; crm_contact_id?: string | null; custom_fields?: { [key: string]: unknown; } | null; customer_email?: string | null; customer_name?: string | null; description?: string | null; external_owner_id?: string | null; invoice_id?: string | null; owner_id?: string | null; priority?: "low" | "normal" | "high" | "urgent"; product_id?: string | null; queue_id?: string | null; sla_due_at?: unknown; sla_policy_id?: string | null; source?: "email" | "chat" | "phone" | "web_form" | "api" | "internal" | "connector_sync"; subject: string; tags?: Array | null; type?: "external" | "internal"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "support-ticket"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/tickets"; }; export type PostAdminSupportTicketsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSupportTicketsError = PostAdminSupportTicketsErrors[keyof PostAdminSupportTicketsErrors]; export type PostAdminSupportTicketsResponses = { /** * Success */ 201: { data?: SupportTicket; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSupportTicketsResponse = PostAdminSupportTicketsResponses[keyof PostAdminSupportTicketsResponses]; export type GetAdminCrawlerResultsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/results/{id}"; }; export type GetAdminCrawlerResultsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrawlerResultsByIdError = GetAdminCrawlerResultsByIdErrors[keyof GetAdminCrawlerResultsByIdErrors]; export type GetAdminCrawlerResultsByIdResponses = { /** * Success */ 200: { data?: CrawlerResult; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrawlerResultsByIdResponse = GetAdminCrawlerResultsByIdResponses[keyof GetAdminCrawlerResultsByIdResponses]; export type PatchAdminVoiceSessionsByIdStopData = { /** * Request body for the /voice/sessions/:id/stop operation on voice-session resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "voice-session"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/voice/sessions/{id}/stop"; }; export type PatchAdminVoiceSessionsByIdStopErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminVoiceSessionsByIdStopError = PatchAdminVoiceSessionsByIdStopErrors[keyof PatchAdminVoiceSessionsByIdStopErrors]; export type PatchAdminVoiceSessionsByIdStopResponses = { /** * Success */ 200: { data?: VoiceSession; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminVoiceSessionsByIdStopResponse = PatchAdminVoiceSessionsByIdStopResponses[keyof PatchAdminVoiceSessionsByIdStopResponses]; export type PatchAdminReviewsByIdEscalateData = { /** * Request body for the /reviews/:id/escalate operation on review resource */ body?: { data: { attributes?: { assigned_user_id?: string | null; priority?: "low" | "normal" | "high" | "urgent"; queue_id?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "review"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/reviews/{id}/escalate"; }; export type PatchAdminReviewsByIdEscalateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminReviewsByIdEscalateError = PatchAdminReviewsByIdEscalateErrors[keyof PatchAdminReviewsByIdEscalateErrors]; export type PatchAdminReviewsByIdEscalateResponses = { /** * Success */ 200: { data?: Review; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminReviewsByIdEscalateResponse = PatchAdminReviewsByIdEscalateResponses[keyof PatchAdminReviewsByIdEscalateResponses]; export type PostAdminRecipesImportData = { /** * Request body for the /recipes/import operation on recipes-recipe resource */ body: { data: { attributes?: { application_id?: string | null; contact_id?: string | null; cook_time_minutes?: number | null; cuisine_type?: string | null; description?: string | null; difficulty?: "easy" | "medium" | "hard"; image_url?: string | null; image_urls?: Array | null; instructions?: string | null; metadata?: { [key: string]: unknown; } | null; prep_time_minutes?: number | null; servings?: number | null; source_data?: { [key: string]: unknown; } | null; source_name?: string | null; source_provider?: string | null; source_uri?: string | null; source_url?: string | null; title: string; total_time_minutes?: number | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "recipes-recipe"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/import"; }; export type PostAdminRecipesImportErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminRecipesImportError = PostAdminRecipesImportErrors[keyof PostAdminRecipesImportErrors]; export type PostAdminRecipesImportResponses = { /** * Success */ 201: { data?: RecipesRecipe; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminRecipesImportResponse = PostAdminRecipesImportResponses[keyof PostAdminRecipesImportResponses]; export type PatchAdminEmailMarketingSenderProfilesByIdSetDefaultData = { /** * Request body for the /email-marketing/sender-profiles/:id/set-default operation on email-marketing-sender-profile resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "email-marketing-sender-profile"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/sender-profiles/{id}/set-default"; }; export type PatchAdminEmailMarketingSenderProfilesByIdSetDefaultErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailMarketingSenderProfilesByIdSetDefaultError = PatchAdminEmailMarketingSenderProfilesByIdSetDefaultErrors[keyof PatchAdminEmailMarketingSenderProfilesByIdSetDefaultErrors]; export type PatchAdminEmailMarketingSenderProfilesByIdSetDefaultResponses = { /** * Success */ 200: { data?: EmailMarketingSenderProfile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailMarketingSenderProfilesByIdSetDefaultResponse = PatchAdminEmailMarketingSenderProfilesByIdSetDefaultResponses[keyof PatchAdminEmailMarketingSenderProfilesByIdSetDefaultResponses]; export type DeleteAdminAgentsByIdTrainingExamplesByExampleIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { example_id: string; /** * Agent ID (from URL path parameter) */ id: string; }; query?: never; url: "/admin/agents/{id}/training-examples/{example_id}"; }; export type DeleteAdminAgentsByIdTrainingExamplesByExampleIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminAgentsByIdTrainingExamplesByExampleIdError = DeleteAdminAgentsByIdTrainingExamplesByExampleIdErrors[keyof DeleteAdminAgentsByIdTrainingExamplesByExampleIdErrors]; export type DeleteAdminAgentsByIdTrainingExamplesByExampleIdResponses = { /** * Success */ 200: { [key: string]: unknown; }; }; export type DeleteAdminAgentsByIdTrainingExamplesByExampleIdResponse = DeleteAdminAgentsByIdTrainingExamplesByExampleIdResponses[keyof DeleteAdminAgentsByIdTrainingExamplesByExampleIdResponses]; export type PostAdminAgentsImportData = { /** * Request body for the /agents/import operation on agent resource */ body: { data: { attributes?: { data: { [key: string]: unknown; }; }; relationships?: { [key: string]: never; }; type?: "agent"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agents/import"; }; export type PostAdminAgentsImportErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAgentsImportError = PostAdminAgentsImportErrors[keyof PostAdminAgentsImportErrors]; export type PostAdminAgentsImportResponses = { /** * Success */ 201: { data?: Agent; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAgentsImportResponse = PostAdminAgentsImportResponses[keyof PostAdminAgentsImportResponses]; export type GetAdminExtractionResultsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/results"; }; export type GetAdminExtractionResultsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionResultsError = GetAdminExtractionResultsErrors[keyof GetAdminExtractionResultsErrors]; export type GetAdminExtractionResultsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a extraction-result */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionResultsResponse = GetAdminExtractionResultsResponses[keyof GetAdminExtractionResultsResponses]; export type PatchAdminWebhookConfigsByIdRotateSecretData = { /** * Request body for the /webhook-configs/:id/rotate-secret operation on webhook-config resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "webhook-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/webhook-configs/{id}/rotate-secret"; }; export type PatchAdminWebhookConfigsByIdRotateSecretErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminWebhookConfigsByIdRotateSecretError = PatchAdminWebhookConfigsByIdRotateSecretErrors[keyof PatchAdminWebhookConfigsByIdRotateSecretErrors]; export type PatchAdminWebhookConfigsByIdRotateSecretResponses = { /** * Success */ 200: { data?: WebhookConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminWebhookConfigsByIdRotateSecretResponse = PatchAdminWebhookConfigsByIdRotateSecretResponses[keyof PatchAdminWebhookConfigsByIdRotateSecretResponses]; export type GetAdminSettlementStatementsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/settlement-statements/{id}"; }; export type GetAdminSettlementStatementsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSettlementStatementsByIdError = GetAdminSettlementStatementsByIdErrors[keyof GetAdminSettlementStatementsByIdErrors]; export type GetAdminSettlementStatementsByIdResponses = { /** * Success */ 200: { data?: SettlementStatement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSettlementStatementsByIdResponse = GetAdminSettlementStatementsByIdResponses[keyof GetAdminSettlementStatementsByIdResponses]; export type PatchAdminExtractionResultsByIdRegenerateData = { /** * Request body for the /extraction/results/:id/regenerate operation on extraction-result resource */ body?: { data: { attributes?: { feedback?: string | null; fields_to_retry?: Array | null; schema_version_id?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "extraction-result"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/results/{id}/regenerate"; }; export type PatchAdminExtractionResultsByIdRegenerateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminExtractionResultsByIdRegenerateError = PatchAdminExtractionResultsByIdRegenerateErrors[keyof PatchAdminExtractionResultsByIdRegenerateErrors]; export type PatchAdminExtractionResultsByIdRegenerateResponses = { /** * Success */ 200: { data?: ExtractionResult; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminExtractionResultsByIdRegenerateResponse = PatchAdminExtractionResultsByIdRegenerateResponses[keyof PatchAdminExtractionResultsByIdRegenerateResponses]; export type PatchAdminCrawlerNewsMonitorsByIdResumeData = { /** * Request body for the /crawler/news-monitors/:id/resume operation on news-monitor resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "news-monitor"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/news-monitors/{id}/resume"; }; export type PatchAdminCrawlerNewsMonitorsByIdResumeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrawlerNewsMonitorsByIdResumeError = PatchAdminCrawlerNewsMonitorsByIdResumeErrors[keyof PatchAdminCrawlerNewsMonitorsByIdResumeErrors]; export type PatchAdminCrawlerNewsMonitorsByIdResumeResponses = { /** * Success */ 200: { data?: NewsMonitor; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrawlerNewsMonitorsByIdResumeResponse = PatchAdminCrawlerNewsMonitorsByIdResumeResponses[keyof PatchAdminCrawlerNewsMonitorsByIdResumeResponses]; export type PatchAdminEmailMarketingTemplatesByIdPreviewData = { /** * Request body for the /email-marketing/templates/:id/preview operation on email-marketing-template resource */ body?: { data: { attributes?: { variables?: { [key: string]: unknown; } | null; }; id: string; relationships?: { [key: string]: never; }; type?: "email-marketing-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/templates/{id}/preview"; }; export type PatchAdminEmailMarketingTemplatesByIdPreviewErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailMarketingTemplatesByIdPreviewError = PatchAdminEmailMarketingTemplatesByIdPreviewErrors[keyof PatchAdminEmailMarketingTemplatesByIdPreviewErrors]; export type PatchAdminEmailMarketingTemplatesByIdPreviewResponses = { /** * Success */ 200: { data?: EmailMarketingTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailMarketingTemplatesByIdPreviewResponse = PatchAdminEmailMarketingTemplatesByIdPreviewResponses[keyof PatchAdminEmailMarketingTemplatesByIdPreviewResponses]; export type PostAdminWorkspacesByWorkspaceIdExtractionDocumentsDismissAllTrainedData = { /** * Request body for the /workspaces/:workspace_id/extraction/documents/dismiss-all-trained operation on bulk-dismissal-result resource */ body?: { data: { attributes?: { [key: string]: never; }; relationships?: { [key: string]: never; }; type?: "bulk-dismissal-result"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspaces/{workspace_id}/extraction/documents/dismiss-all-trained"; }; export type PostAdminWorkspacesByWorkspaceIdExtractionDocumentsDismissAllTrainedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminWorkspacesByWorkspaceIdExtractionDocumentsDismissAllTrainedError = PostAdminWorkspacesByWorkspaceIdExtractionDocumentsDismissAllTrainedErrors[keyof PostAdminWorkspacesByWorkspaceIdExtractionDocumentsDismissAllTrainedErrors]; export type PostAdminWorkspacesByWorkspaceIdExtractionDocumentsDismissAllTrainedResponses = { /** * Success */ 201: { data?: BulkDismissalResult; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminWorkspacesByWorkspaceIdExtractionDocumentsDismissAllTrainedResponse = PostAdminWorkspacesByWorkspaceIdExtractionDocumentsDismissAllTrainedResponses[keyof PostAdminWorkspacesByWorkspaceIdExtractionDocumentsDismissAllTrainedResponses]; export type GetAdminImpactAssessmentsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/impact-assessments"; }; export type GetAdminImpactAssessmentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminImpactAssessmentsError = GetAdminImpactAssessmentsErrors[keyof GetAdminImpactAssessmentsErrors]; export type GetAdminImpactAssessmentsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a data-protection-impact-assessment */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminImpactAssessmentsResponse = GetAdminImpactAssessmentsResponses[keyof GetAdminImpactAssessmentsResponses]; export type PostAdminImpactAssessmentsData = { /** * Request body for the /impact-assessments operation on data-protection-impact-assessment resource */ body: { data: { attributes?: { /** * Email or name of the person conducting the assessment */ assessor?: string | null; description: string; findings?: string | null; mitigations?: string | null; /** * Optional link to ProcessingActivity record */ processing_activity_id?: string | null; risk_level: "low" | "medium" | "high" | "critical"; status?: "draft" | "in_review" | "approved" | "rejected"; title: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "data-protection-impact-assessment"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/impact-assessments"; }; export type PostAdminImpactAssessmentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminImpactAssessmentsError = PostAdminImpactAssessmentsErrors[keyof PostAdminImpactAssessmentsErrors]; export type PostAdminImpactAssessmentsResponses = { /** * Success */ 201: { data?: DataProtectionImpactAssessment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminImpactAssessmentsResponse = PostAdminImpactAssessmentsResponses[keyof PostAdminImpactAssessmentsResponses]; export type DeleteAdminClinicalNoteTemplatesByIdPermanentData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/note-templates/{id}/permanent"; }; export type DeleteAdminClinicalNoteTemplatesByIdPermanentErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalNoteTemplatesByIdPermanentError = DeleteAdminClinicalNoteTemplatesByIdPermanentErrors[keyof DeleteAdminClinicalNoteTemplatesByIdPermanentErrors]; export type DeleteAdminClinicalNoteTemplatesByIdPermanentResponses = { /** * Deleted successfully */ 200: unknown; }; export type DeleteAdminAgentDeploymentsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-deployments/{id}"; }; export type DeleteAdminAgentDeploymentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminAgentDeploymentsByIdError = DeleteAdminAgentDeploymentsByIdErrors[keyof DeleteAdminAgentDeploymentsByIdErrors]; export type DeleteAdminAgentDeploymentsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminAgentDeploymentsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-deployments/{id}"; }; export type GetAdminAgentDeploymentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentDeploymentsByIdError = GetAdminAgentDeploymentsByIdErrors[keyof GetAdminAgentDeploymentsByIdErrors]; export type GetAdminAgentDeploymentsByIdResponses = { /** * Success */ 200: { data?: AgentDeployment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAgentDeploymentsByIdResponse = GetAdminAgentDeploymentsByIdResponses[keyof GetAdminAgentDeploymentsByIdResponses]; export type PatchAdminAgentDeploymentsByIdData = { /** * Request body for the /agent-deployments/:id operation on agent-deployment resource */ body?: { data: { attributes?: { allow_tenant_clone?: boolean | null; auto_deploy_agents?: boolean | null; is_application_default?: boolean | null; overrides?: { [key: string]: unknown; } | null; pinned_version_id?: string | null; seal_policy?: AgentDeploymentSealPolicyInputUpdateType; }; id: string; relationships?: { [key: string]: never; }; type?: "agent-deployment"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-deployments/{id}"; }; export type PatchAdminAgentDeploymentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminAgentDeploymentsByIdError = PatchAdminAgentDeploymentsByIdErrors[keyof PatchAdminAgentDeploymentsByIdErrors]; export type PatchAdminAgentDeploymentsByIdResponses = { /** * Success */ 200: { data?: AgentDeployment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminAgentDeploymentsByIdResponse = PatchAdminAgentDeploymentsByIdResponses[keyof PatchAdminAgentDeploymentsByIdResponses]; export type GetAdminPlanBundlesCanEnableData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { application_id: string; capability_key: string; /** * When supplied, gate 3 (`plan.capability_tiers`) is evaluated; otherwise skipped. */ plan_slug?: string; }; url: "/admin/plan-bundles/can-enable"; }; export type GetAdminPlanBundlesCanEnableErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPlanBundlesCanEnableError = GetAdminPlanBundlesCanEnableErrors[keyof GetAdminPlanBundlesCanEnableErrors]; export type GetAdminPlanBundlesCanEnableResponses = { /** * Success */ 200: { result: { [key: string]: unknown; }; }; }; export type GetAdminPlanBundlesCanEnableResponse = GetAdminPlanBundlesCanEnableResponses[keyof GetAdminPlanBundlesCanEnableResponses]; export type DeleteAdminInvoicesPaymentsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/payments/{id}"; }; export type DeleteAdminInvoicesPaymentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminInvoicesPaymentsByIdError = DeleteAdminInvoicesPaymentsByIdErrors[keyof DeleteAdminInvoicesPaymentsByIdErrors]; export type DeleteAdminInvoicesPaymentsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminInvoicesPaymentsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/payments/{id}"; }; export type GetAdminInvoicesPaymentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminInvoicesPaymentsByIdError = GetAdminInvoicesPaymentsByIdErrors[keyof GetAdminInvoicesPaymentsByIdErrors]; export type GetAdminInvoicesPaymentsByIdResponses = { /** * Success */ 200: { data?: InvoicesPayment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminInvoicesPaymentsByIdResponse = GetAdminInvoicesPaymentsByIdResponses[keyof GetAdminInvoicesPaymentsByIdResponses]; export type GetAdminClinicalSupplementRecCacheByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-rec-cache/{id}"; }; export type GetAdminClinicalSupplementRecCacheByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalSupplementRecCacheByIdError = GetAdminClinicalSupplementRecCacheByIdErrors[keyof GetAdminClinicalSupplementRecCacheByIdErrors]; export type GetAdminClinicalSupplementRecCacheByIdResponses = { /** * Success */ 200: { data?: ClinicalSupplementRecCache; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalSupplementRecCacheByIdResponse = GetAdminClinicalSupplementRecCacheByIdResponses[keyof GetAdminClinicalSupplementRecCacheByIdResponses]; export type PatchAdminClinicalSupplementRecCacheByIdData = { /** * Request body for the /clinical/supplement-rec-cache/:id operation on clinical-supplement-rec-cache resource */ body?: { data: { attributes?: { expires_at?: unknown; generated_at?: unknown; recommendations?: { [key: string]: unknown; } | null; status?: "pending" | "ready" | "expired"; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-supplement-rec-cache"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-rec-cache/{id}"; }; export type PatchAdminClinicalSupplementRecCacheByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalSupplementRecCacheByIdError = PatchAdminClinicalSupplementRecCacheByIdErrors[keyof PatchAdminClinicalSupplementRecCacheByIdErrors]; export type PatchAdminClinicalSupplementRecCacheByIdResponses = { /** * Success */ 200: { data?: ClinicalSupplementRecCache; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalSupplementRecCacheByIdResponse = PatchAdminClinicalSupplementRecCacheByIdResponses[keyof PatchAdminClinicalSupplementRecCacheByIdResponses]; export type PatchAdminClinicalNoteTemplatesCatalogByIdArchiveData = { /** * Request body for the /clinical/note-templates/catalog/:id/archive operation on clinical-note-template resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-note-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/note-templates/catalog/{id}/archive"; }; export type PatchAdminClinicalNoteTemplatesCatalogByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalNoteTemplatesCatalogByIdArchiveError = PatchAdminClinicalNoteTemplatesCatalogByIdArchiveErrors[keyof PatchAdminClinicalNoteTemplatesCatalogByIdArchiveErrors]; export type PatchAdminClinicalNoteTemplatesCatalogByIdArchiveResponses = { /** * Success */ 200: { data?: ClinicalNoteTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalNoteTemplatesCatalogByIdArchiveResponse = PatchAdminClinicalNoteTemplatesCatalogByIdArchiveResponses[keyof PatchAdminClinicalNoteTemplatesCatalogByIdArchiveResponses]; export type GetAdminCrawlerSiteConfigsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/site-configs"; }; export type GetAdminCrawlerSiteConfigsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrawlerSiteConfigsError = GetAdminCrawlerSiteConfigsErrors[keyof GetAdminCrawlerSiteConfigsErrors]; export type GetAdminCrawlerSiteConfigsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crawler-site-config */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrawlerSiteConfigsResponse = GetAdminCrawlerSiteConfigsResponses[keyof GetAdminCrawlerSiteConfigsResponses]; export type PostAdminCrawlerSiteConfigsData = { /** * Request body for the /crawler/site-configs operation on crawler-site-config resource */ body: { data: { attributes?: { browser_auth_session_id?: string | null; browser_fallback_strategy?: "native" | "sidecar"; custom_headers?: { [key: string]: unknown; } | null; domain: string; preferred_strategy?: "native" | "sidecar" | "auto" | "browser_session"; rate_limit_rpm?: number | null; requires_js?: boolean | null; respect_robots?: boolean | null; user_agent?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "crawler-site-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/site-configs"; }; export type PostAdminCrawlerSiteConfigsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrawlerSiteConfigsError = PostAdminCrawlerSiteConfigsErrors[keyof PostAdminCrawlerSiteConfigsErrors]; export type PostAdminCrawlerSiteConfigsResponses = { /** * Success */ 201: { data?: CrawlerSiteConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrawlerSiteConfigsResponse = PostAdminCrawlerSiteConfigsResponses[keyof PostAdminCrawlerSiteConfigsResponses]; export type GetAdminAmendmentRequestsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/amendment-requests/{id}"; }; export type GetAdminAmendmentRequestsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAmendmentRequestsByIdError = GetAdminAmendmentRequestsByIdErrors[keyof GetAdminAmendmentRequestsByIdErrors]; export type GetAdminAmendmentRequestsByIdResponses = { /** * Success */ 200: { data?: AmendmentRequest; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAmendmentRequestsByIdResponse = GetAdminAmendmentRequestsByIdResponses[keyof GetAdminAmendmentRequestsByIdResponses]; export type DeleteAdminClinicalPracticeToolsByIdPermanentData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-tools/{id}/permanent"; }; export type DeleteAdminClinicalPracticeToolsByIdPermanentErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalPracticeToolsByIdPermanentError = DeleteAdminClinicalPracticeToolsByIdPermanentErrors[keyof DeleteAdminClinicalPracticeToolsByIdPermanentErrors]; export type DeleteAdminClinicalPracticeToolsByIdPermanentResponses = { /** * Deleted successfully */ 200: unknown; }; export type DeleteAdminContractsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/contracts/{id}"; }; export type DeleteAdminContractsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminContractsByIdError = DeleteAdminContractsByIdErrors[keyof DeleteAdminContractsByIdErrors]; export type DeleteAdminContractsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminContractsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/contracts/{id}"; }; export type GetAdminContractsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminContractsByIdError = GetAdminContractsByIdErrors[keyof GetAdminContractsByIdErrors]; export type GetAdminContractsByIdResponses = { /** * Success */ 200: { data?: Contract; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminContractsByIdResponse = GetAdminContractsByIdResponses[keyof GetAdminContractsByIdResponses]; export type PatchAdminContractsByIdData = { /** * Request body for the /contracts/:id operation on contract resource */ body?: { data: { attributes?: { auto_renewal?: boolean | null; /** * Plain-text contract body (used by ClauseExtractor). */ body_text?: string | null; counterparty_name?: string | null; custom_fields?: { [key: string]: unknown; } | null; end_date?: string | null; external_url?: string | null; renewal_date?: string | null; renewal_notice_days?: number | null; start_date?: string | null; status?: "draft" | "active" | "expired" | "terminated" | "renewed"; title?: string | null; total_value_amount?: string | null; total_value_currency?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "contract"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/contracts/{id}"; }; export type PatchAdminContractsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminContractsByIdError = PatchAdminContractsByIdErrors[keyof PatchAdminContractsByIdErrors]; export type PatchAdminContractsByIdResponses = { /** * Success */ 200: { data?: Contract; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminContractsByIdResponse = PatchAdminContractsByIdResponses[keyof PatchAdminContractsByIdResponses]; export type GetAdminCrmContactsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; status?: "lead" | "marketing_qualified" | "sales_qualified" | "opportunity" | "customer" | "evangelist" | "churned" | "discharged"; filters?: Array<{ [key: string]: unknown; }>; tags?: Array; name?: string; owner_id?: string; }; url: "/admin/crm/contacts/workspace/{workspace_id}"; }; export type GetAdminCrmContactsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmContactsWorkspaceByWorkspaceIdError = GetAdminCrmContactsWorkspaceByWorkspaceIdErrors[keyof GetAdminCrmContactsWorkspaceByWorkspaceIdErrors]; export type GetAdminCrmContactsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crm-contact */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmContactsWorkspaceByWorkspaceIdResponse = GetAdminCrmContactsWorkspaceByWorkspaceIdResponses[keyof GetAdminCrmContactsWorkspaceByWorkspaceIdResponses]; export type PatchAdminSchedulingBookingsByIdMarkNoShowData = { /** * Request body for the /scheduling/bookings/:id/mark-no-show operation on scheduling-booking resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "scheduling-booking"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/bookings/{id}/mark-no-show"; }; export type PatchAdminSchedulingBookingsByIdMarkNoShowErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSchedulingBookingsByIdMarkNoShowError = PatchAdminSchedulingBookingsByIdMarkNoShowErrors[keyof PatchAdminSchedulingBookingsByIdMarkNoShowErrors]; export type PatchAdminSchedulingBookingsByIdMarkNoShowResponses = { /** * Success */ 200: { data?: SchedulingBooking; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSchedulingBookingsByIdMarkNoShowResponse = PatchAdminSchedulingBookingsByIdMarkNoShowResponses[keyof PatchAdminSchedulingBookingsByIdMarkNoShowResponses]; export type GetAdminExtractionResultsDocumentByDocumentIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { document_id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/results/document/{document_id}"; }; export type GetAdminExtractionResultsDocumentByDocumentIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionResultsDocumentByDocumentIdError = GetAdminExtractionResultsDocumentByDocumentIdErrors[keyof GetAdminExtractionResultsDocumentByDocumentIdErrors]; export type GetAdminExtractionResultsDocumentByDocumentIdResponses = { /** * Success */ 200: { data?: ExtractionResult; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionResultsDocumentByDocumentIdResponse = GetAdminExtractionResultsDocumentByDocumentIdResponses[keyof GetAdminExtractionResultsDocumentByDocumentIdResponses]; export type PatchAdminClinicalPracticeResourcesCatalogByIdArchiveData = { /** * Request body for the /clinical/practice-resources/catalog/:id/archive operation on clinical-practice-resource resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-practice-resource"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-resources/catalog/{id}/archive"; }; export type PatchAdminClinicalPracticeResourcesCatalogByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalPracticeResourcesCatalogByIdArchiveError = PatchAdminClinicalPracticeResourcesCatalogByIdArchiveErrors[keyof PatchAdminClinicalPracticeResourcesCatalogByIdArchiveErrors]; export type PatchAdminClinicalPracticeResourcesCatalogByIdArchiveResponses = { /** * Success */ 200: { data?: ClinicalPracticeResource; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalPracticeResourcesCatalogByIdArchiveResponse = PatchAdminClinicalPracticeResourcesCatalogByIdArchiveResponses[keyof PatchAdminClinicalPracticeResourcesCatalogByIdArchiveResponses]; export type GetAdminPermissionsMetaData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/permissions/meta"; }; export type GetAdminPermissionsMetaErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPermissionsMetaError = GetAdminPermissionsMetaErrors[keyof GetAdminPermissionsMetaErrors]; export type GetAdminPermissionsMetaResponses = { /** * Success */ 200: { data?: PermissionMeta; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPermissionsMetaResponse = GetAdminPermissionsMetaResponses[keyof GetAdminPermissionsMetaResponses]; export type GetAdminClinicalSupplementTemplateCollectionsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-template-collections"; }; export type GetAdminClinicalSupplementTemplateCollectionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalSupplementTemplateCollectionsError = GetAdminClinicalSupplementTemplateCollectionsErrors[keyof GetAdminClinicalSupplementTemplateCollectionsErrors]; export type GetAdminClinicalSupplementTemplateCollectionsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-supplement-template-collection */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalSupplementTemplateCollectionsResponse = GetAdminClinicalSupplementTemplateCollectionsResponses[keyof GetAdminClinicalSupplementTemplateCollectionsResponses]; export type PostAdminClinicalSupplementTemplateCollectionsData = { /** * Request body for the /clinical/supplement-template-collections operation on clinical-supplement-template-collection resource */ body: { data: { attributes?: { description?: string | null; metadata?: { [key: string]: unknown; } | null; name: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-supplement-template-collection"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-template-collections"; }; export type PostAdminClinicalSupplementTemplateCollectionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalSupplementTemplateCollectionsError = PostAdminClinicalSupplementTemplateCollectionsErrors[keyof PostAdminClinicalSupplementTemplateCollectionsErrors]; export type PostAdminClinicalSupplementTemplateCollectionsResponses = { /** * Success */ 201: { data?: ClinicalSupplementTemplateCollection; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalSupplementTemplateCollectionsResponse = PostAdminClinicalSupplementTemplateCollectionsResponses[keyof PostAdminClinicalSupplementTemplateCollectionsResponses]; export type PatchAdminEmailOutboundEmailsByIdSendData = { /** * Request body for the /email/outbound-emails/:id/send operation on email-outbound-email resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "email-outbound-email"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/outbound-emails/{id}/send"; }; export type PatchAdminEmailOutboundEmailsByIdSendErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailOutboundEmailsByIdSendError = PatchAdminEmailOutboundEmailsByIdSendErrors[keyof PatchAdminEmailOutboundEmailsByIdSendErrors]; export type PatchAdminEmailOutboundEmailsByIdSendResponses = { /** * Success */ 200: { data?: EmailOutboundEmail; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailOutboundEmailsByIdSendResponse = PatchAdminEmailOutboundEmailsByIdSendResponses[keyof PatchAdminEmailOutboundEmailsByIdSendResponses]; export type GetAdminComplianceRequirementCompletionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/compliance-requirement-completions/{id}"; }; export type GetAdminComplianceRequirementCompletionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminComplianceRequirementCompletionsByIdError = GetAdminComplianceRequirementCompletionsByIdErrors[keyof GetAdminComplianceRequirementCompletionsByIdErrors]; export type GetAdminComplianceRequirementCompletionsByIdResponses = { /** * Success */ 200: { data?: ComplianceRequirementCompletion; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminComplianceRequirementCompletionsByIdResponse = GetAdminComplianceRequirementCompletionsByIdResponses[keyof GetAdminComplianceRequirementCompletionsByIdResponses]; export type PostAdminAgentsByIdPublishVersionData = { /** * Request body for the /agents/:id/publish-version operation on agent resource */ body: { data: { attributes?: { changes_summary?: string | null; version_number: number; }; relationships?: { [key: string]: never; }; type?: "agent"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { /** * Agent ID (from URL path parameter) */ id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agents/{id}/publish-version"; }; export type PostAdminAgentsByIdPublishVersionErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAgentsByIdPublishVersionError = PostAdminAgentsByIdPublishVersionErrors[keyof PostAdminAgentsByIdPublishVersionErrors]; export type PostAdminAgentsByIdPublishVersionResponses = { /** * Success */ 201: { /** * A "Resource object" representing a agent */ data?: { /** * An attributes object for a agent */ attributes?: { /** * Stable catalog taxonomy for what the agent primarily does * (for example: document_extraction, classification, generation, advisory). * */ agent_function?: string | null; /** * When true (default), tenants can customize the agent's behavior via the `instructions` field. * When false, `instructions` is ignored during prompt resolution — only `default_instructions` * (set at clone time by the ISV) is used. Prevents tenant customization of compliance-sensitive * or regulated-workflow agents. * */ allow_instruction_override: boolean; /** * When true, tenants under this application may clone this agent into their * workspace via :create_workspace_agent. When false (default), only system * actors and ISV server keys can provision workspace copies. Only meaningful * when application_id is set. * */ allow_tenant_clone: boolean; /** * When set, this agent belongs to an ISV Application definition. Null = workspace-owned. */ application_id?: string | null; /** * Optional higher-level catalog grouping for browsing and UI segmentation * (for example: operations, extraction, generation, platform_advisors). * */ catalog_family?: string | null; cloned_from_id?: string | null; /** * Field included by default. */ created_at: unknown; default_instructions?: string | null; description?: string | null; /** * Agent execution mode: :extraction for document processing, :agentic for multi-turn tool-calling */ execution_mode: "extraction" | "agentic"; /** * Stable catalog taxonomy for the primary input shape * (for example: document, text, transcript, brief, mixed_context). * */ input_kind?: string | null; /** * When true, non-privileged actors cannot modify `input_schema` on any AgentVersion * belonging to this agent. Only SystemActor, platform admins, and ISV owners can bypass. * */ input_schema_locked: boolean; instructions?: string | null; /** * When true and application_id is set, this agent is auto-provisioned to new workspaces * created under the application. Workspace copies have workspace_id set and is_application_default: false. * */ is_application_default: boolean; is_system: boolean; /** * Optional platform-curated metadata populated for system agents and overridable on clones. */ metadata: { [key: string]: unknown; }; name: string; /** * Stable catalog taxonomy for the primary output shape * (for example: structured_json, recommendation_json, scored_json, diagram_code). * */ output_kind?: string | null; /** * When true, non-privileged actors cannot modify `output_schema` on any AgentVersion * belonging to this agent. Only SystemActor, platform admins, and ISV owners can bypass. * Used to protect production schemas from accidental changes. * */ output_schema_locked: boolean; /** * ISV-defined keyed text fragments for system prompt interpolation. * * Supports two value types per key: * - **String**: static fragment injected at every execution. The prompt placeholder * `{key}` is replaced with this string. * - **Map**: input-driven. The prompt placeholder `{key}` is replaced with the * sub-map value looked up by the execution input of the same name. * * Example: * %{ * "transcript_context" => "Always interpret as one-sided audio...", * "detail_level" => %{ * "brief" => "BRIEF: bullet points only, <400 words.", * "standard" => "STANDARD: rich bullets, 2-4 sentences each.", * "detailed" => "DETAILED: comprehensive documentation." * } * } * * With this config, a prompt template containing `{transcript_context}` and * `{detail_level}` — and an execution input of `detail_level: "standard"` — * produces the fully resolved system prompt with both placeholders substituted. * */ prompt_variants?: { [key: string]: unknown; } | null; /** * Points to the AgentVersion this agent was cloned from (for lineage tracking) */ source_version_id?: string | null; /** * Stable identifier for system agents. Matches registry slug. Immutable after creation. */ system_slug?: string | null; tags: Array; /** * Denormalized from workspace for unique name constraint */ tenant_id?: string | null; /** * Temporary model override for testing. Supersedes version model_id. Clear when done. */ test_model_override?: string | null; test_result?: { [key: string]: unknown; } | null; updated_at: unknown; validation_result?: { [key: string]: unknown; } | null; /** * Industry vertical for the agent (validated against extraction.config_enums 'agent_vertical') */ vertical: string; /** * List of exposed system field names to include in webhook payloads */ webhook_system_fields?: Array | null; workspace_id?: string | null; }; id: string; /** * A relationships object for a agent */ relationships?: { versions?: { /** * Relationship data for versions */ data?: Array<{ id: string; meta?: { [key: string]: unknown; }; type: string; }>; }; workspace?: { /** * An identifier for workspace */ data?: { id: string; meta?: { [key: string]: unknown; }; type: string; } | null; }; }; type: string; }; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAgentsByIdPublishVersionResponse = PostAdminAgentsByIdPublishVersionResponses[keyof PostAdminAgentsByIdPublishVersionResponses]; export type PatchAdminAgentDeploymentsByIdAcceptUpdateData = { /** * Request body for the /agent-deployments/:id/accept-update operation on agent-deployment resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "agent-deployment"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-deployments/{id}/accept-update"; }; export type PatchAdminAgentDeploymentsByIdAcceptUpdateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminAgentDeploymentsByIdAcceptUpdateError = PatchAdminAgentDeploymentsByIdAcceptUpdateErrors[keyof PatchAdminAgentDeploymentsByIdAcceptUpdateErrors]; export type PatchAdminAgentDeploymentsByIdAcceptUpdateResponses = { /** * Success */ 200: { data?: AgentDeployment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminAgentDeploymentsByIdAcceptUpdateResponse = PatchAdminAgentDeploymentsByIdAcceptUpdateResponses[keyof PatchAdminAgentDeploymentsByIdAcceptUpdateResponses]; export type GetAdminClinicalSupplementTemplatesCatalogData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-templates/catalog"; }; export type GetAdminClinicalSupplementTemplatesCatalogErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalSupplementTemplatesCatalogError = GetAdminClinicalSupplementTemplatesCatalogErrors[keyof GetAdminClinicalSupplementTemplatesCatalogErrors]; export type GetAdminClinicalSupplementTemplatesCatalogResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-supplement-template */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalSupplementTemplatesCatalogResponse = GetAdminClinicalSupplementTemplatesCatalogResponses[keyof GetAdminClinicalSupplementTemplatesCatalogResponses]; export type PostAdminClinicalSupplementTemplatesCatalogData = { /** * Request body for the /clinical/supplement-templates/catalog operation on clinical-supplement-template resource */ body: { data: { attributes?: { applicable_conditions?: Array | null; category?: string | null; description?: string | null; metadata?: { [key: string]: unknown; } | null; name: string; supplements: Array<{ [key: string]: unknown; }>; tags?: Array | null; }; relationships?: { [key: string]: never; }; type?: "clinical-supplement-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-templates/catalog"; }; export type PostAdminClinicalSupplementTemplatesCatalogErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalSupplementTemplatesCatalogError = PostAdminClinicalSupplementTemplatesCatalogErrors[keyof PostAdminClinicalSupplementTemplatesCatalogErrors]; export type PostAdminClinicalSupplementTemplatesCatalogResponses = { /** * Success */ 201: { data?: ClinicalSupplementTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalSupplementTemplatesCatalogResponse = PostAdminClinicalSupplementTemplatesCatalogResponses[keyof PostAdminClinicalSupplementTemplatesCatalogResponses]; export type PostAdminAiSearchData = { /** * Request body for the /ai/search operation on search resource */ body: { data: { attributes?: { query: string; top_k?: number | null; }; relationships?: { [key: string]: never; }; type?: "search"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ai/search"; }; export type PostAdminAiSearchErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAiSearchError = PostAdminAiSearchErrors[keyof PostAdminAiSearchErrors]; export type PostAdminAiSearchResponses = { /** * Success */ 201: { data?: Search; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAiSearchResponse = PostAdminAiSearchResponses[keyof PostAdminAiSearchResponses]; export type PostAdminStorageFilesByIdDownloadUrlData = { /** * Request body for the /storage-files/:id/download-url operation on storage-file resource */ body?: { data: { expires_in?: number | null; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/storage-files/{id}/download-url"; }; export type PostAdminStorageFilesByIdDownloadUrlErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminStorageFilesByIdDownloadUrlError = PostAdminStorageFilesByIdDownloadUrlErrors[keyof PostAdminStorageFilesByIdDownloadUrlErrors]; export type PostAdminStorageFilesByIdDownloadUrlResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminStorageFilesByIdDownloadUrlResponse = PostAdminStorageFilesByIdDownloadUrlResponses[keyof PostAdminStorageFilesByIdDownloadUrlResponses]; export type GetAdminCreditPackagesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/credit-packages"; }; export type GetAdminCreditPackagesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCreditPackagesError = GetAdminCreditPackagesErrors[keyof GetAdminCreditPackagesErrors]; export type GetAdminCreditPackagesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a credit-package */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCreditPackagesResponse = GetAdminCreditPackagesResponses[keyof GetAdminCreditPackagesResponses]; export type PostAdminCreditPackagesData = { /** * Request body for the /credit-packages operation on credit-package resource */ body: { data: { attributes?: { /** * Optional - inferred from x-application-key header when not provided */ application_id?: string | null; credits: number; name: string; price: { amount: string; currency: string; }; slug: string; }; relationships?: { [key: string]: never; }; type?: "credit-package"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/credit-packages"; }; export type PostAdminCreditPackagesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCreditPackagesError = PostAdminCreditPackagesErrors[keyof PostAdminCreditPackagesErrors]; export type PostAdminCreditPackagesResponses = { /** * Success */ 201: { data?: CreditPackage; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCreditPackagesResponse = PostAdminCreditPackagesResponses[keyof PostAdminCreditPackagesResponses]; export type PostAdminExtractionBatchesByIdFinishAllData = { /** * Request body for the /extraction/batches/:id/finish-all operation on extraction-batch resource */ body: { data: { batch_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/extraction/batches/{id}/finish-all"; }; export type PostAdminExtractionBatchesByIdFinishAllErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminExtractionBatchesByIdFinishAllError = PostAdminExtractionBatchesByIdFinishAllErrors[keyof PostAdminExtractionBatchesByIdFinishAllErrors]; export type PostAdminExtractionBatchesByIdFinishAllResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminExtractionBatchesByIdFinishAllResponse = PostAdminExtractionBatchesByIdFinishAllResponses[keyof PostAdminExtractionBatchesByIdFinishAllResponses]; export type GetAdminSearchSavedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/search/saved"; }; export type GetAdminSearchSavedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSearchSavedError = GetAdminSearchSavedErrors[keyof GetAdminSearchSavedErrors]; export type GetAdminSearchSavedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a saved-search */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSearchSavedResponse = GetAdminSearchSavedResponses[keyof GetAdminSearchSavedResponses]; export type PostAdminSearchSavedData = { /** * Request body for the /search/saved operation on saved-search resource */ body: { data: { attributes?: { filters?: { [key: string]: unknown; } | null; is_shared?: boolean | null; name: string; query: string; search_type?: "keyword" | "semantic"; }; relationships?: { [key: string]: never; }; type?: "saved-search"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/search/saved"; }; export type PostAdminSearchSavedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSearchSavedError = PostAdminSearchSavedErrors[keyof PostAdminSearchSavedErrors]; export type PostAdminSearchSavedResponses = { /** * Success */ 201: { data?: SavedSearch; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSearchSavedResponse = PostAdminSearchSavedResponses[keyof PostAdminSearchSavedResponses]; export type PatchAdminUsersAuthOauthLinkData = { /** * Request body for the /users/auth/oauth/link operation on user resource */ body: { data: { attributes?: { /** * OAuth provider token bundle. May include access_token, refresh_token, expires_in. */ oauth_tokens: { [key: string]: unknown; }; provider: string; /** * OAuth provider user_info payload — must include sub/uid/id. */ user_info: { [key: string]: unknown; }; }; id: string; relationships?: { [key: string]: never; }; type?: "user"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/users/auth/oauth/link"; }; export type PatchAdminUsersAuthOauthLinkErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminUsersAuthOauthLinkError = PatchAdminUsersAuthOauthLinkErrors[keyof PatchAdminUsersAuthOauthLinkErrors]; export type PatchAdminUsersAuthOauthLinkResponses = { /** * Success */ 200: { data?: User; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminUsersAuthOauthLinkResponse = PatchAdminUsersAuthOauthLinkResponses[keyof PatchAdminUsersAuthOauthLinkResponses]; export type DeleteAdminEmailMarketingTemplatesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/templates/{id}"; }; export type DeleteAdminEmailMarketingTemplatesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminEmailMarketingTemplatesByIdError = DeleteAdminEmailMarketingTemplatesByIdErrors[keyof DeleteAdminEmailMarketingTemplatesByIdErrors]; export type DeleteAdminEmailMarketingTemplatesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminEmailMarketingTemplatesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/templates/{id}"; }; export type GetAdminEmailMarketingTemplatesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailMarketingTemplatesByIdError = GetAdminEmailMarketingTemplatesByIdErrors[keyof GetAdminEmailMarketingTemplatesByIdErrors]; export type GetAdminEmailMarketingTemplatesByIdResponses = { /** * Success */ 200: { data?: EmailMarketingTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailMarketingTemplatesByIdResponse = GetAdminEmailMarketingTemplatesByIdResponses[keyof GetAdminEmailMarketingTemplatesByIdResponses]; export type PatchAdminEmailMarketingTemplatesByIdData = { /** * Request body for the /email-marketing/templates/:id operation on email-marketing-template resource */ body?: { data: { attributes?: { ai_instructions?: string | null; body_template?: string | null; name?: string | null; subject_template?: string | null; type?: "template" | "prompt"; variables?: Array | null; }; id: string; relationships?: { [key: string]: never; }; type?: "email-marketing-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/templates/{id}"; }; export type PatchAdminEmailMarketingTemplatesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailMarketingTemplatesByIdError = PatchAdminEmailMarketingTemplatesByIdErrors[keyof PatchAdminEmailMarketingTemplatesByIdErrors]; export type PatchAdminEmailMarketingTemplatesByIdResponses = { /** * Success */ 200: { data?: EmailMarketingTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailMarketingTemplatesByIdResponse = PatchAdminEmailMarketingTemplatesByIdResponses[keyof PatchAdminEmailMarketingTemplatesByIdResponses]; export type GetAdminDocumentsStatsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/documents/stats"; }; export type GetAdminDocumentsStatsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminDocumentsStatsError = GetAdminDocumentsStatsErrors[keyof GetAdminDocumentsStatsErrors]; export type GetAdminDocumentsStatsResponses = { /** * Success */ 200: { data?: DocumentStats; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminDocumentsStatsResponse = GetAdminDocumentsStatsResponses[keyof GetAdminDocumentsStatsResponses]; export type PostAdminAiGraphRelationshipsDeleteData = { /** * Request body for the /ai/graph/relationships/delete operation on graph-node resource */ body: { data: { from_node_id: string; relationship_type: string; to_node_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/ai/graph/relationships/delete"; }; export type PostAdminAiGraphRelationshipsDeleteErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAiGraphRelationshipsDeleteError = PostAdminAiGraphRelationshipsDeleteErrors[keyof PostAdminAiGraphRelationshipsDeleteErrors]; export type PostAdminAiGraphRelationshipsDeleteResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminAiGraphRelationshipsDeleteResponse = PostAdminAiGraphRelationshipsDeleteResponses[keyof PostAdminAiGraphRelationshipsDeleteResponses]; export type GetAdminReviewQueuesSummariesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/review-queues/summaries"; }; export type GetAdminReviewQueuesSummariesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminReviewQueuesSummariesError = GetAdminReviewQueuesSummariesErrors[keyof GetAdminReviewQueuesSummariesErrors]; export type GetAdminReviewQueuesSummariesResponses = { /** * Success */ 200: Array<{ [key: string]: unknown; }>; }; export type GetAdminReviewQueuesSummariesResponse = GetAdminReviewQueuesSummariesResponses[keyof GetAdminReviewQueuesSummariesResponses]; export type GetAdminCrawlerBrowserSessionsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/browser-sessions"; }; export type GetAdminCrawlerBrowserSessionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrawlerBrowserSessionsError = GetAdminCrawlerBrowserSessionsErrors[keyof GetAdminCrawlerBrowserSessionsErrors]; export type GetAdminCrawlerBrowserSessionsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a browser-session */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrawlerBrowserSessionsResponse = GetAdminCrawlerBrowserSessionsResponses[keyof GetAdminCrawlerBrowserSessionsResponses]; export type PostAdminCrawlerBrowserSessionsData = { /** * Request body for the /crawler/browser-sessions operation on browser-session resource */ body: { data: { attributes?: { /** * The target domain this session authenticates against (e.g. example.com) */ domain: string; expires_at?: unknown; session_state: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "browser-session"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/browser-sessions"; }; export type PostAdminCrawlerBrowserSessionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrawlerBrowserSessionsError = PostAdminCrawlerBrowserSessionsErrors[keyof PostAdminCrawlerBrowserSessionsErrors]; export type PostAdminCrawlerBrowserSessionsResponses = { /** * Success */ 201: { data?: BrowserSession; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrawlerBrowserSessionsResponse = PostAdminCrawlerBrowserSessionsResponses[keyof PostAdminCrawlerBrowserSessionsResponses]; export type GetAdminWebhookDeliveriesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/webhook-deliveries"; }; export type GetAdminWebhookDeliveriesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWebhookDeliveriesError = GetAdminWebhookDeliveriesErrors[keyof GetAdminWebhookDeliveriesErrors]; export type GetAdminWebhookDeliveriesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a webhook-delivery */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWebhookDeliveriesResponse = GetAdminWebhookDeliveriesResponses[keyof GetAdminWebhookDeliveriesResponses]; export type GetAdminClinicalInsuranceAuthorizationsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; insurance_record_id: string; }; url: "/admin/clinical/insurance-authorizations"; }; export type GetAdminClinicalInsuranceAuthorizationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalInsuranceAuthorizationsError = GetAdminClinicalInsuranceAuthorizationsErrors[keyof GetAdminClinicalInsuranceAuthorizationsErrors]; export type GetAdminClinicalInsuranceAuthorizationsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-insurance-authorization */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalInsuranceAuthorizationsResponse = GetAdminClinicalInsuranceAuthorizationsResponses[keyof GetAdminClinicalInsuranceAuthorizationsResponses]; export type PostAdminClinicalInsuranceAuthorizationsData = { /** * Request body for the /clinical/insurance-authorizations operation on clinical-insurance-authorization resource */ body: { data: { attributes?: { authorization_end?: string | null; authorization_start?: string | null; authorized_units: number; cpt_codes_authorized?: Array | null; insurance_record_id: string; metadata?: { [key: string]: unknown; } | null; notes?: string | null; reauthorization_reminder?: string | null; status?: "active" | "exhausted" | "expired" | "cancelled"; unit_type: "visits" | "hours"; used_units?: number | null; }; relationships?: { [key: string]: never; }; type?: "clinical-insurance-authorization"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/insurance-authorizations"; }; export type PostAdminClinicalInsuranceAuthorizationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalInsuranceAuthorizationsError = PostAdminClinicalInsuranceAuthorizationsErrors[keyof PostAdminClinicalInsuranceAuthorizationsErrors]; export type PostAdminClinicalInsuranceAuthorizationsResponses = { /** * Success */ 201: { data?: ClinicalInsuranceAuthorization; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalInsuranceAuthorizationsResponse = PostAdminClinicalInsuranceAuthorizationsResponses[keyof PostAdminClinicalInsuranceAuthorizationsResponses]; export type PatchAdminPipelineExecutionsByIdApproveData = { /** * Request body for the /pipeline-executions/:id/approve operation on pipeline-execution resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "pipeline-execution"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pipeline-executions/{id}/approve"; }; export type PatchAdminPipelineExecutionsByIdApproveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPipelineExecutionsByIdApproveError = PatchAdminPipelineExecutionsByIdApproveErrors[keyof PatchAdminPipelineExecutionsByIdApproveErrors]; export type PatchAdminPipelineExecutionsByIdApproveResponses = { /** * Success */ 200: { data?: PipelineExecution; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPipelineExecutionsByIdApproveResponse = PatchAdminPipelineExecutionsByIdApproveResponses[keyof PatchAdminPipelineExecutionsByIdApproveResponses]; export type GetAdminExtractionDocumentsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/documents"; }; export type GetAdminExtractionDocumentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionDocumentsError = GetAdminExtractionDocumentsErrors[keyof GetAdminExtractionDocumentsErrors]; export type GetAdminExtractionDocumentsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a extraction-document */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionDocumentsResponse = GetAdminExtractionDocumentsResponses[keyof GetAdminExtractionDocumentsResponses]; export type GetAdminAgentVersionRevisionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-version-revisions/{id}"; }; export type GetAdminAgentVersionRevisionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentVersionRevisionsByIdError = GetAdminAgentVersionRevisionsByIdErrors[keyof GetAdminAgentVersionRevisionsByIdErrors]; export type GetAdminAgentVersionRevisionsByIdResponses = { /** * Success */ 200: { data?: AgentVersionRevision; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAgentVersionRevisionsByIdResponse = GetAdminAgentVersionRevisionsByIdResponses[keyof GetAdminAgentVersionRevisionsByIdResponses]; export type GetAdminCrawlerNewsSummariesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/news-summaries"; }; export type GetAdminCrawlerNewsSummariesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrawlerNewsSummariesError = GetAdminCrawlerNewsSummariesErrors[keyof GetAdminCrawlerNewsSummariesErrors]; export type GetAdminCrawlerNewsSummariesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a news-summary */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrawlerNewsSummariesResponse = GetAdminCrawlerNewsSummariesResponses[keyof GetAdminCrawlerNewsSummariesResponses]; export type GetAdminContractsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/contracts"; }; export type GetAdminContractsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminContractsError = GetAdminContractsErrors[keyof GetAdminContractsErrors]; export type GetAdminContractsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a contract */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminContractsResponse = GetAdminContractsResponses[keyof GetAdminContractsResponses]; export type PostAdminContractsData = { /** * Request body for the /contracts operation on contract resource */ body: { data: { attributes?: { auto_renewal?: boolean | null; /** * Plain-text contract body (used by ClauseExtractor). */ body_text?: string | null; connector_instance_id?: string | null; counterparty_name?: string | null; custom_fields?: { [key: string]: unknown; } | null; end_date?: string | null; external_url?: string | null; renewal_date?: string | null; renewal_notice_days?: number | null; source_id: string; source_system: "salesforce" | "hubspot" | "manual"; start_date?: string | null; status?: "draft" | "active" | "expired" | "terminated" | "renewed"; title: string; total_value_amount?: string | null; total_value_currency?: string | null; }; relationships?: { [key: string]: never; }; type?: "contract"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/contracts"; }; export type PostAdminContractsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminContractsError = PostAdminContractsErrors[keyof PostAdminContractsErrors]; export type PostAdminContractsResponses = { /** * Success */ 201: { data?: Contract; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminContractsResponse = PostAdminContractsResponses[keyof PostAdminContractsResponses]; export type GetAdminExtractionAgentsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/agents/{id}"; }; export type GetAdminExtractionAgentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionAgentsByIdError = GetAdminExtractionAgentsByIdErrors[keyof GetAdminExtractionAgentsByIdErrors]; export type GetAdminExtractionAgentsByIdResponses = { /** * Success */ 200: { data?: ExtractionAgent; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionAgentsByIdResponse = GetAdminExtractionAgentsByIdResponses[keyof GetAdminExtractionAgentsByIdResponses]; export type GetAdminSchedulingEventsByDateRangeData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; start_time: unknown; end_time: unknown; }; url: "/admin/scheduling/events/by_date_range"; }; export type GetAdminSchedulingEventsByDateRangeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingEventsByDateRangeError = GetAdminSchedulingEventsByDateRangeErrors[keyof GetAdminSchedulingEventsByDateRangeErrors]; export type GetAdminSchedulingEventsByDateRangeResponses = { /** * Success */ 200: { /** * An array of resource objects representing a scheduling-event */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingEventsByDateRangeResponse = GetAdminSchedulingEventsByDateRangeResponses[keyof GetAdminSchedulingEventsByDateRangeResponses]; export type GetAdminApplicationsByApplicationIdEmailTemplatesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { application_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/applications/{application_id}/email-templates"; }; export type GetAdminApplicationsByApplicationIdEmailTemplatesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminApplicationsByApplicationIdEmailTemplatesError = GetAdminApplicationsByApplicationIdEmailTemplatesErrors[keyof GetAdminApplicationsByApplicationIdEmailTemplatesErrors]; export type GetAdminApplicationsByApplicationIdEmailTemplatesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a email-template */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminApplicationsByApplicationIdEmailTemplatesResponse = GetAdminApplicationsByApplicationIdEmailTemplatesResponses[keyof GetAdminApplicationsByApplicationIdEmailTemplatesResponses]; export type PostAdminApplicationsByApplicationIdEmailTemplatesData = { /** * Request body for the /applications/:application_id/email-templates operation on email-template resource */ body: { data: { attributes?: { /** * Email body in markdown (supports {{variable}} interpolation) */ body_markdown: string; /** * Whether this email is sent */ enabled?: boolean | null; /** * Display name for the template */ name: string; /** * Primary brand color for email styling (hex) */ primary_color?: string | null; /** * Unique identifier for this template within the application */ slug: string; /** * Email subject line (supports {{variable}} interpolation) */ subject: string; }; relationships?: { [key: string]: never; }; type?: "email-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { /** * Optional - inferred from x-application-key header when not provided */ application_id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/applications/{application_id}/email-templates"; }; export type PostAdminApplicationsByApplicationIdEmailTemplatesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminApplicationsByApplicationIdEmailTemplatesError = PostAdminApplicationsByApplicationIdEmailTemplatesErrors[keyof PostAdminApplicationsByApplicationIdEmailTemplatesErrors]; export type PostAdminApplicationsByApplicationIdEmailTemplatesResponses = { /** * Success */ 201: { data?: EmailTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminApplicationsByApplicationIdEmailTemplatesResponse = PostAdminApplicationsByApplicationIdEmailTemplatesResponses[keyof PostAdminApplicationsByApplicationIdEmailTemplatesResponses]; export type PostAdminRecipesShoppingListsGenerateData = { /** * Request body for the /recipes/shopping-lists/generate operation on recipes-shopping-list resource */ body: { data: { meal_schedule_id: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/recipes/shopping-lists/generate"; }; export type PostAdminRecipesShoppingListsGenerateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminRecipesShoppingListsGenerateError = PostAdminRecipesShoppingListsGenerateErrors[keyof PostAdminRecipesShoppingListsGenerateErrors]; export type PostAdminRecipesShoppingListsGenerateResponses = { /** * Success */ 201: RecipesShoppingListType; }; export type PostAdminRecipesShoppingListsGenerateResponse = PostAdminRecipesShoppingListsGenerateResponses[keyof PostAdminRecipesShoppingListsGenerateResponses]; export type GetAdminImpactAssessmentsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/impact-assessments/{id}"; }; export type GetAdminImpactAssessmentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminImpactAssessmentsByIdError = GetAdminImpactAssessmentsByIdErrors[keyof GetAdminImpactAssessmentsByIdErrors]; export type GetAdminImpactAssessmentsByIdResponses = { /** * Success */ 200: { data?: DataProtectionImpactAssessment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminImpactAssessmentsByIdResponse = GetAdminImpactAssessmentsByIdResponses[keyof GetAdminImpactAssessmentsByIdResponses]; export type PatchAdminImpactAssessmentsByIdData = { /** * Request body for the /impact-assessments/:id operation on data-protection-impact-assessment resource */ body?: { data: { attributes?: { description?: string | null; findings?: string | null; mitigations?: string | null; risk_level?: "low" | "medium" | "high" | "critical"; status?: "draft" | "in_review" | "approved" | "rejected"; title?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "data-protection-impact-assessment"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/impact-assessments/{id}"; }; export type PatchAdminImpactAssessmentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminImpactAssessmentsByIdError = PatchAdminImpactAssessmentsByIdErrors[keyof PatchAdminImpactAssessmentsByIdErrors]; export type PatchAdminImpactAssessmentsByIdResponses = { /** * Success */ 200: { data?: DataProtectionImpactAssessment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminImpactAssessmentsByIdResponse = PatchAdminImpactAssessmentsByIdResponses[keyof PatchAdminImpactAssessmentsByIdResponses]; export type GetAdminCatalogClassificationSuggestionsWorkspaceByWorkspaceIdPendingData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/classification-suggestions/workspace/{workspace_id}/pending"; }; export type GetAdminCatalogClassificationSuggestionsWorkspaceByWorkspaceIdPendingErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogClassificationSuggestionsWorkspaceByWorkspaceIdPendingError = GetAdminCatalogClassificationSuggestionsWorkspaceByWorkspaceIdPendingErrors[keyof GetAdminCatalogClassificationSuggestionsWorkspaceByWorkspaceIdPendingErrors]; export type GetAdminCatalogClassificationSuggestionsWorkspaceByWorkspaceIdPendingResponses = { /** * Success */ 200: { /** * An array of resource objects representing a catalog-classification-suggestion */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogClassificationSuggestionsWorkspaceByWorkspaceIdPendingResponse = GetAdminCatalogClassificationSuggestionsWorkspaceByWorkspaceIdPendingResponses[keyof GetAdminCatalogClassificationSuggestionsWorkspaceByWorkspaceIdPendingResponses]; export type GetAdminLlmAnalyticsWorkspaceData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id?: string; }; url: "/admin/llm-analytics/workspace"; }; export type GetAdminLlmAnalyticsWorkspaceErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminLlmAnalyticsWorkspaceError = GetAdminLlmAnalyticsWorkspaceErrors[keyof GetAdminLlmAnalyticsWorkspaceErrors]; export type GetAdminLlmAnalyticsWorkspaceResponses = { /** * Success */ 200: { data?: LlmAnalytics; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminLlmAnalyticsWorkspaceResponse = GetAdminLlmAnalyticsWorkspaceResponses[keyof GetAdminLlmAnalyticsWorkspaceResponses]; export type DeleteAdminClinicalHealthMetricsByIdPermanentData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/health-metrics/{id}/permanent"; }; export type DeleteAdminClinicalHealthMetricsByIdPermanentErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalHealthMetricsByIdPermanentError = DeleteAdminClinicalHealthMetricsByIdPermanentErrors[keyof DeleteAdminClinicalHealthMetricsByIdPermanentErrors]; export type DeleteAdminClinicalHealthMetricsByIdPermanentResponses = { /** * Deleted successfully */ 200: unknown; }; export type PostAdminThreadsActiveData = { /** * Request body for the /threads/active operation on chat-thread resource */ body?: { data: { attributes?: { [key: string]: never; }; relationships?: { [key: string]: never; }; type?: "chat-thread"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/threads/active"; }; export type PostAdminThreadsActiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminThreadsActiveError = PostAdminThreadsActiveErrors[keyof PostAdminThreadsActiveErrors]; export type PostAdminThreadsActiveResponses = { /** * Success */ 201: { data?: ChatThread; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminThreadsActiveResponse = PostAdminThreadsActiveResponses[keyof PostAdminThreadsActiveResponses]; export type GetAdminPlansSlugBySlugData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { slug: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/plans/slug/{slug}"; }; export type GetAdminPlansSlugBySlugErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPlansSlugBySlugError = GetAdminPlansSlugBySlugErrors[keyof GetAdminPlansSlugBySlugErrors]; export type GetAdminPlansSlugBySlugResponses = { /** * Success */ 200: { data?: Plan; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPlansSlugBySlugResponse = GetAdminPlansSlugBySlugResponses[keyof GetAdminPlansSlugBySlugResponses]; export type GetAdminCrmPhoneNumbersEntityByEntityTypeByEntityIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { entity_type: "contact" | "company"; entity_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/phone-numbers/entity/{entity_type}/{entity_id}"; }; export type GetAdminCrmPhoneNumbersEntityByEntityTypeByEntityIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmPhoneNumbersEntityByEntityTypeByEntityIdError = GetAdminCrmPhoneNumbersEntityByEntityTypeByEntityIdErrors[keyof GetAdminCrmPhoneNumbersEntityByEntityTypeByEntityIdErrors]; export type GetAdminCrmPhoneNumbersEntityByEntityTypeByEntityIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crm-phone-number */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmPhoneNumbersEntityByEntityTypeByEntityIdResponse = GetAdminCrmPhoneNumbersEntityByEntityTypeByEntityIdResponses[keyof GetAdminCrmPhoneNumbersEntityByEntityTypeByEntityIdResponses]; export type GetAdminAgentVersionRevisionsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-version-revisions"; }; export type GetAdminAgentVersionRevisionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentVersionRevisionsError = GetAdminAgentVersionRevisionsErrors[keyof GetAdminAgentVersionRevisionsErrors]; export type GetAdminAgentVersionRevisionsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a agent-version-revision */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAgentVersionRevisionsResponse = GetAdminAgentVersionRevisionsResponses[keyof GetAdminAgentVersionRevisionsResponses]; export type GetAdminIsvRevenueByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/isv-revenue/{id}"; }; export type GetAdminIsvRevenueByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminIsvRevenueByIdError = GetAdminIsvRevenueByIdErrors[keyof GetAdminIsvRevenueByIdErrors]; export type GetAdminIsvRevenueByIdResponses = { /** * Success */ 200: { data?: IsvRevenue; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminIsvRevenueByIdResponse = GetAdminIsvRevenueByIdResponses[keyof GetAdminIsvRevenueByIdResponses]; export type DeleteAdminClinicalClientMedicationsByIdPermanentData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-medications/{id}/permanent"; }; export type DeleteAdminClinicalClientMedicationsByIdPermanentErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalClientMedicationsByIdPermanentError = DeleteAdminClinicalClientMedicationsByIdPermanentErrors[keyof DeleteAdminClinicalClientMedicationsByIdPermanentErrors]; export type DeleteAdminClinicalClientMedicationsByIdPermanentResponses = { /** * Deleted successfully */ 200: unknown; }; export type DeleteAdminInvoicesRecurringSchedulesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/recurring-schedules/{id}"; }; export type DeleteAdminInvoicesRecurringSchedulesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminInvoicesRecurringSchedulesByIdError = DeleteAdminInvoicesRecurringSchedulesByIdErrors[keyof DeleteAdminInvoicesRecurringSchedulesByIdErrors]; export type DeleteAdminInvoicesRecurringSchedulesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminInvoicesRecurringSchedulesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/recurring-schedules/{id}"; }; export type GetAdminInvoicesRecurringSchedulesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminInvoicesRecurringSchedulesByIdError = GetAdminInvoicesRecurringSchedulesByIdErrors[keyof GetAdminInvoicesRecurringSchedulesByIdErrors]; export type GetAdminInvoicesRecurringSchedulesByIdResponses = { /** * Success */ 200: { data?: InvoicesRecurringSchedule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminInvoicesRecurringSchedulesByIdResponse = GetAdminInvoicesRecurringSchedulesByIdResponses[keyof GetAdminInvoicesRecurringSchedulesByIdResponses]; export type PatchAdminInvoicesRecurringSchedulesByIdData = { /** * Request body for the /invoices/recurring-schedules/:id operation on invoices-recurring-schedule resource */ body?: { data: { attributes?: { auto_send?: boolean | null; contact_id?: string | null; end_date?: string | null; frequency?: "weekly" | "biweekly" | "monthly" | "quarterly" | "annually"; line_items?: Array<{ [key: string]: unknown; }> | null; metadata?: { [key: string]: unknown; } | null; name?: string | null; template_id?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "invoices-recurring-schedule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/recurring-schedules/{id}"; }; export type PatchAdminInvoicesRecurringSchedulesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvoicesRecurringSchedulesByIdError = PatchAdminInvoicesRecurringSchedulesByIdErrors[keyof PatchAdminInvoicesRecurringSchedulesByIdErrors]; export type PatchAdminInvoicesRecurringSchedulesByIdResponses = { /** * Success */ 200: { data?: InvoicesRecurringSchedule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvoicesRecurringSchedulesByIdResponse = PatchAdminInvoicesRecurringSchedulesByIdResponses[keyof PatchAdminInvoicesRecurringSchedulesByIdResponses]; export type GetAdminCatalogProductVariantsProductByProductIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { product_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/product-variants/product/{product_id}"; }; export type GetAdminCatalogProductVariantsProductByProductIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogProductVariantsProductByProductIdError = GetAdminCatalogProductVariantsProductByProductIdErrors[keyof GetAdminCatalogProductVariantsProductByProductIdErrors]; export type GetAdminCatalogProductVariantsProductByProductIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a catalog-product-variant */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogProductVariantsProductByProductIdResponse = GetAdminCatalogProductVariantsProductByProductIdResponses[keyof GetAdminCatalogProductVariantsProductByProductIdResponses]; export type DeleteAdminCatalogOptionValuesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/option-values/{id}"; }; export type DeleteAdminCatalogOptionValuesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCatalogOptionValuesByIdError = DeleteAdminCatalogOptionValuesByIdErrors[keyof DeleteAdminCatalogOptionValuesByIdErrors]; export type DeleteAdminCatalogOptionValuesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCatalogOptionValuesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/option-values/{id}"; }; export type GetAdminCatalogOptionValuesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogOptionValuesByIdError = GetAdminCatalogOptionValuesByIdErrors[keyof GetAdminCatalogOptionValuesByIdErrors]; export type GetAdminCatalogOptionValuesByIdResponses = { /** * Success */ 200: { data?: CatalogOptionValue; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogOptionValuesByIdResponse = GetAdminCatalogOptionValuesByIdResponses[keyof GetAdminCatalogOptionValuesByIdResponses]; export type PatchAdminCatalogOptionValuesByIdData = { /** * Request body for the /catalog/option-values/:id operation on catalog-option-value resource */ body?: { data: { attributes?: { metadata?: { [key: string]: unknown; } | null; name?: string | null; position?: number | null; slug?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "catalog-option-value"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/option-values/{id}"; }; export type PatchAdminCatalogOptionValuesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCatalogOptionValuesByIdError = PatchAdminCatalogOptionValuesByIdErrors[keyof PatchAdminCatalogOptionValuesByIdErrors]; export type PatchAdminCatalogOptionValuesByIdResponses = { /** * Success */ 200: { data?: CatalogOptionValue; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCatalogOptionValuesByIdResponse = PatchAdminCatalogOptionValuesByIdResponses[keyof PatchAdminCatalogOptionValuesByIdResponses]; export type GetAdminAgentToolsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-tools"; }; export type GetAdminAgentToolsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentToolsError = GetAdminAgentToolsErrors[keyof GetAdminAgentToolsErrors]; export type GetAdminAgentToolsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a agent-tool */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAgentToolsResponse = GetAdminAgentToolsResponses[keyof GetAdminAgentToolsResponses]; export type PostAdminTenantsByIdSchedulePurgeData = { /** * Request body for the /tenants/:id/schedule-purge operation on tenant resource */ body?: { data: { attributes?: { [key: string]: never; }; relationships?: { [key: string]: never; }; type?: "tenant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants/{id}/schedule-purge"; }; export type PostAdminTenantsByIdSchedulePurgeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminTenantsByIdSchedulePurgeError = PostAdminTenantsByIdSchedulePurgeErrors[keyof PostAdminTenantsByIdSchedulePurgeErrors]; export type PostAdminTenantsByIdSchedulePurgeResponses = { /** * Success */ 201: { data?: Tenant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminTenantsByIdSchedulePurgeResponse = PostAdminTenantsByIdSchedulePurgeResponses[keyof PostAdminTenantsByIdSchedulePurgeResponses]; export type PatchAdminCrawlerNewsMonitorsByIdArchiveData = { /** * Request body for the /crawler/news-monitors/:id/archive operation on news-monitor resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "news-monitor"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/news-monitors/{id}/archive"; }; export type PatchAdminCrawlerNewsMonitorsByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrawlerNewsMonitorsByIdArchiveError = PatchAdminCrawlerNewsMonitorsByIdArchiveErrors[keyof PatchAdminCrawlerNewsMonitorsByIdArchiveErrors]; export type PatchAdminCrawlerNewsMonitorsByIdArchiveResponses = { /** * Success */ 200: { data?: NewsMonitor; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrawlerNewsMonitorsByIdArchiveResponse = PatchAdminCrawlerNewsMonitorsByIdArchiveResponses[keyof PatchAdminCrawlerNewsMonitorsByIdArchiveResponses]; export type PostAdminDocumentsBulkDeleteData = { /** * Request body for the /documents/bulk-delete operation on operation-success resource */ body: { data: { attributes?: { ids: Array; }; relationships?: { [key: string]: never; }; type?: "operation-success"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/documents/bulk-delete"; }; export type PostAdminDocumentsBulkDeleteErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminDocumentsBulkDeleteError = PostAdminDocumentsBulkDeleteErrors[keyof PostAdminDocumentsBulkDeleteErrors]; export type PostAdminDocumentsBulkDeleteResponses = { /** * Success */ 201: { data?: OperationSuccess; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminDocumentsBulkDeleteResponse = PostAdminDocumentsBulkDeleteResponses[keyof PostAdminDocumentsBulkDeleteResponses]; export type GetAdminMeetingTranscriptsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/meeting-transcripts/{id}"; }; export type GetAdminMeetingTranscriptsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminMeetingTranscriptsByIdError = GetAdminMeetingTranscriptsByIdErrors[keyof GetAdminMeetingTranscriptsByIdErrors]; export type GetAdminMeetingTranscriptsByIdResponses = { /** * Success */ 200: { data?: MeetingTranscript; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminMeetingTranscriptsByIdResponse = GetAdminMeetingTranscriptsByIdResponses[keyof GetAdminMeetingTranscriptsByIdResponses]; export type PostAdminContentGenerateImagePromptData = { /** * Request body for the /content/generate-image-prompt operation on content-generation resource */ body: { data: { marketing_copy: string; style?: string | null; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/content/generate-image-prompt"; }; export type PostAdminContentGenerateImagePromptErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminContentGenerateImagePromptError = PostAdminContentGenerateImagePromptErrors[keyof PostAdminContentGenerateImagePromptErrors]; export type PostAdminContentGenerateImagePromptResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminContentGenerateImagePromptResponse = PostAdminContentGenerateImagePromptResponses[keyof PostAdminContentGenerateImagePromptResponses]; export type PatchAdminTenantsByIdSuspendData = { /** * Request body for the /tenants/:id/suspend operation on tenant resource */ body: { data: { attributes?: { reason: string; }; id: string; relationships?: { [key: string]: never; }; type?: "tenant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants/{id}/suspend"; }; export type PatchAdminTenantsByIdSuspendErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminTenantsByIdSuspendError = PatchAdminTenantsByIdSuspendErrors[keyof PatchAdminTenantsByIdSuspendErrors]; export type PatchAdminTenantsByIdSuspendResponses = { /** * Success */ 200: { data?: Tenant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminTenantsByIdSuspendResponse = PatchAdminTenantsByIdSuspendResponses[keyof PatchAdminTenantsByIdSuspendResponses]; export type PatchAdminClinicalGoalTemplatesCatalogByIdRestoreData = { /** * Request body for the /clinical/goal-templates/catalog/:id/restore operation on clinical-goal-template resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-goal-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-templates/catalog/{id}/restore"; }; export type PatchAdminClinicalGoalTemplatesCatalogByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalGoalTemplatesCatalogByIdRestoreError = PatchAdminClinicalGoalTemplatesCatalogByIdRestoreErrors[keyof PatchAdminClinicalGoalTemplatesCatalogByIdRestoreErrors]; export type PatchAdminClinicalGoalTemplatesCatalogByIdRestoreResponses = { /** * Success */ 200: { data?: ClinicalGoalTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalGoalTemplatesCatalogByIdRestoreResponse = PatchAdminClinicalGoalTemplatesCatalogByIdRestoreResponses[keyof PatchAdminClinicalGoalTemplatesCatalogByIdRestoreResponses]; export type GetAdminCasesAttentionData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; limit?: number; }; url: "/admin/cases/attention"; }; export type GetAdminCasesAttentionErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCasesAttentionError = GetAdminCasesAttentionErrors[keyof GetAdminCasesAttentionErrors]; export type GetAdminCasesAttentionResponses = { /** * Success */ 200: { /** * An array of resource objects representing a case */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCasesAttentionResponse = GetAdminCasesAttentionResponses[keyof GetAdminCasesAttentionResponses]; export type PatchAdminWorkspacesByIdAllocateData = { /** * Request body for the /workspaces/:id/allocate operation on workspace resource */ body: { data: { attributes?: { amount: number; }; id: string; relationships?: { [key: string]: never; }; type?: "workspace"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspaces/{id}/allocate"; }; export type PatchAdminWorkspacesByIdAllocateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminWorkspacesByIdAllocateError = PatchAdminWorkspacesByIdAllocateErrors[keyof PatchAdminWorkspacesByIdAllocateErrors]; export type PatchAdminWorkspacesByIdAllocateResponses = { /** * Success */ 200: { data?: Workspace; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminWorkspacesByIdAllocateResponse = PatchAdminWorkspacesByIdAllocateResponses[keyof PatchAdminWorkspacesByIdAllocateResponses]; export type GetAdminClinicalPracticeResourcesCategoriesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/practice-resources/categories"; }; export type GetAdminClinicalPracticeResourcesCategoriesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPracticeResourcesCategoriesError = GetAdminClinicalPracticeResourcesCategoriesErrors[keyof GetAdminClinicalPracticeResourcesCategoriesErrors]; export type GetAdminClinicalPracticeResourcesCategoriesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-practice-resource-category */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPracticeResourcesCategoriesResponse = GetAdminClinicalPracticeResourcesCategoriesResponses[keyof GetAdminClinicalPracticeResourcesCategoriesResponses]; export type PostAdminExtractionSchemaDiscoveriesBootstrapData = { /** * Request body for the /extraction/schema-discoveries/bootstrap operation on schema-discovery resource */ body: { data: { attributes?: { advanced_mode?: boolean | null; document_id: string; source?: "manual" | "ai_suggestions"; suggested_name?: string | null; workspace_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "schema-discovery"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/schema-discoveries/bootstrap"; }; export type PostAdminExtractionSchemaDiscoveriesBootstrapErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminExtractionSchemaDiscoveriesBootstrapError = PostAdminExtractionSchemaDiscoveriesBootstrapErrors[keyof PostAdminExtractionSchemaDiscoveriesBootstrapErrors]; export type PostAdminExtractionSchemaDiscoveriesBootstrapResponses = { /** * Success */ 201: { data?: SchemaDiscovery; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminExtractionSchemaDiscoveriesBootstrapResponse = PostAdminExtractionSchemaDiscoveriesBootstrapResponses[keyof PostAdminExtractionSchemaDiscoveriesBootstrapResponses]; export type PostAdminCrmPhoneNumbersData = { /** * Request body for the /crm/phone-numbers operation on crm-phone-number resource */ body: { data: { attributes?: { country_code?: string | null; entity_id: string; entity_type: "contact" | "company"; extension?: string | null; is_primary?: boolean | null; label?: "mobile" | "work" | "home" | "fax" | "main" | "other"; number: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "crm-phone-number"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/phone-numbers"; }; export type PostAdminCrmPhoneNumbersErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrmPhoneNumbersError = PostAdminCrmPhoneNumbersErrors[keyof PostAdminCrmPhoneNumbersErrors]; export type PostAdminCrmPhoneNumbersResponses = { /** * Success */ 201: { data?: CrmPhoneNumber; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrmPhoneNumbersResponse = PostAdminCrmPhoneNumbersResponses[keyof PostAdminCrmPhoneNumbersResponses]; export type PostAdminSocialAccountsData = { /** * Request body for the /social/accounts operation on social-account resource */ body: { data: { attributes?: { account_type?: "personal" | "page" | "business" | "creator"; avatar_url?: string | null; connector_instance_id: string; display_name?: string | null; is_active?: boolean | null; metadata?: { [key: string]: unknown; } | null; platform: "facebook" | "instagram" | "threads" | "twitter" | "linkedin" | "reddit" | "bluesky"; platform_user_id: string; posting_enabled?: boolean | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "social-account"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/accounts"; }; export type PostAdminSocialAccountsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSocialAccountsError = PostAdminSocialAccountsErrors[keyof PostAdminSocialAccountsErrors]; export type PostAdminSocialAccountsResponses = { /** * Success */ 201: { data?: SocialAccount; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSocialAccountsResponse = PostAdminSocialAccountsResponses[keyof PostAdminSocialAccountsResponses]; export type GetAdminPipelineNodeExecutionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pipeline-node-executions/{id}"; }; export type GetAdminPipelineNodeExecutionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPipelineNodeExecutionsByIdError = GetAdminPipelineNodeExecutionsByIdErrors[keyof GetAdminPipelineNodeExecutionsByIdErrors]; export type GetAdminPipelineNodeExecutionsByIdResponses = { /** * Success */ 200: { data?: PipelineNodeExecution; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPipelineNodeExecutionsByIdResponse = GetAdminPipelineNodeExecutionsByIdResponses[keyof GetAdminPipelineNodeExecutionsByIdResponses]; export type PatchAdminAmendmentRequestsByIdDenyData = { /** * Request body for the /amendment-requests/:id/deny operation on amendment-request resource */ body?: { data: { attributes?: { denial_reason?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "amendment-request"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/amendment-requests/{id}/deny"; }; export type PatchAdminAmendmentRequestsByIdDenyErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminAmendmentRequestsByIdDenyError = PatchAdminAmendmentRequestsByIdDenyErrors[keyof PatchAdminAmendmentRequestsByIdDenyErrors]; export type PatchAdminAmendmentRequestsByIdDenyResponses = { /** * Success */ 200: { data?: AmendmentRequest; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminAmendmentRequestsByIdDenyResponse = PatchAdminAmendmentRequestsByIdDenyResponses[keyof PatchAdminAmendmentRequestsByIdDenyResponses]; export type GetAdminEphiAssetsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ephi-assets/{id}"; }; export type GetAdminEphiAssetsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEphiAssetsByIdError = GetAdminEphiAssetsByIdErrors[keyof GetAdminEphiAssetsByIdErrors]; export type GetAdminEphiAssetsByIdResponses = { /** * Success */ 200: { data?: EphiAsset; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEphiAssetsByIdResponse = GetAdminEphiAssetsByIdResponses[keyof GetAdminEphiAssetsByIdResponses]; export type PatchAdminEphiAssetsByIdData = { /** * Request body for the /ephi-assets/:id operation on ephi-asset resource */ body?: { data: { attributes?: { asset_type?: "database" | "application" | "api_service" | "storage" | "network" | "endpoint_device" | "backup_system"; /** * Soft ref to BusinessAssociateAgreement — NOT a DB FK */ baa_document_id?: string | null; baa_status?: "in_place" | "needed" | "not_applicable"; classification?: "ephi_primary" | "ephi_secondary" | "ephi_transit" | "non_ephi"; /** * Categories of PHI this asset handles */ data_categories?: Array | null; encryption_at_rest?: boolean | null; encryption_in_transit?: boolean | null; last_assessed_at?: string | null; location?: "cloud" | "on_premise" | "hybrid"; metadata?: { [key: string]: unknown; } | null; name?: string | null; next_assessment_due?: string | null; notes?: string | null; /** * Responsible person or team */ owner?: string | null; /** * Infrastructure provider (e.g., Google Cloud, AWS) */ provider?: string | null; status?: "active" | "decommissioning" | "decommissioned"; }; id: string; relationships?: { [key: string]: never; }; type?: "ephi-asset"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ephi-assets/{id}"; }; export type PatchAdminEphiAssetsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEphiAssetsByIdError = PatchAdminEphiAssetsByIdErrors[keyof PatchAdminEphiAssetsByIdErrors]; export type PatchAdminEphiAssetsByIdResponses = { /** * Success */ 200: { data?: EphiAsset; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEphiAssetsByIdResponse = PatchAdminEphiAssetsByIdResponses[keyof PatchAdminEphiAssetsByIdResponses]; export type PatchAdminExtractionDocumentsByIdExcludeData = { /** * Request body for the /extraction/documents/:id/exclude operation on extraction-document resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "extraction-document"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/documents/{id}/exclude"; }; export type PatchAdminExtractionDocumentsByIdExcludeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminExtractionDocumentsByIdExcludeError = PatchAdminExtractionDocumentsByIdExcludeErrors[keyof PatchAdminExtractionDocumentsByIdExcludeErrors]; export type PatchAdminExtractionDocumentsByIdExcludeResponses = { /** * Success */ 200: { data?: ExtractionDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminExtractionDocumentsByIdExcludeResponse = PatchAdminExtractionDocumentsByIdExcludeResponses[keyof PatchAdminExtractionDocumentsByIdExcludeResponses]; export type PatchAdminApplicationsByIdComplianceTagsData = { /** * Request body for the /applications/:id/compliance-tags operation on application resource */ body?: { data: { attributes?: { /** * Compliance tags (GDPR, HIPAA, SOC2, etc.) for data-handling safeguards. Tags do not force MFA; app-wide MFA enforcement is configured separately via Application.mfa_policy. */ compliance_tags?: Array | null; }; id: string; relationships?: { [key: string]: never; }; type?: "application"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/applications/{id}/compliance-tags"; }; export type PatchAdminApplicationsByIdComplianceTagsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminApplicationsByIdComplianceTagsError = PatchAdminApplicationsByIdComplianceTagsErrors[keyof PatchAdminApplicationsByIdComplianceTagsErrors]; export type PatchAdminApplicationsByIdComplianceTagsResponses = { /** * Success */ 200: { data?: Application; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminApplicationsByIdComplianceTagsResponse = PatchAdminApplicationsByIdComplianceTagsResponses[keyof PatchAdminApplicationsByIdComplianceTagsResponses]; export type PostAdminInvoicesContactsData = { /** * Request body for the /invoices/contacts operation on invoices-contact resource */ body: { data: { attributes?: { email?: string | null; metadata?: { [key: string]: unknown; } | null; name: string; notes?: string | null; payment_terms_default?: string | null; phone?: string | null; tax_id?: string | null; type?: "customer" | "vendor" | "both"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "invoices-contact"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/contacts"; }; export type PostAdminInvoicesContactsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminInvoicesContactsError = PostAdminInvoicesContactsErrors[keyof PostAdminInvoicesContactsErrors]; export type PostAdminInvoicesContactsResponses = { /** * Success */ 201: { data?: InvoicesContact; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminInvoicesContactsResponse = PostAdminInvoicesContactsResponses[keyof PostAdminInvoicesContactsResponses]; export type PatchAdminInvitationsByIdResendData = { /** * Request body for the /invitations/:id/resend operation on invitation resource */ body?: { data: { attributes?: { application_id?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "invitation"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invitations/{id}/resend"; }; export type PatchAdminInvitationsByIdResendErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvitationsByIdResendError = PatchAdminInvitationsByIdResendErrors[keyof PatchAdminInvitationsByIdResendErrors]; export type PatchAdminInvitationsByIdResendResponses = { /** * Success */ 200: { data?: Invitation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvitationsByIdResendResponse = PatchAdminInvitationsByIdResendResponses[keyof PatchAdminInvitationsByIdResendResponses]; export type DeleteAdminProcessingActivitiesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/processing-activities/{id}"; }; export type DeleteAdminProcessingActivitiesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminProcessingActivitiesByIdError = DeleteAdminProcessingActivitiesByIdErrors[keyof DeleteAdminProcessingActivitiesByIdErrors]; export type DeleteAdminProcessingActivitiesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminProcessingActivitiesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/processing-activities/{id}"; }; export type GetAdminProcessingActivitiesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminProcessingActivitiesByIdError = GetAdminProcessingActivitiesByIdErrors[keyof GetAdminProcessingActivitiesByIdErrors]; export type GetAdminProcessingActivitiesByIdResponses = { /** * Success */ 200: { data?: ProcessingActivity; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminProcessingActivitiesByIdResponse = GetAdminProcessingActivitiesByIdResponses[keyof GetAdminProcessingActivitiesByIdResponses]; export type GetAdminRecipesCollectionsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; contact_id?: string; scope?: "workspace" | "contact"; }; url: "/admin/recipes/collections/workspace/{workspace_id}"; }; export type GetAdminRecipesCollectionsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesCollectionsWorkspaceByWorkspaceIdError = GetAdminRecipesCollectionsWorkspaceByWorkspaceIdErrors[keyof GetAdminRecipesCollectionsWorkspaceByWorkspaceIdErrors]; export type GetAdminRecipesCollectionsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a recipes-recipe-collection */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesCollectionsWorkspaceByWorkspaceIdResponse = GetAdminRecipesCollectionsWorkspaceByWorkspaceIdResponses[keyof GetAdminRecipesCollectionsWorkspaceByWorkspaceIdResponses]; export type GetAdminPolicyReviewSchedulesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/policy-review-schedules/{id}"; }; export type GetAdminPolicyReviewSchedulesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPolicyReviewSchedulesByIdError = GetAdminPolicyReviewSchedulesByIdErrors[keyof GetAdminPolicyReviewSchedulesByIdErrors]; export type GetAdminPolicyReviewSchedulesByIdResponses = { /** * Success */ 200: { data?: PolicyReviewSchedule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPolicyReviewSchedulesByIdResponse = GetAdminPolicyReviewSchedulesByIdResponses[keyof GetAdminPolicyReviewSchedulesByIdResponses]; export type GetAdminSupportTicketAttachmentsMessageByTicketMessageIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { ticket_message_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/ticket-attachments/message/{ticket_message_id}"; }; export type GetAdminSupportTicketAttachmentsMessageByTicketMessageIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSupportTicketAttachmentsMessageByTicketMessageIdError = GetAdminSupportTicketAttachmentsMessageByTicketMessageIdErrors[keyof GetAdminSupportTicketAttachmentsMessageByTicketMessageIdErrors]; export type GetAdminSupportTicketAttachmentsMessageByTicketMessageIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a support-ticket-attachment */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSupportTicketAttachmentsMessageByTicketMessageIdResponse = GetAdminSupportTicketAttachmentsMessageByTicketMessageIdResponses[keyof GetAdminSupportTicketAttachmentsMessageByTicketMessageIdResponses]; export type GetAdminReviewsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/reviews"; }; export type GetAdminReviewsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminReviewsError = GetAdminReviewsErrors[keyof GetAdminReviewsErrors]; export type GetAdminReviewsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a review */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminReviewsResponse = GetAdminReviewsResponses[keyof GetAdminReviewsResponses]; export type GetAdminWebhookConfigsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/webhook-configs"; }; export type GetAdminWebhookConfigsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWebhookConfigsError = GetAdminWebhookConfigsErrors[keyof GetAdminWebhookConfigsErrors]; export type GetAdminWebhookConfigsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a webhook-config */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWebhookConfigsResponse = GetAdminWebhookConfigsResponses[keyof GetAdminWebhookConfigsResponses]; export type PostAdminWebhookConfigsData = { /** * Request body for the /webhook-configs operation on webhook-config resource */ body: { data: { attributes?: { application_id?: string | null; enabled?: boolean | null; events?: Array | null; /** * Optional payload filter applied before dispatching. When nil, all matching events are * delivered. When set, the expression is evaluated against the event payload and the webhook * is only delivered if it matches. Fails open — malformed expressions pass all events. * * Supported operators: "eq", "not_eq", "contains", "in", "not_null". * * Example: {"path": "data.status", "op": "eq", "value": "completed"} * */ filter_expression?: { [key: string]: unknown; } | null; name: string; /** * HMAC secret for webhook signature verification — only visible on create/rotate responses */ secret?: string | null; tenant_id?: string | null; /** * ISV filter: specific tenant UUIDs to receive events from (null = all) */ tenant_ids?: Array | null; url: string; /** * Tenant filter: specific workspace UUIDs to receive events from (null = all) */ workspace_ids?: Array | null; }; relationships?: { [key: string]: never; }; type?: "webhook-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/webhook-configs"; }; export type PostAdminWebhookConfigsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminWebhookConfigsError = PostAdminWebhookConfigsErrors[keyof PostAdminWebhookConfigsErrors]; export type PostAdminWebhookConfigsResponses = { /** * Success */ 201: { data?: WebhookConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminWebhookConfigsResponse = PostAdminWebhookConfigsResponses[keyof PostAdminWebhookConfigsResponses]; export type PatchAdminWalletPaymentRetryData = { /** * Request body for the /wallet/payment/retry operation on wallet-public resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "wallet-public"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/wallet/payment/retry"; }; export type PatchAdminWalletPaymentRetryErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminWalletPaymentRetryError = PatchAdminWalletPaymentRetryErrors[keyof PatchAdminWalletPaymentRetryErrors]; export type PatchAdminWalletPaymentRetryResponses = { /** * Success */ 200: { data?: WalletPublic; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminWalletPaymentRetryResponse = PatchAdminWalletPaymentRetryResponses[keyof PatchAdminWalletPaymentRetryResponses]; export type GetAdminTransactionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/transactions/{id}"; }; export type GetAdminTransactionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminTransactionsByIdError = GetAdminTransactionsByIdErrors[keyof GetAdminTransactionsByIdErrors]; export type GetAdminTransactionsByIdResponses = { /** * Success */ 200: { data?: Transaction; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminTransactionsByIdResponse = GetAdminTransactionsByIdResponses[keyof GetAdminTransactionsByIdResponses]; export type PostAdminConnectorsByIdEdamamRecipesSearchData = { /** * Request body for the /connectors/:id/edamam/recipes/search operation on connector-instance resource */ body: { data: { connector_id: string; params?: { [key: string]: unknown; } | null; query: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/connectors/{id}/edamam/recipes/search"; }; export type PostAdminConnectorsByIdEdamamRecipesSearchErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsByIdEdamamRecipesSearchError = PostAdminConnectorsByIdEdamamRecipesSearchErrors[keyof PostAdminConnectorsByIdEdamamRecipesSearchErrors]; export type PostAdminConnectorsByIdEdamamRecipesSearchResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminConnectorsByIdEdamamRecipesSearchResponse = PostAdminConnectorsByIdEdamamRecipesSearchResponses[keyof PostAdminConnectorsByIdEdamamRecipesSearchResponses]; export type DeleteAdminClinicalInsuranceAuthorizationsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/insurance-authorizations/{id}"; }; export type DeleteAdminClinicalInsuranceAuthorizationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalInsuranceAuthorizationsByIdError = DeleteAdminClinicalInsuranceAuthorizationsByIdErrors[keyof DeleteAdminClinicalInsuranceAuthorizationsByIdErrors]; export type DeleteAdminClinicalInsuranceAuthorizationsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminClinicalInsuranceAuthorizationsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/insurance-authorizations/{id}"; }; export type GetAdminClinicalInsuranceAuthorizationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalInsuranceAuthorizationsByIdError = GetAdminClinicalInsuranceAuthorizationsByIdErrors[keyof GetAdminClinicalInsuranceAuthorizationsByIdErrors]; export type GetAdminClinicalInsuranceAuthorizationsByIdResponses = { /** * Success */ 200: { data?: ClinicalInsuranceAuthorization; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalInsuranceAuthorizationsByIdResponse = GetAdminClinicalInsuranceAuthorizationsByIdResponses[keyof GetAdminClinicalInsuranceAuthorizationsByIdResponses]; export type PatchAdminClinicalInsuranceAuthorizationsByIdData = { /** * Request body for the /clinical/insurance-authorizations/:id operation on clinical-insurance-authorization resource */ body?: { data: { attributes?: { authorization_end?: string | null; authorization_start?: string | null; authorized_units?: number | null; cpt_codes_authorized?: Array | null; metadata?: { [key: string]: unknown; } | null; notes?: string | null; reauthorization_reminder?: string | null; status?: "active" | "exhausted" | "expired" | "cancelled"; unit_type?: "visits" | "hours"; used_units?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-insurance-authorization"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/insurance-authorizations/{id}"; }; export type PatchAdminClinicalInsuranceAuthorizationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalInsuranceAuthorizationsByIdError = PatchAdminClinicalInsuranceAuthorizationsByIdErrors[keyof PatchAdminClinicalInsuranceAuthorizationsByIdErrors]; export type PatchAdminClinicalInsuranceAuthorizationsByIdResponses = { /** * Success */ 200: { data?: ClinicalInsuranceAuthorization; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalInsuranceAuthorizationsByIdResponse = PatchAdminClinicalInsuranceAuthorizationsByIdResponses[keyof PatchAdminClinicalInsuranceAuthorizationsByIdResponses]; export type PostAdminRecipesData = { /** * Request body for the /recipes operation on recipes-recipe resource */ body: { data: { attributes?: { application_id?: string | null; contact_id?: string | null; cook_time_minutes?: number | null; cuisine_type?: string | null; description?: string | null; difficulty?: "easy" | "medium" | "hard"; image_url?: string | null; image_urls?: Array | null; instructions?: string | null; metadata?: { [key: string]: unknown; } | null; prep_time_minutes?: number | null; servings?: number | null; source_provider?: string | null; source_type?: "owned" | "external" | "imported"; source_uri?: string | null; title: string; total_time_minutes?: number | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "recipes-recipe"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes"; }; export type PostAdminRecipesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminRecipesError = PostAdminRecipesErrors[keyof PostAdminRecipesErrors]; export type PostAdminRecipesResponses = { /** * Success */ 201: { data?: RecipesRecipe; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminRecipesResponse = PostAdminRecipesResponses[keyof PostAdminRecipesResponses]; export type GetAdminWorkspacesAnalyticsBatchData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_ids: string; }; url: "/admin/workspaces/analytics-batch"; }; export type GetAdminWorkspacesAnalyticsBatchErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWorkspacesAnalyticsBatchError = GetAdminWorkspacesAnalyticsBatchErrors[keyof GetAdminWorkspacesAnalyticsBatchErrors]; export type GetAdminWorkspacesAnalyticsBatchResponses = { /** * Success */ 200: { /** * An array of resource objects representing a training-analytics */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWorkspacesAnalyticsBatchResponse = GetAdminWorkspacesAnalyticsBatchResponses[keyof GetAdminWorkspacesAnalyticsBatchResponses]; export type PostAdminCatalogPriceListEntriesData = { /** * Request body for the /catalog/price-list-entries operation on catalog-price-list-entry resource */ body: { data: { attributes?: { floor_price?: string | number | unknown; modifier?: string | number | unknown; price?: string | number | unknown; price_list_id: string; product_id?: string | null; tiers?: Array<{ [key: string]: unknown; }> | null; variant_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "catalog-price-list-entry"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/price-list-entries"; }; export type PostAdminCatalogPriceListEntriesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCatalogPriceListEntriesError = PostAdminCatalogPriceListEntriesErrors[keyof PostAdminCatalogPriceListEntriesErrors]; export type PostAdminCatalogPriceListEntriesResponses = { /** * Success */ 201: { data?: CatalogPriceListEntry; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCatalogPriceListEntriesResponse = PostAdminCatalogPriceListEntriesResponses[keyof PostAdminCatalogPriceListEntriesResponses]; export type DeleteAdminFormDeploymentsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/form-deployments/{id}"; }; export type DeleteAdminFormDeploymentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminFormDeploymentsByIdError = DeleteAdminFormDeploymentsByIdErrors[keyof DeleteAdminFormDeploymentsByIdErrors]; export type DeleteAdminFormDeploymentsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminFormDeploymentsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/form-deployments/{id}"; }; export type GetAdminFormDeploymentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminFormDeploymentsByIdError = GetAdminFormDeploymentsByIdErrors[keyof GetAdminFormDeploymentsByIdErrors]; export type GetAdminFormDeploymentsByIdResponses = { /** * Success */ 200: { data?: FormDeployment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminFormDeploymentsByIdResponse = GetAdminFormDeploymentsByIdResponses[keyof GetAdminFormDeploymentsByIdResponses]; export type PatchAdminFormDeploymentsByIdData = { /** * Request body for the /form-deployments/:id operation on form-deployment resource */ body?: { data: { attributes?: { allow_tenant_clone?: boolean | null; auto_deploy?: boolean | null; is_application_default?: boolean | null; overrides?: { [key: string]: unknown; } | null; pinned_version_id?: string | null; seal_policy?: FormDeploymentSealPolicyInputUpdateType; }; id: string; relationships?: { [key: string]: never; }; type?: "form-deployment"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/form-deployments/{id}"; }; export type PatchAdminFormDeploymentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminFormDeploymentsByIdError = PatchAdminFormDeploymentsByIdErrors[keyof PatchAdminFormDeploymentsByIdErrors]; export type PatchAdminFormDeploymentsByIdResponses = { /** * Success */ 200: { data?: FormDeployment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminFormDeploymentsByIdResponse = PatchAdminFormDeploymentsByIdResponses[keyof PatchAdminFormDeploymentsByIdResponses]; export type GetAdminExtractionConfigEnumsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; type: string; include_inactive?: boolean; }; url: "/admin/extraction/config-enums"; }; export type GetAdminExtractionConfigEnumsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionConfigEnumsError = GetAdminExtractionConfigEnumsErrors[keyof GetAdminExtractionConfigEnumsErrors]; export type GetAdminExtractionConfigEnumsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a config-enum */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionConfigEnumsResponse = GetAdminExtractionConfigEnumsResponses[keyof GetAdminExtractionConfigEnumsResponses]; export type PostAdminExtractionConfigEnumsData = { /** * Request body for the /extraction/config-enums operation on config-enum resource */ body: { data: { attributes?: { /** * Optional description of this enum value */ description?: string | null; /** * Whether this enum value is active (inactive values are hidden by default) */ is_active?: boolean | null; /** * Human-readable display label */ label: string; /** * Sort order for display (lower numbers first) */ sort_order?: number | null; /** * The enum type (e.g., 'agent_domain', 'document_category') */ type: string; /** * The enum value (normalized to lowercase) */ value: string; }; relationships?: { [key: string]: never; }; type?: "config-enum"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/config-enums"; }; export type PostAdminExtractionConfigEnumsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminExtractionConfigEnumsError = PostAdminExtractionConfigEnumsErrors[keyof PostAdminExtractionConfigEnumsErrors]; export type PostAdminExtractionConfigEnumsResponses = { /** * Success */ 201: { data?: ConfigEnum; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminExtractionConfigEnumsResponse = PostAdminExtractionConfigEnumsResponses[keyof PostAdminExtractionConfigEnumsResponses]; export type PatchAdminWorkspacesByIdTakeOfflineData = { /** * Request body for the /workspaces/:id/take-offline operation on workspace resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "workspace"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspaces/{id}/take-offline"; }; export type PatchAdminWorkspacesByIdTakeOfflineErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminWorkspacesByIdTakeOfflineError = PatchAdminWorkspacesByIdTakeOfflineErrors[keyof PatchAdminWorkspacesByIdTakeOfflineErrors]; export type PatchAdminWorkspacesByIdTakeOfflineResponses = { /** * Success */ 200: { data?: Workspace; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminWorkspacesByIdTakeOfflineResponse = PatchAdminWorkspacesByIdTakeOfflineResponses[keyof PatchAdminWorkspacesByIdTakeOfflineResponses]; export type DeleteAdminCompositeOperationsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/composite-operations/{id}"; }; export type DeleteAdminCompositeOperationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCompositeOperationsByIdError = DeleteAdminCompositeOperationsByIdErrors[keyof DeleteAdminCompositeOperationsByIdErrors]; export type DeleteAdminCompositeOperationsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCompositeOperationsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/composite-operations/{id}"; }; export type GetAdminCompositeOperationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCompositeOperationsByIdError = GetAdminCompositeOperationsByIdErrors[keyof GetAdminCompositeOperationsByIdErrors]; export type GetAdminCompositeOperationsByIdResponses = { /** * Success */ 200: { data?: CompositeOperation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCompositeOperationsByIdResponse = GetAdminCompositeOperationsByIdResponses[keyof GetAdminCompositeOperationsByIdResponses]; export type PatchAdminCompositeOperationsByIdData = { /** * Request body for the /composite-operations/:id operation on composite-operation resource */ body?: { data: { attributes?: { /** * List of {operation_key, quantity, unit} maps that make up this operation */ components?: Array<{ [key: string]: unknown; }> | null; /** * Default LLM model for token cost estimation (e.g., 'gpt-4o') */ default_model?: string | null; /** * Description of what this composite operation does */ description?: string | null; /** * Human-readable name (e.g., 'AI Clinical Notes') */ display_name?: string | null; /** * Whether this operation is visible in the client-facing capacity calculator */ is_public?: boolean | null; /** * Display ordering in calculator and dashboards */ sort_order?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "composite-operation"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/composite-operations/{id}"; }; export type PatchAdminCompositeOperationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCompositeOperationsByIdError = PatchAdminCompositeOperationsByIdErrors[keyof PatchAdminCompositeOperationsByIdErrors]; export type PatchAdminCompositeOperationsByIdResponses = { /** * Success */ 200: { data?: CompositeOperation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCompositeOperationsByIdResponse = PatchAdminCompositeOperationsByIdResponses[keyof PatchAdminCompositeOperationsByIdResponses]; export type GetAdminAuditChainEntriesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/audit-chain-entries/{id}"; }; export type GetAdminAuditChainEntriesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAuditChainEntriesByIdError = GetAdminAuditChainEntriesByIdErrors[keyof GetAdminAuditChainEntriesByIdErrors]; export type GetAdminAuditChainEntriesByIdResponses = { /** * Success */ 200: { data?: AuditChainEntry; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAuditChainEntriesByIdResponse = GetAdminAuditChainEntriesByIdResponses[keyof GetAdminAuditChainEntriesByIdResponses]; export type DeleteAdminTrainingSessionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/training-sessions/{id}"; }; export type DeleteAdminTrainingSessionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminTrainingSessionsByIdError = DeleteAdminTrainingSessionsByIdErrors[keyof DeleteAdminTrainingSessionsByIdErrors]; export type DeleteAdminTrainingSessionsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminTrainingSessionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/training-sessions/{id}"; }; export type GetAdminTrainingSessionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminTrainingSessionsByIdError = GetAdminTrainingSessionsByIdErrors[keyof GetAdminTrainingSessionsByIdErrors]; export type GetAdminTrainingSessionsByIdResponses = { /** * Success */ 200: { data?: TrainingSession; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminTrainingSessionsByIdResponse = GetAdminTrainingSessionsByIdResponses[keyof GetAdminTrainingSessionsByIdResponses]; export type PostAdminSupportSyncConfigsData = { /** * Request body for the /support/sync-configs operation on support-sync-config resource */ body: { data: { attributes?: { connector_instance_id: string; direction?: "bidirectional" | "inbound" | "outbound"; enabled?: boolean | null; status_mapping?: { [key: string]: unknown; } | null; sync_interval_minutes?: number | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "support-sync-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/sync-configs"; }; export type PostAdminSupportSyncConfigsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSupportSyncConfigsError = PostAdminSupportSyncConfigsErrors[keyof PostAdminSupportSyncConfigsErrors]; export type PostAdminSupportSyncConfigsResponses = { /** * Success */ 201: { data?: SupportSyncConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSupportSyncConfigsResponse = PostAdminSupportSyncConfigsResponses[keyof PostAdminSupportSyncConfigsResponses]; export type PostAdminConnectorsFullscriptTreatmentPlansCancelData = { /** * Request body for the /connectors/fullscript/treatment-plans/cancel operation on connector-instance resource */ body: { data: { connector_id: string; treatment_plan_id: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/connectors/fullscript/treatment-plans/cancel"; }; export type PostAdminConnectorsFullscriptTreatmentPlansCancelErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsFullscriptTreatmentPlansCancelError = PostAdminConnectorsFullscriptTreatmentPlansCancelErrors[keyof PostAdminConnectorsFullscriptTreatmentPlansCancelErrors]; export type PostAdminConnectorsFullscriptTreatmentPlansCancelResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminConnectorsFullscriptTreatmentPlansCancelResponse = PostAdminConnectorsFullscriptTreatmentPlansCancelResponses[keyof PostAdminConnectorsFullscriptTreatmentPlansCancelResponses]; export type DeleteAdminAiConversationsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ai/conversations/{id}"; }; export type DeleteAdminAiConversationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminAiConversationsByIdError = DeleteAdminAiConversationsByIdErrors[keyof DeleteAdminAiConversationsByIdErrors]; export type DeleteAdminAiConversationsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminAiConversationsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ai/conversations/{id}"; }; export type GetAdminAiConversationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAiConversationsByIdError = GetAdminAiConversationsByIdErrors[keyof GetAdminAiConversationsByIdErrors]; export type GetAdminAiConversationsByIdResponses = { /** * Success */ 200: { data?: ChatConversation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAiConversationsByIdResponse = GetAdminAiConversationsByIdResponses[keyof GetAdminAiConversationsByIdResponses]; export type PatchAdminAiConversationsByIdData = { /** * Request body for the /ai/conversations/:id operation on chat-conversation resource */ body?: { data: { attributes?: { /** * Structured data providing context for this conversation (e.g., failed prediction results) */ context_data?: { [key: string]: unknown; } | null; title?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "chat-conversation"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ai/conversations/{id}"; }; export type PatchAdminAiConversationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminAiConversationsByIdError = PatchAdminAiConversationsByIdErrors[keyof PatchAdminAiConversationsByIdErrors]; export type PatchAdminAiConversationsByIdResponses = { /** * Success */ 200: { data?: ChatConversation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminAiConversationsByIdResponse = PatchAdminAiConversationsByIdResponses[keyof PatchAdminAiConversationsByIdResponses]; export type GetAdminPaymentMethodsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/payment-methods"; }; export type GetAdminPaymentMethodsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPaymentMethodsError = GetAdminPaymentMethodsErrors[keyof GetAdminPaymentMethodsErrors]; export type GetAdminPaymentMethodsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a payment-method */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPaymentMethodsResponse = GetAdminPaymentMethodsResponses[keyof GetAdminPaymentMethodsResponses]; export type PostAdminPaymentMethodsData = { /** * Request body for the /payment-methods operation on payment-method resource */ body: { data: { attributes?: { brand?: string | null; customer_id?: string | null; exp_month?: number | null; exp_year?: number | null; is_default?: boolean | null; last4?: string | null; nickname?: string | null; provider?: "qorpay" | "stripe"; provider_token: string; type: "card" | "bank_account"; }; relationships?: { [key: string]: never; }; type?: "payment-method"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/payment-methods"; }; export type PostAdminPaymentMethodsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminPaymentMethodsError = PostAdminPaymentMethodsErrors[keyof PostAdminPaymentMethodsErrors]; export type PostAdminPaymentMethodsResponses = { /** * Success */ 201: { data?: PaymentMethod; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminPaymentMethodsResponse = PostAdminPaymentMethodsResponses[keyof PostAdminPaymentMethodsResponses]; export type DeleteAdminRiskAssessmentsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/risk-assessments/{id}"; }; export type DeleteAdminRiskAssessmentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminRiskAssessmentsByIdError = DeleteAdminRiskAssessmentsByIdErrors[keyof DeleteAdminRiskAssessmentsByIdErrors]; export type DeleteAdminRiskAssessmentsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminRiskAssessmentsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/risk-assessments/{id}"; }; export type GetAdminRiskAssessmentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRiskAssessmentsByIdError = GetAdminRiskAssessmentsByIdErrors[keyof GetAdminRiskAssessmentsByIdErrors]; export type GetAdminRiskAssessmentsByIdResponses = { /** * Success */ 200: { data?: RiskAssessment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRiskAssessmentsByIdResponse = GetAdminRiskAssessmentsByIdResponses[keyof GetAdminRiskAssessmentsByIdResponses]; export type GetAdminCrmExportsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/exports/workspace/{workspace_id}"; }; export type GetAdminCrmExportsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmExportsWorkspaceByWorkspaceIdError = GetAdminCrmExportsWorkspaceByWorkspaceIdErrors[keyof GetAdminCrmExportsWorkspaceByWorkspaceIdErrors]; export type GetAdminCrmExportsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crm-data-export-job */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmExportsWorkspaceByWorkspaceIdResponse = GetAdminCrmExportsWorkspaceByWorkspaceIdResponses[keyof GetAdminCrmExportsWorkspaceByWorkspaceIdResponses]; export type PatchAdminTenantsByIdReactivateData = { /** * Request body for the /tenants/:id/reactivate operation on tenant resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "tenant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants/{id}/reactivate"; }; export type PatchAdminTenantsByIdReactivateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminTenantsByIdReactivateError = PatchAdminTenantsByIdReactivateErrors[keyof PatchAdminTenantsByIdReactivateErrors]; export type PatchAdminTenantsByIdReactivateResponses = { /** * Success */ 200: { data?: Tenant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminTenantsByIdReactivateResponse = PatchAdminTenantsByIdReactivateResponses[keyof PatchAdminTenantsByIdReactivateResponses]; export type GetAdminRecipesShoppingListItemsShoppingListByShoppingListIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { shopping_list_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/shopping-list-items/shopping-list/{shopping_list_id}"; }; export type GetAdminRecipesShoppingListItemsShoppingListByShoppingListIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesShoppingListItemsShoppingListByShoppingListIdError = GetAdminRecipesShoppingListItemsShoppingListByShoppingListIdErrors[keyof GetAdminRecipesShoppingListItemsShoppingListByShoppingListIdErrors]; export type GetAdminRecipesShoppingListItemsShoppingListByShoppingListIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a recipes-shopping-list-item */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesShoppingListItemsShoppingListByShoppingListIdResponse = GetAdminRecipesShoppingListItemsShoppingListByShoppingListIdResponses[keyof GetAdminRecipesShoppingListItemsShoppingListByShoppingListIdResponses]; export type PostAdminEmailMarketingCampaignsByIdImportRecipientsData = { /** * Request body for the /email-marketing/campaigns/:id/import-recipients operation on campaign resource */ body: { data: { campaign_id: string; column_mapping?: { [key: string]: unknown; } | null; csv_storage_key: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/email-marketing/campaigns/{id}/import-recipients"; }; export type PostAdminEmailMarketingCampaignsByIdImportRecipientsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminEmailMarketingCampaignsByIdImportRecipientsError = PostAdminEmailMarketingCampaignsByIdImportRecipientsErrors[keyof PostAdminEmailMarketingCampaignsByIdImportRecipientsErrors]; export type PostAdminEmailMarketingCampaignsByIdImportRecipientsResponses = { /** * Success */ 201: { result: { [key: string]: unknown; }; }; }; export type PostAdminEmailMarketingCampaignsByIdImportRecipientsResponse = PostAdminEmailMarketingCampaignsByIdImportRecipientsResponses[keyof PostAdminEmailMarketingCampaignsByIdImportRecipientsResponses]; export type GetAdminSupportTicketMessagesTicketByTicketIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { ticket_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/ticket-messages/ticket/{ticket_id}"; }; export type GetAdminSupportTicketMessagesTicketByTicketIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSupportTicketMessagesTicketByTicketIdError = GetAdminSupportTicketMessagesTicketByTicketIdErrors[keyof GetAdminSupportTicketMessagesTicketByTicketIdErrors]; export type GetAdminSupportTicketMessagesTicketByTicketIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a support-ticket-message */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSupportTicketMessagesTicketByTicketIdResponse = GetAdminSupportTicketMessagesTicketByTicketIdResponses[keyof GetAdminSupportTicketMessagesTicketByTicketIdResponses]; export type PostAdminRecipesBulkImportData = { /** * Request body for the /recipes/bulk-import operation on recipes-recipe resource */ body: { data: { recipes: Array<{ [key: string]: unknown; }>; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/recipes/bulk-import"; }; export type PostAdminRecipesBulkImportErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminRecipesBulkImportError = PostAdminRecipesBulkImportErrors[keyof PostAdminRecipesBulkImportErrors]; export type PostAdminRecipesBulkImportResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminRecipesBulkImportResponse = PostAdminRecipesBulkImportResponses[keyof PostAdminRecipesBulkImportResponses]; export type PatchAdminExtractionDocumentsByIdDismissData = { /** * Request body for the /extraction/documents/:id/dismiss operation on extraction-document resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "extraction-document"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/documents/{id}/dismiss"; }; export type PatchAdminExtractionDocumentsByIdDismissErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminExtractionDocumentsByIdDismissError = PatchAdminExtractionDocumentsByIdDismissErrors[keyof PatchAdminExtractionDocumentsByIdDismissErrors]; export type PatchAdminExtractionDocumentsByIdDismissResponses = { /** * Success */ 200: { data?: ExtractionDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminExtractionDocumentsByIdDismissResponse = PatchAdminExtractionDocumentsByIdDismissResponses[keyof PatchAdminExtractionDocumentsByIdDismissResponses]; export type DeleteAdminComplianceRequirementsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/compliance-requirements/{id}"; }; export type DeleteAdminComplianceRequirementsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminComplianceRequirementsByIdError = DeleteAdminComplianceRequirementsByIdErrors[keyof DeleteAdminComplianceRequirementsByIdErrors]; export type DeleteAdminComplianceRequirementsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminComplianceRequirementsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/compliance-requirements/{id}"; }; export type GetAdminComplianceRequirementsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminComplianceRequirementsByIdError = GetAdminComplianceRequirementsByIdErrors[keyof GetAdminComplianceRequirementsByIdErrors]; export type GetAdminComplianceRequirementsByIdResponses = { /** * Success */ 200: { data?: ComplianceRequirement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminComplianceRequirementsByIdResponse = GetAdminComplianceRequirementsByIdResponses[keyof GetAdminComplianceRequirementsByIdResponses]; export type PatchAdminComplianceRequirementsByIdData = { /** * Request body for the /compliance-requirements/:id operation on compliance-requirement resource */ body?: { data: { attributes?: { deadline?: unknown; description?: string | null; /** * Regulatory framework: gdpr, hipaa, pci_dss, etc. */ framework?: string | null; is_blocking?: boolean | null; recurrence_days?: number | null; recurring?: boolean | null; required_for_roles?: Array | null; title?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "compliance-requirement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/compliance-requirements/{id}"; }; export type PatchAdminComplianceRequirementsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminComplianceRequirementsByIdError = PatchAdminComplianceRequirementsByIdErrors[keyof PatchAdminComplianceRequirementsByIdErrors]; export type PatchAdminComplianceRequirementsByIdResponses = { /** * Success */ 200: { data?: ComplianceRequirement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminComplianceRequirementsByIdResponse = PatchAdminComplianceRequirementsByIdResponses[keyof PatchAdminComplianceRequirementsByIdResponses]; export type GetAdminWorkspacesByWorkspaceIdExtractionExportsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; workspace_id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspaces/{workspace_id}/extraction/exports/{id}"; }; export type GetAdminWorkspacesByWorkspaceIdExtractionExportsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWorkspacesByWorkspaceIdExtractionExportsByIdError = GetAdminWorkspacesByWorkspaceIdExtractionExportsByIdErrors[keyof GetAdminWorkspacesByWorkspaceIdExtractionExportsByIdErrors]; export type GetAdminWorkspacesByWorkspaceIdExtractionExportsByIdResponses = { /** * Success */ 200: { data?: ExtractionExport; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWorkspacesByWorkspaceIdExtractionExportsByIdResponse = GetAdminWorkspacesByWorkspaceIdExtractionExportsByIdResponses[keyof GetAdminWorkspacesByWorkspaceIdExtractionExportsByIdResponses]; export type GetAdminEmailMarketingGeneratedEmailsCampaignByCampaignIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { campaign_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/generated-emails/campaign/{campaign_id}"; }; export type GetAdminEmailMarketingGeneratedEmailsCampaignByCampaignIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailMarketingGeneratedEmailsCampaignByCampaignIdError = GetAdminEmailMarketingGeneratedEmailsCampaignByCampaignIdErrors[keyof GetAdminEmailMarketingGeneratedEmailsCampaignByCampaignIdErrors]; export type GetAdminEmailMarketingGeneratedEmailsCampaignByCampaignIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a email-marketing-generated-email */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailMarketingGeneratedEmailsCampaignByCampaignIdResponse = GetAdminEmailMarketingGeneratedEmailsCampaignByCampaignIdResponses[keyof GetAdminEmailMarketingGeneratedEmailsCampaignByCampaignIdResponses]; export type PostAdminSupportCannedResponsesData = { /** * Request body for the /support/canned-responses operation on support-canned-response resource */ body: { data: { attributes?: { category?: string | null; content: string; name: string; shortcut?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "support-canned-response"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/canned-responses"; }; export type PostAdminSupportCannedResponsesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSupportCannedResponsesError = PostAdminSupportCannedResponsesErrors[keyof PostAdminSupportCannedResponsesErrors]; export type PostAdminSupportCannedResponsesResponses = { /** * Success */ 201: { data?: SupportCannedResponse; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSupportCannedResponsesResponse = PostAdminSupportCannedResponsesResponses[keyof PostAdminSupportCannedResponsesResponses]; export type PostAdminUsersAuthLoginData = { /** * Request body for the /users/auth/login operation on user resource */ body: { data: { attributes?: { /** * The identity to use for retrieving the user. */ email: string; /** * The password to check for the matching user. */ password: string; }; relationships?: { [key: string]: never; }; type?: "user"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/users/auth/login"; }; export type PostAdminUsersAuthLoginErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminUsersAuthLoginError = PostAdminUsersAuthLoginErrors[keyof PostAdminUsersAuthLoginErrors]; export type PostAdminUsersAuthLoginResponses = { /** * Success */ 201: { data?: User; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminUsersAuthLoginResponse = PostAdminUsersAuthLoginResponses[keyof PostAdminUsersAuthLoginResponses]; export type DeleteAdminCatalogViewRulesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/view-rules/{id}"; }; export type DeleteAdminCatalogViewRulesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCatalogViewRulesByIdError = DeleteAdminCatalogViewRulesByIdErrors[keyof DeleteAdminCatalogViewRulesByIdErrors]; export type DeleteAdminCatalogViewRulesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type DeleteAdminSocialAccountsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/accounts/{id}"; }; export type DeleteAdminSocialAccountsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminSocialAccountsByIdError = DeleteAdminSocialAccountsByIdErrors[keyof DeleteAdminSocialAccountsByIdErrors]; export type DeleteAdminSocialAccountsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminSocialAccountsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/accounts/{id}"; }; export type GetAdminSocialAccountsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialAccountsByIdError = GetAdminSocialAccountsByIdErrors[keyof GetAdminSocialAccountsByIdErrors]; export type GetAdminSocialAccountsByIdResponses = { /** * Success */ 200: { data?: SocialAccount; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialAccountsByIdResponse = GetAdminSocialAccountsByIdResponses[keyof GetAdminSocialAccountsByIdResponses]; export type PatchAdminSocialAccountsByIdData = { /** * Request body for the /social/accounts/:id operation on social-account resource */ body?: { data: { attributes?: { avatar_url?: string | null; display_name?: string | null; last_verified_at?: unknown; metadata?: { [key: string]: unknown; } | null; }; id: string; relationships?: { [key: string]: never; }; type?: "social-account"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/accounts/{id}"; }; export type PatchAdminSocialAccountsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSocialAccountsByIdError = PatchAdminSocialAccountsByIdErrors[keyof PatchAdminSocialAccountsByIdErrors]; export type PatchAdminSocialAccountsByIdResponses = { /** * Success */ 200: { data?: SocialAccount; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSocialAccountsByIdResponse = PatchAdminSocialAccountsByIdResponses[keyof PatchAdminSocialAccountsByIdResponses]; export type PatchAdminUsersByIdAdminData = { /** * Request body for the /users/:id/admin operation on user resource */ body?: { data: { attributes?: { is_platform_admin?: boolean | null; password?: string | null; password_confirmation?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "user"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/users/{id}/admin"; }; export type PatchAdminUsersByIdAdminErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminUsersByIdAdminError = PatchAdminUsersByIdAdminErrors[keyof PatchAdminUsersByIdAdminErrors]; export type PatchAdminUsersByIdAdminResponses = { /** * Success */ 200: { data?: User; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminUsersByIdAdminResponse = PatchAdminUsersByIdAdminResponses[keyof PatchAdminUsersByIdAdminResponses]; export type PostAdminSupportTicketRatingsData = { /** * Request body for the /support/ticket-ratings operation on support-ticket-rating resource */ body: { data: { attributes?: { comment?: string | null; score: number; ticket_id: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "support-ticket-rating"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/ticket-ratings"; }; export type PostAdminSupportTicketRatingsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSupportTicketRatingsError = PostAdminSupportTicketRatingsErrors[keyof PostAdminSupportTicketRatingsErrors]; export type PostAdminSupportTicketRatingsResponses = { /** * Success */ 201: { data?: SupportTicketRating; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSupportTicketRatingsResponse = PostAdminSupportTicketRatingsResponses[keyof PostAdminSupportTicketRatingsResponses]; export type GetAdminStorageStatsTenantByTenantIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { /** * The tenant ID to get stats for */ tenant_id: string; }; query?: never; url: "/admin/storage/stats/tenant/{tenant_id}"; }; export type GetAdminStorageStatsTenantByTenantIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminStorageStatsTenantByTenantIdError = GetAdminStorageStatsTenantByTenantIdErrors[keyof GetAdminStorageStatsTenantByTenantIdErrors]; export type GetAdminStorageStatsTenantByTenantIdResponses = { /** * Success */ 200: { result: StorageStatsType; }; }; export type GetAdminStorageStatsTenantByTenantIdResponse = GetAdminStorageStatsTenantByTenantIdResponses[keyof GetAdminStorageStatsTenantByTenantIdResponses]; export type PostAdminCampaignsSequencesData = { /** * Request body for the /campaigns/sequences operation on email-marketing-sequence resource */ body: { data: { attributes?: { campaign_id?: string | null; name: string; trigger_deal_stage_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "email-marketing-sequence"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/campaigns/sequences"; }; export type PostAdminCampaignsSequencesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCampaignsSequencesError = PostAdminCampaignsSequencesErrors[keyof PostAdminCampaignsSequencesErrors]; export type PostAdminCampaignsSequencesResponses = { /** * Success */ 201: { data?: EmailMarketingSequence; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCampaignsSequencesResponse = PostAdminCampaignsSequencesResponses[keyof PostAdminCampaignsSequencesResponses]; export type PostAdminCrmActivitiesData = { /** * Request body for the /crm/activities operation on crm-activity resource */ body: { data: { attributes?: { ai_summary?: string | null; application_id?: string | null; body?: string | null; content_hash?: string | null; direction?: "inbound" | "outbound" | "internal"; duration_seconds?: number | null; occurred_at: unknown; properties?: { [key: string]: unknown; } | null; sentiment?: "positive" | "neutral" | "negative"; source?: "manual" | "import" | "channel" | "connector" | "ai_extracted" | "api"; source_ref?: string | null; subject?: string | null; type: "call" | "email" | "meeting" | "note" | "task" | "sms" | "chat" | "custom"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "crm-activity"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/activities"; }; export type PostAdminCrmActivitiesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrmActivitiesError = PostAdminCrmActivitiesErrors[keyof PostAdminCrmActivitiesErrors]; export type PostAdminCrmActivitiesResponses = { /** * Success */ 201: { data?: CrmActivity; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrmActivitiesResponse = PostAdminCrmActivitiesResponses[keyof PostAdminCrmActivitiesResponses]; export type GetAdminAuditLogsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/audit-logs"; }; export type GetAdminAuditLogsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAuditLogsError = GetAdminAuditLogsErrors[keyof GetAdminAuditLogsErrors]; export type GetAdminAuditLogsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a audit-log */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAuditLogsResponse = GetAdminAuditLogsResponses[keyof GetAdminAuditLogsResponses]; export type PatchAdminSchedulingBookingsByIdConfirmData = { /** * Request body for the /scheduling/bookings/:id/confirm operation on scheduling-booking resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "scheduling-booking"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/bookings/{id}/confirm"; }; export type PatchAdminSchedulingBookingsByIdConfirmErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSchedulingBookingsByIdConfirmError = PatchAdminSchedulingBookingsByIdConfirmErrors[keyof PatchAdminSchedulingBookingsByIdConfirmErrors]; export type PatchAdminSchedulingBookingsByIdConfirmResponses = { /** * Success */ 200: { data?: SchedulingBooking; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSchedulingBookingsByIdConfirmResponse = PatchAdminSchedulingBookingsByIdConfirmResponses[keyof PatchAdminSchedulingBookingsByIdConfirmResponses]; export type GetAdminWholesaleAgreementsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/wholesale-agreements/{id}"; }; export type GetAdminWholesaleAgreementsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWholesaleAgreementsByIdError = GetAdminWholesaleAgreementsByIdErrors[keyof GetAdminWholesaleAgreementsByIdErrors]; export type GetAdminWholesaleAgreementsByIdResponses = { /** * Success */ 200: { data?: WholesaleAgreement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWholesaleAgreementsByIdResponse = GetAdminWholesaleAgreementsByIdResponses[keyof GetAdminWholesaleAgreementsByIdResponses]; export type PatchAdminWholesaleAgreementsByIdData = { /** * Request body for the /wholesale-agreements/:id operation on wholesale-agreement resource */ body?: { data: { attributes?: { effective_date?: string | null; /** * Days to hold funds before release */ hold_days?: number | null; /** * Optional ISV-configurable Layer 1 dunning cadence override. * */ layer1_dunning_config?: { [key: string]: unknown; } | null; /** * Minimum payout amount in cents ($25.00 default) */ minimum_payout_cents?: number | null; /** * Per-service minimum retail floors that ISV must charge their tenants. * Format: [%{"service_id" => "doc_extraction_base", "minimum" => %Money{}}] * Platform admin sets these to ensure ISVs don't undercut below certain prices. * */ minimum_retail_floors?: Array<{ [key: string]: unknown; }> | null; notes?: string | null; /** * Per-ISV platform-account overdraft limit in credits. nil falls back to * the platform default. * */ overdraft_limit_credits?: number | null; /** * Per-seat monthly platform fee in cents. Charged to the ISV's Application * liability account at each subscription renewal for seat-based plans. * e.g., 500 = $5.00/seat/month. nil = no per-seat fee (credit-only ISVs). * */ per_seat_fee_cents?: number | null; /** * Which capability tiers this ISV may enable on applications. * */ permitted_capability_tiers?: Array<"core" | "standard" | "premium"> | null; /** * Per-ISV refund-reversal window in days. nil falls back to platform default. * */ refund_reversal_days?: number | null; settlement_frequency?: "monthly" | "weekly" | "daily"; /** * Per-ISV one-time signup-grant amount in credits, deposited to the * `Platform:Application:*` wholesale account when the ISV-tenant's first * Application is created (after proof-of-life passes). nil falls back to * `config :gpt_core, :default_isv_signup_grant_credits`. * */ signup_grant_credits?: number | null; /** * Origin of the signup grant. * - `:default` — runtime-created ISV; subject to proof-of-life gate. * - `:pre_seeded` — platform-curated ISV from `priv/data/platform_isvs.json`; * bypasses proof-of-life (presence in the seed file is implicit trust). * Set by `PlatformIsvProvisioner` in Phase 4. * */ signup_grant_source?: "default" | "pre_seeded"; /** * Lifecycle state of the per-ISV signup grant. * - `:pending` — no Application has been created yet; grant has not fired. * - `:granted` — grant fired and `Platform:Application:*` was credited. * - `:insufficient_proof_of_life` — first Application creation found the * owner lacking verified email or registered payment method; grant deferred * until proof-of-life lands. * */ signup_grant_status?: "pending" | "granted" | "insufficient_proof_of_life"; }; id: string; relationships?: { [key: string]: never; }; type?: "wholesale-agreement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/wholesale-agreements/{id}"; }; export type PatchAdminWholesaleAgreementsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminWholesaleAgreementsByIdError = PatchAdminWholesaleAgreementsByIdErrors[keyof PatchAdminWholesaleAgreementsByIdErrors]; export type PatchAdminWholesaleAgreementsByIdResponses = { /** * Success */ 200: { data?: WholesaleAgreement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminWholesaleAgreementsByIdResponse = PatchAdminWholesaleAgreementsByIdResponses[keyof PatchAdminWholesaleAgreementsByIdResponses]; export type GetAdminPricingStrategiesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pricing-strategies/{id}"; }; export type GetAdminPricingStrategiesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPricingStrategiesByIdError = GetAdminPricingStrategiesByIdErrors[keyof GetAdminPricingStrategiesByIdErrors]; export type GetAdminPricingStrategiesByIdResponses = { /** * Success */ 200: { data?: PricingStrategy; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPricingStrategiesByIdResponse = GetAdminPricingStrategiesByIdResponses[keyof GetAdminPricingStrategiesByIdResponses]; export type PatchAdminPricingStrategiesByIdData = { /** * Request body for the /pricing-strategies/:id operation on pricing-strategy resource */ body?: { data: { attributes?: { /** * The minimum price per unit for this service */ floor_price?: { amount: string; currency: string; } | unknown; /** * The mandatory margin percentage (default 20%) */ margin_percent?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "pricing-strategy"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pricing-strategies/{id}"; }; export type PatchAdminPricingStrategiesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPricingStrategiesByIdError = PatchAdminPricingStrategiesByIdErrors[keyof PatchAdminPricingStrategiesByIdErrors]; export type PatchAdminPricingStrategiesByIdResponses = { /** * Success */ 200: { data?: PricingStrategy; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPricingStrategiesByIdResponse = PatchAdminPricingStrategiesByIdResponses[keyof PatchAdminPricingStrategiesByIdResponses]; export type GetAdminEmailOutboundEmailsWorkspaceByWorkspaceIdContactByContactRefIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { contact_ref_id: string; workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/outbound-emails/workspace/{workspace_id}/contact/{contact_ref_id}"; }; export type GetAdminEmailOutboundEmailsWorkspaceByWorkspaceIdContactByContactRefIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailOutboundEmailsWorkspaceByWorkspaceIdContactByContactRefIdError = GetAdminEmailOutboundEmailsWorkspaceByWorkspaceIdContactByContactRefIdErrors[keyof GetAdminEmailOutboundEmailsWorkspaceByWorkspaceIdContactByContactRefIdErrors]; export type GetAdminEmailOutboundEmailsWorkspaceByWorkspaceIdContactByContactRefIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a email-outbound-email */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailOutboundEmailsWorkspaceByWorkspaceIdContactByContactRefIdResponse = GetAdminEmailOutboundEmailsWorkspaceByWorkspaceIdContactByContactRefIdResponses[keyof GetAdminEmailOutboundEmailsWorkspaceByWorkspaceIdContactByContactRefIdResponses]; export type PatchAdminUserProfilesByIdDismissAnnouncementData = { /** * Request body for the /user-profiles/:id/dismiss-announcement operation on user-profile resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "user-profile"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/user-profiles/{id}/dismiss-announcement"; }; export type PatchAdminUserProfilesByIdDismissAnnouncementErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminUserProfilesByIdDismissAnnouncementError = PatchAdminUserProfilesByIdDismissAnnouncementErrors[keyof PatchAdminUserProfilesByIdDismissAnnouncementErrors]; export type PatchAdminUserProfilesByIdDismissAnnouncementResponses = { /** * Success */ 200: { data?: UserProfile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminUserProfilesByIdDismissAnnouncementResponse = PatchAdminUserProfilesByIdDismissAnnouncementResponses[keyof PatchAdminUserProfilesByIdDismissAnnouncementResponses]; export type GetAdminCatalogTaxonomyNodesTaxonomyByTaxonomyIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { taxonomy_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/taxonomy-nodes/taxonomy/{taxonomy_id}"; }; export type GetAdminCatalogTaxonomyNodesTaxonomyByTaxonomyIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogTaxonomyNodesTaxonomyByTaxonomyIdError = GetAdminCatalogTaxonomyNodesTaxonomyByTaxonomyIdErrors[keyof GetAdminCatalogTaxonomyNodesTaxonomyByTaxonomyIdErrors]; export type GetAdminCatalogTaxonomyNodesTaxonomyByTaxonomyIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a catalog-taxonomy-node */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogTaxonomyNodesTaxonomyByTaxonomyIdResponse = GetAdminCatalogTaxonomyNodesTaxonomyByTaxonomyIdResponses[keyof GetAdminCatalogTaxonomyNodesTaxonomyByTaxonomyIdResponses]; export type PostAdminEmailMarketingCampaignsByIdExportData = { /** * Request body for the /email-marketing/campaigns/:id/export operation on campaign resource */ body: { data: { campaign_id: string; export_type: "recipients" | "results" | "tracking"; format?: "csv"; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/email-marketing/campaigns/{id}/export"; }; export type PostAdminEmailMarketingCampaignsByIdExportErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminEmailMarketingCampaignsByIdExportError = PostAdminEmailMarketingCampaignsByIdExportErrors[keyof PostAdminEmailMarketingCampaignsByIdExportErrors]; export type PostAdminEmailMarketingCampaignsByIdExportResponses = { /** * Success */ 201: { result: { [key: string]: unknown; }; }; }; export type PostAdminEmailMarketingCampaignsByIdExportResponse = PostAdminEmailMarketingCampaignsByIdExportResponses[keyof PostAdminEmailMarketingCampaignsByIdExportResponses]; export type PatchAdminNotificationMethodsByIdSetPrimaryData = { /** * Request body for the /notification-methods/:id/set-primary operation on notification-method resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "notification-method"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/notification-methods/{id}/set-primary"; }; export type PatchAdminNotificationMethodsByIdSetPrimaryErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminNotificationMethodsByIdSetPrimaryError = PatchAdminNotificationMethodsByIdSetPrimaryErrors[keyof PatchAdminNotificationMethodsByIdSetPrimaryErrors]; export type PatchAdminNotificationMethodsByIdSetPrimaryResponses = { /** * Success */ 200: { data?: NotificationMethod; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminNotificationMethodsByIdSetPrimaryResponse = PatchAdminNotificationMethodsByIdSetPrimaryResponses[keyof PatchAdminNotificationMethodsByIdSetPrimaryResponses]; export type GetAdminCrmRelationshipsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/relationships/workspace/{workspace_id}"; }; export type GetAdminCrmRelationshipsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmRelationshipsWorkspaceByWorkspaceIdError = GetAdminCrmRelationshipsWorkspaceByWorkspaceIdErrors[keyof GetAdminCrmRelationshipsWorkspaceByWorkspaceIdErrors]; export type GetAdminCrmRelationshipsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crm-relationship */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmRelationshipsWorkspaceByWorkspaceIdResponse = GetAdminCrmRelationshipsWorkspaceByWorkspaceIdResponses[keyof GetAdminCrmRelationshipsWorkspaceByWorkspaceIdResponses]; export type GetAdminWorkspacesByWorkspaceIdExtractionExportsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { /** * The workspace to list exports for */ workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; /** * Export statuses to filter by (optional for code interface) */ status?: Array<"pending" | "processing" | "completed" | "failed">; }; url: "/admin/workspaces/{workspace_id}/extraction/exports"; }; export type GetAdminWorkspacesByWorkspaceIdExtractionExportsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWorkspacesByWorkspaceIdExtractionExportsError = GetAdminWorkspacesByWorkspaceIdExtractionExportsErrors[keyof GetAdminWorkspacesByWorkspaceIdExtractionExportsErrors]; export type GetAdminWorkspacesByWorkspaceIdExtractionExportsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a extraction-export */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWorkspacesByWorkspaceIdExtractionExportsResponse = GetAdminWorkspacesByWorkspaceIdExtractionExportsResponses[keyof GetAdminWorkspacesByWorkspaceIdExtractionExportsResponses]; export type PostAdminWorkspacesByWorkspaceIdExtractionExportsData = { /** * Request body for the /workspaces/:workspace_id/extraction/exports operation on extraction-export resource */ body: { data: { attributes?: { config?: { [key: string]: unknown; } | null; format: "csv" | "json" | "excel" | "markdown"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "extraction-export"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspaces/{workspace_id}/extraction/exports"; }; export type PostAdminWorkspacesByWorkspaceIdExtractionExportsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminWorkspacesByWorkspaceIdExtractionExportsError = PostAdminWorkspacesByWorkspaceIdExtractionExportsErrors[keyof PostAdminWorkspacesByWorkspaceIdExtractionExportsErrors]; export type PostAdminWorkspacesByWorkspaceIdExtractionExportsResponses = { /** * Success */ 201: { data?: ExtractionExport; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminWorkspacesByWorkspaceIdExtractionExportsResponse = PostAdminWorkspacesByWorkspaceIdExtractionExportsResponses[keyof PostAdminWorkspacesByWorkspaceIdExtractionExportsResponses]; export type PatchAdminSchedulingBookingsByIdRescheduleData = { /** * Request body for the /scheduling/bookings/:id/reschedule operation on scheduling-booking resource */ body: { data: { attributes?: { new_end_time: unknown; new_start_time: unknown; }; id: string; relationships?: { [key: string]: never; }; type?: "scheduling-booking"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/bookings/{id}/reschedule"; }; export type PatchAdminSchedulingBookingsByIdRescheduleErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSchedulingBookingsByIdRescheduleError = PatchAdminSchedulingBookingsByIdRescheduleErrors[keyof PatchAdminSchedulingBookingsByIdRescheduleErrors]; export type PatchAdminSchedulingBookingsByIdRescheduleResponses = { /** * Success */ 200: { data?: SchedulingBooking; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSchedulingBookingsByIdRescheduleResponse = PatchAdminSchedulingBookingsByIdRescheduleResponses[keyof PatchAdminSchedulingBookingsByIdRescheduleResponses]; export type DeleteAdminRecipesFoodItemsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/food-items/{id}"; }; export type DeleteAdminRecipesFoodItemsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminRecipesFoodItemsByIdError = DeleteAdminRecipesFoodItemsByIdErrors[keyof DeleteAdminRecipesFoodItemsByIdErrors]; export type DeleteAdminRecipesFoodItemsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminRecipesFoodItemsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/food-items/{id}"; }; export type GetAdminRecipesFoodItemsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesFoodItemsByIdError = GetAdminRecipesFoodItemsByIdErrors[keyof GetAdminRecipesFoodItemsByIdErrors]; export type GetAdminRecipesFoodItemsByIdResponses = { /** * Success */ 200: { data?: RecipesFoodItem; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesFoodItemsByIdResponse = GetAdminRecipesFoodItemsByIdResponses[keyof GetAdminRecipesFoodItemsByIdResponses]; export type PatchAdminRecipesFoodItemsByIdData = { /** * Request body for the /recipes/food-items/:id operation on recipes-food-item resource */ body?: { data: { attributes?: { allergens?: Array | null; default_unit?: string | null; food_group?: string | null; name?: string | null; nutrition_per_100g?: { [key: string]: unknown; } | null; unit_conversions?: { [key: string]: unknown; } | null; }; id: string; relationships?: { [key: string]: never; }; type?: "recipes-food-item"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/food-items/{id}"; }; export type PatchAdminRecipesFoodItemsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminRecipesFoodItemsByIdError = PatchAdminRecipesFoodItemsByIdErrors[keyof PatchAdminRecipesFoodItemsByIdErrors]; export type PatchAdminRecipesFoodItemsByIdResponses = { /** * Success */ 200: { data?: RecipesFoodItem; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminRecipesFoodItemsByIdResponse = PatchAdminRecipesFoodItemsByIdResponses[keyof PatchAdminRecipesFoodItemsByIdResponses]; export type PatchAdminPlansByIdDeprecateData = { /** * Request body for the /plans/:id/deprecate operation on plan resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "plan"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/plans/{id}/deprecate"; }; export type PatchAdminPlansByIdDeprecateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPlansByIdDeprecateError = PatchAdminPlansByIdDeprecateErrors[keyof PatchAdminPlansByIdDeprecateErrors]; export type PatchAdminPlansByIdDeprecateResponses = { /** * Success */ 200: { data?: Plan; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPlansByIdDeprecateResponse = PatchAdminPlansByIdDeprecateResponses[keyof PatchAdminPlansByIdDeprecateResponses]; export type PatchAdminAgentExecutionsByIdCancelData = { /** * Request body for the /agent-executions/:id/cancel operation on agent-execution resource */ body?: { data: { attributes?: { /** * Full LangChain message chain for checkpoint/resume. Not exposed in API. */ conversation_history?: Array<{ [key: string]: unknown; }> | null; }; id: string; relationships?: { [key: string]: never; }; type?: "agent-execution"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-executions/{id}/cancel"; }; export type PatchAdminAgentExecutionsByIdCancelErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminAgentExecutionsByIdCancelError = PatchAdminAgentExecutionsByIdCancelErrors[keyof PatchAdminAgentExecutionsByIdCancelErrors]; export type PatchAdminAgentExecutionsByIdCancelResponses = { /** * Success */ 200: { data?: AgentExecution; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminAgentExecutionsByIdCancelResponse = PatchAdminAgentExecutionsByIdCancelResponses[keyof PatchAdminAgentExecutionsByIdCancelResponses]; export type GetAdminApplicationsCurrentData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/applications/current"; }; export type GetAdminApplicationsCurrentErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminApplicationsCurrentError = GetAdminApplicationsCurrentErrors[keyof GetAdminApplicationsCurrentErrors]; export type GetAdminApplicationsCurrentResponses = { /** * Success */ 200: { result: { [key: string]: unknown; }; }; }; export type GetAdminApplicationsCurrentResponse = GetAdminApplicationsCurrentResponses[keyof GetAdminApplicationsCurrentResponses]; export type GetAdminAgentsByIdTrainingStatsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { /** * Agent ID from URL path */ id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agents/{id}/training-stats"; }; export type GetAdminAgentsByIdTrainingStatsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentsByIdTrainingStatsError = GetAdminAgentsByIdTrainingStatsErrors[keyof GetAdminAgentsByIdTrainingStatsErrors]; export type GetAdminAgentsByIdTrainingStatsResponses = { /** * Success */ 200: { data?: AgentTrainingStats; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAgentsByIdTrainingStatsResponse = GetAdminAgentsByIdTrainingStatsResponses[keyof GetAdminAgentsByIdTrainingStatsResponses]; export type PatchAdminCrmContactsByIdArchiveData = { /** * Request body for the /crm/contacts/:id/archive operation on crm-contact resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-contact"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/contacts/{id}/archive"; }; export type PatchAdminCrmContactsByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmContactsByIdArchiveError = PatchAdminCrmContactsByIdArchiveErrors[keyof PatchAdminCrmContactsByIdArchiveErrors]; export type PatchAdminCrmContactsByIdArchiveResponses = { /** * Success */ 200: { data?: CrmContact; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmContactsByIdArchiveResponse = PatchAdminCrmContactsByIdArchiveResponses[keyof PatchAdminCrmContactsByIdArchiveResponses]; export type GetAdminContractClausesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/contract-clauses"; }; export type GetAdminContractClausesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminContractClausesError = GetAdminContractClausesErrors[keyof GetAdminContractClausesErrors]; export type GetAdminContractClausesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a contract-clause */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminContractClausesResponse = GetAdminContractClausesResponses[keyof GetAdminContractClausesResponses]; export type PatchAdminWalletInvoicesByIdVoidData = { /** * Request body for the /wallet/invoices/:id/void operation on invoice resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "invoice"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/wallet/invoices/{id}/void"; }; export type PatchAdminWalletInvoicesByIdVoidErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminWalletInvoicesByIdVoidError = PatchAdminWalletInvoicesByIdVoidErrors[keyof PatchAdminWalletInvoicesByIdVoidErrors]; export type PatchAdminWalletInvoicesByIdVoidResponses = { /** * Success */ 200: { data?: Invoice; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminWalletInvoicesByIdVoidResponse = PatchAdminWalletInvoicesByIdVoidResponses[keyof PatchAdminWalletInvoicesByIdVoidResponses]; export type GetAdminClinicalGoalTemplatesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-templates/{id}"; }; export type GetAdminClinicalGoalTemplatesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalGoalTemplatesByIdError = GetAdminClinicalGoalTemplatesByIdErrors[keyof GetAdminClinicalGoalTemplatesByIdErrors]; export type GetAdminClinicalGoalTemplatesByIdResponses = { /** * Success */ 200: { data?: ClinicalGoalTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalGoalTemplatesByIdResponse = GetAdminClinicalGoalTemplatesByIdResponses[keyof GetAdminClinicalGoalTemplatesByIdResponses]; export type PatchAdminClinicalGoalTemplatesByIdData = { /** * Request body for the /clinical/goal-templates/:id operation on clinical-goal-template resource */ body?: { data: { attributes?: { action_steps?: Array | null; age_groups?: Array | null; applicable_conditions?: Array | null; category?: string | null; description?: string | null; difficulty?: "beginner" | "intermediate" | "advanced"; evidence_base?: string | null; frequency?: "daily" | "weekly"; goal_type?: string | null; instructions?: string | null; is_active?: boolean | null; linked_metric_type?: string | null; metadata?: { [key: string]: unknown; } | null; priority?: "high" | "medium" | "low"; source_reference?: string | null; suggested_duration_days?: number | null; tags?: Array | null; target_value?: string | number | unknown; timeframe?: string | null; title?: string | null; tool_ids?: Array | null; unit?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-goal-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-templates/{id}"; }; export type PatchAdminClinicalGoalTemplatesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalGoalTemplatesByIdError = PatchAdminClinicalGoalTemplatesByIdErrors[keyof PatchAdminClinicalGoalTemplatesByIdErrors]; export type PatchAdminClinicalGoalTemplatesByIdResponses = { /** * Success */ 200: { data?: ClinicalGoalTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalGoalTemplatesByIdResponse = PatchAdminClinicalGoalTemplatesByIdResponses[keyof PatchAdminClinicalGoalTemplatesByIdResponses]; export type GetAdminTenantsByTenantIdWorkspaceStatsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { tenant_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants/{tenant_id}/workspace_stats"; }; export type GetAdminTenantsByTenantIdWorkspaceStatsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminTenantsByTenantIdWorkspaceStatsError = GetAdminTenantsByTenantIdWorkspaceStatsErrors[keyof GetAdminTenantsByTenantIdWorkspaceStatsErrors]; export type GetAdminTenantsByTenantIdWorkspaceStatsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a workspace-document-stats */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminTenantsByTenantIdWorkspaceStatsResponse = GetAdminTenantsByTenantIdWorkspaceStatsResponses[keyof GetAdminTenantsByTenantIdWorkspaceStatsResponses]; export type PatchAdminClinicalNotesByIdApproveData = { /** * Request body for the /clinical/notes/:id/approve operation on clinical-note resource */ body: { data: { attributes?: { reviewed_by_id: string; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-note"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/notes/{id}/approve"; }; export type PatchAdminClinicalNotesByIdApproveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalNotesByIdApproveError = PatchAdminClinicalNotesByIdApproveErrors[keyof PatchAdminClinicalNotesByIdApproveErrors]; export type PatchAdminClinicalNotesByIdApproveResponses = { /** * Success */ 200: { data?: ClinicalNote; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalNotesByIdApproveResponse = PatchAdminClinicalNotesByIdApproveResponses[keyof PatchAdminClinicalNotesByIdApproveResponses]; export type PostAdminConnectorsFullscriptTreatmentPlansGetData = { /** * Request body for the /connectors/fullscript/treatment-plans/get operation on connector-instance resource */ body: { data: { connector_id: string; treatment_plan_id: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/connectors/fullscript/treatment-plans/get"; }; export type PostAdminConnectorsFullscriptTreatmentPlansGetErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsFullscriptTreatmentPlansGetError = PostAdminConnectorsFullscriptTreatmentPlansGetErrors[keyof PostAdminConnectorsFullscriptTreatmentPlansGetErrors]; export type PostAdminConnectorsFullscriptTreatmentPlansGetResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminConnectorsFullscriptTreatmentPlansGetResponse = PostAdminConnectorsFullscriptTreatmentPlansGetResponses[keyof PostAdminConnectorsFullscriptTreatmentPlansGetResponses]; export type GetAdminWebhookDeliveriesStatsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/webhook-deliveries/stats"; }; export type GetAdminWebhookDeliveriesStatsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWebhookDeliveriesStatsError = GetAdminWebhookDeliveriesStatsErrors[keyof GetAdminWebhookDeliveriesStatsErrors]; export type GetAdminWebhookDeliveriesStatsResponses = { /** * Success */ 200: { result: { [key: string]: unknown; }; }; }; export type GetAdminWebhookDeliveriesStatsResponse = GetAdminWebhookDeliveriesStatsResponses[keyof GetAdminWebhookDeliveriesStatsResponses]; export type PatchAdminImpactAssessmentsByIdApproveData = { /** * Request body for the /impact-assessments/:id/approve operation on data-protection-impact-assessment resource */ body?: { data: { attributes?: { approved_by?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "data-protection-impact-assessment"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/impact-assessments/{id}/approve"; }; export type PatchAdminImpactAssessmentsByIdApproveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminImpactAssessmentsByIdApproveError = PatchAdminImpactAssessmentsByIdApproveErrors[keyof PatchAdminImpactAssessmentsByIdApproveErrors]; export type PatchAdminImpactAssessmentsByIdApproveResponses = { /** * Success */ 200: { data?: DataProtectionImpactAssessment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminImpactAssessmentsByIdApproveResponse = PatchAdminImpactAssessmentsByIdApproveResponses[keyof PatchAdminImpactAssessmentsByIdApproveResponses]; export type GetAdminWalletSeatsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/wallet/seats"; }; export type GetAdminWalletSeatsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWalletSeatsError = GetAdminWalletSeatsErrors[keyof GetAdminWalletSeatsErrors]; export type GetAdminWalletSeatsResponses = { /** * Success */ 200: { data?: SeatInfo; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWalletSeatsResponse = GetAdminWalletSeatsResponses[keyof GetAdminWalletSeatsResponses]; export type PostAdminAgentsByIdTestData = { /** * Request body for the /agents/:id/test operation on agent resource */ body: { data: { attributes?: { sample_input: string; }; relationships?: { [key: string]: never; }; type?: "agent"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { /** * Agent ID (from URL path parameter) */ id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agents/{id}/test"; }; export type PostAdminAgentsByIdTestErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAgentsByIdTestError = PostAdminAgentsByIdTestErrors[keyof PostAdminAgentsByIdTestErrors]; export type PostAdminAgentsByIdTestResponses = { /** * Success */ 201: { data?: Agent; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAgentsByIdTestResponse = PostAdminAgentsByIdTestResponses[keyof PostAdminAgentsByIdTestResponses]; export type PatchAdminConsentRecordsByIdWithdrawData = { /** * Request body for the /consent-records/:id/withdraw operation on consent-record resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "consent-record"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/consent-records/{id}/withdraw"; }; export type PatchAdminConsentRecordsByIdWithdrawErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminConsentRecordsByIdWithdrawError = PatchAdminConsentRecordsByIdWithdrawErrors[keyof PatchAdminConsentRecordsByIdWithdrawErrors]; export type PatchAdminConsentRecordsByIdWithdrawResponses = { /** * Success */ 200: { data?: ConsentRecord; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminConsentRecordsByIdWithdrawResponse = PatchAdminConsentRecordsByIdWithdrawResponses[keyof PatchAdminConsentRecordsByIdWithdrawResponses]; export type PatchAdminSchedulingRemindersByIdCancelData = { /** * Request body for the /scheduling/reminders/:id/cancel operation on scheduling-reminder resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "scheduling-reminder"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/reminders/{id}/cancel"; }; export type PatchAdminSchedulingRemindersByIdCancelErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSchedulingRemindersByIdCancelError = PatchAdminSchedulingRemindersByIdCancelErrors[keyof PatchAdminSchedulingRemindersByIdCancelErrors]; export type PatchAdminSchedulingRemindersByIdCancelResponses = { /** * Success */ 200: { data?: SchedulingReminder; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSchedulingRemindersByIdCancelResponse = PatchAdminSchedulingRemindersByIdCancelResponses[keyof PatchAdminSchedulingRemindersByIdCancelResponses]; export type PatchAdminEmailOutboundEmailsByIdCancelScheduleData = { /** * Request body for the /email/outbound-emails/:id/cancel-schedule operation on email-outbound-email resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "email-outbound-email"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/outbound-emails/{id}/cancel-schedule"; }; export type PatchAdminEmailOutboundEmailsByIdCancelScheduleErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailOutboundEmailsByIdCancelScheduleError = PatchAdminEmailOutboundEmailsByIdCancelScheduleErrors[keyof PatchAdminEmailOutboundEmailsByIdCancelScheduleErrors]; export type PatchAdminEmailOutboundEmailsByIdCancelScheduleResponses = { /** * Success */ 200: { data?: EmailOutboundEmail; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailOutboundEmailsByIdCancelScheduleResponse = PatchAdminEmailOutboundEmailsByIdCancelScheduleResponses[keyof PatchAdminEmailOutboundEmailsByIdCancelScheduleResponses]; export type GetAdminSchedulingLocationsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/locations/{id}"; }; export type GetAdminSchedulingLocationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingLocationsByIdError = GetAdminSchedulingLocationsByIdErrors[keyof GetAdminSchedulingLocationsByIdErrors]; export type GetAdminSchedulingLocationsByIdResponses = { /** * Success */ 200: { data?: SchedulingLocation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingLocationsByIdResponse = GetAdminSchedulingLocationsByIdResponses[keyof GetAdminSchedulingLocationsByIdResponses]; export type PatchAdminSchedulingLocationsByIdData = { /** * Request body for the /scheduling/locations/:id operation on scheduling-location resource */ body?: { data: { attributes?: { address?: string | null; capacity?: number | null; city?: string | null; country?: string | null; instructions?: string | null; is_active?: boolean | null; latitude?: number | null; longitude?: number | null; metadata?: { [key: string]: unknown; } | null; name?: string | null; postal_code?: string | null; state?: string | null; type?: "venue" | "room" | "virtual" | "resource"; url?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "scheduling-location"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/locations/{id}"; }; export type PatchAdminSchedulingLocationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSchedulingLocationsByIdError = PatchAdminSchedulingLocationsByIdErrors[keyof PatchAdminSchedulingLocationsByIdErrors]; export type PatchAdminSchedulingLocationsByIdResponses = { /** * Success */ 200: { data?: SchedulingLocation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSchedulingLocationsByIdResponse = PatchAdminSchedulingLocationsByIdResponses[keyof PatchAdminSchedulingLocationsByIdResponses]; export type GetAdminClinicalNotesByNoteIdVersionsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { note_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/notes/{note_id}/versions"; }; export type GetAdminClinicalNotesByNoteIdVersionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalNotesByNoteIdVersionsError = GetAdminClinicalNotesByNoteIdVersionsErrors[keyof GetAdminClinicalNotesByNoteIdVersionsErrors]; export type GetAdminClinicalNotesByNoteIdVersionsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-note-version */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalNotesByNoteIdVersionsResponse = GetAdminClinicalNotesByNoteIdVersionsResponses[keyof GetAdminClinicalNotesByNoteIdVersionsResponses]; export type PatchAdminInvoicesByIdSendData = { /** * Request body for the /invoices/:id/send operation on invoices-invoice resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "invoices-invoice"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/{id}/send"; }; export type PatchAdminInvoicesByIdSendErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvoicesByIdSendError = PatchAdminInvoicesByIdSendErrors[keyof PatchAdminInvoicesByIdSendErrors]; export type PatchAdminInvoicesByIdSendResponses = { /** * Success */ 200: { data?: InvoicesInvoice; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvoicesByIdSendResponse = PatchAdminInvoicesByIdSendResponses[keyof PatchAdminInvoicesByIdSendResponses]; export type PatchAdminInvoicesRecurringSchedulesByIdResumeData = { /** * Request body for the /invoices/recurring-schedules/:id/resume operation on invoices-recurring-schedule resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "invoices-recurring-schedule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/recurring-schedules/{id}/resume"; }; export type PatchAdminInvoicesRecurringSchedulesByIdResumeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvoicesRecurringSchedulesByIdResumeError = PatchAdminInvoicesRecurringSchedulesByIdResumeErrors[keyof PatchAdminInvoicesRecurringSchedulesByIdResumeErrors]; export type PatchAdminInvoicesRecurringSchedulesByIdResumeResponses = { /** * Success */ 200: { data?: InvoicesRecurringSchedule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvoicesRecurringSchedulesByIdResumeResponse = PatchAdminInvoicesRecurringSchedulesByIdResumeResponses[keyof PatchAdminInvoicesRecurringSchedulesByIdResumeResponses]; export type PostAdminCrmExportsData = { /** * Request body for the /crm/exports operation on crm-data-export-job resource */ body: { data: { attributes?: { entity_subtype?: string | null; entity_type: "contact" | "custom_entity" | "activity"; filters?: Array<{ [key: string]: unknown; }> | null; format: "json" | "csv"; include?: Array | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "crm-data-export-job"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/exports"; }; export type PostAdminCrmExportsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrmExportsError = PostAdminCrmExportsErrors[keyof PostAdminCrmExportsErrors]; export type PostAdminCrmExportsResponses = { /** * Success */ 201: { data?: CrmDataExportJob; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrmExportsResponse = PostAdminCrmExportsResponses[keyof PostAdminCrmExportsResponses]; export type GetAdminRecipesRecipeTagsRecipeByRecipeIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { recipe_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/recipe-tags/recipe/{recipe_id}"; }; export type GetAdminRecipesRecipeTagsRecipeByRecipeIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesRecipeTagsRecipeByRecipeIdError = GetAdminRecipesRecipeTagsRecipeByRecipeIdErrors[keyof GetAdminRecipesRecipeTagsRecipeByRecipeIdErrors]; export type GetAdminRecipesRecipeTagsRecipeByRecipeIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a recipes-recipe-tag */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesRecipeTagsRecipeByRecipeIdResponse = GetAdminRecipesRecipeTagsRecipeByRecipeIdResponses[keyof GetAdminRecipesRecipeTagsRecipeByRecipeIdResponses]; export type GetAdminAgentSoulsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-souls"; }; export type GetAdminAgentSoulsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentSoulsError = GetAdminAgentSoulsErrors[keyof GetAdminAgentSoulsErrors]; export type GetAdminAgentSoulsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a agent-soul */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAgentSoulsResponse = GetAdminAgentSoulsResponses[keyof GetAdminAgentSoulsResponses]; export type PostAdminAgentSoulsData = { /** * Request body for the /agent-souls operation on agent-soul resource */ body: { data: { attributes?: { application_id?: string | null; content: string; is_default?: boolean | null; name: string; scope_type: "platform" | "application" | "workspace"; /** * Stable identifier for platform-provisioned souls. NULL for ISV-created souls. */ system_slug?: string | null; workspace_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "agent-soul"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-souls"; }; export type PostAdminAgentSoulsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAgentSoulsError = PostAdminAgentSoulsErrors[keyof PostAdminAgentSoulsErrors]; export type PostAdminAgentSoulsResponses = { /** * Success */ 201: { data?: AgentSoul; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAgentSoulsResponse = PostAdminAgentSoulsResponses[keyof PostAdminAgentSoulsResponses]; export type DeleteAdminAiMessagesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ai/messages/{id}"; }; export type DeleteAdminAiMessagesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminAiMessagesByIdError = DeleteAdminAiMessagesByIdErrors[keyof DeleteAdminAiMessagesByIdErrors]; export type DeleteAdminAiMessagesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminAiMessagesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ai/messages/{id}"; }; export type GetAdminAiMessagesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAiMessagesByIdError = GetAdminAiMessagesByIdErrors[keyof GetAdminAiMessagesByIdErrors]; export type GetAdminAiMessagesByIdResponses = { /** * Success */ 200: { data?: ChatAiMessage; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAiMessagesByIdResponse = GetAdminAiMessagesByIdResponses[keyof GetAdminAiMessagesByIdResponses]; export type PatchAdminClinicalSupplementTemplatesByIdArchiveData = { /** * Request body for the /clinical/supplement-templates/:id/archive operation on clinical-supplement-template resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-supplement-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-templates/{id}/archive"; }; export type PatchAdminClinicalSupplementTemplatesByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalSupplementTemplatesByIdArchiveError = PatchAdminClinicalSupplementTemplatesByIdArchiveErrors[keyof PatchAdminClinicalSupplementTemplatesByIdArchiveErrors]; export type PatchAdminClinicalSupplementTemplatesByIdArchiveResponses = { /** * Success */ 200: { data?: ClinicalSupplementTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalSupplementTemplatesByIdArchiveResponse = PatchAdminClinicalSupplementTemplatesByIdArchiveResponses[keyof PatchAdminClinicalSupplementTemplatesByIdArchiveResponses]; export type DeleteAdminClinicalPracticeResourcesCatalogByIdPermanentData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-resources/catalog/{id}/permanent"; }; export type DeleteAdminClinicalPracticeResourcesCatalogByIdPermanentErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalPracticeResourcesCatalogByIdPermanentError = DeleteAdminClinicalPracticeResourcesCatalogByIdPermanentErrors[keyof DeleteAdminClinicalPracticeResourcesCatalogByIdPermanentErrors]; export type DeleteAdminClinicalPracticeResourcesCatalogByIdPermanentResponses = { /** * Deleted successfully */ 200: unknown; }; export type PostAdminSocialCampaignsByIdAdaptForPlatformsData = { /** * Request body for the /social/campaigns/:id/adapt-for-platforms operation on social-campaign resource */ body: { data: { campaign_id: string; social_account_id: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/social/campaigns/{id}/adapt-for-platforms"; }; export type PostAdminSocialCampaignsByIdAdaptForPlatformsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSocialCampaignsByIdAdaptForPlatformsError = PostAdminSocialCampaignsByIdAdaptForPlatformsErrors[keyof PostAdminSocialCampaignsByIdAdaptForPlatformsErrors]; export type PostAdminSocialCampaignsByIdAdaptForPlatformsResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminSocialCampaignsByIdAdaptForPlatformsResponse = PostAdminSocialCampaignsByIdAdaptForPlatformsResponses[keyof PostAdminSocialCampaignsByIdAdaptForPlatformsResponses]; export type PatchAdminSocialPostsByIdCancelData = { /** * Request body for the /social/posts/:id/cancel operation on social-post resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "social-post"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/posts/{id}/cancel"; }; export type PatchAdminSocialPostsByIdCancelErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSocialPostsByIdCancelError = PatchAdminSocialPostsByIdCancelErrors[keyof PatchAdminSocialPostsByIdCancelErrors]; export type PatchAdminSocialPostsByIdCancelResponses = { /** * Success */ 200: { data?: SocialPost; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSocialPostsByIdCancelResponse = PatchAdminSocialPostsByIdCancelResponses[keyof PatchAdminSocialPostsByIdCancelResponses]; export type GetAdminRiskAssessmentsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/risk-assessments"; }; export type GetAdminRiskAssessmentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRiskAssessmentsError = GetAdminRiskAssessmentsErrors[keyof GetAdminRiskAssessmentsErrors]; export type GetAdminRiskAssessmentsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a risk-assessment */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRiskAssessmentsResponse = GetAdminRiskAssessmentsResponses[keyof GetAdminRiskAssessmentsResponses]; export type PostAdminRiskAssessmentsData = { /** * Request body for the /risk-assessments operation on risk-assessment resource */ body: { data: { attributes?: { assessment_type: "security" | "privacy" | "operational" | "compliance"; /** * Optional link to DPIA */ dpia_id?: string | null; expires_at?: unknown; findings?: { [key: string]: unknown; } | null; mitigations?: { [key: string]: unknown; } | null; /** * Optional link to ProcessingActivity */ processing_activity_id?: string | null; reviewer_id?: string | null; risk_level: "low" | "medium" | "high" | "critical"; status?: "draft" | "in_review" | "approved" | "expired"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "risk-assessment"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/risk-assessments"; }; export type PostAdminRiskAssessmentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminRiskAssessmentsError = PostAdminRiskAssessmentsErrors[keyof PostAdminRiskAssessmentsErrors]; export type PostAdminRiskAssessmentsResponses = { /** * Success */ 201: { data?: RiskAssessment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminRiskAssessmentsResponse = PostAdminRiskAssessmentsResponses[keyof PostAdminRiskAssessmentsResponses]; export type PatchAdminAgentExecutionsByIdResumeData = { /** * Request body for the /agent-executions/:id/resume operation on agent-execution resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "agent-execution"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-executions/{id}/resume"; }; export type PatchAdminAgentExecutionsByIdResumeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminAgentExecutionsByIdResumeError = PatchAdminAgentExecutionsByIdResumeErrors[keyof PatchAdminAgentExecutionsByIdResumeErrors]; export type PatchAdminAgentExecutionsByIdResumeResponses = { /** * Success */ 200: { data?: AgentExecution; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminAgentExecutionsByIdResumeResponse = PatchAdminAgentExecutionsByIdResumeResponses[keyof PatchAdminAgentExecutionsByIdResumeResponses]; export type PostAdminRecipesFoodItemsData = { /** * Request body for the /recipes/food-items operation on recipes-food-item resource */ body: { data: { attributes?: { allergens?: Array | null; application_id: string; default_unit?: string | null; external_id?: string | null; external_source?: string | null; food_group?: string | null; name: string; nutrition_per_100g?: { [key: string]: unknown; } | null; unit_conversions?: { [key: string]: unknown; } | null; }; relationships?: { [key: string]: never; }; type?: "recipes-food-item"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/food-items"; }; export type PostAdminRecipesFoodItemsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminRecipesFoodItemsError = PostAdminRecipesFoodItemsErrors[keyof PostAdminRecipesFoodItemsErrors]; export type PostAdminRecipesFoodItemsResponses = { /** * Success */ 201: { data?: RecipesFoodItem; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminRecipesFoodItemsResponse = PostAdminRecipesFoodItemsResponses[keyof PostAdminRecipesFoodItemsResponses]; export type PostAdminCatalogProductsData = { /** * Request body for the /catalog/products operation on catalog-product resource */ body: { data: { attributes?: { application_id?: string | null; base_price?: string | number | unknown; currency?: string | null; description?: string | null; media?: Array<{ [key: string]: unknown; }> | null; name: string; properties?: { [key: string]: unknown; } | null; short_description?: string | null; sku?: string | null; slug: string; status?: "draft" | "active" | "archived" | "discontinued"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "catalog-product"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/products"; }; export type PostAdminCatalogProductsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCatalogProductsError = PostAdminCatalogProductsErrors[keyof PostAdminCatalogProductsErrors]; export type PostAdminCatalogProductsResponses = { /** * Success */ 201: { data?: CatalogProduct; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCatalogProductsResponse = PostAdminCatalogProductsResponses[keyof PostAdminCatalogProductsResponses]; export type GetAdminDisclosureLogsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/disclosure-logs/{id}"; }; export type GetAdminDisclosureLogsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminDisclosureLogsByIdError = GetAdminDisclosureLogsByIdErrors[keyof GetAdminDisclosureLogsByIdErrors]; export type GetAdminDisclosureLogsByIdResponses = { /** * Success */ 200: { data?: DisclosureLog; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminDisclosureLogsByIdResponse = GetAdminDisclosureLogsByIdResponses[keyof GetAdminDisclosureLogsByIdResponses]; export type PostAdminConnectorsFullscriptCreatePatientData = { /** * Request body for the /connectors/fullscript/create-patient operation on connector-instance resource */ body: { data: { connector_id: string; date_of_birth?: string | null; email: string; first_name: string; last_name: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/connectors/fullscript/create-patient"; }; export type PostAdminConnectorsFullscriptCreatePatientErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsFullscriptCreatePatientError = PostAdminConnectorsFullscriptCreatePatientErrors[keyof PostAdminConnectorsFullscriptCreatePatientErrors]; export type PostAdminConnectorsFullscriptCreatePatientResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminConnectorsFullscriptCreatePatientResponse = PostAdminConnectorsFullscriptCreatePatientResponses[keyof PostAdminConnectorsFullscriptCreatePatientResponses]; export type GetAdminContractRenewalAlertsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/contract-renewal-alerts"; }; export type GetAdminContractRenewalAlertsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminContractRenewalAlertsError = GetAdminContractRenewalAlertsErrors[keyof GetAdminContractRenewalAlertsErrors]; export type GetAdminContractRenewalAlertsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a contract-renewal-alert */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminContractRenewalAlertsResponse = GetAdminContractRenewalAlertsResponses[keyof GetAdminContractRenewalAlertsResponses]; export type GetAdminSchedulingBookingsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/scheduling/bookings"; }; export type GetAdminSchedulingBookingsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingBookingsError = GetAdminSchedulingBookingsErrors[keyof GetAdminSchedulingBookingsErrors]; export type GetAdminSchedulingBookingsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a scheduling-booking */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingBookingsResponse = GetAdminSchedulingBookingsResponses[keyof GetAdminSchedulingBookingsResponses]; export type PostAdminSchedulingBookingsData = { /** * Request body for the /scheduling/bookings operation on scheduling-booking resource */ body: { data: { attributes?: { _hp_field?: string | null; booked_by_user_id?: string | null; booker_contact_id?: string | null; booker_email: string; booker_name: string; booker_phone?: string | null; booker_timezone?: string | null; end_time: unknown; event_type_id: string; intake_responses?: { [key: string]: unknown; } | null; metadata?: { [key: string]: unknown; } | null; party_size?: number | null; start_time: unknown; workspace_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "scheduling-booking"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/bookings"; }; export type PostAdminSchedulingBookingsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSchedulingBookingsError = PostAdminSchedulingBookingsErrors[keyof PostAdminSchedulingBookingsErrors]; export type PostAdminSchedulingBookingsResponses = { /** * Success */ 201: { data?: SchedulingBooking; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSchedulingBookingsResponse = PostAdminSchedulingBookingsResponses[keyof PostAdminSchedulingBookingsResponses]; export type PatchAdminSchedulingCalendarSyncsByIdResumeData = { /** * Request body for the /scheduling/calendar-syncs/:id/resume operation on scheduling-calendar-sync resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "scheduling-calendar-sync"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/calendar-syncs/{id}/resume"; }; export type PatchAdminSchedulingCalendarSyncsByIdResumeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSchedulingCalendarSyncsByIdResumeError = PatchAdminSchedulingCalendarSyncsByIdResumeErrors[keyof PatchAdminSchedulingCalendarSyncsByIdResumeErrors]; export type PatchAdminSchedulingCalendarSyncsByIdResumeResponses = { /** * Success */ 200: { data?: SchedulingCalendarSync; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSchedulingCalendarSyncsByIdResumeResponse = PatchAdminSchedulingCalendarSyncsByIdResumeResponses[keyof PatchAdminSchedulingCalendarSyncsByIdResumeResponses]; export type PatchAdminExtractionDocumentsByIdRestoreData = { /** * Request body for the /extraction/documents/:id/restore operation on extraction-document resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "extraction-document"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/documents/{id}/restore"; }; export type PatchAdminExtractionDocumentsByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminExtractionDocumentsByIdRestoreError = PatchAdminExtractionDocumentsByIdRestoreErrors[keyof PatchAdminExtractionDocumentsByIdRestoreErrors]; export type PatchAdminExtractionDocumentsByIdRestoreResponses = { /** * Success */ 200: { data?: ExtractionDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminExtractionDocumentsByIdRestoreResponse = PatchAdminExtractionDocumentsByIdRestoreResponses[keyof PatchAdminExtractionDocumentsByIdRestoreResponses]; export type GetAdminBalancesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/balances/{id}"; }; export type GetAdminBalancesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminBalancesByIdError = GetAdminBalancesByIdErrors[keyof GetAdminBalancesByIdErrors]; export type GetAdminBalancesByIdResponses = { /** * Success */ 200: { data?: Balance; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminBalancesByIdResponse = GetAdminBalancesByIdResponses[keyof GetAdminBalancesByIdResponses]; export type PatchAdminBusinessAssociateAgreementsByIdSignData = { /** * Request body for the /business-associate-agreements/:id/sign operation on business-associate-agreement resource */ body?: { data: { attributes?: { counterparty_signatory?: string | null; signed_by_id?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "business-associate-agreement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/business-associate-agreements/{id}/sign"; }; export type PatchAdminBusinessAssociateAgreementsByIdSignErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminBusinessAssociateAgreementsByIdSignError = PatchAdminBusinessAssociateAgreementsByIdSignErrors[keyof PatchAdminBusinessAssociateAgreementsByIdSignErrors]; export type PatchAdminBusinessAssociateAgreementsByIdSignResponses = { /** * Success */ 200: { data?: BusinessAssociateAgreement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminBusinessAssociateAgreementsByIdSignResponse = PatchAdminBusinessAssociateAgreementsByIdSignResponses[keyof PatchAdminBusinessAssociateAgreementsByIdSignResponses]; export type GetAdminSocialTrendingHistoryWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/trending/history/workspace/{workspace_id}"; }; export type GetAdminSocialTrendingHistoryWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialTrendingHistoryWorkspaceByWorkspaceIdError = GetAdminSocialTrendingHistoryWorkspaceByWorkspaceIdErrors[keyof GetAdminSocialTrendingHistoryWorkspaceByWorkspaceIdErrors]; export type GetAdminSocialTrendingHistoryWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a trending-snapshot */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialTrendingHistoryWorkspaceByWorkspaceIdResponse = GetAdminSocialTrendingHistoryWorkspaceByWorkspaceIdResponses[keyof GetAdminSocialTrendingHistoryWorkspaceByWorkspaceIdResponses]; export type PatchAdminClinicalGoalTemplatesByIdArchiveData = { /** * Request body for the /clinical/goal-templates/:id/archive operation on clinical-goal-template resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-goal-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-templates/{id}/archive"; }; export type PatchAdminClinicalGoalTemplatesByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalGoalTemplatesByIdArchiveError = PatchAdminClinicalGoalTemplatesByIdArchiveErrors[keyof PatchAdminClinicalGoalTemplatesByIdArchiveErrors]; export type PatchAdminClinicalGoalTemplatesByIdArchiveResponses = { /** * Success */ 200: { data?: ClinicalGoalTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalGoalTemplatesByIdArchiveResponse = PatchAdminClinicalGoalTemplatesByIdArchiveResponses[keyof PatchAdminClinicalGoalTemplatesByIdArchiveResponses]; export type PostAdminExtractionDocumentsUploadData = { /** * Request body for the /extraction/documents/upload operation on extraction-document resource */ body: { data: { attributes?: { /** * DEPRECATED. The S3 bucket where this document is stored. Use storage_file_id instead. */ bucket_name?: string | null; /** * Content hash for deduplication (blake3: or sha256: prefix + 64 hex characters) */ file_hash?: string | null; file_size_bytes?: number | null; file_type: "pdf" | "docx" | "image" | "zip" | "audio" | "video"; filename: string; parent_document_id?: string | null; storage_path: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "extraction-document"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/documents/upload"; }; export type PostAdminExtractionDocumentsUploadErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminExtractionDocumentsUploadError = PostAdminExtractionDocumentsUploadErrors[keyof PostAdminExtractionDocumentsUploadErrors]; export type PostAdminExtractionDocumentsUploadResponses = { /** * Success */ 201: { data?: ExtractionDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminExtractionDocumentsUploadResponse = PostAdminExtractionDocumentsUploadResponses[keyof PostAdminExtractionDocumentsUploadResponses]; export type GetAdminExtractionChunkEntityLinksDocumentByDocumentIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { document_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/chunk-entity-links/document/{document_id}"; }; export type GetAdminExtractionChunkEntityLinksDocumentByDocumentIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionChunkEntityLinksDocumentByDocumentIdError = GetAdminExtractionChunkEntityLinksDocumentByDocumentIdErrors[keyof GetAdminExtractionChunkEntityLinksDocumentByDocumentIdErrors]; export type GetAdminExtractionChunkEntityLinksDocumentByDocumentIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a chunk-entity-link */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionChunkEntityLinksDocumentByDocumentIdResponse = GetAdminExtractionChunkEntityLinksDocumentByDocumentIdResponses[keyof GetAdminExtractionChunkEntityLinksDocumentByDocumentIdResponses]; export type DeleteAdminSystemMessagesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/system-messages/{id}"; }; export type DeleteAdminSystemMessagesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminSystemMessagesByIdError = DeleteAdminSystemMessagesByIdErrors[keyof DeleteAdminSystemMessagesByIdErrors]; export type DeleteAdminSystemMessagesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminSystemMessagesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/system-messages/{id}"; }; export type GetAdminSystemMessagesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSystemMessagesByIdError = GetAdminSystemMessagesByIdErrors[keyof GetAdminSystemMessagesByIdErrors]; export type GetAdminSystemMessagesByIdResponses = { /** * Success */ 200: { data?: SystemMessage; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSystemMessagesByIdResponse = GetAdminSystemMessagesByIdResponses[keyof GetAdminSystemMessagesByIdResponses]; export type PatchAdminSystemMessagesByIdData = { /** * Request body for the /system-messages/:id operation on system-message resource */ body?: { data: { attributes?: { /** * Markdown content */ content?: string | null; is_active?: boolean | null; /** * For ToS: forces users to re-accept even if they accepted a previous version */ requires_acceptance?: boolean | null; title?: string | null; version?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "system-message"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/system-messages/{id}"; }; export type PatchAdminSystemMessagesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSystemMessagesByIdError = PatchAdminSystemMessagesByIdErrors[keyof PatchAdminSystemMessagesByIdErrors]; export type PatchAdminSystemMessagesByIdResponses = { /** * Success */ 200: { data?: SystemMessage; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSystemMessagesByIdResponse = PatchAdminSystemMessagesByIdResponses[keyof PatchAdminSystemMessagesByIdResponses]; export type GetAdminClinicalClientSupplementsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-supplements/{id}"; }; export type GetAdminClinicalClientSupplementsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalClientSupplementsByIdError = GetAdminClinicalClientSupplementsByIdErrors[keyof GetAdminClinicalClientSupplementsByIdErrors]; export type GetAdminClinicalClientSupplementsByIdResponses = { /** * Success */ 200: { data?: ClinicalClientSupplement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalClientSupplementsByIdResponse = GetAdminClinicalClientSupplementsByIdResponses[keyof GetAdminClinicalClientSupplementsByIdResponses]; export type PatchAdminClinicalClientSupplementsByIdData = { /** * Request body for the /clinical/client-supplements/:id operation on clinical-client-supplement resource */ body?: { data: { attributes?: { discontinued_at?: unknown; dosage?: string | null; frequency?: string | null; fullscript_product_id?: string | null; fullscript_treatment_plan_id?: string | null; fullscript_variant_id?: string | null; instructions?: string | null; interaction_flags?: Array | null; metadata?: { [key: string]: unknown; } | null; name?: string | null; prescribed_at?: unknown; protocol_template_id?: string | null; rationale_client?: string | null; rationale_clinical?: string | null; route?: string | null; source?: string | null; status?: "active" | "discontinued" | "on_hold"; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-client-supplement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-supplements/{id}"; }; export type PatchAdminClinicalClientSupplementsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalClientSupplementsByIdError = PatchAdminClinicalClientSupplementsByIdErrors[keyof PatchAdminClinicalClientSupplementsByIdErrors]; export type PatchAdminClinicalClientSupplementsByIdResponses = { /** * Success */ 200: { data?: ClinicalClientSupplement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalClientSupplementsByIdResponse = PatchAdminClinicalClientSupplementsByIdResponses[keyof PatchAdminClinicalClientSupplementsByIdResponses]; export type PatchAdminEmailInboundAddressesByIdEnableData = { /** * Request body for the /email/inbound-addresses/:id/enable operation on email-inbound-address resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "email-inbound-address"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/inbound-addresses/{id}/enable"; }; export type PatchAdminEmailInboundAddressesByIdEnableErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailInboundAddressesByIdEnableError = PatchAdminEmailInboundAddressesByIdEnableErrors[keyof PatchAdminEmailInboundAddressesByIdEnableErrors]; export type PatchAdminEmailInboundAddressesByIdEnableResponses = { /** * Success */ 200: { data?: EmailInboundAddress; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailInboundAddressesByIdEnableResponse = PatchAdminEmailInboundAddressesByIdEnableResponses[keyof PatchAdminEmailInboundAddressesByIdEnableResponses]; export type PostAdminCrmPipelinesData = { /** * Request body for the /crm/pipelines operation on crm-pipeline resource */ body: { data: { attributes?: { application_id: string; entity_type?: string | null; is_default?: boolean | null; name: string; workspace_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "crm-pipeline"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/pipelines"; }; export type PostAdminCrmPipelinesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrmPipelinesError = PostAdminCrmPipelinesErrors[keyof PostAdminCrmPipelinesErrors]; export type PostAdminCrmPipelinesResponses = { /** * Success */ 201: { data?: CrmPipeline; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrmPipelinesResponse = PostAdminCrmPipelinesResponses[keyof PostAdminCrmPipelinesResponses]; export type GetAdminLlmAnalyticsUsageData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/llm-analytics/usage"; }; export type GetAdminLlmAnalyticsUsageErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminLlmAnalyticsUsageError = GetAdminLlmAnalyticsUsageErrors[keyof GetAdminLlmAnalyticsUsageErrors]; export type GetAdminLlmAnalyticsUsageResponses = { /** * Success */ 200: { data?: LlmAnalytics; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminLlmAnalyticsUsageResponse = GetAdminLlmAnalyticsUsageResponses[keyof GetAdminLlmAnalyticsUsageResponses]; export type GetAdminCatalogStockMovementsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/stock-movements/{id}"; }; export type GetAdminCatalogStockMovementsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogStockMovementsByIdError = GetAdminCatalogStockMovementsByIdErrors[keyof GetAdminCatalogStockMovementsByIdErrors]; export type GetAdminCatalogStockMovementsByIdResponses = { /** * Success */ 200: { data?: CatalogStockMovement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogStockMovementsByIdResponse = GetAdminCatalogStockMovementsByIdResponses[keyof GetAdminCatalogStockMovementsByIdResponses]; export type PostAdminConnectorsByIdHealthieSyncAllData = { /** * Request body for the /connectors/:id/healthie/sync-all operation on connector-instance resource */ body: { data: { connector_id: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/connectors/{id}/healthie/sync-all"; }; export type PostAdminConnectorsByIdHealthieSyncAllErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsByIdHealthieSyncAllError = PostAdminConnectorsByIdHealthieSyncAllErrors[keyof PostAdminConnectorsByIdHealthieSyncAllErrors]; export type PostAdminConnectorsByIdHealthieSyncAllResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminConnectorsByIdHealthieSyncAllResponse = PostAdminConnectorsByIdHealthieSyncAllResponses[keyof PostAdminConnectorsByIdHealthieSyncAllResponses]; export type DeleteAdminRecipesRecipeTagsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/recipe-tags/{id}"; }; export type DeleteAdminRecipesRecipeTagsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminRecipesRecipeTagsByIdError = DeleteAdminRecipesRecipeTagsByIdErrors[keyof DeleteAdminRecipesRecipeTagsByIdErrors]; export type DeleteAdminRecipesRecipeTagsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminRecipesRecipeTagsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/recipe-tags/{id}"; }; export type GetAdminRecipesRecipeTagsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesRecipeTagsByIdError = GetAdminRecipesRecipeTagsByIdErrors[keyof GetAdminRecipesRecipeTagsByIdErrors]; export type GetAdminRecipesRecipeTagsByIdResponses = { /** * Success */ 200: { data?: RecipesRecipeTag; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesRecipeTagsByIdResponse = GetAdminRecipesRecipeTagsByIdResponses[keyof GetAdminRecipesRecipeTagsByIdResponses]; export type DeleteAdminCrawlerSiteConfigsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/site-configs/{id}"; }; export type DeleteAdminCrawlerSiteConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrawlerSiteConfigsByIdError = DeleteAdminCrawlerSiteConfigsByIdErrors[keyof DeleteAdminCrawlerSiteConfigsByIdErrors]; export type DeleteAdminCrawlerSiteConfigsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCrawlerSiteConfigsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/site-configs/{id}"; }; export type GetAdminCrawlerSiteConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrawlerSiteConfigsByIdError = GetAdminCrawlerSiteConfigsByIdErrors[keyof GetAdminCrawlerSiteConfigsByIdErrors]; export type GetAdminCrawlerSiteConfigsByIdResponses = { /** * Success */ 200: { data?: CrawlerSiteConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrawlerSiteConfigsByIdResponse = GetAdminCrawlerSiteConfigsByIdResponses[keyof GetAdminCrawlerSiteConfigsByIdResponses]; export type PatchAdminCrawlerSiteConfigsByIdData = { /** * Request body for the /crawler/site-configs/:id operation on crawler-site-config resource */ body?: { data: { attributes?: { browser_auth_session_id?: string | null; browser_fallback_strategy?: "native" | "sidecar"; custom_headers?: { [key: string]: unknown; } | null; preferred_strategy?: "native" | "sidecar" | "auto" | "browser_session"; rate_limit_rpm?: number | null; requires_js?: boolean | null; respect_robots?: boolean | null; user_agent?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "crawler-site-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/site-configs/{id}"; }; export type PatchAdminCrawlerSiteConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrawlerSiteConfigsByIdError = PatchAdminCrawlerSiteConfigsByIdErrors[keyof PatchAdminCrawlerSiteConfigsByIdErrors]; export type PatchAdminCrawlerSiteConfigsByIdResponses = { /** * Success */ 200: { data?: CrawlerSiteConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrawlerSiteConfigsByIdResponse = PatchAdminCrawlerSiteConfigsByIdResponses[keyof PatchAdminCrawlerSiteConfigsByIdResponses]; export type GetAdminCrmRelationshipTypesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/relationship-types"; }; export type GetAdminCrmRelationshipTypesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmRelationshipTypesError = GetAdminCrmRelationshipTypesErrors[keyof GetAdminCrmRelationshipTypesErrors]; export type GetAdminCrmRelationshipTypesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crm-relationship-type */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmRelationshipTypesResponse = GetAdminCrmRelationshipTypesResponses[keyof GetAdminCrmRelationshipTypesResponses]; export type PostAdminCrmRelationshipTypesData = { /** * Request body for the /crm/relationship-types operation on crm-relationship-type resource */ body: { data: { attributes?: { application_id: string; is_directional?: boolean | null; is_system?: boolean | null; name: string; properties_schema?: { [key: string]: unknown; } | null; slug: string; source_entity_types?: Array | null; target_entity_types?: Array | null; }; relationships?: { [key: string]: never; }; type?: "crm-relationship-type"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/relationship-types"; }; export type PostAdminCrmRelationshipTypesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrmRelationshipTypesError = PostAdminCrmRelationshipTypesErrors[keyof PostAdminCrmRelationshipTypesErrors]; export type PostAdminCrmRelationshipTypesResponses = { /** * Success */ 201: { data?: CrmRelationshipType; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrmRelationshipTypesResponse = PostAdminCrmRelationshipTypesResponses[keyof PostAdminCrmRelationshipTypesResponses]; export type PostAdminInvoicesRecurringSchedulesData = { /** * Request body for the /invoices/recurring-schedules operation on invoices-recurring-schedule resource */ body: { data: { attributes?: { active?: boolean | null; auto_send?: boolean | null; contact_id?: string | null; end_date?: string | null; frequency: "weekly" | "biweekly" | "monthly" | "quarterly" | "annually"; line_items?: Array<{ [key: string]: unknown; }> | null; metadata?: { [key: string]: unknown; } | null; name: string; next_run_date?: string | null; start_date: string; template_id?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "invoices-recurring-schedule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/recurring-schedules"; }; export type PostAdminInvoicesRecurringSchedulesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminInvoicesRecurringSchedulesError = PostAdminInvoicesRecurringSchedulesErrors[keyof PostAdminInvoicesRecurringSchedulesErrors]; export type PostAdminInvoicesRecurringSchedulesResponses = { /** * Success */ 201: { data?: InvoicesRecurringSchedule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminInvoicesRecurringSchedulesResponse = PostAdminInvoicesRecurringSchedulesResponses[keyof PostAdminInvoicesRecurringSchedulesResponses]; export type GetAdminClinicalPracticeToolsCategoriesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/practice-tools/categories"; }; export type GetAdminClinicalPracticeToolsCategoriesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPracticeToolsCategoriesError = GetAdminClinicalPracticeToolsCategoriesErrors[keyof GetAdminClinicalPracticeToolsCategoriesErrors]; export type GetAdminClinicalPracticeToolsCategoriesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-practice-tool-category */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPracticeToolsCategoriesResponse = GetAdminClinicalPracticeToolsCategoriesResponses[keyof GetAdminClinicalPracticeToolsCategoriesResponses]; export type PostAdminClinicalGoalTemplatesFromExistingData = { /** * Request body for the /clinical/goal-templates/from-existing operation on clinical-goal-template resource */ body: { data: { attributes?: { source_template_id: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-goal-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-templates/from-existing"; }; export type PostAdminClinicalGoalTemplatesFromExistingErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalGoalTemplatesFromExistingError = PostAdminClinicalGoalTemplatesFromExistingErrors[keyof PostAdminClinicalGoalTemplatesFromExistingErrors]; export type PostAdminClinicalGoalTemplatesFromExistingResponses = { /** * Success */ 201: { data?: ClinicalGoalTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalGoalTemplatesFromExistingResponse = PostAdminClinicalGoalTemplatesFromExistingResponses[keyof PostAdminClinicalGoalTemplatesFromExistingResponses]; export type GetAdminClinicalClientMedicationsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-medications/{id}"; }; export type GetAdminClinicalClientMedicationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalClientMedicationsByIdError = GetAdminClinicalClientMedicationsByIdErrors[keyof GetAdminClinicalClientMedicationsByIdErrors]; export type GetAdminClinicalClientMedicationsByIdResponses = { /** * Success */ 200: { data?: ClinicalClientMedication; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalClientMedicationsByIdResponse = GetAdminClinicalClientMedicationsByIdResponses[keyof GetAdminClinicalClientMedicationsByIdResponses]; export type PatchAdminClinicalClientMedicationsByIdData = { /** * Request body for the /clinical/client-medications/:id operation on clinical-client-medication resource */ body?: { data: { attributes?: { clinical_notes?: string | null; dosage?: string | null; end_date?: unknown; external_ids?: { [key: string]: unknown; } | null; frequency?: string | null; generic_name?: string | null; indication?: string | null; instructions?: string | null; interaction_flags?: Array | null; metadata?: { [key: string]: unknown; } | null; name?: string | null; ndc_code?: string | null; pharmacy_name?: string | null; pharmacy_phone?: string | null; prescribed_at?: unknown; prescriber_name?: string | null; prescriber_npi?: string | null; refill_date?: unknown; refills_remaining?: number | null; route?: string | null; source?: string | null; start_date?: unknown; status?: "active" | "discontinued" | "on_hold" | "pending_review"; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-client-medication"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-medications/{id}"; }; export type PatchAdminClinicalClientMedicationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalClientMedicationsByIdError = PatchAdminClinicalClientMedicationsByIdErrors[keyof PatchAdminClinicalClientMedicationsByIdErrors]; export type PatchAdminClinicalClientMedicationsByIdResponses = { /** * Success */ 200: { data?: ClinicalClientMedication; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalClientMedicationsByIdResponse = PatchAdminClinicalClientMedicationsByIdResponses[keyof PatchAdminClinicalClientMedicationsByIdResponses]; export type GetAdminThreadsStatsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/threads/stats"; }; export type GetAdminThreadsStatsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminThreadsStatsError = GetAdminThreadsStatsErrors[keyof GetAdminThreadsStatsErrors]; export type GetAdminThreadsStatsResponses = { /** * Success */ 200: { data?: ChatThreadStats; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminThreadsStatsResponse = GetAdminThreadsStatsResponses[keyof GetAdminThreadsStatsResponses]; export type PatchAdminWalletPlanCancelData = { /** * Request body for the /wallet/plan/cancel operation on wallet-public resource */ body?: { data: { attributes?: { immediate?: boolean | null; }; id: string; relationships?: { [key: string]: never; }; type?: "wallet-public"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/wallet/plan/cancel"; }; export type PatchAdminWalletPlanCancelErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminWalletPlanCancelError = PatchAdminWalletPlanCancelErrors[keyof PatchAdminWalletPlanCancelErrors]; export type PatchAdminWalletPlanCancelResponses = { /** * Success */ 200: { data?: WalletPublic; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminWalletPlanCancelResponse = PatchAdminWalletPlanCancelResponses[keyof PatchAdminWalletPlanCancelResponses]; export type PostAdminTokensData = { /** * Request body for the /tokens operation on token resource */ body?: { data: { attributes?: { card?: { [key: string]: unknown; } | null; type?: "card" | "bank_account"; }; relationships?: { [key: string]: never; }; type?: "token"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tokens"; }; export type PostAdminTokensErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminTokensError = PostAdminTokensErrors[keyof PostAdminTokensErrors]; export type PostAdminTokensResponses = { /** * Success */ 201: { data?: Token; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminTokensResponse = PostAdminTokensResponses[keyof PostAdminTokensResponses]; export type GetAdminPortalInvitationsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/portal-invitations"; }; export type GetAdminPortalInvitationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPortalInvitationsError = GetAdminPortalInvitationsErrors[keyof GetAdminPortalInvitationsErrors]; export type GetAdminPortalInvitationsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a portal-invitation */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPortalInvitationsResponse = GetAdminPortalInvitationsResponses[keyof GetAdminPortalInvitationsResponses]; export type PostAdminPortalInvitationsData = { /** * Request body for the /portal-invitations operation on portal-invitation resource */ body: { data: { attributes?: { email: string; invited_by_id: string; tenant_id: string; }; relationships?: { [key: string]: never; }; type?: "portal-invitation"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/portal-invitations"; }; export type PostAdminPortalInvitationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminPortalInvitationsError = PostAdminPortalInvitationsErrors[keyof PostAdminPortalInvitationsErrors]; export type PostAdminPortalInvitationsResponses = { /** * Success */ 201: { data?: PortalInvitation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminPortalInvitationsResponse = PostAdminPortalInvitationsResponses[keyof PostAdminPortalInvitationsResponses]; export type GetAdminAiGraphNodesByNodeIdRelationshipsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { node_id: string; }; query?: { direction?: "inbound" | "outbound" | "both"; relationship_type?: string; }; url: "/admin/ai/graph/nodes/{node_id}/relationships"; }; export type GetAdminAiGraphNodesByNodeIdRelationshipsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAiGraphNodesByNodeIdRelationshipsError = GetAdminAiGraphNodesByNodeIdRelationshipsErrors[keyof GetAdminAiGraphNodesByNodeIdRelationshipsErrors]; export type GetAdminAiGraphNodesByNodeIdRelationshipsResponses = { /** * Success */ 200: Array<{ [key: string]: unknown; }>; }; export type GetAdminAiGraphNodesByNodeIdRelationshipsResponse = GetAdminAiGraphNodesByNodeIdRelationshipsResponses[keyof GetAdminAiGraphNodesByNodeIdRelationshipsResponses]; export type PatchAdminFormDeploymentsByIdAcceptUpdateData = { /** * Request body for the /form-deployments/:id/accept-update operation on form-deployment resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "form-deployment"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/form-deployments/{id}/accept-update"; }; export type PatchAdminFormDeploymentsByIdAcceptUpdateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminFormDeploymentsByIdAcceptUpdateError = PatchAdminFormDeploymentsByIdAcceptUpdateErrors[keyof PatchAdminFormDeploymentsByIdAcceptUpdateErrors]; export type PatchAdminFormDeploymentsByIdAcceptUpdateResponses = { /** * Success */ 200: { data?: FormDeployment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminFormDeploymentsByIdAcceptUpdateResponse = PatchAdminFormDeploymentsByIdAcceptUpdateResponses[keyof PatchAdminFormDeploymentsByIdAcceptUpdateResponses]; export type GetAdminPermissionsPresetsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; context?: string; app?: string; }; url: "/admin/permissions/presets"; }; export type GetAdminPermissionsPresetsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPermissionsPresetsError = GetAdminPermissionsPresetsErrors[keyof GetAdminPermissionsPresetsErrors]; export type GetAdminPermissionsPresetsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a permission-preset */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPermissionsPresetsResponse = GetAdminPermissionsPresetsResponses[keyof GetAdminPermissionsPresetsResponses]; export type PostAdminWholesaleAgreementsByIdGrantSignupCreditsData = { /** * Request body for the /wholesale-agreements/:id/grant-signup-credits operation on wholesale-agreement resource */ body: { data: { credits: number; reason?: string | null; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/wholesale-agreements/{id}/grant-signup-credits"; }; export type PostAdminWholesaleAgreementsByIdGrantSignupCreditsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminWholesaleAgreementsByIdGrantSignupCreditsError = PostAdminWholesaleAgreementsByIdGrantSignupCreditsErrors[keyof PostAdminWholesaleAgreementsByIdGrantSignupCreditsErrors]; export type PostAdminWholesaleAgreementsByIdGrantSignupCreditsResponses = { /** * Success */ 201: { result: { [key: string]: unknown; }; }; }; export type PostAdminWholesaleAgreementsByIdGrantSignupCreditsResponse = PostAdminWholesaleAgreementsByIdGrantSignupCreditsResponses[keyof PostAdminWholesaleAgreementsByIdGrantSignupCreditsResponses]; export type DeleteAdminClinicalSupplementTemplatesByIdPermanentData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-templates/{id}/permanent"; }; export type DeleteAdminClinicalSupplementTemplatesByIdPermanentErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalSupplementTemplatesByIdPermanentError = DeleteAdminClinicalSupplementTemplatesByIdPermanentErrors[keyof DeleteAdminClinicalSupplementTemplatesByIdPermanentErrors]; export type DeleteAdminClinicalSupplementTemplatesByIdPermanentResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminExtractionChunkEntityLinksEntityByGraphNodeIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { graph_node_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/chunk-entity-links/entity/{graph_node_id}"; }; export type GetAdminExtractionChunkEntityLinksEntityByGraphNodeIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionChunkEntityLinksEntityByGraphNodeIdError = GetAdminExtractionChunkEntityLinksEntityByGraphNodeIdErrors[keyof GetAdminExtractionChunkEntityLinksEntityByGraphNodeIdErrors]; export type GetAdminExtractionChunkEntityLinksEntityByGraphNodeIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a chunk-entity-link */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionChunkEntityLinksEntityByGraphNodeIdResponse = GetAdminExtractionChunkEntityLinksEntityByGraphNodeIdResponses[keyof GetAdminExtractionChunkEntityLinksEntityByGraphNodeIdResponses]; export type PostAdminTenantsIsvData = { /** * Request body for the /tenants/isv operation on tenant resource */ body: { data: { attributes?: { badge_url?: string | null; initial_credits?: number | null; logo_url?: string | null; name: string; owner_id: string; slug: string; }; relationships?: { [key: string]: never; }; type?: "tenant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants/isv"; }; export type PostAdminTenantsIsvErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminTenantsIsvError = PostAdminTenantsIsvErrors[keyof PostAdminTenantsIsvErrors]; export type PostAdminTenantsIsvResponses = { /** * Success */ 201: { data?: Tenant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminTenantsIsvResponse = PostAdminTenantsIsvResponses[keyof PostAdminTenantsIsvResponses]; export type PatchAdminWalletAutoTopUpData = { /** * Request body for the /wallet/auto-top-up operation on wallet-public resource */ body: { data: { attributes?: { amount?: number | null; enabled: boolean; package_id?: string | null; threshold?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "wallet-public"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/wallet/auto-top-up"; }; export type PatchAdminWalletAutoTopUpErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminWalletAutoTopUpError = PatchAdminWalletAutoTopUpErrors[keyof PatchAdminWalletAutoTopUpErrors]; export type PatchAdminWalletAutoTopUpResponses = { /** * Success */ 200: { data?: WalletPublic; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminWalletAutoTopUpResponse = PatchAdminWalletAutoTopUpResponses[keyof PatchAdminWalletAutoTopUpResponses]; export type PostAdminCatalogTaxonomiesData = { /** * Request body for the /catalog/taxonomies operation on catalog-taxonomy resource */ body: { data: { attributes?: { ai_managed?: boolean | null; application_id: string; is_hierarchical?: boolean | null; is_required?: boolean | null; max_depth?: number | null; name: string; scope?: "application" | "workspace"; slug: string; workspace_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "catalog-taxonomy"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/taxonomies"; }; export type PostAdminCatalogTaxonomiesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCatalogTaxonomiesError = PostAdminCatalogTaxonomiesErrors[keyof PostAdminCatalogTaxonomiesErrors]; export type PostAdminCatalogTaxonomiesResponses = { /** * Success */ 201: { data?: CatalogTaxonomy; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCatalogTaxonomiesResponse = PostAdminCatalogTaxonomiesResponses[keyof PostAdminCatalogTaxonomiesResponses]; export type PatchAdminClinicalIntakeTargetsByIdRestoreData = { /** * Request body for the /clinical/intake-targets/:id/restore operation on clinical-intake-target resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-intake-target"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/intake-targets/{id}/restore"; }; export type PatchAdminClinicalIntakeTargetsByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalIntakeTargetsByIdRestoreError = PatchAdminClinicalIntakeTargetsByIdRestoreErrors[keyof PatchAdminClinicalIntakeTargetsByIdRestoreErrors]; export type PatchAdminClinicalIntakeTargetsByIdRestoreResponses = { /** * Success */ 200: { data?: ClinicalIntakeTarget; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalIntakeTargetsByIdRestoreResponse = PatchAdminClinicalIntakeTargetsByIdRestoreResponses[keyof PatchAdminClinicalIntakeTargetsByIdRestoreResponses]; export type GetAdminExtractionShadowComparisonsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/shadow-comparisons"; }; export type GetAdminExtractionShadowComparisonsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionShadowComparisonsError = GetAdminExtractionShadowComparisonsErrors[keyof GetAdminExtractionShadowComparisonsErrors]; export type GetAdminExtractionShadowComparisonsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a shadow-comparison */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionShadowComparisonsResponse = GetAdminExtractionShadowComparisonsResponses[keyof GetAdminExtractionShadowComparisonsResponses]; export type PostAdminExtractionShadowComparisonsData = { /** * Request body for the /extraction/shadow-comparisons operation on shadow-comparison resource */ body: { data: { attributes?: { compared_at?: unknown; document_id: string; /** * Error information if either extractor failed */ error_details?: { [key: string]: unknown; } | null; file_size: number; filename: string; mime_type: string; page_count?: number | null; primary_confidence?: number | null; primary_duration_ms?: number | null; primary_extractor?: string | null; primary_text_length?: number | null; shadow_confidence?: number | null; shadow_duration_ms?: number | null; shadow_extractor: string; shadow_text_length?: number | null; status: "success" | "primary_failed" | "shadow_failed" | "both_failed"; /** * Difference in extracted text length (shadow - primary) */ text_length_diff?: number | null; /** * Similarity score between primary and shadow text (0.0-1.0) */ text_similarity?: number | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "shadow-comparison"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/shadow-comparisons"; }; export type PostAdminExtractionShadowComparisonsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminExtractionShadowComparisonsError = PostAdminExtractionShadowComparisonsErrors[keyof PostAdminExtractionShadowComparisonsErrors]; export type PostAdminExtractionShadowComparisonsResponses = { /** * Success */ 201: { data?: ShadowComparison; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminExtractionShadowComparisonsResponse = PostAdminExtractionShadowComparisonsResponses[keyof PostAdminExtractionShadowComparisonsResponses]; export type GetAdminBreachNotificationsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/breach-notifications"; }; export type GetAdminBreachNotificationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminBreachNotificationsError = GetAdminBreachNotificationsErrors[keyof GetAdminBreachNotificationsErrors]; export type GetAdminBreachNotificationsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a breach-notification */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminBreachNotificationsResponse = GetAdminBreachNotificationsResponses[keyof GetAdminBreachNotificationsResponses]; export type GetAdminWalletForecastData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; days_back?: number; }; url: "/admin/wallet/forecast"; }; export type GetAdminWalletForecastErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWalletForecastError = GetAdminWalletForecastErrors[keyof GetAdminWalletForecastErrors]; export type GetAdminWalletForecastResponses = { /** * Success */ 200: { data?: WalletPublic; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWalletForecastResponse = GetAdminWalletForecastResponses[keyof GetAdminWalletForecastResponses]; export type GetAdminWalletInvoicesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/wallet/invoices"; }; export type GetAdminWalletInvoicesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWalletInvoicesError = GetAdminWalletInvoicesErrors[keyof GetAdminWalletInvoicesErrors]; export type GetAdminWalletInvoicesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a invoice */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWalletInvoicesResponse = GetAdminWalletInvoicesResponses[keyof GetAdminWalletInvoicesResponses]; export type PostAdminClinicalSupplementTemplateCollectionMembershipsData = { /** * Request body for the /clinical/supplement-template-collection-memberships operation on clinical-supplement-template-collection-membership resource */ body: { data: { attributes?: { collection_id: string; sort_order?: number | null; template_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-supplement-template-collection-membership"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-template-collection-memberships"; }; export type PostAdminClinicalSupplementTemplateCollectionMembershipsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalSupplementTemplateCollectionMembershipsError = PostAdminClinicalSupplementTemplateCollectionMembershipsErrors[keyof PostAdminClinicalSupplementTemplateCollectionMembershipsErrors]; export type PostAdminClinicalSupplementTemplateCollectionMembershipsResponses = { /** * Success */ 201: { data?: ClinicalSupplementTemplateCollectionMembership; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalSupplementTemplateCollectionMembershipsResponse = PostAdminClinicalSupplementTemplateCollectionMembershipsResponses[keyof PostAdminClinicalSupplementTemplateCollectionMembershipsResponses]; export type PatchAdminCasesByIdCloseData = { /** * Request body for the /cases/:id/close operation on case resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "case"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/cases/{id}/close"; }; export type PatchAdminCasesByIdCloseErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCasesByIdCloseError = PatchAdminCasesByIdCloseErrors[keyof PatchAdminCasesByIdCloseErrors]; export type PatchAdminCasesByIdCloseResponses = { /** * Success */ 200: { data?: Case; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCasesByIdCloseResponse = PatchAdminCasesByIdCloseResponses[keyof PatchAdminCasesByIdCloseResponses]; export type GetAdminPlanFeatureAllocationsByPlanByPlanIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { plan_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/plan-feature-allocations/by-plan/{plan_id}"; }; export type GetAdminPlanFeatureAllocationsByPlanByPlanIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPlanFeatureAllocationsByPlanByPlanIdError = GetAdminPlanFeatureAllocationsByPlanByPlanIdErrors[keyof GetAdminPlanFeatureAllocationsByPlanByPlanIdErrors]; export type GetAdminPlanFeatureAllocationsByPlanByPlanIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a plan-feature-allocation */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPlanFeatureAllocationsByPlanByPlanIdResponse = GetAdminPlanFeatureAllocationsByPlanByPlanIdResponses[keyof GetAdminPlanFeatureAllocationsByPlanByPlanIdResponses]; export type GetAdminClinicalNoteTemplatesMineData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; created_by_id: string; }; url: "/admin/clinical/note-templates/mine"; }; export type GetAdminClinicalNoteTemplatesMineErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalNoteTemplatesMineError = GetAdminClinicalNoteTemplatesMineErrors[keyof GetAdminClinicalNoteTemplatesMineErrors]; export type GetAdminClinicalNoteTemplatesMineResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-note-template */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalNoteTemplatesMineResponse = GetAdminClinicalNoteTemplatesMineResponses[keyof GetAdminClinicalNoteTemplatesMineResponses]; export type DeleteAdminClinicalSupplementTemplateCollectionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-template-collections/{id}"; }; export type DeleteAdminClinicalSupplementTemplateCollectionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalSupplementTemplateCollectionsByIdError = DeleteAdminClinicalSupplementTemplateCollectionsByIdErrors[keyof DeleteAdminClinicalSupplementTemplateCollectionsByIdErrors]; export type DeleteAdminClinicalSupplementTemplateCollectionsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminClinicalSupplementTemplateCollectionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-template-collections/{id}"; }; export type GetAdminClinicalSupplementTemplateCollectionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalSupplementTemplateCollectionsByIdError = GetAdminClinicalSupplementTemplateCollectionsByIdErrors[keyof GetAdminClinicalSupplementTemplateCollectionsByIdErrors]; export type GetAdminClinicalSupplementTemplateCollectionsByIdResponses = { /** * Success */ 200: { data?: ClinicalSupplementTemplateCollection; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalSupplementTemplateCollectionsByIdResponse = GetAdminClinicalSupplementTemplateCollectionsByIdResponses[keyof GetAdminClinicalSupplementTemplateCollectionsByIdResponses]; export type PatchAdminClinicalSupplementTemplateCollectionsByIdData = { /** * Request body for the /clinical/supplement-template-collections/:id operation on clinical-supplement-template-collection resource */ body?: { data: { attributes?: { description?: string | null; metadata?: { [key: string]: unknown; } | null; name?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-supplement-template-collection"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-template-collections/{id}"; }; export type PatchAdminClinicalSupplementTemplateCollectionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalSupplementTemplateCollectionsByIdError = PatchAdminClinicalSupplementTemplateCollectionsByIdErrors[keyof PatchAdminClinicalSupplementTemplateCollectionsByIdErrors]; export type PatchAdminClinicalSupplementTemplateCollectionsByIdResponses = { /** * Success */ 200: { data?: ClinicalSupplementTemplateCollection; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalSupplementTemplateCollectionsByIdResponse = PatchAdminClinicalSupplementTemplateCollectionsByIdResponses[keyof PatchAdminClinicalSupplementTemplateCollectionsByIdResponses]; export type GetAdminClinicalPracticeResourcesCatalogArchivedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-resources/catalog/archived"; }; export type GetAdminClinicalPracticeResourcesCatalogArchivedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPracticeResourcesCatalogArchivedError = GetAdminClinicalPracticeResourcesCatalogArchivedErrors[keyof GetAdminClinicalPracticeResourcesCatalogArchivedErrors]; export type GetAdminClinicalPracticeResourcesCatalogArchivedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-practice-resource */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPracticeResourcesCatalogArchivedResponse = GetAdminClinicalPracticeResourcesCatalogArchivedResponses[keyof GetAdminClinicalPracticeResourcesCatalogArchivedResponses]; export type GetAdminAgentExecutionsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/agent-executions"; }; export type GetAdminAgentExecutionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentExecutionsError = GetAdminAgentExecutionsErrors[keyof GetAdminAgentExecutionsErrors]; export type GetAdminAgentExecutionsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a agent-execution */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAgentExecutionsResponse = GetAdminAgentExecutionsResponses[keyof GetAdminAgentExecutionsResponses]; export type PatchAdminVoiceSessionsByIdFinalizeData = { /** * Request body for the /voice/sessions/:id/finalize operation on voice-session resource */ body?: { data: { attributes?: { blueprint_id?: string | null; patient_id?: string | null; pii_key?: string | null; pii_mode?: "none" | "tokenize" | "tokenize_encrypt"; }; id: string; relationships?: { [key: string]: never; }; type?: "voice-session"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/voice/sessions/{id}/finalize"; }; export type PatchAdminVoiceSessionsByIdFinalizeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminVoiceSessionsByIdFinalizeError = PatchAdminVoiceSessionsByIdFinalizeErrors[keyof PatchAdminVoiceSessionsByIdFinalizeErrors]; export type PatchAdminVoiceSessionsByIdFinalizeResponses = { /** * Success */ 200: { data?: VoiceSession; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminVoiceSessionsByIdFinalizeResponse = PatchAdminVoiceSessionsByIdFinalizeResponses[keyof PatchAdminVoiceSessionsByIdFinalizeResponses]; export type GetAdminMessagesSearchData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; query: string; thread_id?: string; }; url: "/admin/messages/search"; }; export type GetAdminMessagesSearchErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminMessagesSearchError = GetAdminMessagesSearchErrors[keyof GetAdminMessagesSearchErrors]; export type GetAdminMessagesSearchResponses = { /** * Success */ 200: { /** * An array of resource objects representing a chat-message */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminMessagesSearchResponse = GetAdminMessagesSearchResponses[keyof GetAdminMessagesSearchResponses]; export type PatchAdminApiKeysByIdResetPeriodData = { /** * Request body for the /api-keys/:id/reset-period operation on api-key resource */ body?: { data: { attributes?: { period_started_at?: unknown; }; id: string; relationships?: { [key: string]: never; }; type?: "api-key"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/api-keys/{id}/reset-period"; }; export type PatchAdminApiKeysByIdResetPeriodErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminApiKeysByIdResetPeriodError = PatchAdminApiKeysByIdResetPeriodErrors[keyof PatchAdminApiKeysByIdResetPeriodErrors]; export type PatchAdminApiKeysByIdResetPeriodResponses = { /** * Success */ 200: { data?: ApiKey; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminApiKeysByIdResetPeriodResponse = PatchAdminApiKeysByIdResetPeriodResponses[keyof PatchAdminApiKeysByIdResetPeriodResponses]; export type GetAdminVoiceTranscriptionResultsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/voice/transcription-results"; }; export type GetAdminVoiceTranscriptionResultsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminVoiceTranscriptionResultsError = GetAdminVoiceTranscriptionResultsErrors[keyof GetAdminVoiceTranscriptionResultsErrors]; export type GetAdminVoiceTranscriptionResultsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a voice-transcription-result */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminVoiceTranscriptionResultsResponse = GetAdminVoiceTranscriptionResultsResponses[keyof GetAdminVoiceTranscriptionResultsResponses]; export type PostAdminVoiceTranscriptionResultsData = { /** * Request body for the /voice/transcription-results operation on voice-transcription-result resource */ body: { data: { attributes?: { /** * Extraction document if from audio file upload */ document_id?: string | null; duration_seconds?: number | null; language_detected?: string | null; metadata?: { [key: string]: unknown; } | null; processing_seconds?: number | null; recording_id?: string | null; /** * Timestamped segments with confidence */ segments?: Array<{ [key: string]: unknown; }> | null; session_id?: string | null; /** * candle or whisper-rs */ stt_engine?: string | null; /** * large-v3, medium, base */ stt_model?: string | null; /** * Full transcript text */ text: string; workspace_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "voice-transcription-result"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/voice/transcription-results"; }; export type PostAdminVoiceTranscriptionResultsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminVoiceTranscriptionResultsError = PostAdminVoiceTranscriptionResultsErrors[keyof PostAdminVoiceTranscriptionResultsErrors]; export type PostAdminVoiceTranscriptionResultsResponses = { /** * Success */ 201: { data?: VoiceTranscriptionResult; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminVoiceTranscriptionResultsResponse = PostAdminVoiceTranscriptionResultsResponses[keyof PostAdminVoiceTranscriptionResultsResponses]; export type PatchAdminStorageFilesByIdArchiveData = { /** * Request body for the /storage-files/:id/archive operation on storage-file resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "storage-file"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/storage-files/{id}/archive"; }; export type PatchAdminStorageFilesByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminStorageFilesByIdArchiveError = PatchAdminStorageFilesByIdArchiveErrors[keyof PatchAdminStorageFilesByIdArchiveErrors]; export type PatchAdminStorageFilesByIdArchiveResponses = { /** * Success */ 200: { data?: StorageFile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminStorageFilesByIdArchiveResponse = PatchAdminStorageFilesByIdArchiveResponses[keyof PatchAdminStorageFilesByIdArchiveResponses]; export type GetAdminStorageFilesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/storage-files/{id}"; }; export type GetAdminStorageFilesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminStorageFilesByIdError = GetAdminStorageFilesByIdErrors[keyof GetAdminStorageFilesByIdErrors]; export type GetAdminStorageFilesByIdResponses = { /** * Success */ 200: { data?: StorageFile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminStorageFilesByIdResponse = GetAdminStorageFilesByIdResponses[keyof GetAdminStorageFilesByIdResponses]; export type PatchAdminStorageFilesByIdData = { /** * Request body for the /storage-files/:id operation on storage-file resource */ body?: { data: { attributes?: { filename?: string | null; metadata?: { [key: string]: unknown; } | null; namespace?: string | null; s3_key?: string | null; status?: "active" | "archived" | "pending_deletion" | "quarantined" | "pending_upload"; tags?: Array | null; visibility?: "private" | "workspace" | "tenant" | "public"; }; id: string; relationships?: { [key: string]: never; }; type?: "storage-file"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/storage-files/{id}"; }; export type PatchAdminStorageFilesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminStorageFilesByIdError = PatchAdminStorageFilesByIdErrors[keyof PatchAdminStorageFilesByIdErrors]; export type PatchAdminStorageFilesByIdResponses = { /** * Success */ 200: { data?: StorageFile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminStorageFilesByIdResponse = PatchAdminStorageFilesByIdResponses[keyof PatchAdminStorageFilesByIdResponses]; export type PostAdminExtractionDocumentsFindOrBeginUploadData = { /** * Request body for the /extraction/documents/find-or-begin-upload operation on extraction-document resource */ body: { data: { attributes?: { batch_id?: string | null; content_type?: string | null; file_hash?: string | null; file_size_bytes?: number | null; file_type: string; filename: string; force?: boolean | null; parent_document_id?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "extraction-document"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/documents/find-or-begin-upload"; }; export type PostAdminExtractionDocumentsFindOrBeginUploadErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminExtractionDocumentsFindOrBeginUploadError = PostAdminExtractionDocumentsFindOrBeginUploadErrors[keyof PostAdminExtractionDocumentsFindOrBeginUploadErrors]; export type PostAdminExtractionDocumentsFindOrBeginUploadResponses = { /** * Success */ 201: { data?: ExtractionDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminExtractionDocumentsFindOrBeginUploadResponse = PostAdminExtractionDocumentsFindOrBeginUploadResponses[keyof PostAdminExtractionDocumentsFindOrBeginUploadResponses]; export type PatchAdminClinicalClientGoalsByIdRejectData = { /** * Request body for the /clinical/client-goals/:id/reject operation on clinical-client-goal resource */ body: { data: { attributes?: { reviewed_by_id: string; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-client-goal"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-goals/{id}/reject"; }; export type PatchAdminClinicalClientGoalsByIdRejectErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalClientGoalsByIdRejectError = PatchAdminClinicalClientGoalsByIdRejectErrors[keyof PatchAdminClinicalClientGoalsByIdRejectErrors]; export type PatchAdminClinicalClientGoalsByIdRejectResponses = { /** * Success */ 200: { data?: ClinicalClientGoal; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalClientGoalsByIdRejectResponse = PatchAdminClinicalClientGoalsByIdRejectResponses[keyof PatchAdminClinicalClientGoalsByIdRejectResponses]; export type DeleteAdminWorkspacePreferencesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspace-preferences/{id}"; }; export type DeleteAdminWorkspacePreferencesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminWorkspacePreferencesByIdError = DeleteAdminWorkspacePreferencesByIdErrors[keyof DeleteAdminWorkspacePreferencesByIdErrors]; export type DeleteAdminWorkspacePreferencesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminLlmAnalyticsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/llm-analytics/{id}"; }; export type GetAdminLlmAnalyticsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminLlmAnalyticsByIdError = GetAdminLlmAnalyticsByIdErrors[keyof GetAdminLlmAnalyticsByIdErrors]; export type GetAdminLlmAnalyticsByIdResponses = { /** * Success */ 200: { data?: LlmAnalytics; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminLlmAnalyticsByIdResponse = GetAdminLlmAnalyticsByIdResponses[keyof GetAdminLlmAnalyticsByIdResponses]; export type GetAdminClinicalGoalTemplatesCatalogByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-templates/catalog/{id}"; }; export type GetAdminClinicalGoalTemplatesCatalogByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalGoalTemplatesCatalogByIdError = GetAdminClinicalGoalTemplatesCatalogByIdErrors[keyof GetAdminClinicalGoalTemplatesCatalogByIdErrors]; export type GetAdminClinicalGoalTemplatesCatalogByIdResponses = { /** * Success */ 200: { data?: ClinicalGoalTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalGoalTemplatesCatalogByIdResponse = GetAdminClinicalGoalTemplatesCatalogByIdResponses[keyof GetAdminClinicalGoalTemplatesCatalogByIdResponses]; export type PatchAdminClinicalGoalTemplatesCatalogByIdData = { /** * Request body for the /clinical/goal-templates/catalog/:id operation on clinical-goal-template resource */ body?: { data: { attributes?: { action_steps?: Array | null; age_groups?: Array | null; applicable_conditions?: Array | null; category?: string | null; description?: string | null; difficulty?: "beginner" | "intermediate" | "advanced"; evidence_base?: string | null; frequency?: "daily" | "weekly"; goal_type?: string | null; instructions?: string | null; is_active?: boolean | null; linked_metric_type?: string | null; metadata?: { [key: string]: unknown; } | null; priority?: "high" | "medium" | "low"; source_reference?: string | null; suggested_duration_days?: number | null; tags?: Array | null; target_value?: string | number | unknown; timeframe?: string | null; title?: string | null; tool_ids?: Array | null; unit?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-goal-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-templates/catalog/{id}"; }; export type PatchAdminClinicalGoalTemplatesCatalogByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalGoalTemplatesCatalogByIdError = PatchAdminClinicalGoalTemplatesCatalogByIdErrors[keyof PatchAdminClinicalGoalTemplatesCatalogByIdErrors]; export type PatchAdminClinicalGoalTemplatesCatalogByIdResponses = { /** * Success */ 200: { data?: ClinicalGoalTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalGoalTemplatesCatalogByIdResponse = PatchAdminClinicalGoalTemplatesCatalogByIdResponses[keyof PatchAdminClinicalGoalTemplatesCatalogByIdResponses]; export type GetAdminSocialPostsCampaignBySocialCampaignIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { social_campaign_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/posts/campaign/{social_campaign_id}"; }; export type GetAdminSocialPostsCampaignBySocialCampaignIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialPostsCampaignBySocialCampaignIdError = GetAdminSocialPostsCampaignBySocialCampaignIdErrors[keyof GetAdminSocialPostsCampaignBySocialCampaignIdErrors]; export type GetAdminSocialPostsCampaignBySocialCampaignIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a social-post */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialPostsCampaignBySocialCampaignIdResponse = GetAdminSocialPostsCampaignBySocialCampaignIdResponses[keyof GetAdminSocialPostsCampaignBySocialCampaignIdResponses]; export type PostAdminAgentVersionsByIdRemoveSystemFieldData = { /** * Request body for the /agent-versions/:id/remove-system-field operation on agent-version resource */ body: { data: { system_field_name: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/agent-versions/{id}/remove-system-field"; }; export type PostAdminAgentVersionsByIdRemoveSystemFieldErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAgentVersionsByIdRemoveSystemFieldError = PostAdminAgentVersionsByIdRemoveSystemFieldErrors[keyof PostAdminAgentVersionsByIdRemoveSystemFieldErrors]; export type PostAdminAgentVersionsByIdRemoveSystemFieldResponses = { /** * Success */ 201: unknown; }; export type GetAdminCatalogOptionValuesOptionTypeByOptionTypeIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { option_type_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/option-values/option-type/{option_type_id}"; }; export type GetAdminCatalogOptionValuesOptionTypeByOptionTypeIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogOptionValuesOptionTypeByOptionTypeIdError = GetAdminCatalogOptionValuesOptionTypeByOptionTypeIdErrors[keyof GetAdminCatalogOptionValuesOptionTypeByOptionTypeIdErrors]; export type GetAdminCatalogOptionValuesOptionTypeByOptionTypeIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a catalog-option-value */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogOptionValuesOptionTypeByOptionTypeIdResponse = GetAdminCatalogOptionValuesOptionTypeByOptionTypeIdResponses[keyof GetAdminCatalogOptionValuesOptionTypeByOptionTypeIdResponses]; export type PostAdminCrmFieldDefinitionsData = { /** * Request body for the /crm/field-definitions operation on crm-custom-field-definition resource */ body: { data: { attributes?: { application_id: string; default_value?: string | null; entity_type: string; field_type: string; filterable?: boolean | null; label: string; name: string; options?: Array | null; required?: boolean | null; searchable?: boolean | null; sort_order?: number | null; validation_rules?: { [key: string]: unknown; } | null; }; relationships?: { [key: string]: never; }; type?: "crm-custom-field-definition"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/field-definitions"; }; export type PostAdminCrmFieldDefinitionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrmFieldDefinitionsError = PostAdminCrmFieldDefinitionsErrors[keyof PostAdminCrmFieldDefinitionsErrors]; export type PostAdminCrmFieldDefinitionsResponses = { /** * Success */ 201: { data?: CrmCustomFieldDefinition; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrmFieldDefinitionsResponse = PostAdminCrmFieldDefinitionsResponses[keyof PostAdminCrmFieldDefinitionsResponses]; export type GetAdminApiKeysStatsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; tenant_id: string; key_type?: "user" | "application" | "system" | "server"; }; url: "/admin/api-keys/stats"; }; export type GetAdminApiKeysStatsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminApiKeysStatsError = GetAdminApiKeysStatsErrors[keyof GetAdminApiKeysStatsErrors]; export type GetAdminApiKeysStatsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a api-key */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminApiKeysStatsResponse = GetAdminApiKeysStatsResponses[keyof GetAdminApiKeysStatsResponses]; export type GetAdminSchedulingEventTypesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/scheduling/event-types"; }; export type GetAdminSchedulingEventTypesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingEventTypesError = GetAdminSchedulingEventTypesErrors[keyof GetAdminSchedulingEventTypesErrors]; export type GetAdminSchedulingEventTypesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a scheduling-event-type */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingEventTypesResponse = GetAdminSchedulingEventTypesResponses[keyof GetAdminSchedulingEventTypesResponses]; export type PostAdminSchedulingEventTypesData = { /** * Request body for the /scheduling/event-types operation on scheduling-event-type resource */ body: { data: { attributes?: { billing_operation?: string | null; booking_cooldown_minutes?: number | null; booking_enabled?: boolean | null; buffer_after_minutes?: number | null; buffer_before_minutes?: number | null; capacity?: number | null; color?: string | null; default_reminder_offsets?: Array | null; description?: string | null; duration_minutes: number; intake_form_schema?: { [key: string]: unknown; } | null; location?: SchedulingEventTypeLocationInputCreateType; location_id?: string | null; location_type?: "in_person" | "video" | "phone" | "custom_url"; max_advance_days?: number | null; metadata?: { [key: string]: unknown; } | null; min_notice_minutes?: number | null; name: string; owner_user_id?: string | null; requires_approval?: boolean | null; slug: string; status?: "active" | "archived"; workspace_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "scheduling-event-type"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/event-types"; }; export type PostAdminSchedulingEventTypesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSchedulingEventTypesError = PostAdminSchedulingEventTypesErrors[keyof PostAdminSchedulingEventTypesErrors]; export type PostAdminSchedulingEventTypesResponses = { /** * Success */ 201: { data?: SchedulingEventType; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSchedulingEventTypesResponse = PostAdminSchedulingEventTypesResponses[keyof PostAdminSchedulingEventTypesResponses]; export type GetAdminClinicalSupplementTemplatesArchivedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/supplement-templates/archived"; }; export type GetAdminClinicalSupplementTemplatesArchivedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalSupplementTemplatesArchivedError = GetAdminClinicalSupplementTemplatesArchivedErrors[keyof GetAdminClinicalSupplementTemplatesArchivedErrors]; export type GetAdminClinicalSupplementTemplatesArchivedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-supplement-template */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalSupplementTemplatesArchivedResponse = GetAdminClinicalSupplementTemplatesArchivedResponses[keyof GetAdminClinicalSupplementTemplatesArchivedResponses]; export type PostAdminSupportRoutingRulesData = { /** * Request body for the /support/routing-rules operation on support-routing-rule resource */ body: { data: { attributes?: { action?: "assign_queue" | "assign_queue_and_priority" | "assign_queue_and_tag"; /** * Parameters for the action (e.g., priority_override, tag). Separate from conditions. */ action_params?: { [key: string]: unknown; } | null; application_id: string; conditions?: { [key: string]: unknown; } | null; priority?: number | null; queue_id: string; }; relationships?: { [key: string]: never; }; type?: "support-routing-rule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/routing-rules"; }; export type PostAdminSupportRoutingRulesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSupportRoutingRulesError = PostAdminSupportRoutingRulesErrors[keyof PostAdminSupportRoutingRulesErrors]; export type PostAdminSupportRoutingRulesResponses = { /** * Success */ 201: { data?: SupportRoutingRule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSupportRoutingRulesResponse = PostAdminSupportRoutingRulesResponses[keyof PostAdminSupportRoutingRulesResponses]; export type PostAdminEmailOutboundEmailsComposeWithAiData = { /** * Request body for the /email/outbound-emails/compose-with-ai operation on email-outbound-email resource */ body: { data: { attributes?: { contact_ref_id?: string | null; context?: { [key: string]: unknown; } | null; context_ref_id?: string | null; context_ref_type?: string | null; include_unsubscribe_link?: boolean | null; prompt: string; sender_profile_id?: string | null; to: Array; }; relationships?: { [key: string]: never; }; type?: "email-outbound-email"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/outbound-emails/compose-with-ai"; }; export type PostAdminEmailOutboundEmailsComposeWithAiErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminEmailOutboundEmailsComposeWithAiError = PostAdminEmailOutboundEmailsComposeWithAiErrors[keyof PostAdminEmailOutboundEmailsComposeWithAiErrors]; export type PostAdminEmailOutboundEmailsComposeWithAiResponses = { /** * Success */ 201: { data?: EmailOutboundEmail; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminEmailOutboundEmailsComposeWithAiResponse = PostAdminEmailOutboundEmailsComposeWithAiResponses[keyof PostAdminEmailOutboundEmailsComposeWithAiResponses]; export type GetAdminBrandIdentitiesByWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/brand-identities/by-workspace/{workspace_id}"; }; export type GetAdminBrandIdentitiesByWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminBrandIdentitiesByWorkspaceByWorkspaceIdError = GetAdminBrandIdentitiesByWorkspaceByWorkspaceIdErrors[keyof GetAdminBrandIdentitiesByWorkspaceByWorkspaceIdErrors]; export type GetAdminBrandIdentitiesByWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a brand-identity */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminBrandIdentitiesByWorkspaceByWorkspaceIdResponse = GetAdminBrandIdentitiesByWorkspaceByWorkspaceIdResponses[keyof GetAdminBrandIdentitiesByWorkspaceByWorkspaceIdResponses]; export type PatchAdminClinicalSupplementTemplatesCatalogByIdRestoreData = { /** * Request body for the /clinical/supplement-templates/catalog/:id/restore operation on clinical-supplement-template resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-supplement-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-templates/catalog/{id}/restore"; }; export type PatchAdminClinicalSupplementTemplatesCatalogByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalSupplementTemplatesCatalogByIdRestoreError = PatchAdminClinicalSupplementTemplatesCatalogByIdRestoreErrors[keyof PatchAdminClinicalSupplementTemplatesCatalogByIdRestoreErrors]; export type PatchAdminClinicalSupplementTemplatesCatalogByIdRestoreResponses = { /** * Success */ 200: { data?: ClinicalSupplementTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalSupplementTemplatesCatalogByIdRestoreResponse = PatchAdminClinicalSupplementTemplatesCatalogByIdRestoreResponses[keyof PatchAdminClinicalSupplementTemplatesCatalogByIdRestoreResponses]; export type GetAdminSocialPostsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/posts/workspace/{workspace_id}"; }; export type GetAdminSocialPostsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialPostsWorkspaceByWorkspaceIdError = GetAdminSocialPostsWorkspaceByWorkspaceIdErrors[keyof GetAdminSocialPostsWorkspaceByWorkspaceIdErrors]; export type GetAdminSocialPostsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a social-post */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialPostsWorkspaceByWorkspaceIdResponse = GetAdminSocialPostsWorkspaceByWorkspaceIdResponses[keyof GetAdminSocialPostsWorkspaceByWorkspaceIdResponses]; export type GetAdminClaimedDomainsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/claimed-domains"; }; export type GetAdminClaimedDomainsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClaimedDomainsError = GetAdminClaimedDomainsErrors[keyof GetAdminClaimedDomainsErrors]; export type GetAdminClaimedDomainsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a claimed-domain */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClaimedDomainsResponse = GetAdminClaimedDomainsResponses[keyof GetAdminClaimedDomainsResponses]; export type PostAdminClaimedDomainsData = { /** * Request body for the /claimed-domains operation on claimed-domain resource */ body: { data: { attributes?: { /** * Workspace IDs to auto-add users to on domain join */ auto_join_workspace_ids?: Array | null; /** * Role assigned to auto-joined users */ default_role?: "admin" | "member"; /** * Role assigned in auto-joined workspaces */ default_workspace_role?: "admin" | "editor" | "viewer"; /** * The claimed domain (e.g., acme.com) */ domain: string; tenant_id: string; verification_method?: "dns_txt" | "dns_cname" | "meta_tag" | "manual"; }; relationships?: { [key: string]: never; }; type?: "claimed-domain"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/claimed-domains"; }; export type PostAdminClaimedDomainsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClaimedDomainsError = PostAdminClaimedDomainsErrors[keyof PostAdminClaimedDomainsErrors]; export type PostAdminClaimedDomainsResponses = { /** * Success */ 201: { data?: ClaimedDomain; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClaimedDomainsResponse = PostAdminClaimedDomainsResponses[keyof PostAdminClaimedDomainsResponses]; export type GetAdminVoiceSessionsMineData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/voice/sessions/mine"; }; export type GetAdminVoiceSessionsMineErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminVoiceSessionsMineError = GetAdminVoiceSessionsMineErrors[keyof GetAdminVoiceSessionsMineErrors]; export type GetAdminVoiceSessionsMineResponses = { /** * Success */ 200: { /** * An array of resource objects representing a voice-session */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminVoiceSessionsMineResponse = GetAdminVoiceSessionsMineResponses[keyof GetAdminVoiceSessionsMineResponses]; export type GetAdminBreachIncidentsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/breach-incidents"; }; export type GetAdminBreachIncidentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminBreachIncidentsError = GetAdminBreachIncidentsErrors[keyof GetAdminBreachIncidentsErrors]; export type GetAdminBreachIncidentsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a breach-incident */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminBreachIncidentsResponse = GetAdminBreachIncidentsResponses[keyof GetAdminBreachIncidentsResponses]; export type PostAdminBreachIncidentsData = { /** * Request body for the /breach-incidents operation on breach-incident resource */ body: { data: { attributes?: { /** * Number of affected data subjects */ affected_count?: number | null; description: string; discovery_date: unknown; incident_type: "data_breach" | "unauthorized_access" | "data_loss" | "system_compromise" | "insider_threat"; status?: "identified" | "investigating" | "notifying" | "resolved" | "false_positive"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "breach-incident"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/breach-incidents"; }; export type PostAdminBreachIncidentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminBreachIncidentsError = PostAdminBreachIncidentsErrors[keyof PostAdminBreachIncidentsErrors]; export type PostAdminBreachIncidentsResponses = { /** * Success */ 201: { data?: BreachIncident; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminBreachIncidentsResponse = PostAdminBreachIncidentsResponses[keyof PostAdminBreachIncidentsResponses]; export type GetAdminSchedulingRemindersByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/reminders/{id}"; }; export type GetAdminSchedulingRemindersByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingRemindersByIdError = GetAdminSchedulingRemindersByIdErrors[keyof GetAdminSchedulingRemindersByIdErrors]; export type GetAdminSchedulingRemindersByIdResponses = { /** * Success */ 200: { data?: SchedulingReminder; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingRemindersByIdResponse = GetAdminSchedulingRemindersByIdResponses[keyof GetAdminSchedulingRemindersByIdResponses]; export type GetAdminCasesAttentionSummaryData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/cases/attention-summary"; }; export type GetAdminCasesAttentionSummaryErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCasesAttentionSummaryError = GetAdminCasesAttentionSummaryErrors[keyof GetAdminCasesAttentionSummaryErrors]; export type GetAdminCasesAttentionSummaryResponses = { /** * Success */ 200: { [key: string]: unknown; }; }; export type GetAdminCasesAttentionSummaryResponse = GetAdminCasesAttentionSummaryResponses[keyof GetAdminCasesAttentionSummaryResponses]; export type PatchAdminConfigsByKeyData = { /** * Request body for the /configs/:key operation on config resource */ body?: { data: { attributes?: { description?: string | null; id?: string | null; /** * Marks this config as containing sensitive data (API keys, secrets, etc.) */ is_sensitive?: boolean | null; value?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { key: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/configs/{key}"; }; export type PatchAdminConfigsByKeyErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminConfigsByKeyError = PatchAdminConfigsByKeyErrors[keyof PatchAdminConfigsByKeyErrors]; export type PatchAdminConfigsByKeyResponses = { /** * Success */ 200: { data?: Config; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminConfigsByKeyResponse = PatchAdminConfigsByKeyResponses[keyof PatchAdminConfigsByKeyResponses]; export type GetAdminSchedulingBookingsByBookerData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; booker_email: string; }; url: "/admin/scheduling/bookings/by-booker"; }; export type GetAdminSchedulingBookingsByBookerErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingBookingsByBookerError = GetAdminSchedulingBookingsByBookerErrors[keyof GetAdminSchedulingBookingsByBookerErrors]; export type GetAdminSchedulingBookingsByBookerResponses = { /** * Success */ 200: { /** * An array of resource objects representing a scheduling-booking */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingBookingsByBookerResponse = GetAdminSchedulingBookingsByBookerResponses[keyof GetAdminSchedulingBookingsByBookerResponses]; export type DeleteAdminClinicalPatientsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/patients/{id}"; }; export type DeleteAdminClinicalPatientsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalPatientsByIdError = DeleteAdminClinicalPatientsByIdErrors[keyof DeleteAdminClinicalPatientsByIdErrors]; export type DeleteAdminClinicalPatientsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminClinicalPatientsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/patients/{id}"; }; export type GetAdminClinicalPatientsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPatientsByIdError = GetAdminClinicalPatientsByIdErrors[keyof GetAdminClinicalPatientsByIdErrors]; export type GetAdminClinicalPatientsByIdResponses = { /** * Success */ 200: { data?: ClinicalPatient; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPatientsByIdResponse = GetAdminClinicalPatientsByIdResponses[keyof GetAdminClinicalPatientsByIdResponses]; export type PatchAdminClinicalPatientsByIdData = { /** * Request body for the /clinical/patients/:id operation on clinical-patient resource */ body?: { data: { attributes?: { sex?: string | null; carbs_pct?: string | null; weight_lbs?: string | null; timezone?: string | null; goal_weight_lbs?: string | null; protein_unit?: string | null; profile_data?: { [key: string]: unknown; } | null; enrollment_type?: "initial_consultation" | "transfer" | "group_enrollment" | "readmission"; meals_per_day?: number | null; protein_per_weight?: string | null; referring_physician_name?: string | null; assigned_user_id?: string | null; food_allergies?: Array | null; chief_concern?: string | null; status?: "active" | "inactive" | "archived" | "discharged"; primary_insurance?: string | null; diagnosis_codes?: Array | null; referring_physician_phone?: string | null; external_ids?: { [key: string]: unknown; } | null; contact_id?: string | null; food_aversions?: Array | null; activity_level?: string | null; referring_physician_fax?: string | null; tags?: Array | null; snacks_per_day?: number | null; protein_pct?: string | null; date_of_birth?: string | null; eating_style?: Array | null; state?: string | null; conditions?: Array | null; target_calories_override?: number | null; height_inches?: string | null; followup_interval_value?: number | null; referral_source?: "self" | "physician" | "insurance" | "employer_wellness" | "other"; metadata?: { [key: string]: unknown; } | null; surgical_history?: string | null; followup_interval_unit?: string | null; fat_pct?: string | null; preferred_name?: string | null; food_preferences?: Array | null; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-patient"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/patients/{id}"; }; export type PatchAdminClinicalPatientsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalPatientsByIdError = PatchAdminClinicalPatientsByIdErrors[keyof PatchAdminClinicalPatientsByIdErrors]; export type PatchAdminClinicalPatientsByIdResponses = { /** * Success */ 200: { data?: ClinicalPatient; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalPatientsByIdResponse = PatchAdminClinicalPatientsByIdResponses[keyof PatchAdminClinicalPatientsByIdResponses]; export type GetAdminIsvRevenueData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/isv-revenue"; }; export type GetAdminIsvRevenueErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminIsvRevenueError = GetAdminIsvRevenueErrors[keyof GetAdminIsvRevenueErrors]; export type GetAdminIsvRevenueResponses = { /** * Success */ 200: { /** * An array of resource objects representing a isv-revenue */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminIsvRevenueResponse = GetAdminIsvRevenueResponses[keyof GetAdminIsvRevenueResponses]; export type PostAdminIsvRevenueData = { /** * Request body for the /isv-revenue operation on isv-revenue resource */ body: { data: { attributes?: { /** * Total amount in USD */ amount: { amount: string; currency: string; }; application_id?: string | null; description: string; isv_id: string; /** * Additional context (e.g., operation details, tenant info) */ metadata?: { [key: string]: unknown; } | null; /** * Hard cost from provider (for usage_cost type) */ pass_through_cost?: { amount: string; currency: string; } | unknown; /** * Platform's 20% markup on pass_through_cost */ platform_markup?: { amount: string; currency: string; } | unknown; /** * QorPay/ACH transaction ID for settlements */ qorpay_transaction_id?: string | null; subscription_id?: string | null; tenant_id?: string | null; type: "subscription_revenue" | "package_revenue" | "usage_cost" | "storage_cost" | "payment_processing_cost" | "platform_fee" | "settlement" | "reinvestment"; }; relationships?: { [key: string]: never; }; type?: "isv-revenue"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/isv-revenue"; }; export type PostAdminIsvRevenueErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminIsvRevenueError = PostAdminIsvRevenueErrors[keyof PostAdminIsvRevenueErrors]; export type PostAdminIsvRevenueResponses = { /** * Success */ 201: { data?: IsvRevenue; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminIsvRevenueResponse = PostAdminIsvRevenueResponses[keyof PostAdminIsvRevenueResponses]; export type GetAdminPlanFeatureAllocationsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/plan-feature-allocations"; }; export type GetAdminPlanFeatureAllocationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPlanFeatureAllocationsError = GetAdminPlanFeatureAllocationsErrors[keyof GetAdminPlanFeatureAllocationsErrors]; export type GetAdminPlanFeatureAllocationsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a plan-feature-allocation */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPlanFeatureAllocationsResponse = GetAdminPlanFeatureAllocationsResponses[keyof GetAdminPlanFeatureAllocationsResponses]; export type PostAdminPlanFeatureAllocationsData = { /** * Request body for the /plan-feature-allocations operation on plan-feature-allocation resource */ body: { data: { attributes?: { /** * One-time credit charge to unlock this feature. nil = free activation. */ activation_cost?: number | null; /** * Override the feature's credit_cost for this plan. nil = use feature default. */ credit_cost?: number | null; /** * Whether this feature is available on this plan */ enabled?: boolean | null; feature_definition_id: string; /** * Override the feature's default_limit for this plan. nil = use feature default. */ limit?: number | null; plan_id: string; }; relationships?: { [key: string]: never; }; type?: "plan-feature-allocation"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/plan-feature-allocations"; }; export type PostAdminPlanFeatureAllocationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminPlanFeatureAllocationsError = PostAdminPlanFeatureAllocationsErrors[keyof PostAdminPlanFeatureAllocationsErrors]; export type PostAdminPlanFeatureAllocationsResponses = { /** * Success */ 201: { data?: PlanFeatureAllocation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminPlanFeatureAllocationsResponse = PostAdminPlanFeatureAllocationsResponses[keyof PostAdminPlanFeatureAllocationsResponses]; export type DeleteAdminInvoicesTemplatesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/templates/{id}"; }; export type DeleteAdminInvoicesTemplatesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminInvoicesTemplatesByIdError = DeleteAdminInvoicesTemplatesByIdErrors[keyof DeleteAdminInvoicesTemplatesByIdErrors]; export type DeleteAdminInvoicesTemplatesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminInvoicesTemplatesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/templates/{id}"; }; export type GetAdminInvoicesTemplatesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminInvoicesTemplatesByIdError = GetAdminInvoicesTemplatesByIdErrors[keyof GetAdminInvoicesTemplatesByIdErrors]; export type GetAdminInvoicesTemplatesByIdResponses = { /** * Success */ 200: { data?: InvoicesTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminInvoicesTemplatesByIdResponse = GetAdminInvoicesTemplatesByIdResponses[keyof GetAdminInvoicesTemplatesByIdResponses]; export type PatchAdminInvoicesTemplatesByIdData = { /** * Request body for the /invoices/templates/:id operation on invoices-template resource */ body?: { data: { attributes?: { branding?: { [key: string]: unknown; } | null; default_notes?: string | null; default_payment_terms?: string | null; description?: string | null; is_default?: boolean | null; layout?: { [key: string]: unknown; } | null; metadata?: { [key: string]: unknown; } | null; name?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "invoices-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/templates/{id}"; }; export type PatchAdminInvoicesTemplatesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvoicesTemplatesByIdError = PatchAdminInvoicesTemplatesByIdErrors[keyof PatchAdminInvoicesTemplatesByIdErrors]; export type PatchAdminInvoicesTemplatesByIdResponses = { /** * Success */ 200: { data?: InvoicesTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvoicesTemplatesByIdResponse = PatchAdminInvoicesTemplatesByIdResponses[keyof PatchAdminInvoicesTemplatesByIdResponses]; export type PostAdminConnectorsFullscriptProductsGetData = { /** * Request body for the /connectors/fullscript/products/get operation on connector-instance resource */ body: { data: { connector_id: string; product_id: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/connectors/fullscript/products/get"; }; export type PostAdminConnectorsFullscriptProductsGetErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsFullscriptProductsGetError = PostAdminConnectorsFullscriptProductsGetErrors[keyof PostAdminConnectorsFullscriptProductsGetErrors]; export type PostAdminConnectorsFullscriptProductsGetResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminConnectorsFullscriptProductsGetResponse = PostAdminConnectorsFullscriptProductsGetResponses[keyof PostAdminConnectorsFullscriptProductsGetResponses]; export type GetAdminExtractionWorkflowsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction-workflows"; }; export type GetAdminExtractionWorkflowsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionWorkflowsError = GetAdminExtractionWorkflowsErrors[keyof GetAdminExtractionWorkflowsErrors]; export type GetAdminExtractionWorkflowsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a extraction-workflow */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionWorkflowsResponse = GetAdminExtractionWorkflowsResponses[keyof GetAdminExtractionWorkflowsResponses]; export type PostAdminExtractionWorkflowsData = { /** * Request body for the /extraction-workflows operation on extraction-workflow resource */ body: { data: { attributes?: { /** * Optional description of the workflow purpose and behavior */ description?: string | null; enabled?: boolean | null; /** * Human-readable workflow name */ name: string; /** * Ordered list of workflow steps */ steps?: Array | null; /** * When this workflow is triggered */ trigger?: "on_upload" | "on_schedule" | "manual"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "extraction-workflow"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction-workflows"; }; export type PostAdminExtractionWorkflowsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminExtractionWorkflowsError = PostAdminExtractionWorkflowsErrors[keyof PostAdminExtractionWorkflowsErrors]; export type PostAdminExtractionWorkflowsResponses = { /** * Success */ 201: { data?: ExtractionWorkflow; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminExtractionWorkflowsResponse = PostAdminExtractionWorkflowsResponses[keyof PostAdminExtractionWorkflowsResponses]; export type PostAdminAgentsByIdTeachData = { /** * Request body for the /agents/:id/teach operation on agent resource */ body: { data: { attributes?: { confirmed_fields?: Array | null; correction_reasons?: { [key: string]: unknown; } | null; corrections: { [key: string]: unknown; }; document_id: string; training_note?: string | null; /** * Implicitly verify untouched fields */ verify_remaining?: boolean | null; }; relationships?: { [key: string]: never; }; type?: "agent"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { /** * Agent ID (automatically mapped from route) */ id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agents/{id}/teach"; }; export type PostAdminAgentsByIdTeachErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAgentsByIdTeachError = PostAdminAgentsByIdTeachErrors[keyof PostAdminAgentsByIdTeachErrors]; export type PostAdminAgentsByIdTeachResponses = { /** * Success */ 201: { data?: Agent; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAgentsByIdTeachResponse = PostAdminAgentsByIdTeachResponses[keyof PostAdminAgentsByIdTeachResponses]; export type DeleteAdminRecipesCollectionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/collections/{id}"; }; export type DeleteAdminRecipesCollectionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminRecipesCollectionsByIdError = DeleteAdminRecipesCollectionsByIdErrors[keyof DeleteAdminRecipesCollectionsByIdErrors]; export type DeleteAdminRecipesCollectionsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminRecipesCollectionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/collections/{id}"; }; export type GetAdminRecipesCollectionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesCollectionsByIdError = GetAdminRecipesCollectionsByIdErrors[keyof GetAdminRecipesCollectionsByIdErrors]; export type GetAdminRecipesCollectionsByIdResponses = { /** * Success */ 200: { data?: RecipesRecipeCollection; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesCollectionsByIdResponse = GetAdminRecipesCollectionsByIdResponses[keyof GetAdminRecipesCollectionsByIdResponses]; export type PatchAdminRecipesCollectionsByIdData = { /** * Request body for the /recipes/collections/:id operation on recipes-recipe-collection resource */ body?: { data: { attributes?: { description?: string | null; metadata?: { [key: string]: unknown; } | null; name?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "recipes-recipe-collection"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/collections/{id}"; }; export type PatchAdminRecipesCollectionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminRecipesCollectionsByIdError = PatchAdminRecipesCollectionsByIdErrors[keyof PatchAdminRecipesCollectionsByIdErrors]; export type PatchAdminRecipesCollectionsByIdResponses = { /** * Success */ 200: { data?: RecipesRecipeCollection; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminRecipesCollectionsByIdResponse = PatchAdminRecipesCollectionsByIdResponses[keyof PatchAdminRecipesCollectionsByIdResponses]; export type GetAdminExtractionDocumentsByIdStatusData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/documents/{id}/status"; }; export type GetAdminExtractionDocumentsByIdStatusErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionDocumentsByIdStatusError = GetAdminExtractionDocumentsByIdStatusErrors[keyof GetAdminExtractionDocumentsByIdStatusErrors]; export type GetAdminExtractionDocumentsByIdStatusResponses = { /** * Success */ 200: { data?: ExtractionDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionDocumentsByIdStatusResponse = GetAdminExtractionDocumentsByIdStatusResponses[keyof GetAdminExtractionDocumentsByIdStatusResponses]; export type PatchAdminExtractionDocumentsByIdStatusData = { /** * Request body for the /extraction/documents/:id/status operation on extraction-document resource */ body?: { data: { attributes?: { agent_id?: string | null; agent_version_id?: string | null; /** * Average confidence score across all extracted fields (0.0 to 1.0) */ avg_confidence?: number | null; /** * Credits billed for processing this document */ billed_credits?: number | null; /** * Character count of extracted text */ char_count?: number | null; /** * Overall classification confidence (0.0 to 1.0) */ classification_confidence?: number | null; /** * Timestamp when document processing completed (status changed to :completed) */ completed_at?: unknown; /** * Specific document type from specialty agent (Traffic Citation, Invoice, etc.) */ document_type?: string | null; /** * Document domain from specialty agent (legal, financial, medical, etc.) */ domain?: string | null; error_message?: string | null; /** * Image height in pixels (for image documents) */ image_height?: number | null; /** * Image width in pixels (for image documents) */ image_width?: number | null; /** * Line count of extracted text */ line_count?: number | null; /** * Municipality/agency name extracted from document content */ municipality?: string | null; pages?: number | null; processed_at?: unknown; progress?: number | null; /** * Schema revision number used for extraction */ schema_revision?: number | null; /** * State or province code (2-letter) */ state?: string | null; status?: "queued" | "processing" | "partial" | "completed" | "failed" | "cancelled" | "pending_credits"; /** * Metadata about the training session for this document (trained_at, user_id, scores) */ training_metadata?: { [key: string]: unknown; } | null; /** * Word count of extracted text */ word_count?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "extraction-document"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/documents/{id}/status"; }; export type PatchAdminExtractionDocumentsByIdStatusErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminExtractionDocumentsByIdStatusError = PatchAdminExtractionDocumentsByIdStatusErrors[keyof PatchAdminExtractionDocumentsByIdStatusErrors]; export type PatchAdminExtractionDocumentsByIdStatusResponses = { /** * Success */ 200: { data?: ExtractionDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminExtractionDocumentsByIdStatusResponse = PatchAdminExtractionDocumentsByIdStatusResponses[keyof PatchAdminExtractionDocumentsByIdStatusResponses]; export type PatchAdminReviewsByIdCorrectData = { /** * Request body for the /reviews/:id/correct operation on review resource */ body?: { data: { attributes?: { correction_payload?: { [key: string]: unknown; } | null; notes?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "review"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/reviews/{id}/correct"; }; export type PatchAdminReviewsByIdCorrectErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminReviewsByIdCorrectError = PatchAdminReviewsByIdCorrectErrors[keyof PatchAdminReviewsByIdCorrectErrors]; export type PatchAdminReviewsByIdCorrectResponses = { /** * Success */ 200: { data?: Review; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminReviewsByIdCorrectResponse = PatchAdminReviewsByIdCorrectResponses[keyof PatchAdminReviewsByIdCorrectResponses]; export type GetAdminRecipesFoodItemsApplicationByApplicationIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { application_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/food-items/application/{application_id}"; }; export type GetAdminRecipesFoodItemsApplicationByApplicationIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesFoodItemsApplicationByApplicationIdError = GetAdminRecipesFoodItemsApplicationByApplicationIdErrors[keyof GetAdminRecipesFoodItemsApplicationByApplicationIdErrors]; export type GetAdminRecipesFoodItemsApplicationByApplicationIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a recipes-food-item */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesFoodItemsApplicationByApplicationIdResponse = GetAdminRecipesFoodItemsApplicationByApplicationIdResponses[keyof GetAdminRecipesFoodItemsApplicationByApplicationIdResponses]; export type PatchAdminSocialPostsByIdPublishData = { /** * Request body for the /social/posts/:id/publish operation on social-post resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "social-post"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/posts/{id}/publish"; }; export type PatchAdminSocialPostsByIdPublishErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSocialPostsByIdPublishError = PatchAdminSocialPostsByIdPublishErrors[keyof PatchAdminSocialPostsByIdPublishErrors]; export type PatchAdminSocialPostsByIdPublishResponses = { /** * Success */ 200: { data?: SocialPost; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSocialPostsByIdPublishResponse = PatchAdminSocialPostsByIdPublishResponses[keyof PatchAdminSocialPostsByIdPublishResponses]; export type PatchAdminSocialCampaignsByIdCancelData = { /** * Request body for the /social/campaigns/:id/cancel operation on social-campaign resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "social-campaign"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/campaigns/{id}/cancel"; }; export type PatchAdminSocialCampaignsByIdCancelErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSocialCampaignsByIdCancelError = PatchAdminSocialCampaignsByIdCancelErrors[keyof PatchAdminSocialCampaignsByIdCancelErrors]; export type PatchAdminSocialCampaignsByIdCancelResponses = { /** * Success */ 200: { data?: SocialCampaign; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSocialCampaignsByIdCancelResponse = PatchAdminSocialCampaignsByIdCancelResponses[keyof PatchAdminSocialCampaignsByIdCancelResponses]; export type GetAdminSchedulingAvailabilityRulesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/scheduling/availability-rules"; }; export type GetAdminSchedulingAvailabilityRulesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingAvailabilityRulesError = GetAdminSchedulingAvailabilityRulesErrors[keyof GetAdminSchedulingAvailabilityRulesErrors]; export type GetAdminSchedulingAvailabilityRulesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a scheduling-availability-rule */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingAvailabilityRulesResponse = GetAdminSchedulingAvailabilityRulesResponses[keyof GetAdminSchedulingAvailabilityRulesResponses]; export type PostAdminSchedulingAvailabilityRulesData = { /** * Request body for the /scheduling/availability-rules operation on scheduling-availability-rule resource */ body: { data: { attributes?: { date_overrides?: Array | null; effective_from?: string | null; effective_until?: string | null; event_type_id?: string | null; is_active?: boolean | null; location_id?: string | null; metadata?: { [key: string]: unknown; } | null; name: string; priority?: number | null; timezone: string; type: "recurring" | "override"; user_id?: string | null; weekly_schedule?: SchedulingAvailabilityRuleWeeklyScheduleInputCreateType; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "scheduling-availability-rule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/availability-rules"; }; export type PostAdminSchedulingAvailabilityRulesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSchedulingAvailabilityRulesError = PostAdminSchedulingAvailabilityRulesErrors[keyof PostAdminSchedulingAvailabilityRulesErrors]; export type PostAdminSchedulingAvailabilityRulesResponses = { /** * Success */ 201: { data?: SchedulingAvailabilityRule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSchedulingAvailabilityRulesResponse = PostAdminSchedulingAvailabilityRulesResponses[keyof PostAdminSchedulingAvailabilityRulesResponses]; export type PostAdminCrmAddressesData = { /** * Request body for the /crm/addresses operation on crm-address resource */ body: { data: { attributes?: { city?: string | null; country?: string | null; entity_id: string; entity_type: "contact" | "company"; is_primary?: boolean | null; label?: "home" | "work" | "billing" | "shipping" | "headquarters" | "branch" | "other"; latitude?: number | null; line1?: string | null; line2?: string | null; longitude?: number | null; postal_code?: string | null; state?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "crm-address"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/addresses"; }; export type PostAdminCrmAddressesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrmAddressesError = PostAdminCrmAddressesErrors[keyof PostAdminCrmAddressesErrors]; export type PostAdminCrmAddressesResponses = { /** * Success */ 201: { data?: CrmAddress; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrmAddressesResponse = PostAdminCrmAddressesResponses[keyof PostAdminCrmAddressesResponses]; export type GetAdminWholesaleAgreementsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/wholesale-agreements"; }; export type GetAdminWholesaleAgreementsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWholesaleAgreementsError = GetAdminWholesaleAgreementsErrors[keyof GetAdminWholesaleAgreementsErrors]; export type GetAdminWholesaleAgreementsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a wholesale-agreement */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWholesaleAgreementsResponse = GetAdminWholesaleAgreementsResponses[keyof GetAdminWholesaleAgreementsResponses]; export type PostAdminWholesaleAgreementsData = { /** * Request body for the /wholesale-agreements operation on wholesale-agreement resource */ body: { data: { attributes?: { effective_date?: string | null; /** * Days to hold funds before release */ hold_days?: number | null; isv_tenant_id: string; /** * Optional ISV-configurable Layer 1 dunning cadence override. * */ layer1_dunning_config?: { [key: string]: unknown; } | null; /** * Minimum payout amount in cents ($25.00 default) */ minimum_payout_cents?: number | null; /** * Per-service minimum retail floors that ISV must charge their tenants. * Format: [%{"service_id" => "doc_extraction_base", "minimum" => %Money{}}] * Platform admin sets these to ensure ISVs don't undercut below certain prices. * */ minimum_retail_floors?: Array<{ [key: string]: unknown; }> | null; notes?: string | null; /** * Per-ISV platform-account overdraft limit in credits. nil falls back to * the platform default. * */ overdraft_limit_credits?: number | null; /** * Per-seat monthly platform fee in cents. Charged to the ISV's Application * liability account at each subscription renewal for seat-based plans. * e.g., 500 = $5.00/seat/month. nil = no per-seat fee (credit-only ISVs). * */ per_seat_fee_cents?: number | null; /** * Which capability tiers this ISV may enable on applications. * */ permitted_capability_tiers?: Array<"core" | "standard" | "premium"> | null; /** * Per-ISV refund-reversal window in days. nil falls back to platform default. * */ refund_reversal_days?: number | null; settlement_frequency?: "monthly" | "weekly" | "daily"; /** * Per-ISV one-time signup-grant amount in credits, deposited to the * `Platform:Application:*` wholesale account when the ISV-tenant's first * Application is created (after proof-of-life passes). nil falls back to * `config :gpt_core, :default_isv_signup_grant_credits`. * */ signup_grant_credits?: number | null; /** * Origin of the signup grant. * - `:default` — runtime-created ISV; subject to proof-of-life gate. * - `:pre_seeded` — platform-curated ISV from `priv/data/platform_isvs.json`; * bypasses proof-of-life (presence in the seed file is implicit trust). * Set by `PlatformIsvProvisioner` in Phase 4. * */ signup_grant_source?: "default" | "pre_seeded"; /** * Lifecycle state of the per-ISV signup grant. * - `:pending` — no Application has been created yet; grant has not fired. * - `:granted` — grant fired and `Platform:Application:*` was credited. * - `:insufficient_proof_of_life` — first Application creation found the * owner lacking verified email or registered payment method; grant deferred * until proof-of-life lands. * */ signup_grant_status?: "pending" | "granted" | "insufficient_proof_of_life"; }; relationships?: { [key: string]: never; }; type?: "wholesale-agreement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/wholesale-agreements"; }; export type PostAdminWholesaleAgreementsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminWholesaleAgreementsError = PostAdminWholesaleAgreementsErrors[keyof PostAdminWholesaleAgreementsErrors]; export type PostAdminWholesaleAgreementsResponses = { /** * Success */ 201: { data?: WholesaleAgreement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminWholesaleAgreementsResponse = PostAdminWholesaleAgreementsResponses[keyof PostAdminWholesaleAgreementsResponses]; export type GetAdminClinicalClientGoalsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-goals/{id}"; }; export type GetAdminClinicalClientGoalsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalClientGoalsByIdError = GetAdminClinicalClientGoalsByIdErrors[keyof GetAdminClinicalClientGoalsByIdErrors]; export type GetAdminClinicalClientGoalsByIdResponses = { /** * Success */ 200: { data?: ClinicalClientGoal; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalClientGoalsByIdResponse = GetAdminClinicalClientGoalsByIdResponses[keyof GetAdminClinicalClientGoalsByIdResponses]; export type PatchAdminClinicalClientGoalsByIdData = { /** * Request body for the /clinical/client-goals/:id operation on clinical-client-goal resource */ body?: { data: { attributes?: { achieved_at?: unknown; action_steps?: Array | null; category?: string | null; current_value?: string | number | unknown; description?: string | null; email_sent_at?: unknown; frequency?: "daily" | "weekly"; goal_type?: string | null; linked_metric_type?: string | null; metadata?: { [key: string]: unknown; } | null; position?: number | null; priority?: "high" | "medium" | "low"; progress_notes?: string | null; session_id?: string | null; source?: "manual" | "session" | "template"; status?: "active" | "completed" | "abandoned" | "paused" | "achieved" | "discontinued"; target_date?: string | null; target_value?: string | number | unknown; template_id?: string | null; timeframe?: string | null; title?: string | null; tool_ids?: Array | null; unit?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-client-goal"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-goals/{id}"; }; export type PatchAdminClinicalClientGoalsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalClientGoalsByIdError = PatchAdminClinicalClientGoalsByIdErrors[keyof PatchAdminClinicalClientGoalsByIdErrors]; export type PatchAdminClinicalClientGoalsByIdResponses = { /** * Success */ 200: { data?: ClinicalClientGoal; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalClientGoalsByIdResponse = PatchAdminClinicalClientGoalsByIdResponses[keyof PatchAdminClinicalClientGoalsByIdResponses]; export type GetAdminCatalogProductsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/products/workspace/{workspace_id}"; }; export type GetAdminCatalogProductsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogProductsWorkspaceByWorkspaceIdError = GetAdminCatalogProductsWorkspaceByWorkspaceIdErrors[keyof GetAdminCatalogProductsWorkspaceByWorkspaceIdErrors]; export type GetAdminCatalogProductsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a catalog-product */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogProductsWorkspaceByWorkspaceIdResponse = GetAdminCatalogProductsWorkspaceByWorkspaceIdResponses[keyof GetAdminCatalogProductsWorkspaceByWorkspaceIdResponses]; export type GetAdminWalletFeaturesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/wallet/features"; }; export type GetAdminWalletFeaturesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminWalletFeaturesError = GetAdminWalletFeaturesErrors[keyof GetAdminWalletFeaturesErrors]; export type GetAdminWalletFeaturesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a feature-summary */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminWalletFeaturesResponse = GetAdminWalletFeaturesResponses[keyof GetAdminWalletFeaturesResponses]; export type PostAdminClinicalClientGoalsFromTemplateData = { /** * Request body for the /clinical/client-goals/from-template operation on clinical-client-goal resource */ body: { data: { attributes?: { patient_id: string; template_id: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-client-goal"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-goals/from-template"; }; export type PostAdminClinicalClientGoalsFromTemplateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalClientGoalsFromTemplateError = PostAdminClinicalClientGoalsFromTemplateErrors[keyof PostAdminClinicalClientGoalsFromTemplateErrors]; export type PostAdminClinicalClientGoalsFromTemplateResponses = { /** * Success */ 201: { data?: ClinicalClientGoal; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalClientGoalsFromTemplateResponse = PostAdminClinicalClientGoalsFromTemplateResponses[keyof PostAdminClinicalClientGoalsFromTemplateResponses]; export type DeleteAdminSocialTrendingHistoryByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/trending/history/{id}"; }; export type DeleteAdminSocialTrendingHistoryByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminSocialTrendingHistoryByIdError = DeleteAdminSocialTrendingHistoryByIdErrors[keyof DeleteAdminSocialTrendingHistoryByIdErrors]; export type DeleteAdminSocialTrendingHistoryByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminSocialTrendingHistoryByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/trending/history/{id}"; }; export type GetAdminSocialTrendingHistoryByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialTrendingHistoryByIdError = GetAdminSocialTrendingHistoryByIdErrors[keyof GetAdminSocialTrendingHistoryByIdErrors]; export type GetAdminSocialTrendingHistoryByIdResponses = { /** * Success */ 200: { data?: TrendingSnapshot; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialTrendingHistoryByIdResponse = GetAdminSocialTrendingHistoryByIdResponses[keyof GetAdminSocialTrendingHistoryByIdResponses]; export type PatchAdminPortalChangeRequestsByIdRejectData = { /** * Request body for the /portal-change-requests/:id/reject operation on portal-change-request resource */ body?: { data: { attributes?: { reviewed_by_id?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "portal-change-request"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/portal-change-requests/{id}/reject"; }; export type PatchAdminPortalChangeRequestsByIdRejectErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPortalChangeRequestsByIdRejectError = PatchAdminPortalChangeRequestsByIdRejectErrors[keyof PatchAdminPortalChangeRequestsByIdRejectErrors]; export type PatchAdminPortalChangeRequestsByIdRejectResponses = { /** * Success */ 200: { data?: PortalChangeRequest; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPortalChangeRequestsByIdRejectResponse = PatchAdminPortalChangeRequestsByIdRejectResponses[keyof PatchAdminPortalChangeRequestsByIdRejectResponses]; export type DeleteAdminCrmPipelineStagesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/pipeline-stages/{id}"; }; export type DeleteAdminCrmPipelineStagesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrmPipelineStagesByIdError = DeleteAdminCrmPipelineStagesByIdErrors[keyof DeleteAdminCrmPipelineStagesByIdErrors]; export type DeleteAdminCrmPipelineStagesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCrmPipelineStagesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/pipeline-stages/{id}"; }; export type GetAdminCrmPipelineStagesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmPipelineStagesByIdError = GetAdminCrmPipelineStagesByIdErrors[keyof GetAdminCrmPipelineStagesByIdErrors]; export type GetAdminCrmPipelineStagesByIdResponses = { /** * Success */ 200: { data?: CrmPipelineStage; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmPipelineStagesByIdResponse = GetAdminCrmPipelineStagesByIdResponses[keyof GetAdminCrmPipelineStagesByIdResponses]; export type PatchAdminCrmPipelineStagesByIdData = { /** * Request body for the /crm/pipeline-stages/:id operation on crm-pipeline-stage resource */ body?: { data: { attributes?: { automation_trigger?: string | null; forecast_category?: "pipeline" | "best_case" | "commit" | "closed_won" | "closed_lost"; is_closed?: boolean | null; name?: string | null; order?: number | null; probability?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-pipeline-stage"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/pipeline-stages/{id}"; }; export type PatchAdminCrmPipelineStagesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmPipelineStagesByIdError = PatchAdminCrmPipelineStagesByIdErrors[keyof PatchAdminCrmPipelineStagesByIdErrors]; export type PatchAdminCrmPipelineStagesByIdResponses = { /** * Success */ 200: { data?: CrmPipelineStage; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmPipelineStagesByIdResponse = PatchAdminCrmPipelineStagesByIdResponses[keyof PatchAdminCrmPipelineStagesByIdResponses]; export type PatchAdminEmailInboundAddressesByIdDisableData = { /** * Request body for the /email/inbound-addresses/:id/disable operation on email-inbound-address resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "email-inbound-address"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/inbound-addresses/{id}/disable"; }; export type PatchAdminEmailInboundAddressesByIdDisableErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailInboundAddressesByIdDisableError = PatchAdminEmailInboundAddressesByIdDisableErrors[keyof PatchAdminEmailInboundAddressesByIdDisableErrors]; export type PatchAdminEmailInboundAddressesByIdDisableResponses = { /** * Success */ 200: { data?: EmailInboundAddress; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailInboundAddressesByIdDisableResponse = PatchAdminEmailInboundAddressesByIdDisableResponses[keyof PatchAdminEmailInboundAddressesByIdDisableResponses]; export type GetAdminClinicalGoalAssociationsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; client_goal_id: string; }; url: "/admin/clinical/goal-associations"; }; export type GetAdminClinicalGoalAssociationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalGoalAssociationsError = GetAdminClinicalGoalAssociationsErrors[keyof GetAdminClinicalGoalAssociationsErrors]; export type GetAdminClinicalGoalAssociationsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-goal-association */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalGoalAssociationsResponse = GetAdminClinicalGoalAssociationsResponses[keyof GetAdminClinicalGoalAssociationsResponses]; export type PostAdminClinicalGoalAssociationsData = { /** * Request body for the /clinical/goal-associations operation on clinical-goal-association resource */ body: { data: { attributes?: { client_goal_id: string; entity_id: string; entity_type: "meal_plan" | "session" | "health_metric" | "recipe" | "supplement"; notes?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-goal-association"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-associations"; }; export type PostAdminClinicalGoalAssociationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalGoalAssociationsError = PostAdminClinicalGoalAssociationsErrors[keyof PostAdminClinicalGoalAssociationsErrors]; export type PostAdminClinicalGoalAssociationsResponses = { /** * Success */ 201: { data?: ClinicalGoalAssociation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalGoalAssociationsResponse = PostAdminClinicalGoalAssociationsResponses[keyof PostAdminClinicalGoalAssociationsResponses]; export type GetAdminClinicalPracticeResourcesArchivedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/practice-resources/archived"; }; export type GetAdminClinicalPracticeResourcesArchivedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPracticeResourcesArchivedError = GetAdminClinicalPracticeResourcesArchivedErrors[keyof GetAdminClinicalPracticeResourcesArchivedErrors]; export type GetAdminClinicalPracticeResourcesArchivedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-practice-resource */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPracticeResourcesArchivedResponse = GetAdminClinicalPracticeResourcesArchivedResponses[keyof GetAdminClinicalPracticeResourcesArchivedResponses]; export type GetAdminMeetingsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/meetings"; }; export type GetAdminMeetingsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminMeetingsError = GetAdminMeetingsErrors[keyof GetAdminMeetingsErrors]; export type GetAdminMeetingsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a meeting */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminMeetingsResponse = GetAdminMeetingsResponses[keyof GetAdminMeetingsResponses]; export type PostAdminMeetingsData = { /** * Request body for the /meetings operation on meeting resource */ body: { data: { attributes?: { attendees: { [key: string]: unknown; }; connector_instance_id?: string | null; custom_fields?: { [key: string]: unknown; } | null; end_time?: unknown; external_url?: string | null; join_url?: string | null; location?: string | null; organizer_email?: string | null; source_id: string; source_system: "microsoft_365" | "google_calendar" | "manual"; start_time?: unknown; status?: "scheduled" | "in_progress" | "completed" | "cancelled"; title: string; }; relationships?: { [key: string]: never; }; type?: "meeting"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/meetings"; }; export type PostAdminMeetingsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminMeetingsError = PostAdminMeetingsErrors[keyof PostAdminMeetingsErrors]; export type PostAdminMeetingsResponses = { /** * Success */ 201: { data?: Meeting; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminMeetingsResponse = PostAdminMeetingsResponses[keyof PostAdminMeetingsResponses]; export type PostAdminThreadsByIdSummarizeData = { /** * Request body for the /threads/:id/summarize operation on chat-thread resource */ body?: { data: { attributes?: { [key: string]: never; }; relationships?: { [key: string]: never; }; type?: "chat-thread"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/threads/{id}/summarize"; }; export type PostAdminThreadsByIdSummarizeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminThreadsByIdSummarizeError = PostAdminThreadsByIdSummarizeErrors[keyof PostAdminThreadsByIdSummarizeErrors]; export type PostAdminThreadsByIdSummarizeResponses = { /** * Success */ 201: { data?: ChatThread; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminThreadsByIdSummarizeResponse = PostAdminThreadsByIdSummarizeResponses[keyof PostAdminThreadsByIdSummarizeResponses]; export type PatchAdminCasesByIdDecideData = { /** * Request body for the /cases/:id/decide operation on case resource */ body: { data: { attributes?: { decision_outcome: string; notes?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "case"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/cases/{id}/decide"; }; export type PatchAdminCasesByIdDecideErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCasesByIdDecideError = PatchAdminCasesByIdDecideErrors[keyof PatchAdminCasesByIdDecideErrors]; export type PatchAdminCasesByIdDecideResponses = { /** * Success */ 200: { data?: Case; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCasesByIdDecideResponse = PatchAdminCasesByIdDecideResponses[keyof PatchAdminCasesByIdDecideResponses]; export type PostAdminSupportAiConfigsData = { /** * Request body for the /support/ai-configs operation on support-ai-config resource */ body: { data: { attributes?: { auto_classify?: boolean | null; auto_create_crm_contact?: boolean | null; auto_draft?: boolean | null; classification_model?: string | null; confidence_threshold?: number | null; draft_model?: string | null; sentiment_tracking?: boolean | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "support-ai-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/ai-configs"; }; export type PostAdminSupportAiConfigsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSupportAiConfigsError = PostAdminSupportAiConfigsErrors[keyof PostAdminSupportAiConfigsErrors]; export type PostAdminSupportAiConfigsResponses = { /** * Success */ 201: { data?: SupportAiConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSupportAiConfigsResponse = PostAdminSupportAiConfigsResponses[keyof PostAdminSupportAiConfigsResponses]; export type GetAdminExtractionChunkEntityLinksData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/chunk-entity-links"; }; export type GetAdminExtractionChunkEntityLinksErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionChunkEntityLinksError = GetAdminExtractionChunkEntityLinksErrors[keyof GetAdminExtractionChunkEntityLinksErrors]; export type GetAdminExtractionChunkEntityLinksResponses = { /** * Success */ 200: { /** * An array of resource objects representing a chunk-entity-link */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionChunkEntityLinksResponse = GetAdminExtractionChunkEntityLinksResponses[keyof GetAdminExtractionChunkEntityLinksResponses]; export type PatchAdminAgentsByIdSchemaVersionsByVersionIdData = { /** * Request body for the /agents/:id/schema-versions/:version_id operation on agent resource */ body?: { data: { changes_summary?: string | null; input_schema?: { [key: string]: unknown; } | null; output_schema?: { [key: string]: unknown; } | null; prompt_template?: string | null; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { version_id: string; /** * Agent ID (automatically mapped from route) */ id: string; }; query?: never; url: "/admin/agents/{id}/schema-versions/{version_id}"; }; export type PatchAdminAgentsByIdSchemaVersionsByVersionIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminAgentsByIdSchemaVersionsByVersionIdError = PatchAdminAgentsByIdSchemaVersionsByVersionIdErrors[keyof PatchAdminAgentsByIdSchemaVersionsByVersionIdErrors]; export type PatchAdminAgentsByIdSchemaVersionsByVersionIdResponses = { /** * Success */ 200: { [key: string]: unknown; }; }; export type PatchAdminAgentsByIdSchemaVersionsByVersionIdResponse = PatchAdminAgentsByIdSchemaVersionsByVersionIdResponses[keyof PatchAdminAgentsByIdSchemaVersionsByVersionIdResponses]; export type PatchAdminExtractionDocumentsByIdMarkTrainedData = { /** * Request body for the /extraction/documents/:id/mark-trained operation on extraction-document resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "extraction-document"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/documents/{id}/mark-trained"; }; export type PatchAdminExtractionDocumentsByIdMarkTrainedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminExtractionDocumentsByIdMarkTrainedError = PatchAdminExtractionDocumentsByIdMarkTrainedErrors[keyof PatchAdminExtractionDocumentsByIdMarkTrainedErrors]; export type PatchAdminExtractionDocumentsByIdMarkTrainedResponses = { /** * Success */ 200: { data?: ExtractionDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminExtractionDocumentsByIdMarkTrainedResponse = PatchAdminExtractionDocumentsByIdMarkTrainedResponses[keyof PatchAdminExtractionDocumentsByIdMarkTrainedResponses]; export type DeleteAdminSocialCampaignsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/campaigns/{id}"; }; export type DeleteAdminSocialCampaignsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminSocialCampaignsByIdError = DeleteAdminSocialCampaignsByIdErrors[keyof DeleteAdminSocialCampaignsByIdErrors]; export type DeleteAdminSocialCampaignsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminSocialCampaignsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/campaigns/{id}"; }; export type GetAdminSocialCampaignsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialCampaignsByIdError = GetAdminSocialCampaignsByIdErrors[keyof GetAdminSocialCampaignsByIdErrors]; export type GetAdminSocialCampaignsByIdResponses = { /** * Success */ 200: { data?: SocialCampaign; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialCampaignsByIdResponse = GetAdminSocialCampaignsByIdResponses[keyof GetAdminSocialCampaignsByIdResponses]; export type PatchAdminSocialCampaignsByIdData = { /** * Request body for the /social/campaigns/:id operation on social-campaign resource */ body?: { data: { attributes?: { brand_identity_id?: string | null; content_brief?: string | null; media_urls?: Array | null; name?: string | null; seo_keywords?: Array | null; target_platforms?: Array | null; }; id: string; relationships?: { [key: string]: never; }; type?: "social-campaign"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/campaigns/{id}"; }; export type PatchAdminSocialCampaignsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSocialCampaignsByIdError = PatchAdminSocialCampaignsByIdErrors[keyof PatchAdminSocialCampaignsByIdErrors]; export type PatchAdminSocialCampaignsByIdResponses = { /** * Success */ 200: { data?: SocialCampaign; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSocialCampaignsByIdResponse = PatchAdminSocialCampaignsByIdResponses[keyof PatchAdminSocialCampaignsByIdResponses]; export type GetAdminClinicalGoalTemplateCollectionsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-template-collections"; }; export type GetAdminClinicalGoalTemplateCollectionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalGoalTemplateCollectionsError = GetAdminClinicalGoalTemplateCollectionsErrors[keyof GetAdminClinicalGoalTemplateCollectionsErrors]; export type GetAdminClinicalGoalTemplateCollectionsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-goal-template-collection */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalGoalTemplateCollectionsResponse = GetAdminClinicalGoalTemplateCollectionsResponses[keyof GetAdminClinicalGoalTemplateCollectionsResponses]; export type PostAdminClinicalGoalTemplateCollectionsData = { /** * Request body for the /clinical/goal-template-collections operation on clinical-goal-template-collection resource */ body: { data: { attributes?: { description?: string | null; metadata?: { [key: string]: unknown; } | null; name: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-goal-template-collection"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-template-collections"; }; export type PostAdminClinicalGoalTemplateCollectionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalGoalTemplateCollectionsError = PostAdminClinicalGoalTemplateCollectionsErrors[keyof PostAdminClinicalGoalTemplateCollectionsErrors]; export type PostAdminClinicalGoalTemplateCollectionsResponses = { /** * Success */ 201: { data?: ClinicalGoalTemplateCollection; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalGoalTemplateCollectionsResponse = PostAdminClinicalGoalTemplateCollectionsResponses[keyof PostAdminClinicalGoalTemplateCollectionsResponses]; export type GetAdminVoiceRecordingsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/voice/recordings/{id}"; }; export type GetAdminVoiceRecordingsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminVoiceRecordingsByIdError = GetAdminVoiceRecordingsByIdErrors[keyof GetAdminVoiceRecordingsByIdErrors]; export type GetAdminVoiceRecordingsByIdResponses = { /** * Success */ 200: { data?: VoiceRecording; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminVoiceRecordingsByIdResponse = GetAdminVoiceRecordingsByIdResponses[keyof GetAdminVoiceRecordingsByIdResponses]; export type PatchAdminInvoicesByIdApplyAiSuggestionsData = { /** * Request body for the /invoices/:id/apply-ai-suggestions operation on invoices-invoice resource */ body: { data: { attributes?: { accepted_keys: Array; }; id: string; relationships?: { [key: string]: never; }; type?: "invoices-invoice"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/{id}/apply-ai-suggestions"; }; export type PatchAdminInvoicesByIdApplyAiSuggestionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvoicesByIdApplyAiSuggestionsError = PatchAdminInvoicesByIdApplyAiSuggestionsErrors[keyof PatchAdminInvoicesByIdApplyAiSuggestionsErrors]; export type PatchAdminInvoicesByIdApplyAiSuggestionsResponses = { /** * Success */ 200: { data?: InvoicesInvoice; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvoicesByIdApplyAiSuggestionsResponse = PatchAdminInvoicesByIdApplyAiSuggestionsResponses[keyof PatchAdminInvoicesByIdApplyAiSuggestionsResponses]; export type PatchAdminEmailMarketingGeneratedEmailsByIdApproveData = { /** * Request body for the /email-marketing/generated-emails/:id/approve operation on email-marketing-generated-email resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "email-marketing-generated-email"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/generated-emails/{id}/approve"; }; export type PatchAdminEmailMarketingGeneratedEmailsByIdApproveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailMarketingGeneratedEmailsByIdApproveError = PatchAdminEmailMarketingGeneratedEmailsByIdApproveErrors[keyof PatchAdminEmailMarketingGeneratedEmailsByIdApproveErrors]; export type PatchAdminEmailMarketingGeneratedEmailsByIdApproveResponses = { /** * Success */ 200: { data?: EmailMarketingGeneratedEmail; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailMarketingGeneratedEmailsByIdApproveResponse = PatchAdminEmailMarketingGeneratedEmailsByIdApproveResponses[keyof PatchAdminEmailMarketingGeneratedEmailsByIdApproveResponses]; export type PatchAdminClinicalMealPlansByIdArchiveData = { /** * Request body for the /clinical/meal-plans/:id/archive operation on clinical-meal-plan resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-meal-plan"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/meal-plans/{id}/archive"; }; export type PatchAdminClinicalMealPlansByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalMealPlansByIdArchiveError = PatchAdminClinicalMealPlansByIdArchiveErrors[keyof PatchAdminClinicalMealPlansByIdArchiveErrors]; export type PatchAdminClinicalMealPlansByIdArchiveResponses = { /** * Success */ 200: { data?: ClinicalMealPlan; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalMealPlansByIdArchiveResponse = PatchAdminClinicalMealPlansByIdArchiveResponses[keyof PatchAdminClinicalMealPlansByIdArchiveResponses]; export type PatchAdminPolicyReviewSchedulesByIdMarkOverdueData = { /** * Request body for the /policy-review-schedules/:id/mark-overdue operation on policy-review-schedule resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "policy-review-schedule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/policy-review-schedules/{id}/mark-overdue"; }; export type PatchAdminPolicyReviewSchedulesByIdMarkOverdueErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPolicyReviewSchedulesByIdMarkOverdueError = PatchAdminPolicyReviewSchedulesByIdMarkOverdueErrors[keyof PatchAdminPolicyReviewSchedulesByIdMarkOverdueErrors]; export type PatchAdminPolicyReviewSchedulesByIdMarkOverdueResponses = { /** * Success */ 200: { data?: PolicyReviewSchedule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPolicyReviewSchedulesByIdMarkOverdueResponse = PatchAdminPolicyReviewSchedulesByIdMarkOverdueResponses[keyof PatchAdminPolicyReviewSchedulesByIdMarkOverdueResponses]; export type DeleteAdminCatalogTaxonomiesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/taxonomies/{id}"; }; export type DeleteAdminCatalogTaxonomiesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCatalogTaxonomiesByIdError = DeleteAdminCatalogTaxonomiesByIdErrors[keyof DeleteAdminCatalogTaxonomiesByIdErrors]; export type DeleteAdminCatalogTaxonomiesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCatalogTaxonomiesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/taxonomies/{id}"; }; export type GetAdminCatalogTaxonomiesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogTaxonomiesByIdError = GetAdminCatalogTaxonomiesByIdErrors[keyof GetAdminCatalogTaxonomiesByIdErrors]; export type GetAdminCatalogTaxonomiesByIdResponses = { /** * Success */ 200: { data?: CatalogTaxonomy; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogTaxonomiesByIdResponse = GetAdminCatalogTaxonomiesByIdResponses[keyof GetAdminCatalogTaxonomiesByIdResponses]; export type PatchAdminCatalogTaxonomiesByIdData = { /** * Request body for the /catalog/taxonomies/:id operation on catalog-taxonomy resource */ body?: { data: { attributes?: { ai_managed?: boolean | null; is_hierarchical?: boolean | null; is_required?: boolean | null; max_depth?: number | null; name?: string | null; slug?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "catalog-taxonomy"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/taxonomies/{id}"; }; export type PatchAdminCatalogTaxonomiesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCatalogTaxonomiesByIdError = PatchAdminCatalogTaxonomiesByIdErrors[keyof PatchAdminCatalogTaxonomiesByIdErrors]; export type PatchAdminCatalogTaxonomiesByIdResponses = { /** * Success */ 200: { data?: CatalogTaxonomy; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCatalogTaxonomiesByIdResponse = PatchAdminCatalogTaxonomiesByIdResponses[keyof PatchAdminCatalogTaxonomiesByIdResponses]; export type PatchAdminSubscriptionsByIdCancelData = { /** * Request body for the /subscriptions/:id/cancel operation on subscription resource */ body?: { data: { attributes?: { immediate?: boolean | null; }; id: string; relationships?: { [key: string]: never; }; type?: "subscription"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/subscriptions/{id}/cancel"; }; export type PatchAdminSubscriptionsByIdCancelErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSubscriptionsByIdCancelError = PatchAdminSubscriptionsByIdCancelErrors[keyof PatchAdminSubscriptionsByIdCancelErrors]; export type PatchAdminSubscriptionsByIdCancelResponses = { /** * Success */ 200: { data?: Subscription; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSubscriptionsByIdCancelResponse = PatchAdminSubscriptionsByIdCancelResponses[keyof PatchAdminSubscriptionsByIdCancelResponses]; export type PatchAdminTenantsByIdBrandingData = { /** * Request body for the /tenants/:id/branding operation on tenant resource */ body?: { data: { attributes?: { badge_url?: string | null; logo_url?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "tenant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants/{id}/branding"; }; export type PatchAdminTenantsByIdBrandingErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminTenantsByIdBrandingError = PatchAdminTenantsByIdBrandingErrors[keyof PatchAdminTenantsByIdBrandingErrors]; export type PatchAdminTenantsByIdBrandingResponses = { /** * Success */ 200: { data?: Tenant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminTenantsByIdBrandingResponse = PatchAdminTenantsByIdBrandingResponses[keyof PatchAdminTenantsByIdBrandingResponses]; export type PatchAdminApiKeysByIdRevokeData = { /** * Request body for the /api-keys/:id/revoke operation on api-key resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "api-key"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/api-keys/{id}/revoke"; }; export type PatchAdminApiKeysByIdRevokeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminApiKeysByIdRevokeError = PatchAdminApiKeysByIdRevokeErrors[keyof PatchAdminApiKeysByIdRevokeErrors]; export type PatchAdminApiKeysByIdRevokeResponses = { /** * Success */ 200: { data?: ApiKey; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminApiKeysByIdRevokeResponse = PatchAdminApiKeysByIdRevokeResponses[keyof PatchAdminApiKeysByIdRevokeResponses]; export type PatchAdminClinicalDocumentsByIdTransitionStatusData = { /** * Request body for the /clinical/documents/:id/transition-status operation on clinical-document resource */ body: { data: { attributes?: { extracted_data?: { [key: string]: unknown; } | null; extraction_status: "pending" | "processing" | "completed" | "failed" | "skipped"; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-document"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/documents/{id}/transition-status"; }; export type PatchAdminClinicalDocumentsByIdTransitionStatusErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalDocumentsByIdTransitionStatusError = PatchAdminClinicalDocumentsByIdTransitionStatusErrors[keyof PatchAdminClinicalDocumentsByIdTransitionStatusErrors]; export type PatchAdminClinicalDocumentsByIdTransitionStatusResponses = { /** * Success */ 200: { data?: ClinicalDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalDocumentsByIdTransitionStatusResponse = PatchAdminClinicalDocumentsByIdTransitionStatusResponses[keyof PatchAdminClinicalDocumentsByIdTransitionStatusResponses]; export type GetAdminClinicalPracticeResourcesCatalogByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-resources/catalog/{id}"; }; export type GetAdminClinicalPracticeResourcesCatalogByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPracticeResourcesCatalogByIdError = GetAdminClinicalPracticeResourcesCatalogByIdErrors[keyof GetAdminClinicalPracticeResourcesCatalogByIdErrors]; export type GetAdminClinicalPracticeResourcesCatalogByIdResponses = { /** * Success */ 200: { data?: ClinicalPracticeResource; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPracticeResourcesCatalogByIdResponse = GetAdminClinicalPracticeResourcesCatalogByIdResponses[keyof GetAdminClinicalPracticeResourcesCatalogByIdResponses]; export type PatchAdminClinicalPracticeResourcesCatalogByIdData = { /** * Request body for the /clinical/practice-resources/catalog/:id operation on clinical-practice-resource resource */ body?: { data: { attributes?: { applicable_conditions?: Array | null; audience?: "patient" | "practitioner" | "both"; author?: string | null; category?: string | null; condition_tags?: Array | null; content_format?: "pdf" | "html" | "video_embed" | "external_link" | "interactive"; description?: string | null; estimated_duration_minutes?: number | null; icon_url?: string | null; is_active?: boolean | null; language?: string | null; license?: string | null; metadata?: { [key: string]: unknown; } | null; preview_url?: string | null; reading_level?: "basic" | "intermediate" | "advanced" | "clinical"; related_goal_types?: Array | null; resource_type?: "article" | "video" | "handout" | "worksheet" | "tool_link" | "infographic" | "audio" | "recipe" | "checklist" | "protocol" | "assessment" | "exercise" | "template" | "presentation" | "ebook" | "other"; tags?: Array | null; title?: string | null; url?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-practice-resource"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-resources/catalog/{id}"; }; export type PatchAdminClinicalPracticeResourcesCatalogByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalPracticeResourcesCatalogByIdError = PatchAdminClinicalPracticeResourcesCatalogByIdErrors[keyof PatchAdminClinicalPracticeResourcesCatalogByIdErrors]; export type PatchAdminClinicalPracticeResourcesCatalogByIdResponses = { /** * Success */ 200: { data?: ClinicalPracticeResource; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalPracticeResourcesCatalogByIdResponse = PatchAdminClinicalPracticeResourcesCatalogByIdResponses[keyof PatchAdminClinicalPracticeResourcesCatalogByIdResponses]; export type GetAdminClinicalNotesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; session_id: string; }; url: "/admin/clinical/notes"; }; export type GetAdminClinicalNotesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalNotesError = GetAdminClinicalNotesErrors[keyof GetAdminClinicalNotesErrors]; export type GetAdminClinicalNotesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-note */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalNotesResponse = GetAdminClinicalNotesResponses[keyof GetAdminClinicalNotesResponses]; export type PostAdminClinicalNotesData = { /** * Request body for the /clinical/notes operation on clinical-note resource */ body: { data: { attributes?: { amends_note_id?: string | null; metadata?: { [key: string]: unknown; } | null; note_content?: string | null; note_type?: "adime" | "soap" | "progress" | "discharge" | "addendum"; pipeline_execution_id?: string | null; requires_cosign?: boolean | null; sections?: { [key: string]: unknown; } | null; session_id: string; tags?: Array | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-note"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/notes"; }; export type PostAdminClinicalNotesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalNotesError = PostAdminClinicalNotesErrors[keyof PostAdminClinicalNotesErrors]; export type PostAdminClinicalNotesResponses = { /** * Success */ 201: { data?: ClinicalNote; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalNotesResponse = PostAdminClinicalNotesResponses[keyof PostAdminClinicalNotesResponses]; export type DeleteAdminReviewQueueMembershipsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/review-queue-memberships/{id}"; }; export type DeleteAdminReviewQueueMembershipsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminReviewQueueMembershipsByIdError = DeleteAdminReviewQueueMembershipsByIdErrors[keyof DeleteAdminReviewQueueMembershipsByIdErrors]; export type DeleteAdminReviewQueueMembershipsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminReviewQueueMembershipsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/review-queue-memberships/{id}"; }; export type GetAdminReviewQueueMembershipsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminReviewQueueMembershipsByIdError = GetAdminReviewQueueMembershipsByIdErrors[keyof GetAdminReviewQueueMembershipsByIdErrors]; export type GetAdminReviewQueueMembershipsByIdResponses = { /** * Success */ 200: { data?: ReviewQueueMembership; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminReviewQueueMembershipsByIdResponse = GetAdminReviewQueueMembershipsByIdResponses[keyof GetAdminReviewQueueMembershipsByIdResponses]; export type DeleteAdminCampaignsSequenceStepsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/campaigns/sequence-steps/{id}"; }; export type DeleteAdminCampaignsSequenceStepsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCampaignsSequenceStepsByIdError = DeleteAdminCampaignsSequenceStepsByIdErrors[keyof DeleteAdminCampaignsSequenceStepsByIdErrors]; export type DeleteAdminCampaignsSequenceStepsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCampaignsSequenceStepsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/campaigns/sequence-steps/{id}"; }; export type GetAdminCampaignsSequenceStepsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCampaignsSequenceStepsByIdError = GetAdminCampaignsSequenceStepsByIdErrors[keyof GetAdminCampaignsSequenceStepsByIdErrors]; export type GetAdminCampaignsSequenceStepsByIdResponses = { /** * Success */ 200: { data?: EmailMarketingSequenceStep; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCampaignsSequenceStepsByIdResponse = GetAdminCampaignsSequenceStepsByIdResponses[keyof GetAdminCampaignsSequenceStepsByIdResponses]; export type PatchAdminCampaignsSequenceStepsByIdData = { /** * Request body for the /campaigns/sequence-steps/:id operation on email-marketing-sequence-step resource */ body?: { data: { attributes?: { ai_instructions?: string | null; body_template?: string | null; delay_hours?: number | null; position?: number | null; segment_filter?: { [key: string]: unknown; } | null; subject_template?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "email-marketing-sequence-step"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/campaigns/sequence-steps/{id}"; }; export type PatchAdminCampaignsSequenceStepsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCampaignsSequenceStepsByIdError = PatchAdminCampaignsSequenceStepsByIdErrors[keyof PatchAdminCampaignsSequenceStepsByIdErrors]; export type PatchAdminCampaignsSequenceStepsByIdResponses = { /** * Success */ 200: { data?: EmailMarketingSequenceStep; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCampaignsSequenceStepsByIdResponse = PatchAdminCampaignsSequenceStepsByIdResponses[keyof PatchAdminCampaignsSequenceStepsByIdResponses]; export type GetAdminAiGraphNodesLabelByLabelData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { label: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ai/graph/nodes/label/{label}"; }; export type GetAdminAiGraphNodesLabelByLabelErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAiGraphNodesLabelByLabelError = GetAdminAiGraphNodesLabelByLabelErrors[keyof GetAdminAiGraphNodesLabelByLabelErrors]; export type GetAdminAiGraphNodesLabelByLabelResponses = { /** * Success */ 200: { /** * An array of resource objects representing a graph-node */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAiGraphNodesLabelByLabelResponse = GetAdminAiGraphNodesLabelByLabelResponses[keyof GetAdminAiGraphNodesLabelByLabelResponses]; export type GetAdminClinicalPatientsByIdGoalsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/patients/{id}/goals"; }; export type GetAdminClinicalPatientsByIdGoalsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPatientsByIdGoalsError = GetAdminClinicalPatientsByIdGoalsErrors[keyof GetAdminClinicalPatientsByIdGoalsErrors]; export type GetAdminClinicalPatientsByIdGoalsResponses = { /** * Success */ 200: { data?: ClinicalClientGoal; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPatientsByIdGoalsResponse = GetAdminClinicalPatientsByIdGoalsResponses[keyof GetAdminClinicalPatientsByIdGoalsResponses]; export type PatchAdminRecipesByIdRestoreData = { /** * Request body for the /recipes/:id/restore operation on recipes-recipe resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "recipes-recipe"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/{id}/restore"; }; export type PatchAdminRecipesByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminRecipesByIdRestoreError = PatchAdminRecipesByIdRestoreErrors[keyof PatchAdminRecipesByIdRestoreErrors]; export type PatchAdminRecipesByIdRestoreResponses = { /** * Success */ 200: { data?: RecipesRecipe; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminRecipesByIdRestoreResponse = PatchAdminRecipesByIdRestoreResponses[keyof PatchAdminRecipesByIdRestoreResponses]; export type PatchAdminCrawlerNewsMonitorsByIdPauseData = { /** * Request body for the /crawler/news-monitors/:id/pause operation on news-monitor resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "news-monitor"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/news-monitors/{id}/pause"; }; export type PatchAdminCrawlerNewsMonitorsByIdPauseErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrawlerNewsMonitorsByIdPauseError = PatchAdminCrawlerNewsMonitorsByIdPauseErrors[keyof PatchAdminCrawlerNewsMonitorsByIdPauseErrors]; export type PatchAdminCrawlerNewsMonitorsByIdPauseResponses = { /** * Success */ 200: { data?: NewsMonitor; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrawlerNewsMonitorsByIdPauseResponse = PatchAdminCrawlerNewsMonitorsByIdPauseResponses[keyof PatchAdminCrawlerNewsMonitorsByIdPauseResponses]; export type GetAdminSysAiConfigData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/sys/ai-config"; }; export type GetAdminSysAiConfigErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSysAiConfigError = GetAdminSysAiConfigErrors[keyof GetAdminSysAiConfigErrors]; export type GetAdminSysAiConfigResponses = { /** * Success */ 200: { /** * An array of resource objects representing a ai-config */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSysAiConfigResponse = GetAdminSysAiConfigResponses[keyof GetAdminSysAiConfigResponses]; export type PostAdminSysAiConfigData = { /** * Request body for the /sys/ai-config operation on ai-config resource */ body: { data: { attributes?: { cloud_model?: string | null; embedding_model?: string | null; /** * Per-config fallback chains. Map of model_id => [{fallback_model, reason}]. Null = use platform defaults. */ fallback_chains?: { [key: string]: unknown; } | null; id: string; model_overrides?: { [key: string]: unknown; } | null; /** * Minimum upcharge percentage on provider costs. Null = use config.exs default (20%). */ pricing_floor_percent?: number | null; vector_dimensions?: number | null; /** * Per-workload AI backend overrides stored as JSON-safe strings. NER is intentionally excluded and remains locked to the local GLiNER backend. */ workload_backends?: { [key: string]: unknown; } | null; }; relationships?: { [key: string]: never; }; type?: "ai-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/sys/ai-config"; }; export type PostAdminSysAiConfigErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSysAiConfigError = PostAdminSysAiConfigErrors[keyof PostAdminSysAiConfigErrors]; export type PostAdminSysAiConfigResponses = { /** * Success */ 201: { data?: AiConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSysAiConfigResponse = PostAdminSysAiConfigResponses[keyof PostAdminSysAiConfigResponses]; export type GetAdminLedgerData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ledger"; }; export type GetAdminLedgerErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminLedgerError = GetAdminLedgerErrors[keyof GetAdminLedgerErrors]; export type GetAdminLedgerResponses = { /** * Success */ 200: { /** * An array of resource objects representing a ledger */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminLedgerResponse = GetAdminLedgerResponses[keyof GetAdminLedgerResponses]; export type GetAdminUserProfilesMeData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/user-profiles/me"; }; export type GetAdminUserProfilesMeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminUserProfilesMeError = GetAdminUserProfilesMeErrors[keyof GetAdminUserProfilesMeErrors]; export type GetAdminUserProfilesMeResponses = { /** * Success */ 200: { data?: UserProfile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminUserProfilesMeResponse = GetAdminUserProfilesMeResponses[keyof GetAdminUserProfilesMeResponses]; export type PostAdminInvoicesPaymentsData = { /** * Request body for the /invoices/payments operation on invoices-payment resource */ body: { data: { attributes?: { amount: string | number; currency?: string | null; invoice_id: string; metadata?: { [key: string]: unknown; } | null; method?: "bank_transfer" | "card" | "check" | "cash" | "crypto" | "other"; notes?: string | null; paid_at: unknown; provider?: "qorpay" | "stripe" | "manual"; provider_transaction_id?: string | null; reference?: string | null; }; relationships?: { [key: string]: never; }; type?: "invoices-payment"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/payments"; }; export type PostAdminInvoicesPaymentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminInvoicesPaymentsError = PostAdminInvoicesPaymentsErrors[keyof PostAdminInvoicesPaymentsErrors]; export type PostAdminInvoicesPaymentsResponses = { /** * Success */ 201: { data?: InvoicesPayment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminInvoicesPaymentsResponse = PostAdminInvoicesPaymentsResponses[keyof PostAdminInvoicesPaymentsResponses]; export type GetAdminInvoicesContactsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/contacts/workspace/{workspace_id}"; }; export type GetAdminInvoicesContactsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminInvoicesContactsWorkspaceByWorkspaceIdError = GetAdminInvoicesContactsWorkspaceByWorkspaceIdErrors[keyof GetAdminInvoicesContactsWorkspaceByWorkspaceIdErrors]; export type GetAdminInvoicesContactsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a invoices-contact */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminInvoicesContactsWorkspaceByWorkspaceIdResponse = GetAdminInvoicesContactsWorkspaceByWorkspaceIdResponses[keyof GetAdminInvoicesContactsWorkspaceByWorkspaceIdResponses]; export type GetAdminFormGenerationsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/form-generations"; }; export type GetAdminFormGenerationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminFormGenerationsError = GetAdminFormGenerationsErrors[keyof GetAdminFormGenerationsErrors]; export type GetAdminFormGenerationsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a form-generation-job */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminFormGenerationsResponse = GetAdminFormGenerationsResponses[keyof GetAdminFormGenerationsResponses]; export type PostAdminFormGenerationsData = { /** * Request body for the /form-generations operation on form-generation-job resource */ body: { data: { attributes?: { actor_user_id?: string | null; application_id: string; prompt: string; }; relationships?: { [key: string]: never; }; type?: "form-generation-job"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/form-generations"; }; export type PostAdminFormGenerationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminFormGenerationsError = PostAdminFormGenerationsErrors[keyof PostAdminFormGenerationsErrors]; export type PostAdminFormGenerationsResponses = { /** * Success */ 201: { data?: FormGenerationJob; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminFormGenerationsResponse = PostAdminFormGenerationsResponses[keyof PostAdminFormGenerationsResponses]; export type GetAdminCatalogTaxonomiesApplicationByApplicationIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { application_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/taxonomies/application/{application_id}"; }; export type GetAdminCatalogTaxonomiesApplicationByApplicationIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogTaxonomiesApplicationByApplicationIdError = GetAdminCatalogTaxonomiesApplicationByApplicationIdErrors[keyof GetAdminCatalogTaxonomiesApplicationByApplicationIdErrors]; export type GetAdminCatalogTaxonomiesApplicationByApplicationIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a catalog-taxonomy */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogTaxonomiesApplicationByApplicationIdResponse = GetAdminCatalogTaxonomiesApplicationByApplicationIdResponses[keyof GetAdminCatalogTaxonomiesApplicationByApplicationIdResponses]; export type GetAdminSystemMessagesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/system-messages"; }; export type GetAdminSystemMessagesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSystemMessagesError = GetAdminSystemMessagesErrors[keyof GetAdminSystemMessagesErrors]; export type GetAdminSystemMessagesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a system-message */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSystemMessagesResponse = GetAdminSystemMessagesResponses[keyof GetAdminSystemMessagesResponses]; export type PostAdminSystemMessagesData = { /** * Request body for the /system-messages operation on system-message resource */ body: { data: { attributes?: { /** * Markdown content */ content: string; is_active?: boolean | null; /** * For ToS: forces users to re-accept even if they accepted a previous version */ requires_acceptance?: boolean | null; title: string; type: "tos" | "privacy_policy" | "welcome" | "announcement"; version?: string | null; }; relationships?: { [key: string]: never; }; type?: "system-message"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/system-messages"; }; export type PostAdminSystemMessagesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSystemMessagesError = PostAdminSystemMessagesErrors[keyof PostAdminSystemMessagesErrors]; export type PostAdminSystemMessagesResponses = { /** * Success */ 201: { data?: SystemMessage; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSystemMessagesResponse = PostAdminSystemMessagesResponses[keyof PostAdminSystemMessagesResponses]; export type DeleteAdminInvoicesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/{id}"; }; export type DeleteAdminInvoicesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminInvoicesByIdError = DeleteAdminInvoicesByIdErrors[keyof DeleteAdminInvoicesByIdErrors]; export type DeleteAdminInvoicesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminInvoicesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/{id}"; }; export type GetAdminInvoicesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminInvoicesByIdError = GetAdminInvoicesByIdErrors[keyof GetAdminInvoicesByIdErrors]; export type GetAdminInvoicesByIdResponses = { /** * Success */ 200: { data?: InvoicesInvoice; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminInvoicesByIdResponse = GetAdminInvoicesByIdResponses[keyof GetAdminInvoicesByIdResponses]; export type PatchAdminInvoicesByIdData = { /** * Request body for the /invoices/:id operation on invoices-invoice resource */ body?: { data: { attributes?: { amount_due?: string | number | unknown; amount_paid?: string | number | unknown; billing_address?: InvoicesInvoiceBillingAddressInputUpdateType; contact_id?: string | null; currency?: string | null; due_date?: string | null; issue_date?: string | null; metadata?: { [key: string]: unknown; } | null; notes?: string | null; payment_terms?: string | null; reference_number?: string | null; shipping_address?: InvoicesInvoiceShippingAddressInputUpdateType; subtotal?: string | number | unknown; tax_total?: string | number | unknown; total?: string | number | unknown; }; id: string; relationships?: { [key: string]: never; }; type?: "invoices-invoice"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/{id}"; }; export type PatchAdminInvoicesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvoicesByIdError = PatchAdminInvoicesByIdErrors[keyof PatchAdminInvoicesByIdErrors]; export type PatchAdminInvoicesByIdResponses = { /** * Success */ 200: { data?: InvoicesInvoice; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvoicesByIdResponse = PatchAdminInvoicesByIdResponses[keyof PatchAdminInvoicesByIdResponses]; export type GetAdminEmailInboundAddressesWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/inbound-addresses/workspace/{workspace_id}"; }; export type GetAdminEmailInboundAddressesWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailInboundAddressesWorkspaceByWorkspaceIdError = GetAdminEmailInboundAddressesWorkspaceByWorkspaceIdErrors[keyof GetAdminEmailInboundAddressesWorkspaceByWorkspaceIdErrors]; export type GetAdminEmailInboundAddressesWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a email-inbound-address */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailInboundAddressesWorkspaceByWorkspaceIdResponse = GetAdminEmailInboundAddressesWorkspaceByWorkspaceIdResponses[keyof GetAdminEmailInboundAddressesWorkspaceByWorkspaceIdResponses]; export type PatchAdminUsersAuthOauthUnlinkData = { /** * Request body for the /users/auth/oauth/unlink operation on user resource */ body: { data: { attributes?: { provider: string; }; id: string; relationships?: { [key: string]: never; }; type?: "user"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/users/auth/oauth/unlink"; }; export type PatchAdminUsersAuthOauthUnlinkErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminUsersAuthOauthUnlinkError = PatchAdminUsersAuthOauthUnlinkErrors[keyof PatchAdminUsersAuthOauthUnlinkErrors]; export type PatchAdminUsersAuthOauthUnlinkResponses = { /** * Success */ 200: { data?: User; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminUsersAuthOauthUnlinkResponse = PatchAdminUsersAuthOauthUnlinkResponses[keyof PatchAdminUsersAuthOauthUnlinkResponses]; export type GetAdminDisclosureLogsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/disclosure-logs"; }; export type GetAdminDisclosureLogsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminDisclosureLogsError = GetAdminDisclosureLogsErrors[keyof GetAdminDisclosureLogsErrors]; export type GetAdminDisclosureLogsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a disclosure-log */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminDisclosureLogsResponse = GetAdminDisclosureLogsResponses[keyof GetAdminDisclosureLogsResponses]; export type PostAdminDisclosureLogsData = { /** * Request body for the /disclosure-logs operation on disclosure-log resource */ body: { data: { attributes?: { disclosed_at: unknown; /** * Actor who triggered the disclosure */ disclosed_by_id?: string | null; disclosure_method: "api_call" | "email" | "webhook" | "file_transfer" | "manual"; /** * Reference to consent or BAA authorizing disclosure */ legal_basis?: string | null; /** * Connector-specific details */ metadata?: { [key: string]: unknown; } | null; /** * Categories of PHI disclosed (e.g., demographics, clinical_notes) */ phi_categories?: Array | null; purpose: "treatment" | "payment" | "operations" | "legal" | "research" | "public_health" | "other"; /** * Name of the disclosure recipient (e.g., OpenRouter, Fullscript) */ recipient_name: string; recipient_type: "llm_provider" | "integration_partner" | "healthcare_provider" | "health_plan" | "government" | "other"; /** * ID of the disclosed resource */ resource_id: string; /** * Type of resource disclosed (e.g., clinical_note, health_metric) */ resource_type: string; /** * ID of the data subject whose PHI was disclosed */ subject_id: string; /** * Type of data subject (e.g., patient, contact) */ subject_type: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "disclosure-log"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/disclosure-logs"; }; export type PostAdminDisclosureLogsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminDisclosureLogsError = PostAdminDisclosureLogsErrors[keyof PostAdminDisclosureLogsErrors]; export type PostAdminDisclosureLogsResponses = { /** * Success */ 201: { data?: DisclosureLog; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminDisclosureLogsResponse = PostAdminDisclosureLogsResponses[keyof PostAdminDisclosureLogsResponses]; export type DeleteAdminClinicalIntakeTargetsByIdPermanentData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/intake-targets/{id}/permanent"; }; export type DeleteAdminClinicalIntakeTargetsByIdPermanentErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalIntakeTargetsByIdPermanentError = DeleteAdminClinicalIntakeTargetsByIdPermanentErrors[keyof DeleteAdminClinicalIntakeTargetsByIdPermanentErrors]; export type DeleteAdminClinicalIntakeTargetsByIdPermanentResponses = { /** * Deleted successfully */ 200: unknown; }; export type PostAdminSupportTicketMessagesData = { /** * Request body for the /support/ticket-messages operation on support-ticket-message resource */ body: { data: { attributes?: { ai_draft?: boolean | null; body: string; channel?: string | null; channel_message_id?: string | null; is_internal_note?: boolean | null; sender_id?: string | null; sender_type: "customer" | "agent" | "ai" | "system"; ticket_id: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "support-ticket-message"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/ticket-messages"; }; export type PostAdminSupportTicketMessagesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSupportTicketMessagesError = PostAdminSupportTicketMessagesErrors[keyof PostAdminSupportTicketMessagesErrors]; export type PostAdminSupportTicketMessagesResponses = { /** * Success */ 201: { data?: SupportTicketMessage; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSupportTicketMessagesResponse = PostAdminSupportTicketMessagesResponses[keyof PostAdminSupportTicketMessagesResponses]; export type DeleteAdminCrmPhoneNumbersByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/phone-numbers/{id}"; }; export type DeleteAdminCrmPhoneNumbersByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrmPhoneNumbersByIdError = DeleteAdminCrmPhoneNumbersByIdErrors[keyof DeleteAdminCrmPhoneNumbersByIdErrors]; export type DeleteAdminCrmPhoneNumbersByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCrmPhoneNumbersByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/phone-numbers/{id}"; }; export type GetAdminCrmPhoneNumbersByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmPhoneNumbersByIdError = GetAdminCrmPhoneNumbersByIdErrors[keyof GetAdminCrmPhoneNumbersByIdErrors]; export type GetAdminCrmPhoneNumbersByIdResponses = { /** * Success */ 200: { data?: CrmPhoneNumber; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmPhoneNumbersByIdResponse = GetAdminCrmPhoneNumbersByIdResponses[keyof GetAdminCrmPhoneNumbersByIdResponses]; export type PatchAdminCrmPhoneNumbersByIdData = { /** * Request body for the /crm/phone-numbers/:id operation on crm-phone-number resource */ body?: { data: { attributes?: { country_code?: string | null; extension?: string | null; is_primary?: boolean | null; label?: "mobile" | "work" | "home" | "fax" | "main" | "other"; number?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-phone-number"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/phone-numbers/{id}"; }; export type PatchAdminCrmPhoneNumbersByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmPhoneNumbersByIdError = PatchAdminCrmPhoneNumbersByIdErrors[keyof PatchAdminCrmPhoneNumbersByIdErrors]; export type PatchAdminCrmPhoneNumbersByIdResponses = { /** * Success */ 200: { data?: CrmPhoneNumber; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmPhoneNumbersByIdResponse = PatchAdminCrmPhoneNumbersByIdResponses[keyof PatchAdminCrmPhoneNumbersByIdResponses]; export type PatchAdminCasesByIdReopenData = { /** * Request body for the /cases/:id/reopen operation on case resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "case"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/cases/{id}/reopen"; }; export type PatchAdminCasesByIdReopenErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCasesByIdReopenError = PatchAdminCasesByIdReopenErrors[keyof PatchAdminCasesByIdReopenErrors]; export type PatchAdminCasesByIdReopenResponses = { /** * Success */ 200: { data?: Case; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCasesByIdReopenResponse = PatchAdminCasesByIdReopenResponses[keyof PatchAdminCasesByIdReopenResponses]; export type GetAdminBucketsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/buckets"; }; export type GetAdminBucketsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminBucketsError = GetAdminBucketsErrors[keyof GetAdminBucketsErrors]; export type GetAdminBucketsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a bucket */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminBucketsResponse = GetAdminBucketsResponses[keyof GetAdminBucketsResponses]; export type PostAdminBucketsData = { /** * Request body for the /buckets operation on bucket resource */ body: { data: { attributes?: { name: string; region?: string | null; tenant_id: string; type: "public" | "private" | "processing"; }; relationships?: { [key: string]: never; }; type?: "bucket"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/buckets"; }; export type PostAdminBucketsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminBucketsError = PostAdminBucketsErrors[keyof PostAdminBucketsErrors]; export type PostAdminBucketsResponses = { /** * Success */ 201: { data?: Bucket; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminBucketsResponse = PostAdminBucketsResponses[keyof PostAdminBucketsResponses]; export type PostAdminFormVersionsByIdProposeRuleData = { /** * Request body for the /form-versions/:id/propose-rule operation on form-version resource */ body: { data: { instruction: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/form-versions/{id}/propose-rule"; }; export type PostAdminFormVersionsByIdProposeRuleErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminFormVersionsByIdProposeRuleError = PostAdminFormVersionsByIdProposeRuleErrors[keyof PostAdminFormVersionsByIdProposeRuleErrors]; export type PostAdminFormVersionsByIdProposeRuleResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminFormVersionsByIdProposeRuleResponse = PostAdminFormVersionsByIdProposeRuleResponses[keyof PostAdminFormVersionsByIdProposeRuleResponses]; export type GetAdminDataSubjectRequestsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/data-subject-requests/{id}"; }; export type GetAdminDataSubjectRequestsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminDataSubjectRequestsByIdError = GetAdminDataSubjectRequestsByIdErrors[keyof GetAdminDataSubjectRequestsByIdErrors]; export type GetAdminDataSubjectRequestsByIdResponses = { /** * Success */ 200: { data?: DataSubjectRequest; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminDataSubjectRequestsByIdResponse = GetAdminDataSubjectRequestsByIdResponses[keyof GetAdminDataSubjectRequestsByIdResponses]; export type GetAdminSearchHealthData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/search/health"; }; export type GetAdminSearchHealthErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSearchHealthError = GetAdminSearchHealthErrors[keyof GetAdminSearchHealthErrors]; export type GetAdminSearchHealthResponses = { /** * Success */ 200: { /** * An array of resource objects representing a search */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSearchHealthResponse = GetAdminSearchHealthResponses[keyof GetAdminSearchHealthResponses]; export type GetAdminDataTransferRecordsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/data-transfer-records"; }; export type GetAdminDataTransferRecordsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminDataTransferRecordsError = GetAdminDataTransferRecordsErrors[keyof GetAdminDataTransferRecordsErrors]; export type GetAdminDataTransferRecordsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a data-transfer-record */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminDataTransferRecordsResponse = GetAdminDataTransferRecordsResponses[keyof GetAdminDataTransferRecordsResponses]; export type PostAdminDataTransferRecordsData = { /** * Request body for the /data-transfer-records operation on data-transfer-record resource */ body: { data: { attributes?: { data_categories?: Array | null; /** * ISO country code of the data destination */ destination_jurisdiction: string; legal_basis?: string | null; /** * ISO country code of the data source (e.g., 'DE', 'US') */ source_jurisdiction: string; transfer_mechanism: "scc" | "bcr" | "adequacy_decision" | "derogation" | "consent"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "data-transfer-record"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/data-transfer-records"; }; export type PostAdminDataTransferRecordsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminDataTransferRecordsError = PostAdminDataTransferRecordsErrors[keyof PostAdminDataTransferRecordsErrors]; export type PostAdminDataTransferRecordsResponses = { /** * Success */ 201: { data?: DataTransferRecord; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminDataTransferRecordsResponse = PostAdminDataTransferRecordsResponses[keyof PostAdminDataTransferRecordsResponses]; export type PatchAdminClinicalClientResourceAssignmentsByIdArchiveData = { /** * Request body for the /clinical/client-resource-assignments/:id/archive operation on clinical-client-resource-assignment resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-client-resource-assignment"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-resource-assignments/{id}/archive"; }; export type PatchAdminClinicalClientResourceAssignmentsByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalClientResourceAssignmentsByIdArchiveError = PatchAdminClinicalClientResourceAssignmentsByIdArchiveErrors[keyof PatchAdminClinicalClientResourceAssignmentsByIdArchiveErrors]; export type PatchAdminClinicalClientResourceAssignmentsByIdArchiveResponses = { /** * Success */ 200: { data?: ClinicalClientResourceAssignment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalClientResourceAssignmentsByIdArchiveResponse = PatchAdminClinicalClientResourceAssignmentsByIdArchiveResponses[keyof PatchAdminClinicalClientResourceAssignmentsByIdArchiveResponses]; export type PatchAdminInvoicesByIdVoidData = { /** * Request body for the /invoices/:id/void operation on invoices-invoice resource */ body?: { data: { attributes?: { voided_reason?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "invoices-invoice"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/{id}/void"; }; export type PatchAdminInvoicesByIdVoidErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvoicesByIdVoidError = PatchAdminInvoicesByIdVoidErrors[keyof PatchAdminInvoicesByIdVoidErrors]; export type PatchAdminInvoicesByIdVoidResponses = { /** * Success */ 200: { data?: InvoicesInvoice; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvoicesByIdVoidResponse = PatchAdminInvoicesByIdVoidResponses[keyof PatchAdminInvoicesByIdVoidResponses]; export type GetAdminSupportRoutingRulesApplicationByApplicationIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { application_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/routing-rules/application/{application_id}"; }; export type GetAdminSupportRoutingRulesApplicationByApplicationIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSupportRoutingRulesApplicationByApplicationIdError = GetAdminSupportRoutingRulesApplicationByApplicationIdErrors[keyof GetAdminSupportRoutingRulesApplicationByApplicationIdErrors]; export type GetAdminSupportRoutingRulesApplicationByApplicationIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a support-routing-rule */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSupportRoutingRulesApplicationByApplicationIdResponse = GetAdminSupportRoutingRulesApplicationByApplicationIdResponses[keyof GetAdminSupportRoutingRulesApplicationByApplicationIdResponses]; export type PostAdminConnectorsFullscriptProductsSearchData = { /** * Request body for the /connectors/fullscript/products/search operation on connector-instance resource */ body: { data: { connector_id: string; query: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/connectors/fullscript/products/search"; }; export type PostAdminConnectorsFullscriptProductsSearchErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsFullscriptProductsSearchError = PostAdminConnectorsFullscriptProductsSearchErrors[keyof PostAdminConnectorsFullscriptProductsSearchErrors]; export type PostAdminConnectorsFullscriptProductsSearchResponses = { /** * Success */ 201: Array<{ [key: string]: unknown; }>; }; export type PostAdminConnectorsFullscriptProductsSearchResponse = PostAdminConnectorsFullscriptProductsSearchResponses[keyof PostAdminConnectorsFullscriptProductsSearchResponses]; export type PostAdminEmailMarketingTemplatesCompileData = { /** * Request body for the /email-marketing/templates/compile operation on email-marketing-template resource */ body: { data: { body_mjml: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/email-marketing/templates/compile"; }; export type PostAdminEmailMarketingTemplatesCompileErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminEmailMarketingTemplatesCompileError = PostAdminEmailMarketingTemplatesCompileErrors[keyof PostAdminEmailMarketingTemplatesCompileErrors]; export type PostAdminEmailMarketingTemplatesCompileResponses = { /** * Success */ 201: { result: { [key: string]: unknown; }; }; }; export type PostAdminEmailMarketingTemplatesCompileResponse = PostAdminEmailMarketingTemplatesCompileResponses[keyof PostAdminEmailMarketingTemplatesCompileResponses]; export type PostAdminSocialCampaignsByIdPreviewAdaptationsData = { /** * Request body for the /social/campaigns/:id/preview-adaptations operation on social-campaign resource */ body: { data: { campaign_id: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/social/campaigns/{id}/preview-adaptations"; }; export type PostAdminSocialCampaignsByIdPreviewAdaptationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSocialCampaignsByIdPreviewAdaptationsError = PostAdminSocialCampaignsByIdPreviewAdaptationsErrors[keyof PostAdminSocialCampaignsByIdPreviewAdaptationsErrors]; export type PostAdminSocialCampaignsByIdPreviewAdaptationsResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminSocialCampaignsByIdPreviewAdaptationsResponse = PostAdminSocialCampaignsByIdPreviewAdaptationsResponses[keyof PostAdminSocialCampaignsByIdPreviewAdaptationsResponses]; export type GetAdminClinicalNotesArchivedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/notes/archived"; }; export type GetAdminClinicalNotesArchivedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalNotesArchivedError = GetAdminClinicalNotesArchivedErrors[keyof GetAdminClinicalNotesArchivedErrors]; export type GetAdminClinicalNotesArchivedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-note */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalNotesArchivedResponse = GetAdminClinicalNotesArchivedResponses[keyof GetAdminClinicalNotesArchivedResponses]; export type GetAdminCaseEntityLinksData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/case-entity-links"; }; export type GetAdminCaseEntityLinksErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCaseEntityLinksError = GetAdminCaseEntityLinksErrors[keyof GetAdminCaseEntityLinksErrors]; export type GetAdminCaseEntityLinksResponses = { /** * Success */ 200: { /** * An array of resource objects representing a case-entity-link */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCaseEntityLinksResponse = GetAdminCaseEntityLinksResponses[keyof GetAdminCaseEntityLinksResponses]; export type PostAdminCaseEntityLinksData = { /** * Request body for the /case-entity-links operation on case-entity-link resource */ body: { data: { attributes?: { case_id: string; entity_id: string; entity_type: "extracted_person" | "extracted_org" | "extracted_location" | "custom"; metadata?: { [key: string]: unknown; } | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "case-entity-link"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/case-entity-links"; }; export type PostAdminCaseEntityLinksErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCaseEntityLinksError = PostAdminCaseEntityLinksErrors[keyof PostAdminCaseEntityLinksErrors]; export type PostAdminCaseEntityLinksResponses = { /** * Success */ 201: { data?: CaseEntityLink; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCaseEntityLinksResponse = PostAdminCaseEntityLinksResponses[keyof PostAdminCaseEntityLinksResponses]; export type GetAdminClinicalPracticeToolsCatalogData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-tools/catalog"; }; export type GetAdminClinicalPracticeToolsCatalogErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPracticeToolsCatalogError = GetAdminClinicalPracticeToolsCatalogErrors[keyof GetAdminClinicalPracticeToolsCatalogErrors]; export type GetAdminClinicalPracticeToolsCatalogResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-practice-tool */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPracticeToolsCatalogResponse = GetAdminClinicalPracticeToolsCatalogResponses[keyof GetAdminClinicalPracticeToolsCatalogResponses]; export type PostAdminClinicalPracticeToolsCatalogData = { /** * Request body for the /clinical/practice-tools/catalog operation on clinical-practice-tool resource */ body: { data: { attributes?: { app_store_url?: string | null; category?: string | null; description?: string | null; icon_url?: string | null; integrations?: Array | null; is_active?: boolean | null; logo_url?: string | null; metadata?: { [key: string]: unknown; } | null; name: string; platform?: string | null; play_store_url?: string | null; pricing_model?: "free" | "freemium" | "paid" | "prescription"; privacy_rating?: "hipaa_compliant" | "hipaa_partial" | "standard" | "unknown"; rating?: string | number | unknown; supported_platforms?: Array | null; tags?: Array | null; tool_type?: string | null; url?: string | null; website_url?: string | null; }; relationships?: { [key: string]: never; }; type?: "clinical-practice-tool"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-tools/catalog"; }; export type PostAdminClinicalPracticeToolsCatalogErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalPracticeToolsCatalogError = PostAdminClinicalPracticeToolsCatalogErrors[keyof PostAdminClinicalPracticeToolsCatalogErrors]; export type PostAdminClinicalPracticeToolsCatalogResponses = { /** * Success */ 201: { data?: ClinicalPracticeTool; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalPracticeToolsCatalogResponse = PostAdminClinicalPracticeToolsCatalogResponses[keyof PostAdminClinicalPracticeToolsCatalogResponses]; export type PatchAdminCasesByIdAssignOwnerData = { /** * Request body for the /cases/:id/assign-owner operation on case resource */ body?: { data: { attributes?: { owner_id?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "case"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/cases/{id}/assign-owner"; }; export type PatchAdminCasesByIdAssignOwnerErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCasesByIdAssignOwnerError = PatchAdminCasesByIdAssignOwnerErrors[keyof PatchAdminCasesByIdAssignOwnerErrors]; export type PatchAdminCasesByIdAssignOwnerResponses = { /** * Success */ 200: { data?: Case; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCasesByIdAssignOwnerResponse = PatchAdminCasesByIdAssignOwnerResponses[keyof PatchAdminCasesByIdAssignOwnerResponses]; export type PostAdminConnectorsFullscriptOrdersGetData = { /** * Request body for the /connectors/fullscript/orders/get operation on connector-instance resource */ body: { data: { connector_id: string; order_id: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/connectors/fullscript/orders/get"; }; export type PostAdminConnectorsFullscriptOrdersGetErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsFullscriptOrdersGetError = PostAdminConnectorsFullscriptOrdersGetErrors[keyof PostAdminConnectorsFullscriptOrdersGetErrors]; export type PostAdminConnectorsFullscriptOrdersGetResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminConnectorsFullscriptOrdersGetResponse = PostAdminConnectorsFullscriptOrdersGetResponses[keyof PostAdminConnectorsFullscriptOrdersGetResponses]; export type PostAdminInvitationsAcceptByTokenData = { /** * Request body for the /invitations/accept-by-token operation on invitation resource */ body: { data: { attributes?: { application_id?: string | null; email?: string | null; token: string; }; relationships?: { [key: string]: never; }; type?: "invitation"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invitations/accept-by-token"; }; export type PostAdminInvitationsAcceptByTokenErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminInvitationsAcceptByTokenError = PostAdminInvitationsAcceptByTokenErrors[keyof PostAdminInvitationsAcceptByTokenErrors]; export type PostAdminInvitationsAcceptByTokenResponses = { /** * Success */ 201: { data?: Invitation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminInvitationsAcceptByTokenResponse = PostAdminInvitationsAcceptByTokenResponses[keyof PostAdminInvitationsAcceptByTokenResponses]; export type PatchAdminNotificationMethodsByIdSendVerificationData = { /** * Request body for the /notification-methods/:id/send-verification operation on notification-method resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "notification-method"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/notification-methods/{id}/send-verification"; }; export type PatchAdminNotificationMethodsByIdSendVerificationErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminNotificationMethodsByIdSendVerificationError = PatchAdminNotificationMethodsByIdSendVerificationErrors[keyof PatchAdminNotificationMethodsByIdSendVerificationErrors]; export type PatchAdminNotificationMethodsByIdSendVerificationResponses = { /** * Success */ 200: { data?: NotificationMethod; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminNotificationMethodsByIdSendVerificationResponse = PatchAdminNotificationMethodsByIdSendVerificationResponses[keyof PatchAdminNotificationMethodsByIdSendVerificationResponses]; export type DeleteAdminCrawlerJobsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/jobs/{id}"; }; export type DeleteAdminCrawlerJobsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrawlerJobsByIdError = DeleteAdminCrawlerJobsByIdErrors[keyof DeleteAdminCrawlerJobsByIdErrors]; export type DeleteAdminCrawlerJobsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCrawlerJobsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/jobs/{id}"; }; export type GetAdminCrawlerJobsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrawlerJobsByIdError = GetAdminCrawlerJobsByIdErrors[keyof GetAdminCrawlerJobsByIdErrors]; export type GetAdminCrawlerJobsByIdResponses = { /** * Success */ 200: { data?: CrawlerJob; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrawlerJobsByIdResponse = GetAdminCrawlerJobsByIdResponses[keyof GetAdminCrawlerJobsByIdResponses]; export type DeleteAdminSupportQueueMembersByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/queue-members/{id}"; }; export type DeleteAdminSupportQueueMembersByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminSupportQueueMembersByIdError = DeleteAdminSupportQueueMembersByIdErrors[keyof DeleteAdminSupportQueueMembersByIdErrors]; export type DeleteAdminSupportQueueMembersByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type PatchAdminSupportQueueMembersByIdData = { /** * Request body for the /support/queue-members/:id operation on support-queue-member resource */ body?: { data: { attributes?: { is_available?: boolean | null; max_concurrent_tickets?: number | null; role?: "agent" | "lead" | "supervisor"; }; id: string; relationships?: { [key: string]: never; }; type?: "support-queue-member"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/queue-members/{id}"; }; export type PatchAdminSupportQueueMembersByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSupportQueueMembersByIdError = PatchAdminSupportQueueMembersByIdErrors[keyof PatchAdminSupportQueueMembersByIdErrors]; export type PatchAdminSupportQueueMembersByIdResponses = { /** * Success */ 200: { data?: SupportQueueMember; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSupportQueueMembersByIdResponse = PatchAdminSupportQueueMembersByIdResponses[keyof PatchAdminSupportQueueMembersByIdResponses]; export type PatchAdminSchedulingEventsByIdCompleteData = { /** * Request body for the /scheduling/events/:id/complete operation on scheduling-event resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "scheduling-event"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/events/{id}/complete"; }; export type PatchAdminSchedulingEventsByIdCompleteErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSchedulingEventsByIdCompleteError = PatchAdminSchedulingEventsByIdCompleteErrors[keyof PatchAdminSchedulingEventsByIdCompleteErrors]; export type PatchAdminSchedulingEventsByIdCompleteResponses = { /** * Success */ 200: { data?: SchedulingEvent; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSchedulingEventsByIdCompleteResponse = PatchAdminSchedulingEventsByIdCompleteResponses[keyof PatchAdminSchedulingEventsByIdCompleteResponses]; export type DeleteAdminConnectorsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/connectors/{id}"; }; export type DeleteAdminConnectorsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminConnectorsByIdError = DeleteAdminConnectorsByIdErrors[keyof DeleteAdminConnectorsByIdErrors]; export type DeleteAdminConnectorsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminConnectorsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/connectors/{id}"; }; export type GetAdminConnectorsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminConnectorsByIdError = GetAdminConnectorsByIdErrors[keyof GetAdminConnectorsByIdErrors]; export type GetAdminConnectorsByIdResponses = { /** * Success */ 200: { data?: ConnectorInstance; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminConnectorsByIdResponse = GetAdminConnectorsByIdResponses[keyof GetAdminConnectorsByIdResponses]; export type PatchAdminConnectorsByIdData = { /** * Request body for the /connectors/:id operation on connector-instance resource */ body?: { data: { attributes?: { /** * Connector-specific configuration (URLs, mappings, etc.) */ config?: { [key: string]: unknown; } | null; enabled?: boolean | null; health_status?: "healthy" | "degraded" | "unhealthy" | "unknown"; metadata?: { [key: string]: unknown; } | null; name?: string | null; sync_interval_minutes?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "connector-instance"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/connectors/{id}"; }; export type PatchAdminConnectorsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminConnectorsByIdError = PatchAdminConnectorsByIdErrors[keyof PatchAdminConnectorsByIdErrors]; export type PatchAdminConnectorsByIdResponses = { /** * Success */ 200: { data?: ConnectorInstance; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminConnectorsByIdResponse = PatchAdminConnectorsByIdResponses[keyof PatchAdminConnectorsByIdResponses]; export type PostAdminContentShortenData = { /** * Request body for the /content/shorten operation on content-generation resource */ body: { data: { max_chars: number; platform?: string | null; text: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/content/shorten"; }; export type PostAdminContentShortenErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminContentShortenError = PostAdminContentShortenErrors[keyof PostAdminContentShortenErrors]; export type PostAdminContentShortenResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminContentShortenResponse = PostAdminContentShortenResponses[keyof PostAdminContentShortenResponses]; export type GetAdminComplianceOfficerDesignationsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/compliance-officer-designations/{id}"; }; export type GetAdminComplianceOfficerDesignationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminComplianceOfficerDesignationsByIdError = GetAdminComplianceOfficerDesignationsByIdErrors[keyof GetAdminComplianceOfficerDesignationsByIdErrors]; export type GetAdminComplianceOfficerDesignationsByIdResponses = { /** * Success */ 200: { data?: ComplianceOfficerDesignation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminComplianceOfficerDesignationsByIdResponse = GetAdminComplianceOfficerDesignationsByIdResponses[keyof GetAdminComplianceOfficerDesignationsByIdResponses]; export type GetAdminEphiAssetsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ephi-assets"; }; export type GetAdminEphiAssetsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEphiAssetsError = GetAdminEphiAssetsErrors[keyof GetAdminEphiAssetsErrors]; export type GetAdminEphiAssetsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a ephi-asset */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEphiAssetsResponse = GetAdminEphiAssetsResponses[keyof GetAdminEphiAssetsResponses]; export type PostAdminEphiAssetsData = { /** * Request body for the /ephi-assets operation on ephi-asset resource */ body: { data: { attributes?: { application_id: string; asset_type: "database" | "application" | "api_service" | "storage" | "network" | "endpoint_device" | "backup_system"; /** * Soft ref to BusinessAssociateAgreement — NOT a DB FK */ baa_document_id?: string | null; baa_status: "in_place" | "needed" | "not_applicable"; classification: "ephi_primary" | "ephi_secondary" | "ephi_transit" | "non_ephi"; /** * Categories of PHI this asset handles */ data_categories?: Array | null; encryption_at_rest: boolean; encryption_in_transit: boolean; last_assessed_at?: string | null; location: "cloud" | "on_premise" | "hybrid"; metadata?: { [key: string]: unknown; } | null; name: string; next_assessment_due?: string | null; notes?: string | null; /** * Responsible person or team */ owner?: string | null; /** * Infrastructure provider (e.g., Google Cloud, AWS) */ provider?: string | null; status?: "active" | "decommissioning" | "decommissioned"; workspace_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "ephi-asset"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ephi-assets"; }; export type PostAdminEphiAssetsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminEphiAssetsError = PostAdminEphiAssetsErrors[keyof PostAdminEphiAssetsErrors]; export type PostAdminEphiAssetsResponses = { /** * Success */ 201: { data?: EphiAsset; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminEphiAssetsResponse = PostAdminEphiAssetsResponses[keyof PostAdminEphiAssetsResponses]; export type PostAdminQuoteRequestsData = { /** * Request body for the /quote-requests operation on invoices-quote-request resource */ body: { data: { attributes?: { expires_at?: unknown; line_items?: Array<{ [key: string]: unknown; }> | null; metadata?: { [key: string]: unknown; } | null; notes?: string | null; requester_contact_id?: string | null; requester_email?: string | null; requester_name?: string | null; status?: "received" | "under_review" | "quoted" | "rejected" | "accepted" | "expired"; submitted_via_form_id?: string | null; submitted_via_submission_id?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "invoices-quote-request"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/quote-requests"; }; export type PostAdminQuoteRequestsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminQuoteRequestsError = PostAdminQuoteRequestsErrors[keyof PostAdminQuoteRequestsErrors]; export type PostAdminQuoteRequestsResponses = { /** * Success */ 201: { data?: InvoicesQuoteRequest; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminQuoteRequestsResponse = PostAdminQuoteRequestsResponses[keyof PostAdminQuoteRequestsResponses]; export type GetAdminSubscriptionsCapabilityRevokedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; application_id?: string; revoked_capability?: string; include_canceled: boolean; }; url: "/admin/subscriptions/capability-revoked"; }; export type GetAdminSubscriptionsCapabilityRevokedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSubscriptionsCapabilityRevokedError = GetAdminSubscriptionsCapabilityRevokedErrors[keyof GetAdminSubscriptionsCapabilityRevokedErrors]; export type GetAdminSubscriptionsCapabilityRevokedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a subscription */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSubscriptionsCapabilityRevokedResponse = GetAdminSubscriptionsCapabilityRevokedResponses[keyof GetAdminSubscriptionsCapabilityRevokedResponses]; export type DeleteAdminQuoteRequestsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/quote-requests/{id}"; }; export type DeleteAdminQuoteRequestsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminQuoteRequestsByIdError = DeleteAdminQuoteRequestsByIdErrors[keyof DeleteAdminQuoteRequestsByIdErrors]; export type DeleteAdminQuoteRequestsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminQuoteRequestsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/quote-requests/{id}"; }; export type GetAdminQuoteRequestsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminQuoteRequestsByIdError = GetAdminQuoteRequestsByIdErrors[keyof GetAdminQuoteRequestsByIdErrors]; export type GetAdminQuoteRequestsByIdResponses = { /** * Success */ 200: { data?: InvoicesQuoteRequest; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminQuoteRequestsByIdResponse = GetAdminQuoteRequestsByIdResponses[keyof GetAdminQuoteRequestsByIdResponses]; export type PatchAdminQuoteRequestsByIdData = { /** * Request body for the /quote-requests/:id operation on invoices-quote-request resource */ body?: { data: { attributes?: { expires_at?: unknown; line_items?: Array<{ [key: string]: unknown; }> | null; metadata?: { [key: string]: unknown; } | null; notes?: string | null; requester_contact_id?: string | null; requester_email?: string | null; requester_name?: string | null; status?: "received" | "under_review" | "quoted" | "rejected" | "accepted" | "expired"; }; id: string; relationships?: { [key: string]: never; }; type?: "invoices-quote-request"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/quote-requests/{id}"; }; export type PatchAdminQuoteRequestsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminQuoteRequestsByIdError = PatchAdminQuoteRequestsByIdErrors[keyof PatchAdminQuoteRequestsByIdErrors]; export type PatchAdminQuoteRequestsByIdResponses = { /** * Success */ 200: { data?: InvoicesQuoteRequest; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminQuoteRequestsByIdResponse = PatchAdminQuoteRequestsByIdResponses[keyof PatchAdminQuoteRequestsByIdResponses]; export type GetAdminSupportChannelCaptureConfigsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/channel-capture-configs/workspace/{workspace_id}"; }; export type GetAdminSupportChannelCaptureConfigsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSupportChannelCaptureConfigsWorkspaceByWorkspaceIdError = GetAdminSupportChannelCaptureConfigsWorkspaceByWorkspaceIdErrors[keyof GetAdminSupportChannelCaptureConfigsWorkspaceByWorkspaceIdErrors]; export type GetAdminSupportChannelCaptureConfigsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a support-channel-capture-config */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSupportChannelCaptureConfigsWorkspaceByWorkspaceIdResponse = GetAdminSupportChannelCaptureConfigsWorkspaceByWorkspaceIdResponses[keyof GetAdminSupportChannelCaptureConfigsWorkspaceByWorkspaceIdResponses]; export type PostAdminWebhookDeliveriesBulkRetryData = { /** * Request body for the /webhook-deliveries/bulk-retry operation on webhook-delivery resource */ body: { data: { ids: Array; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/webhook-deliveries/bulk-retry"; }; export type PostAdminWebhookDeliveriesBulkRetryErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminWebhookDeliveriesBulkRetryError = PostAdminWebhookDeliveriesBulkRetryErrors[keyof PostAdminWebhookDeliveriesBulkRetryErrors]; export type PostAdminWebhookDeliveriesBulkRetryResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminWebhookDeliveriesBulkRetryResponse = PostAdminWebhookDeliveriesBulkRetryResponses[keyof PostAdminWebhookDeliveriesBulkRetryResponses]; export type GetAdminSupportAiConfigsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/ai-configs/workspace/{workspace_id}"; }; export type GetAdminSupportAiConfigsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSupportAiConfigsWorkspaceByWorkspaceIdError = GetAdminSupportAiConfigsWorkspaceByWorkspaceIdErrors[keyof GetAdminSupportAiConfigsWorkspaceByWorkspaceIdErrors]; export type GetAdminSupportAiConfigsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a support-ai-config */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSupportAiConfigsWorkspaceByWorkspaceIdResponse = GetAdminSupportAiConfigsWorkspaceByWorkspaceIdResponses[keyof GetAdminSupportAiConfigsWorkspaceByWorkspaceIdResponses]; export type PostAdminConnectorsByIdHealthiePatientsSyncData = { /** * Request body for the /connectors/:id/healthie/patients/sync operation on connector-instance resource */ body: { data: { connector_id: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/connectors/{id}/healthie/patients/sync"; }; export type PostAdminConnectorsByIdHealthiePatientsSyncErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsByIdHealthiePatientsSyncError = PostAdminConnectorsByIdHealthiePatientsSyncErrors[keyof PostAdminConnectorsByIdHealthiePatientsSyncErrors]; export type PostAdminConnectorsByIdHealthiePatientsSyncResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminConnectorsByIdHealthiePatientsSyncResponse = PostAdminConnectorsByIdHealthiePatientsSyncResponses[keyof PostAdminConnectorsByIdHealthiePatientsSyncResponses]; export type PatchAdminExtractionDocumentsByIdDismissTrainingData = { /** * Request body for the /extraction/documents/:id/dismiss-training operation on extraction-document resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "extraction-document"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/documents/{id}/dismiss-training"; }; export type PatchAdminExtractionDocumentsByIdDismissTrainingErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminExtractionDocumentsByIdDismissTrainingError = PatchAdminExtractionDocumentsByIdDismissTrainingErrors[keyof PatchAdminExtractionDocumentsByIdDismissTrainingErrors]; export type PatchAdminExtractionDocumentsByIdDismissTrainingResponses = { /** * Success */ 200: { data?: ExtractionDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminExtractionDocumentsByIdDismissTrainingResponse = PatchAdminExtractionDocumentsByIdDismissTrainingResponses[keyof PatchAdminExtractionDocumentsByIdDismissTrainingResponses]; export type PatchAdminClinicalClientGoalsByIdArchiveData = { /** * Request body for the /clinical/client-goals/:id/archive operation on clinical-client-goal resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-client-goal"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-goals/{id}/archive"; }; export type PatchAdminClinicalClientGoalsByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalClientGoalsByIdArchiveError = PatchAdminClinicalClientGoalsByIdArchiveErrors[keyof PatchAdminClinicalClientGoalsByIdArchiveErrors]; export type PatchAdminClinicalClientGoalsByIdArchiveResponses = { /** * Success */ 200: { data?: ClinicalClientGoal; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalClientGoalsByIdArchiveResponse = PatchAdminClinicalClientGoalsByIdArchiveResponses[keyof PatchAdminClinicalClientGoalsByIdArchiveResponses]; export type PostAdminSysSemanticCacheClearData = { /** * Request body for the /sys/semantic-cache/clear operation on semantic-cache-entry resource */ body: { data: { attributes?: { confirm: boolean; }; relationships?: { [key: string]: never; }; type?: "semantic-cache-entry"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/sys/semantic-cache/clear"; }; export type PostAdminSysSemanticCacheClearErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSysSemanticCacheClearError = PostAdminSysSemanticCacheClearErrors[keyof PostAdminSysSemanticCacheClearErrors]; export type PostAdminSysSemanticCacheClearResponses = { /** * Success */ 201: { data?: SemanticCacheEntry; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSysSemanticCacheClearResponse = PostAdminSysSemanticCacheClearResponses[keyof PostAdminSysSemanticCacheClearResponses]; export type PostAdminConnectorsFullscriptCheckPatientData = { /** * Request body for the /connectors/fullscript/check-patient operation on connector-instance resource */ body: { data: { connector_id: string; email: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/connectors/fullscript/check-patient"; }; export type PostAdminConnectorsFullscriptCheckPatientErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsFullscriptCheckPatientError = PostAdminConnectorsFullscriptCheckPatientErrors[keyof PostAdminConnectorsFullscriptCheckPatientErrors]; export type PostAdminConnectorsFullscriptCheckPatientResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminConnectorsFullscriptCheckPatientResponse = PostAdminConnectorsFullscriptCheckPatientResponses[keyof PostAdminConnectorsFullscriptCheckPatientResponses]; export type PatchAdminEmailMarketingTemplatesByIdRollbackData = { /** * Request body for the /email-marketing/templates/:id/rollback operation on email-marketing-template resource */ body: { data: { attributes?: { version_number: number; }; id: string; relationships?: { [key: string]: never; }; type?: "email-marketing-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/templates/{id}/rollback"; }; export type PatchAdminEmailMarketingTemplatesByIdRollbackErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailMarketingTemplatesByIdRollbackError = PatchAdminEmailMarketingTemplatesByIdRollbackErrors[keyof PatchAdminEmailMarketingTemplatesByIdRollbackErrors]; export type PatchAdminEmailMarketingTemplatesByIdRollbackResponses = { /** * Success */ 200: { data?: EmailMarketingTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailMarketingTemplatesByIdRollbackResponse = PatchAdminEmailMarketingTemplatesByIdRollbackResponses[keyof PatchAdminEmailMarketingTemplatesByIdRollbackResponses]; export type GetAdminNotificationMethodsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/notification-methods"; }; export type GetAdminNotificationMethodsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminNotificationMethodsError = GetAdminNotificationMethodsErrors[keyof GetAdminNotificationMethodsErrors]; export type GetAdminNotificationMethodsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a notification-method */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminNotificationMethodsResponse = GetAdminNotificationMethodsResponses[keyof GetAdminNotificationMethodsResponses]; export type PostAdminNotificationMethodsData = { /** * Request body for the /notification-methods operation on notification-method resource */ body: { data: { attributes?: { /** * Configuration for the method, e.g. %{email: 'foo@bar.com'} or %{url: '...'} */ config?: { [key: string]: unknown; } | null; /** * User-friendly name, e.g. 'Personal Email' */ name: string; type: "email" | "sms" | "slack_webhook" | "generic_webhook"; user_id: string; }; relationships?: { [key: string]: never; }; type?: "notification-method"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/notification-methods"; }; export type PostAdminNotificationMethodsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminNotificationMethodsError = PostAdminNotificationMethodsErrors[keyof PostAdminNotificationMethodsErrors]; export type PostAdminNotificationMethodsResponses = { /** * Success */ 201: { data?: NotificationMethod; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminNotificationMethodsResponse = PostAdminNotificationMethodsResponses[keyof PostAdminNotificationMethodsResponses]; export type GetAdminSocialTrendingWatchesWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/trending/watches/workspace/{workspace_id}"; }; export type GetAdminSocialTrendingWatchesWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialTrendingWatchesWorkspaceByWorkspaceIdError = GetAdminSocialTrendingWatchesWorkspaceByWorkspaceIdErrors[keyof GetAdminSocialTrendingWatchesWorkspaceByWorkspaceIdErrors]; export type GetAdminSocialTrendingWatchesWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a trending-watch */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialTrendingWatchesWorkspaceByWorkspaceIdResponse = GetAdminSocialTrendingWatchesWorkspaceByWorkspaceIdResponses[keyof GetAdminSocialTrendingWatchesWorkspaceByWorkspaceIdResponses]; export type GetAdminAgentsByIdSchemaVersionsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { /** * Agent ID (automatically mapped from route) */ id: string; }; query?: never; url: "/admin/agents/{id}/schema-versions"; }; export type GetAdminAgentsByIdSchemaVersionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentsByIdSchemaVersionsError = GetAdminAgentsByIdSchemaVersionsErrors[keyof GetAdminAgentsByIdSchemaVersionsErrors]; export type GetAdminAgentsByIdSchemaVersionsResponses = { /** * Success */ 200: { result: { [key: string]: unknown; }; }; }; export type GetAdminAgentsByIdSchemaVersionsResponse = GetAdminAgentsByIdSchemaVersionsResponses[keyof GetAdminAgentsByIdSchemaVersionsResponses]; export type PostAdminAgentsByIdSchemaVersionsData = { /** * Request body for the /agents/:id/schema-versions operation on agent resource */ body: { data: { changes_summary?: string | null; input_schema?: { [key: string]: unknown; } | null; output_schema?: { [key: string]: unknown; } | null; prompt_template: string; version_number: number; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { /** * Agent ID (automatically mapped from route) */ id: string; }; query?: never; url: "/admin/agents/{id}/schema-versions"; }; export type PostAdminAgentsByIdSchemaVersionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAgentsByIdSchemaVersionsError = PostAdminAgentsByIdSchemaVersionsErrors[keyof PostAdminAgentsByIdSchemaVersionsErrors]; export type PostAdminAgentsByIdSchemaVersionsResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminAgentsByIdSchemaVersionsResponse = PostAdminAgentsByIdSchemaVersionsResponses[keyof PostAdminAgentsByIdSchemaVersionsResponses]; export type DeleteAdminPlanFeatureAllocationsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/plan-feature-allocations/{id}"; }; export type DeleteAdminPlanFeatureAllocationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminPlanFeatureAllocationsByIdError = DeleteAdminPlanFeatureAllocationsByIdErrors[keyof DeleteAdminPlanFeatureAllocationsByIdErrors]; export type DeleteAdminPlanFeatureAllocationsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminPlanFeatureAllocationsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/plan-feature-allocations/{id}"; }; export type GetAdminPlanFeatureAllocationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPlanFeatureAllocationsByIdError = GetAdminPlanFeatureAllocationsByIdErrors[keyof GetAdminPlanFeatureAllocationsByIdErrors]; export type GetAdminPlanFeatureAllocationsByIdResponses = { /** * Success */ 200: { data?: PlanFeatureAllocation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPlanFeatureAllocationsByIdResponse = GetAdminPlanFeatureAllocationsByIdResponses[keyof GetAdminPlanFeatureAllocationsByIdResponses]; export type PatchAdminPlanFeatureAllocationsByIdData = { /** * Request body for the /plan-feature-allocations/:id operation on plan-feature-allocation resource */ body?: { data: { attributes?: { /** * One-time credit charge to unlock this feature. nil = free activation. */ activation_cost?: number | null; /** * Override the feature's credit_cost for this plan. nil = use feature default. */ credit_cost?: number | null; /** * Whether this feature is available on this plan */ enabled?: boolean | null; /** * Override the feature's default_limit for this plan. nil = use feature default. */ limit?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "plan-feature-allocation"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/plan-feature-allocations/{id}"; }; export type PatchAdminPlanFeatureAllocationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPlanFeatureAllocationsByIdError = PatchAdminPlanFeatureAllocationsByIdErrors[keyof PatchAdminPlanFeatureAllocationsByIdErrors]; export type PatchAdminPlanFeatureAllocationsByIdResponses = { /** * Success */ 200: { data?: PlanFeatureAllocation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPlanFeatureAllocationsByIdResponse = PatchAdminPlanFeatureAllocationsByIdResponses[keyof PatchAdminPlanFeatureAllocationsByIdResponses]; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdExcludedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; limit?: number; agent_version_id?: string; /** * Version mode: 'active' (default, filter to workspace agent's active version), 'all' (no version filtering) */ version_mode?: string; }; url: "/admin/extraction/documents/workspace/{workspace_id}/excluded"; }; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdExcludedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdExcludedError = GetAdminExtractionDocumentsWorkspaceByWorkspaceIdExcludedErrors[keyof GetAdminExtractionDocumentsWorkspaceByWorkspaceIdExcludedErrors]; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdExcludedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a extraction-document */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionDocumentsWorkspaceByWorkspaceIdExcludedResponse = GetAdminExtractionDocumentsWorkspaceByWorkspaceIdExcludedResponses[keyof GetAdminExtractionDocumentsWorkspaceByWorkspaceIdExcludedResponses]; export type GetAdminBrandIdentitiesByTenantByTenantIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { tenant_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/brand-identities/by-tenant/{tenant_id}"; }; export type GetAdminBrandIdentitiesByTenantByTenantIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminBrandIdentitiesByTenantByTenantIdError = GetAdminBrandIdentitiesByTenantByTenantIdErrors[keyof GetAdminBrandIdentitiesByTenantByTenantIdErrors]; export type GetAdminBrandIdentitiesByTenantByTenantIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a brand-identity */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminBrandIdentitiesByTenantByTenantIdResponse = GetAdminBrandIdentitiesByTenantByTenantIdResponses[keyof GetAdminBrandIdentitiesByTenantByTenantIdResponses]; export type PostAdminRecipesRecipeNutritionsData = { /** * Request body for the /recipes/recipe-nutritions operation on recipes-recipe-nutrition resource */ body: { data: { attributes?: { calories?: number | null; carbs_g?: number | null; fat_g?: number | null; fiber_g?: number | null; full_nutrients?: { [key: string]: unknown; } | null; protein_g?: number | null; recipe_id: string; sodium_mg?: number | null; source?: "computed" | "external" | "manual"; sugar_g?: number | null; }; relationships?: { [key: string]: never; }; type?: "recipes-recipe-nutrition"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/recipe-nutritions"; }; export type PostAdminRecipesRecipeNutritionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminRecipesRecipeNutritionsError = PostAdminRecipesRecipeNutritionsErrors[keyof PostAdminRecipesRecipeNutritionsErrors]; export type PostAdminRecipesRecipeNutritionsResponses = { /** * Success */ 201: { data?: RecipesRecipeNutrition; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminRecipesRecipeNutritionsResponse = PostAdminRecipesRecipeNutritionsResponses[keyof PostAdminRecipesRecipeNutritionsResponses]; export type GetAdminCrmCustomEntitiesWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; type?: string; contact_id?: string; filters?: Array<{ [key: string]: unknown; }>; owner_id?: string; }; url: "/admin/crm/custom-entities/workspace/{workspace_id}"; }; export type GetAdminCrmCustomEntitiesWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmCustomEntitiesWorkspaceByWorkspaceIdError = GetAdminCrmCustomEntitiesWorkspaceByWorkspaceIdErrors[keyof GetAdminCrmCustomEntitiesWorkspaceByWorkspaceIdErrors]; export type GetAdminCrmCustomEntitiesWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crm-custom-entity */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmCustomEntitiesWorkspaceByWorkspaceIdResponse = GetAdminCrmCustomEntitiesWorkspaceByWorkspaceIdResponses[keyof GetAdminCrmCustomEntitiesWorkspaceByWorkspaceIdResponses]; export type PatchAdminSocialCampaignsByIdScheduleData = { /** * Request body for the /social/campaigns/:id/schedule operation on social-campaign resource */ body?: { data: { attributes?: { scheduled_at?: unknown; }; id: string; relationships?: { [key: string]: never; }; type?: "social-campaign"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/campaigns/{id}/schedule"; }; export type PatchAdminSocialCampaignsByIdScheduleErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSocialCampaignsByIdScheduleError = PatchAdminSocialCampaignsByIdScheduleErrors[keyof PatchAdminSocialCampaignsByIdScheduleErrors]; export type PatchAdminSocialCampaignsByIdScheduleResponses = { /** * Success */ 200: { data?: SocialCampaign; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSocialCampaignsByIdScheduleResponse = PatchAdminSocialCampaignsByIdScheduleResponses[keyof PatchAdminSocialCampaignsByIdScheduleResponses]; export type GetAdminClinicalNoteTemplatesCatalogData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/note-templates/catalog"; }; export type GetAdminClinicalNoteTemplatesCatalogErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalNoteTemplatesCatalogError = GetAdminClinicalNoteTemplatesCatalogErrors[keyof GetAdminClinicalNoteTemplatesCatalogErrors]; export type GetAdminClinicalNoteTemplatesCatalogResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-note-template */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalNoteTemplatesCatalogResponse = GetAdminClinicalNoteTemplatesCatalogResponses[keyof GetAdminClinicalNoteTemplatesCatalogResponses]; export type PostAdminClinicalNoteTemplatesCatalogData = { /** * Request body for the /clinical/note-templates/catalog operation on clinical-note-template resource */ body: { data: { attributes?: { category?: string | null; description?: string | null; metadata?: { [key: string]: unknown; } | null; note_type?: "soap" | "adime" | "progress" | "discharge" | "addendum"; sections?: { [key: string]: unknown; } | null; tags?: Array | null; title: string; }; relationships?: { [key: string]: never; }; type?: "clinical-note-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/note-templates/catalog"; }; export type PostAdminClinicalNoteTemplatesCatalogErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalNoteTemplatesCatalogError = PostAdminClinicalNoteTemplatesCatalogErrors[keyof PostAdminClinicalNoteTemplatesCatalogErrors]; export type PostAdminClinicalNoteTemplatesCatalogResponses = { /** * Success */ 201: { data?: ClinicalNoteTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalNoteTemplatesCatalogResponse = PostAdminClinicalNoteTemplatesCatalogResponses[keyof PostAdminClinicalNoteTemplatesCatalogResponses]; export type PatchAdminApiKeysByIdRotateData = { /** * Request body for the /api-keys/:id/rotate operation on api-key resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "api-key"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/api-keys/{id}/rotate"; }; export type PatchAdminApiKeysByIdRotateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminApiKeysByIdRotateError = PatchAdminApiKeysByIdRotateErrors[keyof PatchAdminApiKeysByIdRotateErrors]; export type PatchAdminApiKeysByIdRotateResponses = { /** * Success */ 200: { data?: ApiKey; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminApiKeysByIdRotateResponse = PatchAdminApiKeysByIdRotateResponses[keyof PatchAdminApiKeysByIdRotateResponses]; export type PostAdminRecipesIngredientsData = { /** * Request body for the /recipes/ingredients operation on recipes-ingredient resource */ body: { data: { attributes?: { food_group?: string | null; food_item_id?: string | null; name: string; preparation_note?: string | null; quantity?: number | null; recipe_id: string; sort_order?: number | null; unit?: string | null; }; relationships?: { [key: string]: never; }; type?: "recipes-ingredient"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/ingredients"; }; export type PostAdminRecipesIngredientsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminRecipesIngredientsError = PostAdminRecipesIngredientsErrors[keyof PostAdminRecipesIngredientsErrors]; export type PostAdminRecipesIngredientsResponses = { /** * Success */ 201: { data?: RecipesIngredient; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminRecipesIngredientsResponse = PostAdminRecipesIngredientsResponses[keyof PostAdminRecipesIngredientsResponses]; export type PatchAdminClinicalHealthMetricsByIdArchiveData = { /** * Request body for the /clinical/health-metrics/:id/archive operation on clinical-health-metric resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-health-metric"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/health-metrics/{id}/archive"; }; export type PatchAdminClinicalHealthMetricsByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalHealthMetricsByIdArchiveError = PatchAdminClinicalHealthMetricsByIdArchiveErrors[keyof PatchAdminClinicalHealthMetricsByIdArchiveErrors]; export type PatchAdminClinicalHealthMetricsByIdArchiveResponses = { /** * Success */ 200: { data?: ClinicalHealthMetric; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalHealthMetricsByIdArchiveResponse = PatchAdminClinicalHealthMetricsByIdArchiveResponses[keyof PatchAdminClinicalHealthMetricsByIdArchiveResponses]; export type DeleteAdminEmailInclusionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/inclusions/{id}"; }; export type DeleteAdminEmailInclusionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminEmailInclusionsByIdError = DeleteAdminEmailInclusionsByIdErrors[keyof DeleteAdminEmailInclusionsByIdErrors]; export type DeleteAdminEmailInclusionsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminEmailInclusionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/inclusions/{id}"; }; export type GetAdminEmailInclusionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailInclusionsByIdError = GetAdminEmailInclusionsByIdErrors[keyof GetAdminEmailInclusionsByIdErrors]; export type GetAdminEmailInclusionsByIdResponses = { /** * Success */ 200: { data?: EmailInclusion; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailInclusionsByIdResponse = GetAdminEmailInclusionsByIdResponses[keyof GetAdminEmailInclusionsByIdResponses]; export type PatchAdminEmailInclusionsByIdData = { /** * Request body for the /email/inclusions/:id operation on email-inclusion resource */ body?: { data: { attributes?: { data?: { [key: string]: unknown; } | null; position?: number | null; rendered_html?: string | null; title?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "email-inclusion"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/inclusions/{id}"; }; export type PatchAdminEmailInclusionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailInclusionsByIdError = PatchAdminEmailInclusionsByIdErrors[keyof PatchAdminEmailInclusionsByIdErrors]; export type PatchAdminEmailInclusionsByIdResponses = { /** * Success */ 200: { data?: EmailInclusion; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailInclusionsByIdResponse = PatchAdminEmailInclusionsByIdResponses[keyof PatchAdminEmailInclusionsByIdResponses]; export type GetAdminClinicalPatientsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/patients"; }; export type GetAdminClinicalPatientsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPatientsError = GetAdminClinicalPatientsErrors[keyof GetAdminClinicalPatientsErrors]; export type GetAdminClinicalPatientsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-patient */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPatientsResponse = GetAdminClinicalPatientsResponses[keyof GetAdminClinicalPatientsResponses]; export type PostAdminClinicalPatientsData = { /** * Request body for the /clinical/patients operation on clinical-patient resource */ body: { data: { attributes?: { sex?: string | null; carbs_pct?: string | null; weight_lbs?: string | null; timezone?: string | null; goal_weight_lbs?: string | null; protein_unit?: string | null; profile_data?: { [key: string]: unknown; } | null; enrollment_type?: "initial_consultation" | "transfer" | "group_enrollment" | "readmission"; meals_per_day?: number | null; protein_per_weight?: string | null; referring_physician_name?: string | null; assigned_user_id?: string | null; food_allergies: Array; chief_concern?: string | null; status?: "active" | "inactive" | "archived" | "discharged"; primary_insurance?: string | null; diagnosis_codes: Array; referring_physician_phone?: string | null; external_ids?: { [key: string]: unknown; } | null; contact_id?: string | null; food_aversions: Array; activity_level?: string | null; referring_physician_fax?: string | null; tags?: Array | null; snacks_per_day?: number | null; protein_pct?: string | null; workspace_id: string; date_of_birth?: string | null; eating_style: Array; state?: string | null; conditions: Array; target_calories_override?: number | null; height_inches?: string | null; followup_interval_value?: number | null; referral_source?: "self" | "physician" | "insurance" | "employer_wellness" | "other"; metadata?: { [key: string]: unknown; } | null; surgical_history?: string | null; followup_interval_unit?: string | null; fat_pct?: string | null; preferred_name?: string | null; food_preferences: Array; }; relationships?: { [key: string]: never; }; type?: "clinical-patient"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/patients"; }; export type PostAdminClinicalPatientsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalPatientsError = PostAdminClinicalPatientsErrors[keyof PostAdminClinicalPatientsErrors]; export type PostAdminClinicalPatientsResponses = { /** * Success */ 201: { data?: ClinicalPatient; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalPatientsResponse = PostAdminClinicalPatientsResponses[keyof PostAdminClinicalPatientsResponses]; export type GetAdminUsageEventsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/usage-events/{id}"; }; export type GetAdminUsageEventsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminUsageEventsByIdError = GetAdminUsageEventsByIdErrors[keyof GetAdminUsageEventsByIdErrors]; export type GetAdminUsageEventsByIdResponses = { /** * Success */ 200: { data?: UsageEvent; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminUsageEventsByIdResponse = GetAdminUsageEventsByIdResponses[keyof GetAdminUsageEventsByIdResponses]; export type PatchAdminClinicalPracticeToolsCatalogByIdArchiveData = { /** * Request body for the /clinical/practice-tools/catalog/:id/archive operation on clinical-practice-tool resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-practice-tool"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-tools/catalog/{id}/archive"; }; export type PatchAdminClinicalPracticeToolsCatalogByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalPracticeToolsCatalogByIdArchiveError = PatchAdminClinicalPracticeToolsCatalogByIdArchiveErrors[keyof PatchAdminClinicalPracticeToolsCatalogByIdArchiveErrors]; export type PatchAdminClinicalPracticeToolsCatalogByIdArchiveResponses = { /** * Success */ 200: { data?: ClinicalPracticeTool; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalPracticeToolsCatalogByIdArchiveResponse = PatchAdminClinicalPracticeToolsCatalogByIdArchiveResponses[keyof PatchAdminClinicalPracticeToolsCatalogByIdArchiveResponses]; export type GetAdminSocialAccountsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/accounts/workspace/{workspace_id}"; }; export type GetAdminSocialAccountsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialAccountsWorkspaceByWorkspaceIdError = GetAdminSocialAccountsWorkspaceByWorkspaceIdErrors[keyof GetAdminSocialAccountsWorkspaceByWorkspaceIdErrors]; export type GetAdminSocialAccountsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a social-account */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialAccountsWorkspaceByWorkspaceIdResponse = GetAdminSocialAccountsWorkspaceByWorkspaceIdResponses[keyof GetAdminSocialAccountsWorkspaceByWorkspaceIdResponses]; export type GetAdminClinicalIntakeTargetsActiveByPatientIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { patient_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/intake-targets/active/{patient_id}"; }; export type GetAdminClinicalIntakeTargetsActiveByPatientIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalIntakeTargetsActiveByPatientIdError = GetAdminClinicalIntakeTargetsActiveByPatientIdErrors[keyof GetAdminClinicalIntakeTargetsActiveByPatientIdErrors]; export type GetAdminClinicalIntakeTargetsActiveByPatientIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-intake-target */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalIntakeTargetsActiveByPatientIdResponse = GetAdminClinicalIntakeTargetsActiveByPatientIdResponses[keyof GetAdminClinicalIntakeTargetsActiveByPatientIdResponses]; export type DeleteAdminCasesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/cases/{id}"; }; export type DeleteAdminCasesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCasesByIdError = DeleteAdminCasesByIdErrors[keyof DeleteAdminCasesByIdErrors]; export type DeleteAdminCasesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCasesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/cases/{id}"; }; export type GetAdminCasesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCasesByIdError = GetAdminCasesByIdErrors[keyof GetAdminCasesByIdErrors]; export type GetAdminCasesByIdResponses = { /** * Success */ 200: { data?: Case; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCasesByIdResponse = GetAdminCasesByIdResponses[keyof GetAdminCasesByIdResponses]; export type PatchAdminCasesByIdData = { /** * Request body for the /cases/:id operation on case resource */ body?: { data: { attributes?: { contact_id?: string | null; custom_fields?: { [key: string]: unknown; } | null; deal_id?: string | null; invoice_id?: string | null; owner_id?: string | null; priority?: string | null; sla_due_at?: unknown; summary?: string | null; title?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "case"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/cases/{id}"; }; export type PatchAdminCasesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCasesByIdError = PatchAdminCasesByIdErrors[keyof PatchAdminCasesByIdErrors]; export type PatchAdminCasesByIdResponses = { /** * Success */ 200: { data?: Case; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCasesByIdResponse = PatchAdminCasesByIdResponses[keyof PatchAdminCasesByIdResponses]; export type GetAdminSocialTrendingItemsSnapshotBySnapshotIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { snapshot_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/trending/items/snapshot/{snapshot_id}"; }; export type GetAdminSocialTrendingItemsSnapshotBySnapshotIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialTrendingItemsSnapshotBySnapshotIdError = GetAdminSocialTrendingItemsSnapshotBySnapshotIdErrors[keyof GetAdminSocialTrendingItemsSnapshotBySnapshotIdErrors]; export type GetAdminSocialTrendingItemsSnapshotBySnapshotIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a trending-snapshot-item */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialTrendingItemsSnapshotBySnapshotIdResponse = GetAdminSocialTrendingItemsSnapshotBySnapshotIdResponses[keyof GetAdminSocialTrendingItemsSnapshotBySnapshotIdResponses]; export type DeleteAdminClinicalGoalTemplateCollectionMembershipsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-template-collection-memberships/{id}"; }; export type DeleteAdminClinicalGoalTemplateCollectionMembershipsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalGoalTemplateCollectionMembershipsByIdError = DeleteAdminClinicalGoalTemplateCollectionMembershipsByIdErrors[keyof DeleteAdminClinicalGoalTemplateCollectionMembershipsByIdErrors]; export type DeleteAdminClinicalGoalTemplateCollectionMembershipsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminClinicalGoalTemplateCollectionMembershipsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-template-collection-memberships/{id}"; }; export type GetAdminClinicalGoalTemplateCollectionMembershipsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalGoalTemplateCollectionMembershipsByIdError = GetAdminClinicalGoalTemplateCollectionMembershipsByIdErrors[keyof GetAdminClinicalGoalTemplateCollectionMembershipsByIdErrors]; export type GetAdminClinicalGoalTemplateCollectionMembershipsByIdResponses = { /** * Success */ 200: { data?: ClinicalGoalTemplateCollectionMembership; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalGoalTemplateCollectionMembershipsByIdResponse = GetAdminClinicalGoalTemplateCollectionMembershipsByIdResponses[keyof GetAdminClinicalGoalTemplateCollectionMembershipsByIdResponses]; export type PatchAdminClinicalGoalTemplateCollectionMembershipsByIdData = { /** * Request body for the /clinical/goal-template-collection-memberships/:id operation on clinical-goal-template-collection-membership resource */ body?: { data: { attributes?: { sort_order?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-goal-template-collection-membership"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-template-collection-memberships/{id}"; }; export type PatchAdminClinicalGoalTemplateCollectionMembershipsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalGoalTemplateCollectionMembershipsByIdError = PatchAdminClinicalGoalTemplateCollectionMembershipsByIdErrors[keyof PatchAdminClinicalGoalTemplateCollectionMembershipsByIdErrors]; export type PatchAdminClinicalGoalTemplateCollectionMembershipsByIdResponses = { /** * Success */ 200: { data?: ClinicalGoalTemplateCollectionMembership; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalGoalTemplateCollectionMembershipsByIdResponse = PatchAdminClinicalGoalTemplateCollectionMembershipsByIdResponses[keyof PatchAdminClinicalGoalTemplateCollectionMembershipsByIdResponses]; export type GetAdminCrmDealProductsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/deal-products"; }; export type GetAdminCrmDealProductsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmDealProductsError = GetAdminCrmDealProductsErrors[keyof GetAdminCrmDealProductsErrors]; export type GetAdminCrmDealProductsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crm-deal-product */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmDealProductsResponse = GetAdminCrmDealProductsResponses[keyof GetAdminCrmDealProductsResponses]; export type PostAdminCrmDealProductsData = { /** * Request body for the /crm/deal-products operation on crm-deal-product resource */ body: { data: { attributes?: { deal_id: string; /** * Weak reference to catalog product (not a FK) */ product_id: string; properties?: { [key: string]: unknown; } | null; quantity?: number | null; unit_price?: string | number | unknown; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "crm-deal-product"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/deal-products"; }; export type PostAdminCrmDealProductsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrmDealProductsError = PostAdminCrmDealProductsErrors[keyof PostAdminCrmDealProductsErrors]; export type PostAdminCrmDealProductsResponses = { /** * Success */ 201: { data?: CrmDealProduct; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrmDealProductsResponse = PostAdminCrmDealProductsResponses[keyof PostAdminCrmDealProductsResponses]; export type DeleteAdminAiGraphNodesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ai/graph/nodes/{id}"; }; export type DeleteAdminAiGraphNodesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminAiGraphNodesByIdError = DeleteAdminAiGraphNodesByIdErrors[keyof DeleteAdminAiGraphNodesByIdErrors]; export type DeleteAdminAiGraphNodesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type DeleteAdminBucketsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/buckets/{id}"; }; export type DeleteAdminBucketsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminBucketsByIdError = DeleteAdminBucketsByIdErrors[keyof DeleteAdminBucketsByIdErrors]; export type DeleteAdminBucketsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminBucketsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/buckets/{id}"; }; export type GetAdminBucketsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminBucketsByIdError = GetAdminBucketsByIdErrors[keyof GetAdminBucketsByIdErrors]; export type GetAdminBucketsByIdResponses = { /** * Success */ 200: { data?: Bucket; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminBucketsByIdResponse = GetAdminBucketsByIdResponses[keyof GetAdminBucketsByIdResponses]; export type PatchAdminBucketsByIdData = { /** * Request body for the /buckets/:id operation on bucket resource */ body?: { data: { attributes?: { region?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "bucket"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/buckets/{id}"; }; export type PatchAdminBucketsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminBucketsByIdError = PatchAdminBucketsByIdErrors[keyof PatchAdminBucketsByIdErrors]; export type PatchAdminBucketsByIdResponses = { /** * Success */ 200: { data?: Bucket; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminBucketsByIdResponse = PatchAdminBucketsByIdResponses[keyof PatchAdminBucketsByIdResponses]; export type GetAdminConnectorsByIdHealthieStatusData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query: { connector_id: string; workspace_id: string; }; url: "/admin/connectors/{id}/healthie/status"; }; export type GetAdminConnectorsByIdHealthieStatusErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminConnectorsByIdHealthieStatusError = GetAdminConnectorsByIdHealthieStatusErrors[keyof GetAdminConnectorsByIdHealthieStatusErrors]; export type GetAdminConnectorsByIdHealthieStatusResponses = { /** * Success */ 200: { [key: string]: unknown; }; }; export type GetAdminConnectorsByIdHealthieStatusResponse = GetAdminConnectorsByIdHealthieStatusResponses[keyof GetAdminConnectorsByIdHealthieStatusResponses]; export type PatchAdminSupportTicketsByIdMergeData = { /** * Request body for the /support/tickets/:id/merge operation on support-ticket resource */ body: { data: { attributes?: { merged_ticket_id: string; }; id: string; relationships?: { [key: string]: never; }; type?: "support-ticket"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/tickets/{id}/merge"; }; export type PatchAdminSupportTicketsByIdMergeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSupportTicketsByIdMergeError = PatchAdminSupportTicketsByIdMergeErrors[keyof PatchAdminSupportTicketsByIdMergeErrors]; export type PatchAdminSupportTicketsByIdMergeResponses = { /** * Success */ 200: { data?: SupportTicket; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSupportTicketsByIdMergeResponse = PatchAdminSupportTicketsByIdMergeResponses[keyof PatchAdminSupportTicketsByIdMergeResponses]; export type GetAdminLegalAcceptancesLatestData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; user_id: string; document_type: string; }; url: "/admin/legal-acceptances/latest"; }; export type GetAdminLegalAcceptancesLatestErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminLegalAcceptancesLatestError = GetAdminLegalAcceptancesLatestErrors[keyof GetAdminLegalAcceptancesLatestErrors]; export type GetAdminLegalAcceptancesLatestResponses = { /** * Success */ 200: { /** * An array of resource objects representing a legal-acceptance */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminLegalAcceptancesLatestResponse = GetAdminLegalAcceptancesLatestResponses[keyof GetAdminLegalAcceptancesLatestResponses]; export type GetAdminUsageEventsByUserData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; tenant_id: string; user_id: string; start_date?: unknown; end_date?: unknown; }; url: "/admin/usage-events/by-user"; }; export type GetAdminUsageEventsByUserErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminUsageEventsByUserError = GetAdminUsageEventsByUserErrors[keyof GetAdminUsageEventsByUserErrors]; export type GetAdminUsageEventsByUserResponses = { /** * Success */ 200: { /** * An array of resource objects representing a usage-event */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminUsageEventsByUserResponse = GetAdminUsageEventsByUserResponses[keyof GetAdminUsageEventsByUserResponses]; export type GetAdminConfigsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/configs"; }; export type GetAdminConfigsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminConfigsError = GetAdminConfigsErrors[keyof GetAdminConfigsErrors]; export type GetAdminConfigsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a config */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminConfigsResponse = GetAdminConfigsResponses[keyof GetAdminConfigsResponses]; export type PostAdminConfigsData = { /** * Request body for the /configs operation on config resource */ body: { data: { attributes?: { description?: string | null; /** * Marks this config as containing sensitive data (API keys, secrets, etc.) */ is_sensitive?: boolean | null; key: string; value: string; }; relationships?: { [key: string]: never; }; type?: "config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/configs"; }; export type PostAdminConfigsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConfigsError = PostAdminConfigsErrors[keyof PostAdminConfigsErrors]; export type PostAdminConfigsResponses = { /** * Success */ 201: { data?: Config; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminConfigsResponse = PostAdminConfigsResponses[keyof PostAdminConfigsResponses]; export type GetAdminAgentExecutionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-executions/{id}"; }; export type GetAdminAgentExecutionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentExecutionsByIdError = GetAdminAgentExecutionsByIdErrors[keyof GetAdminAgentExecutionsByIdErrors]; export type GetAdminAgentExecutionsByIdResponses = { /** * Success */ 200: { data?: AgentExecution; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAgentExecutionsByIdResponse = GetAdminAgentExecutionsByIdResponses[keyof GetAdminAgentExecutionsByIdResponses]; export type PatchAdminClinicalClientResourceAssignmentsByIdRestoreData = { /** * Request body for the /clinical/client-resource-assignments/:id/restore operation on clinical-client-resource-assignment resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-client-resource-assignment"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-resource-assignments/{id}/restore"; }; export type PatchAdminClinicalClientResourceAssignmentsByIdRestoreErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalClientResourceAssignmentsByIdRestoreError = PatchAdminClinicalClientResourceAssignmentsByIdRestoreErrors[keyof PatchAdminClinicalClientResourceAssignmentsByIdRestoreErrors]; export type PatchAdminClinicalClientResourceAssignmentsByIdRestoreResponses = { /** * Success */ 200: { data?: ClinicalClientResourceAssignment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalClientResourceAssignmentsByIdRestoreResponse = PatchAdminClinicalClientResourceAssignmentsByIdRestoreResponses[keyof PatchAdminClinicalClientResourceAssignmentsByIdRestoreResponses]; export type DeleteAdminThreadsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/threads/{id}"; }; export type DeleteAdminThreadsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminThreadsByIdError = DeleteAdminThreadsByIdErrors[keyof DeleteAdminThreadsByIdErrors]; export type DeleteAdminThreadsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminThreadsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/threads/{id}"; }; export type GetAdminThreadsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminThreadsByIdError = GetAdminThreadsByIdErrors[keyof GetAdminThreadsByIdErrors]; export type GetAdminThreadsByIdResponses = { /** * Success */ 200: { data?: ChatThread; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminThreadsByIdResponse = GetAdminThreadsByIdResponses[keyof GetAdminThreadsByIdResponses]; export type PatchAdminThreadsByIdData = { /** * Request body for the /threads/:id operation on chat-thread resource */ body?: { data: { attributes?: { context_summary?: string | null; metadata?: { [key: string]: unknown; } | null; title?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "chat-thread"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/threads/{id}"; }; export type PatchAdminThreadsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminThreadsByIdError = PatchAdminThreadsByIdErrors[keyof PatchAdminThreadsByIdErrors]; export type PatchAdminThreadsByIdResponses = { /** * Success */ 200: { data?: ChatThread; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminThreadsByIdResponse = PatchAdminThreadsByIdResponses[keyof PatchAdminThreadsByIdResponses]; export type PostAdminIsvCrmEntityTypesData = { /** * Request body for the /isv/crm/entity-types operation on crm-custom-entity-type resource */ body: { data: { attributes?: { application_id: string; field_definitions?: Array<{ [key: string]: unknown; }> | null; icon?: string | null; /** * Optional alias used as an include key in CRM data exports. When set, this * alias can be passed in the `include` array of a DataExportJob to embed * custom entities of this type into contact exports. If nil, the type is * not available as an export include. Must be unique per application. * Example: a CustomEntityType with slug "client_goals" and include_alias "goals" * allows `include: ["goals"]` in export requests. * */ include_alias?: string | null; name: string; pipelineable?: boolean | null; relationships_config?: { [key: string]: unknown; } | null; searchable?: boolean | null; slug: string; }; relationships?: { [key: string]: never; }; type?: "crm-custom-entity-type"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/isv/crm/entity-types"; }; export type PostAdminIsvCrmEntityTypesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminIsvCrmEntityTypesError = PostAdminIsvCrmEntityTypesErrors[keyof PostAdminIsvCrmEntityTypesErrors]; export type PostAdminIsvCrmEntityTypesResponses = { /** * Success */ 201: { data?: CrmCustomEntityType; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminIsvCrmEntityTypesResponse = PostAdminIsvCrmEntityTypesResponses[keyof PostAdminIsvCrmEntityTypesResponses]; export type GetAdminClinicalHealthMetricsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; patient_id: string; }; url: "/admin/clinical/health-metrics"; }; export type GetAdminClinicalHealthMetricsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalHealthMetricsError = GetAdminClinicalHealthMetricsErrors[keyof GetAdminClinicalHealthMetricsErrors]; export type GetAdminClinicalHealthMetricsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-health-metric */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalHealthMetricsResponse = GetAdminClinicalHealthMetricsResponses[keyof GetAdminClinicalHealthMetricsResponses]; export type PostAdminClinicalHealthMetricsData = { /** * Request body for the /clinical/health-metrics operation on clinical-health-metric resource */ body: { data: { attributes?: { confidence?: string | number | unknown; context_tags?: Array | null; extracted_from?: string | null; measured_at?: unknown; metadata?: { [key: string]: unknown; } | null; metric_category?: string | null; metric_type: string; patient_id: string; pipeline_execution_id?: string | null; raw_extract?: string | null; session_id?: string | null; source?: string | null; unit?: string | null; value_numeric?: string | number | unknown; value_text?: string | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-health-metric"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/health-metrics"; }; export type PostAdminClinicalHealthMetricsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalHealthMetricsError = PostAdminClinicalHealthMetricsErrors[keyof PostAdminClinicalHealthMetricsErrors]; export type PostAdminClinicalHealthMetricsResponses = { /** * Success */ 201: { data?: ClinicalHealthMetric; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalHealthMetricsResponse = PostAdminClinicalHealthMetricsResponses[keyof PostAdminClinicalHealthMetricsResponses]; export type GetAdminClinicalSupplementTemplatesCatalogByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-templates/catalog/{id}"; }; export type GetAdminClinicalSupplementTemplatesCatalogByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalSupplementTemplatesCatalogByIdError = GetAdminClinicalSupplementTemplatesCatalogByIdErrors[keyof GetAdminClinicalSupplementTemplatesCatalogByIdErrors]; export type GetAdminClinicalSupplementTemplatesCatalogByIdResponses = { /** * Success */ 200: { data?: ClinicalSupplementTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalSupplementTemplatesCatalogByIdResponse = GetAdminClinicalSupplementTemplatesCatalogByIdResponses[keyof GetAdminClinicalSupplementTemplatesCatalogByIdResponses]; export type PatchAdminClinicalSupplementTemplatesCatalogByIdData = { /** * Request body for the /clinical/supplement-templates/catalog/:id operation on clinical-supplement-template resource */ body?: { data: { attributes?: { applicable_conditions?: Array | null; category?: string | null; description?: string | null; is_active?: boolean | null; metadata?: { [key: string]: unknown; } | null; name?: string | null; supplements?: Array<{ [key: string]: unknown; }> | null; tags?: Array | null; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-supplement-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-templates/catalog/{id}"; }; export type PatchAdminClinicalSupplementTemplatesCatalogByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalSupplementTemplatesCatalogByIdError = PatchAdminClinicalSupplementTemplatesCatalogByIdErrors[keyof PatchAdminClinicalSupplementTemplatesCatalogByIdErrors]; export type PatchAdminClinicalSupplementTemplatesCatalogByIdResponses = { /** * Success */ 200: { data?: ClinicalSupplementTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalSupplementTemplatesCatalogByIdResponse = PatchAdminClinicalSupplementTemplatesCatalogByIdResponses[keyof PatchAdminClinicalSupplementTemplatesCatalogByIdResponses]; export type GetAdminSupportQueueMembersQueueByQueueIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { queue_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/queue-members/queue/{queue_id}"; }; export type GetAdminSupportQueueMembersQueueByQueueIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSupportQueueMembersQueueByQueueIdError = GetAdminSupportQueueMembersQueueByQueueIdErrors[keyof GetAdminSupportQueueMembersQueueByQueueIdErrors]; export type GetAdminSupportQueueMembersQueueByQueueIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a support-queue-member */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSupportQueueMembersQueueByQueueIdResponse = GetAdminSupportQueueMembersQueueByQueueIdResponses[keyof GetAdminSupportQueueMembersQueueByQueueIdResponses]; export type DeleteAdminSocialTrendingWatchesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/trending/watches/{id}"; }; export type DeleteAdminSocialTrendingWatchesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminSocialTrendingWatchesByIdError = DeleteAdminSocialTrendingWatchesByIdErrors[keyof DeleteAdminSocialTrendingWatchesByIdErrors]; export type DeleteAdminSocialTrendingWatchesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminSocialTrendingWatchesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/trending/watches/{id}"; }; export type GetAdminSocialTrendingWatchesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialTrendingWatchesByIdError = GetAdminSocialTrendingWatchesByIdErrors[keyof GetAdminSocialTrendingWatchesByIdErrors]; export type GetAdminSocialTrendingWatchesByIdResponses = { /** * Success */ 200: { data?: TrendingWatch; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialTrendingWatchesByIdResponse = GetAdminSocialTrendingWatchesByIdResponses[keyof GetAdminSocialTrendingWatchesByIdResponses]; export type PatchAdminSocialTrendingWatchesByIdData = { /** * Request body for the /social/trending/watches/:id operation on trending-watch resource */ body?: { data: { attributes?: { conditions?: { [key: string]: unknown; } | null; enabled?: boolean | null; name?: string | null; notification_config?: { [key: string]: unknown; } | null; query?: string | null; sources?: Array<"twitter" | "reddit" | "linkedin" | "facebook" | "instagram" | "newsapi" | "gnews" | "bing_news"> | null; }; id: string; relationships?: { [key: string]: never; }; type?: "trending-watch"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/trending/watches/{id}"; }; export type PatchAdminSocialTrendingWatchesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSocialTrendingWatchesByIdError = PatchAdminSocialTrendingWatchesByIdErrors[keyof PatchAdminSocialTrendingWatchesByIdErrors]; export type PatchAdminSocialTrendingWatchesByIdResponses = { /** * Success */ 200: { data?: TrendingWatch; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSocialTrendingWatchesByIdResponse = PatchAdminSocialTrendingWatchesByIdResponses[keyof PatchAdminSocialTrendingWatchesByIdResponses]; export type DeleteAdminCrmEmailAddressesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/email-addresses/{id}"; }; export type DeleteAdminCrmEmailAddressesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrmEmailAddressesByIdError = DeleteAdminCrmEmailAddressesByIdErrors[keyof DeleteAdminCrmEmailAddressesByIdErrors]; export type DeleteAdminCrmEmailAddressesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCrmEmailAddressesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/email-addresses/{id}"; }; export type GetAdminCrmEmailAddressesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmEmailAddressesByIdError = GetAdminCrmEmailAddressesByIdErrors[keyof GetAdminCrmEmailAddressesByIdErrors]; export type GetAdminCrmEmailAddressesByIdResponses = { /** * Success */ 200: { data?: CrmEmailAddress; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmEmailAddressesByIdResponse = GetAdminCrmEmailAddressesByIdResponses[keyof GetAdminCrmEmailAddressesByIdResponses]; export type PatchAdminCrmEmailAddressesByIdData = { /** * Request body for the /crm/email-addresses/:id operation on crm-email-address resource */ body?: { data: { attributes?: { email?: string | null; is_primary?: boolean | null; is_verified?: boolean | null; label?: "work" | "personal" | "billing" | "support" | "other"; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-email-address"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/email-addresses/{id}"; }; export type PatchAdminCrmEmailAddressesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmEmailAddressesByIdError = PatchAdminCrmEmailAddressesByIdErrors[keyof PatchAdminCrmEmailAddressesByIdErrors]; export type PatchAdminCrmEmailAddressesByIdResponses = { /** * Success */ 200: { data?: CrmEmailAddress; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmEmailAddressesByIdResponse = PatchAdminCrmEmailAddressesByIdResponses[keyof PatchAdminCrmEmailAddressesByIdResponses]; export type PatchAdminPipelineExecutionsByIdRefineData = { /** * Request body for the /pipeline-executions/:id/refine operation on pipeline-execution resource */ body: { data: { attributes?: { instruction: string; node_id: string; }; id: string; relationships?: { [key: string]: never; }; type?: "pipeline-execution"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pipeline-executions/{id}/refine"; }; export type PatchAdminPipelineExecutionsByIdRefineErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPipelineExecutionsByIdRefineError = PatchAdminPipelineExecutionsByIdRefineErrors[keyof PatchAdminPipelineExecutionsByIdRefineErrors]; export type PatchAdminPipelineExecutionsByIdRefineResponses = { /** * Success */ 200: { data?: PipelineExecution; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPipelineExecutionsByIdRefineResponse = PatchAdminPipelineExecutionsByIdRefineResponses[keyof PatchAdminPipelineExecutionsByIdRefineResponses]; export type PatchAdminWalletAddonsData = { /** * Request body for the /wallet/addons operation on wallet resource */ body: { data: { attributes?: { addon_slug: string; quantity?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "wallet"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/wallet/addons"; }; export type PatchAdminWalletAddonsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminWalletAddonsError = PatchAdminWalletAddonsErrors[keyof PatchAdminWalletAddonsErrors]; export type PatchAdminWalletAddonsResponses = { /** * Success */ 200: { data?: Wallet; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminWalletAddonsResponse = PatchAdminWalletAddonsResponses[keyof PatchAdminWalletAddonsResponses]; export type GetAdminPipelineExecutionsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/pipeline-executions"; }; export type GetAdminPipelineExecutionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPipelineExecutionsError = GetAdminPipelineExecutionsErrors[keyof GetAdminPipelineExecutionsErrors]; export type GetAdminPipelineExecutionsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a pipeline-execution */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPipelineExecutionsResponse = GetAdminPipelineExecutionsResponses[keyof GetAdminPipelineExecutionsResponses]; export type PostAdminCatalogProductVariantsData = { /** * Request body for the /catalog/product-variants operation on catalog-product-variant resource */ body: { data: { attributes?: { media?: Array<{ [key: string]: unknown; }> | null; position?: number | null; price_override?: string | number | unknown; product_id: string; properties?: { [key: string]: unknown; } | null; sku: string; status?: "active" | "archived"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "catalog-product-variant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/product-variants"; }; export type PostAdminCatalogProductVariantsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCatalogProductVariantsError = PostAdminCatalogProductVariantsErrors[keyof PostAdminCatalogProductVariantsErrors]; export type PostAdminCatalogProductVariantsResponses = { /** * Success */ 201: { data?: CatalogProductVariant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCatalogProductVariantsResponse = PostAdminCatalogProductVariantsResponses[keyof PostAdminCatalogProductVariantsResponses]; export type PatchAdminEmailMarketingTemplatesByIdPublishData = { /** * Request body for the /email-marketing/templates/:id/publish operation on email-marketing-template resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "email-marketing-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/templates/{id}/publish"; }; export type PatchAdminEmailMarketingTemplatesByIdPublishErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailMarketingTemplatesByIdPublishError = PatchAdminEmailMarketingTemplatesByIdPublishErrors[keyof PatchAdminEmailMarketingTemplatesByIdPublishErrors]; export type PatchAdminEmailMarketingTemplatesByIdPublishResponses = { /** * Success */ 200: { data?: EmailMarketingTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailMarketingTemplatesByIdPublishResponse = PatchAdminEmailMarketingTemplatesByIdPublishResponses[keyof PatchAdminEmailMarketingTemplatesByIdPublishResponses]; export type GetAdminSocialMetricsAccountBySocialAccountIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { social_account_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/metrics/account/{social_account_id}"; }; export type GetAdminSocialMetricsAccountBySocialAccountIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialMetricsAccountBySocialAccountIdError = GetAdminSocialMetricsAccountBySocialAccountIdErrors[keyof GetAdminSocialMetricsAccountBySocialAccountIdErrors]; export type GetAdminSocialMetricsAccountBySocialAccountIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a post-metric */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialMetricsAccountBySocialAccountIdResponse = GetAdminSocialMetricsAccountBySocialAccountIdResponses[keyof GetAdminSocialMetricsAccountBySocialAccountIdResponses]; export type DeleteAdminMessagesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/messages/{id}"; }; export type DeleteAdminMessagesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminMessagesByIdError = DeleteAdminMessagesByIdErrors[keyof DeleteAdminMessagesByIdErrors]; export type DeleteAdminMessagesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminMessagesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/messages/{id}"; }; export type GetAdminMessagesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminMessagesByIdError = GetAdminMessagesByIdErrors[keyof GetAdminMessagesByIdErrors]; export type GetAdminMessagesByIdResponses = { /** * Success */ 200: { data?: ChatMessage; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminMessagesByIdResponse = GetAdminMessagesByIdResponses[keyof GetAdminMessagesByIdResponses]; export type PatchAdminMessagesByIdData = { /** * Request body for the /messages/:id operation on chat-message resource */ body?: { data: { attributes?: { content?: string | null; metadata?: { [key: string]: unknown; } | null; role?: "user" | "assistant" | "system" | "tool"; }; id: string; relationships?: { [key: string]: never; }; type?: "chat-message"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/messages/{id}"; }; export type PatchAdminMessagesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminMessagesByIdError = PatchAdminMessagesByIdErrors[keyof PatchAdminMessagesByIdErrors]; export type PatchAdminMessagesByIdResponses = { /** * Success */ 200: { data?: ChatMessage; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminMessagesByIdResponse = PatchAdminMessagesByIdResponses[keyof PatchAdminMessagesByIdResponses]; export type DeleteAdminPlatformPricingConfigsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/platform-pricing-configs/{id}"; }; export type DeleteAdminPlatformPricingConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminPlatformPricingConfigsByIdError = DeleteAdminPlatformPricingConfigsByIdErrors[keyof DeleteAdminPlatformPricingConfigsByIdErrors]; export type DeleteAdminPlatformPricingConfigsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminPlatformPricingConfigsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/platform-pricing-configs/{id}"; }; export type GetAdminPlatformPricingConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPlatformPricingConfigsByIdError = GetAdminPlatformPricingConfigsByIdErrors[keyof GetAdminPlatformPricingConfigsByIdErrors]; export type GetAdminPlatformPricingConfigsByIdResponses = { /** * Success */ 200: { data?: PlatformPricingConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPlatformPricingConfigsByIdResponse = GetAdminPlatformPricingConfigsByIdResponses[keyof GetAdminPlatformPricingConfigsByIdResponses]; export type PatchAdminPlatformPricingConfigsByIdData = { /** * Request body for the /platform-pricing-configs/:id operation on platform-pricing-config resource */ body?: { data: { attributes?: { /** * Schedule A category (e.g., 'llm', 'agent', 'extraction', 'communication') */ category?: string | null; /** * Pricing model: 'fixed' (credit rate) or 'passthrough' (provider cost + margin) */ cost_model?: string | null; /** * Default credit rate for this operation. NULL for passthrough (LLM). */ default_rate_credits?: number | null; /** * Human-readable description of this service */ description?: string | null; /** * Human-readable name for admin UI (e.g., 'LLM Input Tokens') */ display_name?: string | null; /** * Minimum price ISVs can charge. NULL means no configured floor. */ floor_price?: { amount: string; currency: string; } | unknown; /** * Platform COGS for this service (e.g., $0.002 per page for OCR) */ hard_cost?: { amount: string; currency: string; } | unknown; /** * Whether this operation incurs charges. False = metered only. */ is_billable?: boolean | null; /** * Minimum margin percentage. NULL means no configured margin. */ margin_percent?: number | null; /** * Additional configuration metadata (e.g., metric unit, operation type) */ metadata?: { [key: string]: unknown; } | null; /** * Schedule A operation key (e.g., 'llm_input_tokens', 'agent_execution_step') */ operation_key?: string | null; /** * Billing unit (e.g., 'per 1K tokens', 'per page', 'per email') */ unit?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "platform-pricing-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/platform-pricing-configs/{id}"; }; export type PatchAdminPlatformPricingConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPlatformPricingConfigsByIdError = PatchAdminPlatformPricingConfigsByIdErrors[keyof PatchAdminPlatformPricingConfigsByIdErrors]; export type PatchAdminPlatformPricingConfigsByIdResponses = { /** * Success */ 200: { data?: PlatformPricingConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPlatformPricingConfigsByIdResponse = PatchAdminPlatformPricingConfigsByIdResponses[keyof PatchAdminPlatformPricingConfigsByIdResponses]; export type DeleteAdminTenantsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants/{id}"; }; export type DeleteAdminTenantsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminTenantsByIdError = DeleteAdminTenantsByIdErrors[keyof DeleteAdminTenantsByIdErrors]; export type DeleteAdminTenantsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminTenantsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants/{id}"; }; export type GetAdminTenantsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminTenantsByIdError = GetAdminTenantsByIdErrors[keyof GetAdminTenantsByIdErrors]; export type GetAdminTenantsByIdResponses = { /** * Success */ 200: { data?: Tenant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminTenantsByIdResponse = GetAdminTenantsByIdResponses[keyof GetAdminTenantsByIdResponses]; export type PatchAdminTenantsByIdData = { /** * Request body for the /tenants/:id operation on tenant resource */ body?: { data: { attributes?: { badge_url?: string | null; contact_email?: string | null; contact_phone?: string | null; description?: string | null; kind?: "platform" | "isv" | "tenant"; logo_url?: string | null; /** * Freeform metadata for ISV-specific configuration (e.g. payout details) */ metadata?: { [key: string]: unknown; } | null; /** * Tenant-level MFA enforcement policy. * * * `:required` — every request scoped to this tenant must present a session * JWT with `mfa_satisfied: true`. Enforced by the * `GptCoreWeb.Plugs.RequireTenantMfa` plug at request time. * * `:user_choice` — defer to per-user opt-in (default) * * Does not support `:tenant_choice` — that would be a cycle. * */ mfa_policy?: "required" | "user_choice"; name?: string | null; parent_id?: string | null; /** * Subscription tier that gates feature access */ plan_tier?: "free" | "pro" | "business" | "enterprise"; /** * Tenant-specific portal configuration overrides (merged over Application portal_defaults) */ portal_overrides?: { [key: string]: unknown; } | null; slug?: string | null; /** * Tenant-set overage ceiling in bytes. nil = use plan max */ storage_spending_cap_bytes?: number | null; /** * Cost in credits for training on a single document */ training_price_credits?: number | null; /** * Memorable slug for vanity URLs */ vanity_slug?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "tenant"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants/{id}"; }; export type PatchAdminTenantsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminTenantsByIdError = PatchAdminTenantsByIdErrors[keyof PatchAdminTenantsByIdErrors]; export type PatchAdminTenantsByIdResponses = { /** * Success */ 200: { data?: Tenant; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminTenantsByIdResponse = PatchAdminTenantsByIdResponses[keyof PatchAdminTenantsByIdResponses]; export type GetAdminCaseTypesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/case-types"; }; export type GetAdminCaseTypesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCaseTypesError = GetAdminCaseTypesErrors[keyof GetAdminCaseTypesErrors]; export type GetAdminCaseTypesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a case-type */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCaseTypesResponse = GetAdminCaseTypesResponses[keyof GetAdminCaseTypesResponses]; export type PostAdminCaseTypesData = { /** * Request body for the /case-types operation on case-type resource */ body: { data: { attributes?: { decision_outcomes?: Array | null; description?: string | null; expected_document_types?: Array | null; grouping_rules?: CaseTypeGroupingRulesInputCreateType; is_active?: boolean | null; name: string; required_reviews?: CaseTypeRequiredReviewsInputCreateType; routing_rules?: CaseTypeRoutingRulesInputCreateType; schema_family_id?: string | null; slug: string; state_machine: CaseTypeStateMachineInputCreateType; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "case-type"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/case-types"; }; export type PostAdminCaseTypesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCaseTypesError = PostAdminCaseTypesErrors[keyof PostAdminCaseTypesErrors]; export type PostAdminCaseTypesResponses = { /** * Success */ 201: { data?: CaseType; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCaseTypesResponse = PostAdminCaseTypesResponses[keyof PostAdminCaseTypesResponses]; export type DeleteAdminCrmFieldDefinitionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/field-definitions/{id}"; }; export type DeleteAdminCrmFieldDefinitionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrmFieldDefinitionsByIdError = DeleteAdminCrmFieldDefinitionsByIdErrors[keyof DeleteAdminCrmFieldDefinitionsByIdErrors]; export type DeleteAdminCrmFieldDefinitionsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCrmFieldDefinitionsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/field-definitions/{id}"; }; export type GetAdminCrmFieldDefinitionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmFieldDefinitionsByIdError = GetAdminCrmFieldDefinitionsByIdErrors[keyof GetAdminCrmFieldDefinitionsByIdErrors]; export type GetAdminCrmFieldDefinitionsByIdResponses = { /** * Success */ 200: { data?: CrmCustomFieldDefinition; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmFieldDefinitionsByIdResponse = GetAdminCrmFieldDefinitionsByIdResponses[keyof GetAdminCrmFieldDefinitionsByIdResponses]; export type PatchAdminCrmFieldDefinitionsByIdData = { /** * Request body for the /crm/field-definitions/:id operation on crm-custom-field-definition resource */ body?: { data: { attributes?: { default_value?: string | null; filterable?: boolean | null; label?: string | null; options?: Array | null; required?: boolean | null; searchable?: boolean | null; sort_order?: number | null; validation_rules?: { [key: string]: unknown; } | null; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-custom-field-definition"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/field-definitions/{id}"; }; export type PatchAdminCrmFieldDefinitionsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmFieldDefinitionsByIdError = PatchAdminCrmFieldDefinitionsByIdErrors[keyof PatchAdminCrmFieldDefinitionsByIdErrors]; export type PatchAdminCrmFieldDefinitionsByIdResponses = { /** * Success */ 200: { data?: CrmCustomFieldDefinition; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmFieldDefinitionsByIdResponse = PatchAdminCrmFieldDefinitionsByIdResponses[keyof PatchAdminCrmFieldDefinitionsByIdResponses]; export type GetAdminRecipesShoppingListsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/shopping-lists/workspace/{workspace_id}"; }; export type GetAdminRecipesShoppingListsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesShoppingListsWorkspaceByWorkspaceIdError = GetAdminRecipesShoppingListsWorkspaceByWorkspaceIdErrors[keyof GetAdminRecipesShoppingListsWorkspaceByWorkspaceIdErrors]; export type GetAdminRecipesShoppingListsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a recipes-shopping-list */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesShoppingListsWorkspaceByWorkspaceIdResponse = GetAdminRecipesShoppingListsWorkspaceByWorkspaceIdResponses[keyof GetAdminRecipesShoppingListsWorkspaceByWorkspaceIdResponses]; export type GetAdminCompositeOperationsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/composite-operations"; }; export type GetAdminCompositeOperationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCompositeOperationsError = GetAdminCompositeOperationsErrors[keyof GetAdminCompositeOperationsErrors]; export type GetAdminCompositeOperationsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a composite-operation */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCompositeOperationsResponse = GetAdminCompositeOperationsResponses[keyof GetAdminCompositeOperationsResponses]; export type PostAdminCompositeOperationsData = { /** * Request body for the /composite-operations operation on composite-operation resource */ body: { data: { attributes?: { /** * Application this composite operation belongs to */ application_id: string; /** * List of {operation_key, quantity, unit} maps that make up this operation */ components?: Array<{ [key: string]: unknown; }> | null; /** * Default LLM model for token cost estimation (e.g., 'gpt-4o') */ default_model?: string | null; /** * Description of what this composite operation does */ description?: string | null; /** * Human-readable name (e.g., 'AI Clinical Notes') */ display_name: string; /** * Whether this operation is visible in the client-facing capacity calculator */ is_public?: boolean | null; /** * Unique key within the application (e.g., 'clinical_note_generation') */ key: string; /** * Display ordering in calculator and dashboards */ sort_order?: number | null; }; relationships?: { [key: string]: never; }; type?: "composite-operation"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/composite-operations"; }; export type PostAdminCompositeOperationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCompositeOperationsError = PostAdminCompositeOperationsErrors[keyof PostAdminCompositeOperationsErrors]; export type PostAdminCompositeOperationsResponses = { /** * Success */ 201: { data?: CompositeOperation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCompositeOperationsResponse = PostAdminCompositeOperationsResponses[keyof PostAdminCompositeOperationsResponses]; export type GetAdminCrmCompaniesWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; owner_id?: string; }; url: "/admin/crm/companies/workspace/{workspace_id}"; }; export type GetAdminCrmCompaniesWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmCompaniesWorkspaceByWorkspaceIdError = GetAdminCrmCompaniesWorkspaceByWorkspaceIdErrors[keyof GetAdminCrmCompaniesWorkspaceByWorkspaceIdErrors]; export type GetAdminCrmCompaniesWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crm-company */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmCompaniesWorkspaceByWorkspaceIdResponse = GetAdminCrmCompaniesWorkspaceByWorkspaceIdResponses[keyof GetAdminCrmCompaniesWorkspaceByWorkspaceIdResponses]; export type PatchAdminPipelineExecutionsByIdCheckpointData = { /** * Request body for the /pipeline-executions/:id/checkpoint operation on pipeline-execution resource */ body?: { data: { attributes?: { checkpoint_data?: { [key: string]: unknown; } | null; }; id: string; relationships?: { [key: string]: never; }; type?: "pipeline-execution"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pipeline-executions/{id}/checkpoint"; }; export type PatchAdminPipelineExecutionsByIdCheckpointErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPipelineExecutionsByIdCheckpointError = PatchAdminPipelineExecutionsByIdCheckpointErrors[keyof PatchAdminPipelineExecutionsByIdCheckpointErrors]; export type PatchAdminPipelineExecutionsByIdCheckpointResponses = { /** * Success */ 200: { data?: PipelineExecution; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPipelineExecutionsByIdCheckpointResponse = PatchAdminPipelineExecutionsByIdCheckpointResponses[keyof PatchAdminPipelineExecutionsByIdCheckpointResponses]; export type GetAdminCrmWebsitesEntityByEntityTypeByEntityIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { entity_type: "contact" | "company"; entity_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/websites/entity/{entity_type}/{entity_id}"; }; export type GetAdminCrmWebsitesEntityByEntityTypeByEntityIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmWebsitesEntityByEntityTypeByEntityIdError = GetAdminCrmWebsitesEntityByEntityTypeByEntityIdErrors[keyof GetAdminCrmWebsitesEntityByEntityTypeByEntityIdErrors]; export type GetAdminCrmWebsitesEntityByEntityTypeByEntityIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crm-website */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmWebsitesEntityByEntityTypeByEntityIdResponse = GetAdminCrmWebsitesEntityByEntityTypeByEntityIdResponses[keyof GetAdminCrmWebsitesEntityByEntityTypeByEntityIdResponses]; export type PostAdminAiChunksSearchData = { /** * Request body for the /ai/chunks/search operation on document-chunk resource */ body: { data: { attributes?: { limit?: number | null; query_embedding: unknown; tenant_id: string; }; relationships?: { [key: string]: never; }; type?: "document-chunk"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ai/chunks/search"; }; export type PostAdminAiChunksSearchErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAiChunksSearchError = PostAdminAiChunksSearchErrors[keyof PostAdminAiChunksSearchErrors]; export type PostAdminAiChunksSearchResponses = { /** * Success */ 201: { data?: DocumentChunk; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAiChunksSearchResponse = PostAdminAiChunksSearchResponses[keyof PostAdminAiChunksSearchResponses]; export type GetAdminStorageFilesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/storage-files"; }; export type GetAdminStorageFilesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminStorageFilesError = GetAdminStorageFilesErrors[keyof GetAdminStorageFilesErrors]; export type GetAdminStorageFilesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a storage-file */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminStorageFilesResponse = GetAdminStorageFilesResponses[keyof GetAdminStorageFilesResponses]; export type PostAdminStorageFilesData = { /** * Request body for the /storage-files operation on storage-file resource */ body: { data: { attributes?: { checksum?: string | null; content_type: string; expires_at?: unknown; filename: string; /** * Forms-runtime linkage to a `GptCore.Forms.Resources.Submission` this upload is scoped to. Nullable UUID, no FK (cross-tier: Storage is Tier 1, Submission is Tier 2). Respondent read access on the Forms side gates through this field. */ linked_submission_id?: string | null; metadata?: { [key: string]: unknown; } | null; namespace: string; origin_domain: string; parent_id?: string | null; s3_bucket: string; s3_key: string; size_bytes: number; source_type: "upload" | "generated" | "ingested" | "cloned"; status?: "active" | "archived" | "pending_deletion" | "quarantined" | "pending_upload"; tags?: Array | null; visibility?: "private" | "workspace" | "tenant" | "public"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "storage-file"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/storage-files"; }; export type PostAdminStorageFilesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminStorageFilesError = PostAdminStorageFilesErrors[keyof PostAdminStorageFilesErrors]; export type PostAdminStorageFilesResponses = { /** * Success */ 201: { data?: StorageFile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminStorageFilesResponse = PostAdminStorageFilesResponses[keyof PostAdminStorageFilesResponses]; export type GetAdminClinicalSessionsByPatientData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; patient_id: string; }; url: "/admin/clinical/sessions/by-patient"; }; export type GetAdminClinicalSessionsByPatientErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalSessionsByPatientError = GetAdminClinicalSessionsByPatientErrors[keyof GetAdminClinicalSessionsByPatientErrors]; export type GetAdminClinicalSessionsByPatientResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-session */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalSessionsByPatientResponse = GetAdminClinicalSessionsByPatientResponses[keyof GetAdminClinicalSessionsByPatientResponses]; export type GetAdminApplicationsBySlugBySlugData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { slug: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/applications/by-slug/{slug}"; }; export type GetAdminApplicationsBySlugBySlugErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminApplicationsBySlugBySlugError = GetAdminApplicationsBySlugBySlugErrors[keyof GetAdminApplicationsBySlugBySlugErrors]; export type GetAdminApplicationsBySlugBySlugResponses = { /** * Success */ 200: { data?: Application; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminApplicationsBySlugBySlugResponse = GetAdminApplicationsBySlugBySlugResponses[keyof GetAdminApplicationsBySlugBySlugResponses]; export type GetAdminSubscriptionsByTenantByTenantIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { tenant_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/subscriptions/by-tenant/{tenant_id}"; }; export type GetAdminSubscriptionsByTenantByTenantIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSubscriptionsByTenantByTenantIdError = GetAdminSubscriptionsByTenantByTenantIdErrors[keyof GetAdminSubscriptionsByTenantByTenantIdErrors]; export type GetAdminSubscriptionsByTenantByTenantIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a subscription */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSubscriptionsByTenantByTenantIdResponse = GetAdminSubscriptionsByTenantByTenantIdResponses[keyof GetAdminSubscriptionsByTenantByTenantIdResponses]; export type GetAdminBucketsAllData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/buckets/all"; }; export type GetAdminBucketsAllErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminBucketsAllError = GetAdminBucketsAllErrors[keyof GetAdminBucketsAllErrors]; export type GetAdminBucketsAllResponses = { /** * Success */ 200: { /** * An array of resource objects representing a bucket */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminBucketsAllResponse = GetAdminBucketsAllResponses[keyof GetAdminBucketsAllResponses]; export type PatchAdminSchedulingEventsByIdCancelData = { /** * Request body for the /scheduling/events/:id/cancel operation on scheduling-event resource */ body?: { data: { attributes?: { cancellation_reason?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "scheduling-event"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/events/{id}/cancel"; }; export type PatchAdminSchedulingEventsByIdCancelErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSchedulingEventsByIdCancelError = PatchAdminSchedulingEventsByIdCancelErrors[keyof PatchAdminSchedulingEventsByIdCancelErrors]; export type PatchAdminSchedulingEventsByIdCancelResponses = { /** * Success */ 200: { data?: SchedulingEvent; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSchedulingEventsByIdCancelResponse = PatchAdminSchedulingEventsByIdCancelResponses[keyof PatchAdminSchedulingEventsByIdCancelResponses]; export type DeleteAdminLegalDocumentsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/legal-documents/{id}"; }; export type DeleteAdminLegalDocumentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminLegalDocumentsByIdError = DeleteAdminLegalDocumentsByIdErrors[keyof DeleteAdminLegalDocumentsByIdErrors]; export type DeleteAdminLegalDocumentsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminLegalDocumentsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/legal-documents/{id}"; }; export type GetAdminLegalDocumentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminLegalDocumentsByIdError = GetAdminLegalDocumentsByIdErrors[keyof GetAdminLegalDocumentsByIdErrors]; export type GetAdminLegalDocumentsByIdResponses = { /** * Success */ 200: { data?: LegalDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminLegalDocumentsByIdResponse = GetAdminLegalDocumentsByIdResponses[keyof GetAdminLegalDocumentsByIdResponses]; export type PatchAdminLegalDocumentsByIdData = { /** * Request body for the /legal-documents/:id operation on legal-document resource */ body?: { data: { attributes?: { active_from?: unknown; active_until?: unknown; content?: string | null; is_active?: boolean | null; locale?: string | null; region?: string | null; requires_acceptance?: boolean | null; title?: string | null; version?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "legal-document"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/legal-documents/{id}"; }; export type PatchAdminLegalDocumentsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminLegalDocumentsByIdError = PatchAdminLegalDocumentsByIdErrors[keyof PatchAdminLegalDocumentsByIdErrors]; export type PatchAdminLegalDocumentsByIdResponses = { /** * Success */ 200: { data?: LegalDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminLegalDocumentsByIdResponse = PatchAdminLegalDocumentsByIdResponses[keyof PatchAdminLegalDocumentsByIdResponses]; export type DeleteAdminPlansByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/plans/{id}"; }; export type DeleteAdminPlansByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminPlansByIdError = DeleteAdminPlansByIdErrors[keyof DeleteAdminPlansByIdErrors]; export type DeleteAdminPlansByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminPlansByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/plans/{id}"; }; export type GetAdminPlansByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPlansByIdError = GetAdminPlansByIdErrors[keyof GetAdminPlansByIdErrors]; export type GetAdminPlansByIdResponses = { /** * Success */ 200: { data?: Plan; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPlansByIdResponse = GetAdminPlansByIdResponses[keyof GetAdminPlansByIdResponses]; export type PatchAdminPlansByIdData = { /** * Request body for the /plans/:id operation on plan resource */ body?: { data: { attributes?: { /** * Explicit acknowledgement that this Plan edit may affect existing * subscribers' renewal terms. Required when ≥ 1 active subscriber exists * and a pricing-relevant attribute is changing. See * `GptCore.Billing.Plan.pricing_relevant_attrs/0` for the gated set. * */ ack_plan_revision?: boolean | null; billing_interval?: number | null; /** * Capability tiers this plan entitles subscribers to */ capability_tiers?: Array<"core" | "standard" | "premium"> | null; /** * Maximum number of concurrent long-running operations a tenant may have * in-flight under this plan (e.g. extraction jobs, batch agent runs). * `nil` means no plan-level limit. When set, must be > 0. * */ concurrent_operations_limit?: number | null; /** * Credits allocated per seat at renewal. nil = falls back to monthly_credits. */ credits_per_seat?: number | null; /** * Optional ISV-configurable Layer 2 dunning cadence override. Nil falls * back to platform defaults. Supported keys: * "retry_days", "soft_suspend_day", "hard_cancel_day", "purge_day", * and "hard_purge_day". * */ dunning_config?: { [key: string]: unknown; } | null; /** * One-time credits granted upon first subscription (Welcome Bonus) */ initial_credits?: number | null; /** * Distinguishes base plans from add-ons */ is_addon?: boolean | null; /** * Maximum number of renewals for free trial (nil = unlimited) */ max_renewals?: number | null; /** * Hard cap on seats before overage. nil = unlimited seats */ max_seats?: number | null; /** * Seats included in the bundle (for display/marketing) */ min_seats?: number | null; monthly_credits?: number | null; monthly_price?: { amount: string; currency: string; } | unknown; name?: string | null; /** * Per-seat price beyond max_seats. nil = overage not allowed (hard cap) */ overage_seat_price?: { amount: string; currency: string; } | unknown; /** * Platform tier this plan maps to. Controls platform-level feature gating. */ plan_tier?: "free" | "pro" | "business" | "enterprise"; /** * Window size in seconds for `rate_limit_requests`. `nil` means no * plan-level rate limit. When set, must be > 0. * */ rate_limit_period_seconds?: number | null; /** * Maximum number of API requests allowed per `rate_limit_period_seconds` * window for tenants subscribed to this plan. `nil` means no plan-level * rate limit (falls back to global default). When set, must be > 0. * * Free-tier plans (`monthly_price` = 0) cannot exceed the platform-wide * ceiling configured via `:platform_free_tier_max_rpm`. * */ rate_limit_requests?: number | null; /** * Operator-supplied reason for editing a Plan with active subscribers. * Required (non-empty, ≤ 280 chars) when `ack_plan_revision: true`. * Written to the `plan_revised_with_active_subscribers` audit row. * */ reason?: string | null; /** * Storage included in plan (bytes). Free=1GB, Pro=10GB, Business=50GB, Enterprise=500GB */ storage_included_bytes?: number | null; /** * Hard ceiling in bytes. Prevents runaway bills. nil = unlimited */ storage_max_bytes?: number | null; /** * Cents per GB-month overage. Free=0 (hard cap), Pro=25, Business=20, Enterprise=15 */ storage_overage_rate_cents?: number | null; type?: "credits" | "storage" | "credits_storage" | "compute" | "seats" | "agents" | "support"; }; id: string; relationships?: { [key: string]: never; }; type?: "plan"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/plans/{id}"; }; export type PatchAdminPlansByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPlansByIdError = PatchAdminPlansByIdErrors[keyof PatchAdminPlansByIdErrors]; export type PatchAdminPlansByIdResponses = { /** * Success */ 200: { data?: Plan; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPlansByIdResponse = PatchAdminPlansByIdResponses[keyof PatchAdminPlansByIdResponses]; export type PatchAdminSchedulingEventTypesByIdArchiveData = { /** * Request body for the /scheduling/event-types/:id/archive operation on scheduling-event-type resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "scheduling-event-type"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/event-types/{id}/archive"; }; export type PatchAdminSchedulingEventTypesByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSchedulingEventTypesByIdArchiveError = PatchAdminSchedulingEventTypesByIdArchiveErrors[keyof PatchAdminSchedulingEventTypesByIdArchiveErrors]; export type PatchAdminSchedulingEventTypesByIdArchiveResponses = { /** * Success */ 200: { data?: SchedulingEventType; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSchedulingEventTypesByIdArchiveResponse = PatchAdminSchedulingEventTypesByIdArchiveResponses[keyof PatchAdminSchedulingEventTypesByIdArchiveResponses]; export type GetAdminLegalAcceptancesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/legal-acceptances"; }; export type GetAdminLegalAcceptancesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminLegalAcceptancesError = GetAdminLegalAcceptancesErrors[keyof GetAdminLegalAcceptancesErrors]; export type GetAdminLegalAcceptancesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a legal-acceptance */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminLegalAcceptancesResponse = GetAdminLegalAcceptancesResponses[keyof GetAdminLegalAcceptancesResponses]; export type PatchAdminSettlementsByIdMarkHeldData = { /** * Request body for the /settlements/:id/mark-held operation on settlement resource */ body?: { data: { attributes?: { hold_days?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "settlement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/settlements/{id}/mark-held"; }; export type PatchAdminSettlementsByIdMarkHeldErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSettlementsByIdMarkHeldError = PatchAdminSettlementsByIdMarkHeldErrors[keyof PatchAdminSettlementsByIdMarkHeldErrors]; export type PatchAdminSettlementsByIdMarkHeldResponses = { /** * Success */ 200: { data?: Settlement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSettlementsByIdMarkHeldResponse = PatchAdminSettlementsByIdMarkHeldResponses[keyof PatchAdminSettlementsByIdMarkHeldResponses]; export type GetAdminBreachNotificationArtifactsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/breach-notification-artifacts"; }; export type GetAdminBreachNotificationArtifactsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminBreachNotificationArtifactsError = GetAdminBreachNotificationArtifactsErrors[keyof GetAdminBreachNotificationArtifactsErrors]; export type GetAdminBreachNotificationArtifactsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a breach-notification-artifact */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminBreachNotificationArtifactsResponse = GetAdminBreachNotificationArtifactsResponses[keyof GetAdminBreachNotificationArtifactsResponses]; export type PostAdminBreachNotificationArtifactsData = { /** * Request body for the /breach-notification-artifacts operation on breach-notification-artifact resource */ body: { data: { attributes?: { artifact_type: "individual_notification" | "hhs_report" | "media_notice" | "state_ag_report"; breach_incident_id: string; /** * Generated notification text */ content: string; metadata?: { [key: string]: unknown; } | null; /** * Number of recipients for individual notifications */ recipient_count?: number | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "breach-notification-artifact"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/breach-notification-artifacts"; }; export type PostAdminBreachNotificationArtifactsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminBreachNotificationArtifactsError = PostAdminBreachNotificationArtifactsErrors[keyof PostAdminBreachNotificationArtifactsErrors]; export type PostAdminBreachNotificationArtifactsResponses = { /** * Success */ 201: { data?: BreachNotificationArtifact; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminBreachNotificationArtifactsResponse = PostAdminBreachNotificationArtifactsResponses[keyof PostAdminBreachNotificationArtifactsResponses]; export type PatchAdminPlansByIdArchiveData = { /** * Request body for the /plans/:id/archive operation on plan resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "plan"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/plans/{id}/archive"; }; export type PatchAdminPlansByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPlansByIdArchiveError = PatchAdminPlansByIdArchiveErrors[keyof PatchAdminPlansByIdArchiveErrors]; export type PatchAdminPlansByIdArchiveResponses = { /** * Success */ 200: { data?: Plan; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPlansByIdArchiveResponse = PatchAdminPlansByIdArchiveResponses[keyof PatchAdminPlansByIdArchiveResponses]; export type PatchAdminUsersByIdResetPasswordData = { /** * Request body for the /users/:id/reset-password operation on user resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "user"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/users/{id}/reset-password"; }; export type PatchAdminUsersByIdResetPasswordErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminUsersByIdResetPasswordError = PatchAdminUsersByIdResetPasswordErrors[keyof PatchAdminUsersByIdResetPasswordErrors]; export type PatchAdminUsersByIdResetPasswordResponses = { /** * Success */ 200: { data?: User; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminUsersByIdResetPasswordResponse = PatchAdminUsersByIdResetPasswordResponses[keyof PatchAdminUsersByIdResetPasswordResponses]; export type GetAdminEphiDataFlowsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ephi-data-flows"; }; export type GetAdminEphiDataFlowsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEphiDataFlowsError = GetAdminEphiDataFlowsErrors[keyof GetAdminEphiDataFlowsErrors]; export type GetAdminEphiDataFlowsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a ephi-data-flow */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEphiDataFlowsResponse = GetAdminEphiDataFlowsResponses[keyof GetAdminEphiDataFlowsResponses]; export type PostAdminEphiDataFlowsData = { /** * Request body for the /ephi-data-flows operation on ephi-data-flow resource */ body: { data: { attributes?: { application_id: string; /** * Categories of PHI flowing between assets */ data_categories?: Array | null; description?: string | null; /** * Soft ref to destination EphiAsset — NOT a DB FK */ destination_asset_id: string; encryption: "encrypted" | "unencrypted" | "partial"; flow_type: "api_call" | "database_replication" | "file_transfer" | "event_stream" | "user_access"; frequency: "real_time" | "batch_daily" | "on_demand" | "scheduled"; is_active?: boolean | null; metadata?: { [key: string]: unknown; } | null; /** * Transport protocol (e.g., HTTPS/TLS 1.3) */ protocol?: string | null; /** * Soft ref to source EphiAsset — NOT a DB FK */ source_asset_id: string; workspace_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "ephi-data-flow"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ephi-data-flows"; }; export type PostAdminEphiDataFlowsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminEphiDataFlowsError = PostAdminEphiDataFlowsErrors[keyof PostAdminEphiDataFlowsErrors]; export type PostAdminEphiDataFlowsResponses = { /** * Success */ 201: { data?: EphiDataFlow; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminEphiDataFlowsResponse = PostAdminEphiDataFlowsResponses[keyof PostAdminEphiDataFlowsResponses]; export type DeleteAdminCrawlerNewsMonitorsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/news-monitors/{id}"; }; export type DeleteAdminCrawlerNewsMonitorsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrawlerNewsMonitorsByIdError = DeleteAdminCrawlerNewsMonitorsByIdErrors[keyof DeleteAdminCrawlerNewsMonitorsByIdErrors]; export type DeleteAdminCrawlerNewsMonitorsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCrawlerNewsMonitorsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/news-monitors/{id}"; }; export type GetAdminCrawlerNewsMonitorsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrawlerNewsMonitorsByIdError = GetAdminCrawlerNewsMonitorsByIdErrors[keyof GetAdminCrawlerNewsMonitorsByIdErrors]; export type GetAdminCrawlerNewsMonitorsByIdResponses = { /** * Success */ 200: { data?: NewsMonitor; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrawlerNewsMonitorsByIdResponse = GetAdminCrawlerNewsMonitorsByIdResponses[keyof GetAdminCrawlerNewsMonitorsByIdResponses]; export type PatchAdminCrawlerNewsMonitorsByIdData = { /** * Request body for the /crawler/news-monitors/:id operation on news-monitor resource */ body?: { data: { attributes?: { frequency?: "daily" | "twice_daily" | "hourly"; metadata?: { [key: string]: unknown; } | null; name?: string | null; source_urls?: Array | null; summary_model?: "default" | "balanced" | "accurate"; tags?: Array | null; topic?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "news-monitor"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/news-monitors/{id}"; }; export type PatchAdminCrawlerNewsMonitorsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrawlerNewsMonitorsByIdError = PatchAdminCrawlerNewsMonitorsByIdErrors[keyof PatchAdminCrawlerNewsMonitorsByIdErrors]; export type PatchAdminCrawlerNewsMonitorsByIdResponses = { /** * Success */ 200: { data?: NewsMonitor; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrawlerNewsMonitorsByIdResponse = PatchAdminCrawlerNewsMonitorsByIdResponses[keyof PatchAdminCrawlerNewsMonitorsByIdResponses]; export type GetAdminMeetingTranscriptsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/meeting-transcripts"; }; export type GetAdminMeetingTranscriptsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminMeetingTranscriptsError = GetAdminMeetingTranscriptsErrors[keyof GetAdminMeetingTranscriptsErrors]; export type GetAdminMeetingTranscriptsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a meeting-transcript */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminMeetingTranscriptsResponse = GetAdminMeetingTranscriptsResponses[keyof GetAdminMeetingTranscriptsResponses]; export type GetAdminSocialAccountsPlatformByPlatformData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { platform: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/accounts/platform/{platform}"; }; export type GetAdminSocialAccountsPlatformByPlatformErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialAccountsPlatformByPlatformError = GetAdminSocialAccountsPlatformByPlatformErrors[keyof GetAdminSocialAccountsPlatformByPlatformErrors]; export type GetAdminSocialAccountsPlatformByPlatformResponses = { /** * Success */ 200: { /** * An array of resource objects representing a social-account */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialAccountsPlatformByPlatformResponse = GetAdminSocialAccountsPlatformByPlatformResponses[keyof GetAdminSocialAccountsPlatformByPlatformResponses]; export type PatchAdminInvitationsByIdAcceptData = { /** * Request body for the /invitations/:id/accept operation on invitation resource */ body: { data: { attributes?: { application_id?: string | null; email?: string | null; token: string; }; id: string; relationships?: { [key: string]: never; }; type?: "invitation"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invitations/{id}/accept"; }; export type PatchAdminInvitationsByIdAcceptErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvitationsByIdAcceptError = PatchAdminInvitationsByIdAcceptErrors[keyof PatchAdminInvitationsByIdAcceptErrors]; export type PatchAdminInvitationsByIdAcceptResponses = { /** * Success */ 200: { data?: Invitation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvitationsByIdAcceptResponse = PatchAdminInvitationsByIdAcceptResponses[keyof PatchAdminInvitationsByIdAcceptResponses]; export type GetAdminFeatureUsagesByTenantByTenantIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { tenant_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/feature-usages/by-tenant/{tenant_id}"; }; export type GetAdminFeatureUsagesByTenantByTenantIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminFeatureUsagesByTenantByTenantIdError = GetAdminFeatureUsagesByTenantByTenantIdErrors[keyof GetAdminFeatureUsagesByTenantByTenantIdErrors]; export type GetAdminFeatureUsagesByTenantByTenantIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a feature-usage */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminFeatureUsagesByTenantByTenantIdResponse = GetAdminFeatureUsagesByTenantByTenantIdResponses[keyof GetAdminFeatureUsagesByTenantByTenantIdResponses]; export type PatchAdminAmendmentRequestsByIdApplyData = { /** * Request body for the /amendment-requests/:id/apply operation on amendment-request resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "amendment-request"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/amendment-requests/{id}/apply"; }; export type PatchAdminAmendmentRequestsByIdApplyErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminAmendmentRequestsByIdApplyError = PatchAdminAmendmentRequestsByIdApplyErrors[keyof PatchAdminAmendmentRequestsByIdApplyErrors]; export type PatchAdminAmendmentRequestsByIdApplyResponses = { /** * Success */ 200: { data?: AmendmentRequest; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminAmendmentRequestsByIdApplyResponse = PatchAdminAmendmentRequestsByIdApplyResponses[keyof PatchAdminAmendmentRequestsByIdApplyResponses]; export type GetAdminExtractionAnalysesByResultByExtractionResultIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { extraction_result_id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/analyses/by-result/{extraction_result_id}"; }; export type GetAdminExtractionAnalysesByResultByExtractionResultIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionAnalysesByResultByExtractionResultIdError = GetAdminExtractionAnalysesByResultByExtractionResultIdErrors[keyof GetAdminExtractionAnalysesByResultByExtractionResultIdErrors]; export type GetAdminExtractionAnalysesByResultByExtractionResultIdResponses = { /** * Success */ 200: { data?: ExtractionAnalysis; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionAnalysesByResultByExtractionResultIdResponse = GetAdminExtractionAnalysesByResultByExtractionResultIdResponses[keyof GetAdminExtractionAnalysesByResultByExtractionResultIdResponses]; export type GetAdminConsentRecordsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/consent-records/{id}"; }; export type GetAdminConsentRecordsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminConsentRecordsByIdError = GetAdminConsentRecordsByIdErrors[keyof GetAdminConsentRecordsByIdErrors]; export type GetAdminConsentRecordsByIdResponses = { /** * Success */ 200: { data?: ConsentRecord; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminConsentRecordsByIdResponse = GetAdminConsentRecordsByIdResponses[keyof GetAdminConsentRecordsByIdResponses]; export type PostAdminSocialTrendingWatchesData = { /** * Request body for the /social/trending/watches operation on trending-watch resource */ body: { data: { attributes?: { conditions?: { [key: string]: unknown; } | null; created_by_id?: string | null; enabled?: boolean | null; name: string; notification_config?: { [key: string]: unknown; } | null; query?: string | null; sources?: Array<"twitter" | "reddit" | "linkedin" | "facebook" | "instagram" | "newsapi" | "gnews" | "bing_news"> | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "trending-watch"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/trending/watches"; }; export type PostAdminSocialTrendingWatchesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSocialTrendingWatchesError = PostAdminSocialTrendingWatchesErrors[keyof PostAdminSocialTrendingWatchesErrors]; export type PostAdminSocialTrendingWatchesResponses = { /** * Success */ 201: { data?: TrendingWatch; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSocialTrendingWatchesResponse = PostAdminSocialTrendingWatchesResponses[keyof PostAdminSocialTrendingWatchesResponses]; export type PatchAdminSchedulingCalendarSyncsByIdPauseData = { /** * Request body for the /scheduling/calendar-syncs/:id/pause operation on scheduling-calendar-sync resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "scheduling-calendar-sync"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/calendar-syncs/{id}/pause"; }; export type PatchAdminSchedulingCalendarSyncsByIdPauseErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSchedulingCalendarSyncsByIdPauseError = PatchAdminSchedulingCalendarSyncsByIdPauseErrors[keyof PatchAdminSchedulingCalendarSyncsByIdPauseErrors]; export type PatchAdminSchedulingCalendarSyncsByIdPauseResponses = { /** * Success */ 200: { data?: SchedulingCalendarSync; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSchedulingCalendarSyncsByIdPauseResponse = PatchAdminSchedulingCalendarSyncsByIdPauseResponses[keyof PatchAdminSchedulingCalendarSyncsByIdPauseResponses]; export type PatchAdminCasesByIdTransitionStateData = { /** * Request body for the /cases/:id/transition-state operation on case resource */ body?: { data: { attributes?: { state?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "case"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/cases/{id}/transition-state"; }; export type PatchAdminCasesByIdTransitionStateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCasesByIdTransitionStateError = PatchAdminCasesByIdTransitionStateErrors[keyof PatchAdminCasesByIdTransitionStateErrors]; export type PatchAdminCasesByIdTransitionStateResponses = { /** * Success */ 200: { data?: Case; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCasesByIdTransitionStateResponse = PatchAdminCasesByIdTransitionStateResponses[keyof PatchAdminCasesByIdTransitionStateResponses]; export type DeleteAdminEmailOutboundEmailsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/outbound-emails/{id}"; }; export type DeleteAdminEmailOutboundEmailsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminEmailOutboundEmailsByIdError = DeleteAdminEmailOutboundEmailsByIdErrors[keyof DeleteAdminEmailOutboundEmailsByIdErrors]; export type DeleteAdminEmailOutboundEmailsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminEmailOutboundEmailsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/outbound-emails/{id}"; }; export type GetAdminEmailOutboundEmailsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailOutboundEmailsByIdError = GetAdminEmailOutboundEmailsByIdErrors[keyof GetAdminEmailOutboundEmailsByIdErrors]; export type GetAdminEmailOutboundEmailsByIdResponses = { /** * Success */ 200: { data?: EmailOutboundEmail; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailOutboundEmailsByIdResponse = GetAdminEmailOutboundEmailsByIdResponses[keyof GetAdminEmailOutboundEmailsByIdResponses]; export type PatchAdminEmailOutboundEmailsByIdData = { /** * Request body for the /email/outbound-emails/:id operation on email-outbound-email resource */ body?: { data: { attributes?: { attachments?: Array<{ [key: string]: unknown; }> | null; body_html?: string | null; body_text?: string | null; include_unsubscribe_link?: boolean | null; sender_profile_id?: string | null; subject?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "email-outbound-email"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/outbound-emails/{id}"; }; export type PatchAdminEmailOutboundEmailsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailOutboundEmailsByIdError = PatchAdminEmailOutboundEmailsByIdErrors[keyof PatchAdminEmailOutboundEmailsByIdErrors]; export type PatchAdminEmailOutboundEmailsByIdResponses = { /** * Success */ 200: { data?: EmailOutboundEmail; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailOutboundEmailsByIdResponse = PatchAdminEmailOutboundEmailsByIdResponses[keyof PatchAdminEmailOutboundEmailsByIdResponses]; export type GetAdminTrainingExamplesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; agent_id?: string; field_name?: string; document_type?: string; inserted_at_gte?: unknown; inserted_at_lte?: unknown; /** * Filter to a specific version */ version_id?: string; /** * Filter to multiple versions */ version_ids?: Array; /** * Version mode: 'active' (default, filter to agent's active version), 'all' (no version filtering) */ version_mode?: string; }; url: "/admin/training-examples"; }; export type GetAdminTrainingExamplesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminTrainingExamplesError = GetAdminTrainingExamplesErrors[keyof GetAdminTrainingExamplesErrors]; export type GetAdminTrainingExamplesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a training-example */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminTrainingExamplesResponse = GetAdminTrainingExamplesResponses[keyof GetAdminTrainingExamplesResponses]; export type PostAdminTrainingExamplesData = { /** * Request body for the /training-examples operation on training-example resource */ body: { data: { attributes?: { agent_id: string; /** * The AI's confidence score for the original extraction (0.0 - 1.0) */ confidence_score?: number | null; /** * The user's corrected value */ corrected_value?: string | null; /** * Structured correction data: fields_changed, reason, original_confidence */ correction_metadata?: { [key: string]: unknown; } | null; /** * Per-field correction reasons: %{field_name => reason_string} */ correction_reasons?: { [key: string]: unknown; } | null; /** * The source document from which this training example was created */ document_id?: string | null; /** * The type of document (e.g., 'Invoice', 'Receipt', 'Contract') */ document_type?: string | null; embedding?: unknown; /** * The field name that was corrected (e.g., 'customer_name', 'total_amount') */ field_name?: string | null; /** * S3 path to the original document image for visual RAG retrieval */ input_image_ref?: string | null; input_text: string; /** * Whether this example was explicitly confirmed by a user */ is_confirmed?: boolean | null; /** * The AI's original extraction value before user correction */ original_value?: string | null; output_json: { [key: string]: unknown; }; /** * General note about these corrections (e.g., 'Poor OCR quality', 'Non-standard date format') */ training_note?: string | null; training_session_id?: string | null; version_id?: string | null; workspace_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "training-example"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/training-examples"; }; export type PostAdminTrainingExamplesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminTrainingExamplesError = PostAdminTrainingExamplesErrors[keyof PostAdminTrainingExamplesErrors]; export type PostAdminTrainingExamplesResponses = { /** * Success */ 201: { data?: TrainingExample; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminTrainingExamplesResponse = PostAdminTrainingExamplesResponses[keyof PostAdminTrainingExamplesResponses]; export type PatchAdminEmailOutboundEmailsByIdScheduleData = { /** * Request body for the /email/outbound-emails/:id/schedule operation on email-outbound-email resource */ body?: { data: { attributes?: { scheduled_for?: unknown; }; id: string; relationships?: { [key: string]: never; }; type?: "email-outbound-email"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/outbound-emails/{id}/schedule"; }; export type PatchAdminEmailOutboundEmailsByIdScheduleErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailOutboundEmailsByIdScheduleError = PatchAdminEmailOutboundEmailsByIdScheduleErrors[keyof PatchAdminEmailOutboundEmailsByIdScheduleErrors]; export type PatchAdminEmailOutboundEmailsByIdScheduleResponses = { /** * Success */ 200: { data?: EmailOutboundEmail; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailOutboundEmailsByIdScheduleResponse = PatchAdminEmailOutboundEmailsByIdScheduleResponses[keyof PatchAdminEmailOutboundEmailsByIdScheduleResponses]; export type DeleteAdminCatalogPriceListsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/price-lists/{id}"; }; export type DeleteAdminCatalogPriceListsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCatalogPriceListsByIdError = DeleteAdminCatalogPriceListsByIdErrors[keyof DeleteAdminCatalogPriceListsByIdErrors]; export type DeleteAdminCatalogPriceListsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCatalogPriceListsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/price-lists/{id}"; }; export type GetAdminCatalogPriceListsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogPriceListsByIdError = GetAdminCatalogPriceListsByIdErrors[keyof GetAdminCatalogPriceListsByIdErrors]; export type GetAdminCatalogPriceListsByIdResponses = { /** * Success */ 200: { data?: CatalogPriceList; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogPriceListsByIdResponse = GetAdminCatalogPriceListsByIdResponses[keyof GetAdminCatalogPriceListsByIdResponses]; export type PatchAdminCatalogPriceListsByIdData = { /** * Request body for the /catalog/price-lists/:id operation on catalog-price-list resource */ body?: { data: { attributes?: { currency?: string | null; default_modifier?: string | number | unknown; name?: string | null; priority?: number | null; slug?: string | null; status?: "active" | "draft" | "expired"; strategy?: "fixed" | "percentage_discount" | "tiered"; valid_from?: unknown; valid_until?: unknown; }; id: string; relationships?: { [key: string]: never; }; type?: "catalog-price-list"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/price-lists/{id}"; }; export type PatchAdminCatalogPriceListsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCatalogPriceListsByIdError = PatchAdminCatalogPriceListsByIdErrors[keyof PatchAdminCatalogPriceListsByIdErrors]; export type PatchAdminCatalogPriceListsByIdResponses = { /** * Success */ 200: { data?: CatalogPriceList; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCatalogPriceListsByIdResponse = PatchAdminCatalogPriceListsByIdResponses[keyof PatchAdminCatalogPriceListsByIdResponses]; export type PostAdminUsersAuthMagicLinkLoginData = { /** * Request body for the /users/auth/magic-link/login operation on user resource */ body: { data: { attributes?: { token: string; }; relationships?: { [key: string]: never; }; type?: "user"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/users/auth/magic-link/login"; }; export type PostAdminUsersAuthMagicLinkLoginErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminUsersAuthMagicLinkLoginError = PostAdminUsersAuthMagicLinkLoginErrors[keyof PostAdminUsersAuthMagicLinkLoginErrors]; export type PostAdminUsersAuthMagicLinkLoginResponses = { /** * Success */ 201: { data?: User; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminUsersAuthMagicLinkLoginResponse = PostAdminUsersAuthMagicLinkLoginResponses[keyof PostAdminUsersAuthMagicLinkLoginResponses]; export type GetAdminApiKeysActiveData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/api-keys/active"; }; export type GetAdminApiKeysActiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminApiKeysActiveError = GetAdminApiKeysActiveErrors[keyof GetAdminApiKeysActiveErrors]; export type GetAdminApiKeysActiveResponses = { /** * Success */ 200: { /** * An array of resource objects representing a api-key */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminApiKeysActiveResponse = GetAdminApiKeysActiveResponses[keyof GetAdminApiKeysActiveResponses]; export type GetAdminCrmCustomEntitiesByEntityIdVersionsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { entity_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/custom-entities/{entity_id}/versions"; }; export type GetAdminCrmCustomEntitiesByEntityIdVersionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmCustomEntitiesByEntityIdVersionsError = GetAdminCrmCustomEntitiesByEntityIdVersionsErrors[keyof GetAdminCrmCustomEntitiesByEntityIdVersionsErrors]; export type GetAdminCrmCustomEntitiesByEntityIdVersionsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crm-custom-entity-version */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmCustomEntitiesByEntityIdVersionsResponse = GetAdminCrmCustomEntitiesByEntityIdVersionsResponses[keyof GetAdminCrmCustomEntitiesByEntityIdVersionsResponses]; export type PatchAdminClinicalClientSupplementsByIdArchiveData = { /** * Request body for the /clinical/client-supplements/:id/archive operation on clinical-client-supplement resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-client-supplement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-supplements/{id}/archive"; }; export type PatchAdminClinicalClientSupplementsByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalClientSupplementsByIdArchiveError = PatchAdminClinicalClientSupplementsByIdArchiveErrors[keyof PatchAdminClinicalClientSupplementsByIdArchiveErrors]; export type PatchAdminClinicalClientSupplementsByIdArchiveResponses = { /** * Success */ 200: { data?: ClinicalClientSupplement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalClientSupplementsByIdArchiveResponse = PatchAdminClinicalClientSupplementsByIdArchiveResponses[keyof PatchAdminClinicalClientSupplementsByIdArchiveResponses]; export type PatchAdminCrmExportsByIdRefreshUrlData = { /** * Request body for the /crm/exports/:id/refresh-url operation on crm-data-export-job resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-data-export-job"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/exports/{id}/refresh-url"; }; export type PatchAdminCrmExportsByIdRefreshUrlErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmExportsByIdRefreshUrlError = PatchAdminCrmExportsByIdRefreshUrlErrors[keyof PatchAdminCrmExportsByIdRefreshUrlErrors]; export type PatchAdminCrmExportsByIdRefreshUrlResponses = { /** * Success */ 200: { data?: CrmDataExportJob; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmExportsByIdRefreshUrlResponse = PatchAdminCrmExportsByIdRefreshUrlResponses[keyof PatchAdminCrmExportsByIdRefreshUrlResponses]; export type PatchAdminCrawlerSchedulesByIdEnableData = { /** * Request body for the /crawler/schedules/:id/enable operation on crawler-schedule resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "crawler-schedule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/schedules/{id}/enable"; }; export type PatchAdminCrawlerSchedulesByIdEnableErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrawlerSchedulesByIdEnableError = PatchAdminCrawlerSchedulesByIdEnableErrors[keyof PatchAdminCrawlerSchedulesByIdEnableErrors]; export type PatchAdminCrawlerSchedulesByIdEnableResponses = { /** * Success */ 200: { data?: CrawlerSchedule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrawlerSchedulesByIdEnableResponse = PatchAdminCrawlerSchedulesByIdEnableResponses[keyof PatchAdminCrawlerSchedulesByIdEnableResponses]; export type GetAdminPostProcessingHooksData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/post-processing-hooks"; }; export type GetAdminPostProcessingHooksErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPostProcessingHooksError = GetAdminPostProcessingHooksErrors[keyof GetAdminPostProcessingHooksErrors]; export type GetAdminPostProcessingHooksResponses = { /** * Success */ 200: { /** * An array of resource objects representing a post-processing-hook */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPostProcessingHooksResponse = GetAdminPostProcessingHooksResponses[keyof GetAdminPostProcessingHooksResponses]; export type PostAdminPostProcessingHooksData = { /** * Request body for the /post-processing-hooks operation on post-processing-hook resource */ body: { data: { attributes?: { /** * Optional application scope. When set, hook only runs for documents from this application. */ application_id?: string | null; /** * Whether webhook response can modify extracted fields (webhook type only) */ can_modify?: boolean | null; /** * Type-specific configuration: * webhook: %{"url" => string, "timeout_ms" => integer, "retry_count" => integer, "headers" => map, "signing_secret" => string} * oban_worker: %{"worker" => string, "queue" => string, "args" => map} * reactor_step: %{"module" => string, "opts" => map} * */ config?: { [key: string]: unknown; } | null; enabled?: boolean | null; /** * Glob patterns for fields that trigger this hook. Empty = all fields. Max 20. */ field_filter?: Array | null; /** * Human-readable hook name */ name: string; /** * Execution order (ascending). Hooks at same order run sequentially. */ order?: number | null; /** * When this hook fires in the extraction lifecycle */ trigger?: "after_extraction" | "after_validation" | "before_downstream"; /** * Execution type: webhook, oban_worker, or reactor_step */ type?: "webhook" | "oban_worker" | "reactor_step"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "post-processing-hook"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/post-processing-hooks"; }; export type PostAdminPostProcessingHooksErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminPostProcessingHooksError = PostAdminPostProcessingHooksErrors[keyof PostAdminPostProcessingHooksErrors]; export type PostAdminPostProcessingHooksResponses = { /** * Success */ 201: { data?: PostProcessingHook; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminPostProcessingHooksResponse = PostAdminPostProcessingHooksResponses[keyof PostAdminPostProcessingHooksResponses]; export type PostAdminAgentsByIdAnalyzeTrainingData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { /** * Agent ID (from URL path parameter) */ id: string; }; query?: never; url: "/admin/agents/{id}/analyze-training"; }; export type PostAdminAgentsByIdAnalyzeTrainingErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAgentsByIdAnalyzeTrainingError = PostAdminAgentsByIdAnalyzeTrainingErrors[keyof PostAdminAgentsByIdAnalyzeTrainingErrors]; export type PostAdminAgentsByIdAnalyzeTrainingResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminAgentsByIdAnalyzeTrainingResponse = PostAdminAgentsByIdAnalyzeTrainingResponses[keyof PostAdminAgentsByIdAnalyzeTrainingResponses]; export type DeleteAdminClinicalPatientInsuranceByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/patient-insurance/{id}"; }; export type DeleteAdminClinicalPatientInsuranceByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalPatientInsuranceByIdError = DeleteAdminClinicalPatientInsuranceByIdErrors[keyof DeleteAdminClinicalPatientInsuranceByIdErrors]; export type DeleteAdminClinicalPatientInsuranceByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminClinicalPatientInsuranceByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/patient-insurance/{id}"; }; export type GetAdminClinicalPatientInsuranceByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPatientInsuranceByIdError = GetAdminClinicalPatientInsuranceByIdErrors[keyof GetAdminClinicalPatientInsuranceByIdErrors]; export type GetAdminClinicalPatientInsuranceByIdResponses = { /** * Success */ 200: { data?: ClinicalPatientInsurance; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPatientInsuranceByIdResponse = GetAdminClinicalPatientInsuranceByIdResponses[keyof GetAdminClinicalPatientInsuranceByIdResponses]; export type PatchAdminClinicalPatientInsuranceByIdData = { /** * Request body for the /clinical/patient-insurance/:id operation on clinical-patient-insurance resource */ body?: { data: { attributes?: { authorization_number?: string | null; carrier_name?: string | null; copay_amount?: string | number | unknown; coverage_end?: string | null; coverage_start?: string | null; group_number?: string | null; member_id?: string | null; metadata?: { [key: string]: unknown; } | null; payer_id?: string | null; plan_name?: string | null; plan_type?: "ppo" | "hmo" | "epo" | "pos" | "hdhp" | "medicaid" | "medicare" | "tricare" | "other"; rank?: "primary" | "secondary" | "tertiary"; status?: "active" | "inactive" | "pending_verification"; subscriber_name?: string | null; subscriber_relationship?: "self" | "spouse" | "child" | "other"; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-patient-insurance"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/patient-insurance/{id}"; }; export type PatchAdminClinicalPatientInsuranceByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalPatientInsuranceByIdError = PatchAdminClinicalPatientInsuranceByIdErrors[keyof PatchAdminClinicalPatientInsuranceByIdErrors]; export type PatchAdminClinicalPatientInsuranceByIdResponses = { /** * Success */ 200: { data?: ClinicalPatientInsurance; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalPatientInsuranceByIdResponse = PatchAdminClinicalPatientInsuranceByIdResponses[keyof PatchAdminClinicalPatientInsuranceByIdResponses]; export type PostAdminCrmRelationshipsData = { /** * Request body for the /crm/relationships operation on crm-relationship resource */ body: { data: { attributes?: { properties?: { [key: string]: unknown; } | null; relationship_type_id: string; source_entity_id: string; source_entity_type: string; strength?: number | null; target_entity_id: string; target_entity_type: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "crm-relationship"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/relationships"; }; export type PostAdminCrmRelationshipsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrmRelationshipsError = PostAdminCrmRelationshipsErrors[keyof PostAdminCrmRelationshipsErrors]; export type PostAdminCrmRelationshipsResponses = { /** * Success */ 201: { data?: CrmRelationship; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrmRelationshipsResponse = PostAdminCrmRelationshipsResponses[keyof PostAdminCrmRelationshipsResponses]; export type PatchAdminPolicyReviewSchedulesByIdMarkDueData = { /** * Request body for the /policy-review-schedules/:id/mark-due operation on policy-review-schedule resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "policy-review-schedule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/policy-review-schedules/{id}/mark-due"; }; export type PatchAdminPolicyReviewSchedulesByIdMarkDueErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPolicyReviewSchedulesByIdMarkDueError = PatchAdminPolicyReviewSchedulesByIdMarkDueErrors[keyof PatchAdminPolicyReviewSchedulesByIdMarkDueErrors]; export type PatchAdminPolicyReviewSchedulesByIdMarkDueResponses = { /** * Success */ 200: { data?: PolicyReviewSchedule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPolicyReviewSchedulesByIdMarkDueResponse = PatchAdminPolicyReviewSchedulesByIdMarkDueResponses[keyof PatchAdminPolicyReviewSchedulesByIdMarkDueResponses]; export type GetAdminSearchAnalyticsSummaryData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/search/analytics/summary"; }; export type GetAdminSearchAnalyticsSummaryErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSearchAnalyticsSummaryError = GetAdminSearchAnalyticsSummaryErrors[keyof GetAdminSearchAnalyticsSummaryErrors]; export type GetAdminSearchAnalyticsSummaryResponses = { /** * Success */ 200: { /** * An array of resource objects representing a search-analytics */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSearchAnalyticsSummaryResponse = GetAdminSearchAnalyticsSummaryResponses[keyof GetAdminSearchAnalyticsSummaryResponses]; export type PostAdminTrainingExamplesBulkData = { /** * Request body for the /training-examples/bulk operation on training-example resource */ body: { data: { agent_id: string; examples: Array<{ [key: string]: unknown; }>; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/training-examples/bulk"; }; export type PostAdminTrainingExamplesBulkErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminTrainingExamplesBulkError = PostAdminTrainingExamplesBulkErrors[keyof PostAdminTrainingExamplesBulkErrors]; export type PostAdminTrainingExamplesBulkResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminTrainingExamplesBulkResponse = PostAdminTrainingExamplesBulkResponses[keyof PostAdminTrainingExamplesBulkResponses]; export type PostAdminContentSeoEnrichData = { /** * Request body for the /content/seo-enrich operation on content-generation resource */ body: { data: { target_keywords: Array; text: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/content/seo-enrich"; }; export type PostAdminContentSeoEnrichErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminContentSeoEnrichError = PostAdminContentSeoEnrichErrors[keyof PostAdminContentSeoEnrichErrors]; export type PostAdminContentSeoEnrichResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminContentSeoEnrichResponse = PostAdminContentSeoEnrichResponses[keyof PostAdminContentSeoEnrichResponses]; export type PostAdminAgentsByIdCloneData = { /** * Request body for the /agents/:id/clone operation on agent resource */ body: { data: { attributes?: { new_name: string; }; relationships?: { [key: string]: never; }; type?: "agent"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { /** * Agent ID (from URL path parameter) */ id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agents/{id}/clone"; }; export type PostAdminAgentsByIdCloneErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAgentsByIdCloneError = PostAdminAgentsByIdCloneErrors[keyof PostAdminAgentsByIdCloneErrors]; export type PostAdminAgentsByIdCloneResponses = { /** * Success */ 201: { data?: Agent; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAgentsByIdCloneResponse = PostAdminAgentsByIdCloneResponses[keyof PostAdminAgentsByIdCloneResponses]; export type GetAdminCrmExportsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/exports/{id}"; }; export type GetAdminCrmExportsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmExportsByIdError = GetAdminCrmExportsByIdErrors[keyof GetAdminCrmExportsByIdErrors]; export type GetAdminCrmExportsByIdResponses = { /** * Success */ 200: { data?: CrmDataExportJob; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmExportsByIdResponse = GetAdminCrmExportsByIdResponses[keyof GetAdminCrmExportsByIdResponses]; export type GetAdminUsageEventsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; tenant_id: string; start_date?: unknown; end_date?: unknown; }; url: "/admin/usage-events"; }; export type GetAdminUsageEventsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminUsageEventsError = GetAdminUsageEventsErrors[keyof GetAdminUsageEventsErrors]; export type GetAdminUsageEventsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a usage-event */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminUsageEventsResponse = GetAdminUsageEventsResponses[keyof GetAdminUsageEventsResponses]; export type GetAdminRecipesScheduledMealsMealScheduleByMealScheduleIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { meal_schedule_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/scheduled-meals/meal-schedule/{meal_schedule_id}"; }; export type GetAdminRecipesScheduledMealsMealScheduleByMealScheduleIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesScheduledMealsMealScheduleByMealScheduleIdError = GetAdminRecipesScheduledMealsMealScheduleByMealScheduleIdErrors[keyof GetAdminRecipesScheduledMealsMealScheduleByMealScheduleIdErrors]; export type GetAdminRecipesScheduledMealsMealScheduleByMealScheduleIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a recipes-scheduled-meal */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesScheduledMealsMealScheduleByMealScheduleIdResponse = GetAdminRecipesScheduledMealsMealScheduleByMealScheduleIdResponses[keyof GetAdminRecipesScheduledMealsMealScheduleByMealScheduleIdResponses]; export type GetAdminSubscriptionsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/subscriptions"; }; export type GetAdminSubscriptionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSubscriptionsError = GetAdminSubscriptionsErrors[keyof GetAdminSubscriptionsErrors]; export type GetAdminSubscriptionsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a subscription */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSubscriptionsResponse = GetAdminSubscriptionsResponses[keyof GetAdminSubscriptionsResponses]; export type PostAdminSubscriptionsData = { /** * Request body for the /subscriptions operation on subscription resource */ body: { data: { attributes?: { billing_interval?: number | null; current_period_end?: unknown; customer_id: string; is_addon?: boolean | null; monthly_credits?: number | null; monthly_price?: { amount: string; currency: string; } | unknown; overage_seats?: number | null; pending_plan_id?: string | null; plan_id: string; promotional_months?: number | null; promotional_months_used?: number | null; promotional_price?: { amount: string; currency: string; } | unknown; quantity?: number | null; renewal_count?: number | null; status?: "active" | "past_due" | "canceled" | "incomplete" | "pending_cancellation" | "downgrade_scheduled" | "capability_revoked_grace" | "canceled_capability_revoked"; type?: "credits" | "storage" | "credits_storage" | "compute" | "seats" | "agents" | "support"; }; relationships?: { [key: string]: never; }; type?: "subscription"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/subscriptions"; }; export type PostAdminSubscriptionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSubscriptionsError = PostAdminSubscriptionsErrors[keyof PostAdminSubscriptionsErrors]; export type PostAdminSubscriptionsResponses = { /** * Success */ 201: { data?: Subscription; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSubscriptionsResponse = PostAdminSubscriptionsResponses[keyof PostAdminSubscriptionsResponses]; export type PostAdminWebhookConfigsByIdTestData = { /** * Request body for the /webhook-configs/:id/test operation on webhook-config resource */ body?: { data: { attributes?: { [key: string]: never; }; relationships?: { [key: string]: never; }; type?: "webhook-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/webhook-configs/{id}/test"; }; export type PostAdminWebhookConfigsByIdTestErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminWebhookConfigsByIdTestError = PostAdminWebhookConfigsByIdTestErrors[keyof PostAdminWebhookConfigsByIdTestErrors]; export type PostAdminWebhookConfigsByIdTestResponses = { /** * Success */ 201: { data?: WebhookConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminWebhookConfigsByIdTestResponse = PostAdminWebhookConfigsByIdTestResponses[keyof PostAdminWebhookConfigsByIdTestResponses]; export type DeleteAdminCrmCompaniesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/companies/{id}"; }; export type DeleteAdminCrmCompaniesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrmCompaniesByIdError = DeleteAdminCrmCompaniesByIdErrors[keyof DeleteAdminCrmCompaniesByIdErrors]; export type DeleteAdminCrmCompaniesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCrmCompaniesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/companies/{id}"; }; export type GetAdminCrmCompaniesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmCompaniesByIdError = GetAdminCrmCompaniesByIdErrors[keyof GetAdminCrmCompaniesByIdErrors]; export type GetAdminCrmCompaniesByIdResponses = { /** * Success */ 200: { data?: CrmCompany; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmCompaniesByIdResponse = GetAdminCrmCompaniesByIdResponses[keyof GetAdminCrmCompaniesByIdResponses]; export type PatchAdminCrmCompaniesByIdData = { /** * Request body for the /crm/companies/:id operation on crm-company resource */ body?: { data: { attributes?: { annual_revenue?: string | number | unknown; description?: string | null; domain?: string | null; employee_count?: number | null; external_owner_id?: string | null; founded_date?: string | null; industry?: string | null; lifecycle_stage?: "lead" | "marketing_qualified" | "sales_qualified" | "opportunity" | "customer" | "evangelist" | "churned" | "discharged"; location?: string | null; name?: string | null; owner_id?: string | null; properties?: { [key: string]: unknown; } | null; /** * VAT/EIN for invoicing cross-domain use */ tax_id?: string | null; type?: "public" | "private" | "nonprofit" | "government" | "partnership" | "other"; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-company"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/companies/{id}"; }; export type PatchAdminCrmCompaniesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmCompaniesByIdError = PatchAdminCrmCompaniesByIdErrors[keyof PatchAdminCrmCompaniesByIdErrors]; export type PatchAdminCrmCompaniesByIdResponses = { /** * Success */ 200: { data?: CrmCompany; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmCompaniesByIdResponse = PatchAdminCrmCompaniesByIdResponses[keyof PatchAdminCrmCompaniesByIdResponses]; export type PatchAdminCrawlerBrowserSessionsByIdRefreshData = { /** * Request body for the /crawler/browser-sessions/:id/refresh operation on browser-session resource */ body?: { data: { attributes?: { session_state?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "browser-session"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/browser-sessions/{id}/refresh"; }; export type PatchAdminCrawlerBrowserSessionsByIdRefreshErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrawlerBrowserSessionsByIdRefreshError = PatchAdminCrawlerBrowserSessionsByIdRefreshErrors[keyof PatchAdminCrawlerBrowserSessionsByIdRefreshErrors]; export type PatchAdminCrawlerBrowserSessionsByIdRefreshResponses = { /** * Success */ 200: { data?: BrowserSession; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrawlerBrowserSessionsByIdRefreshResponse = PatchAdminCrawlerBrowserSessionsByIdRefreshResponses[keyof PatchAdminCrawlerBrowserSessionsByIdRefreshResponses]; export type DeleteAdminSupportCannedResponsesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/canned-responses/{id}"; }; export type DeleteAdminSupportCannedResponsesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminSupportCannedResponsesByIdError = DeleteAdminSupportCannedResponsesByIdErrors[keyof DeleteAdminSupportCannedResponsesByIdErrors]; export type DeleteAdminSupportCannedResponsesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type PatchAdminSupportCannedResponsesByIdData = { /** * Request body for the /support/canned-responses/:id operation on support-canned-response resource */ body?: { data: { attributes?: { category?: string | null; content?: string | null; name?: string | null; shortcut?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "support-canned-response"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/canned-responses/{id}"; }; export type PatchAdminSupportCannedResponsesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSupportCannedResponsesByIdError = PatchAdminSupportCannedResponsesByIdErrors[keyof PatchAdminSupportCannedResponsesByIdErrors]; export type PatchAdminSupportCannedResponsesByIdResponses = { /** * Success */ 200: { data?: SupportCannedResponse; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSupportCannedResponsesByIdResponse = PatchAdminSupportCannedResponsesByIdResponses[keyof PatchAdminSupportCannedResponsesByIdResponses]; export type PostAdminAgentVersionComparisonsData = { /** * Request body for the /agent-version-comparisons operation on agent-version-comparison resource */ body: { data: { attributes?: { version_a_id: string; version_b_id: string; }; relationships?: { [key: string]: never; }; type?: "agent-version-comparison"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agent-version-comparisons"; }; export type PostAdminAgentVersionComparisonsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAgentVersionComparisonsError = PostAdminAgentVersionComparisonsErrors[keyof PostAdminAgentVersionComparisonsErrors]; export type PostAdminAgentVersionComparisonsResponses = { /** * Success */ 201: { data?: AgentVersionComparison; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAgentVersionComparisonsResponse = PostAdminAgentVersionComparisonsResponses[keyof PostAdminAgentVersionComparisonsResponses]; export type GetAdminStorageRecommendationsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/storage-recommendations"; }; export type GetAdminStorageRecommendationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminStorageRecommendationsError = GetAdminStorageRecommendationsErrors[keyof GetAdminStorageRecommendationsErrors]; export type GetAdminStorageRecommendationsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a storage-recommendation */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminStorageRecommendationsResponse = GetAdminStorageRecommendationsResponses[keyof GetAdminStorageRecommendationsResponses]; export type GetAdminClinicalPatientsByIdInsuranceRecordsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/patients/{id}/insurance_records"; }; export type GetAdminClinicalPatientsByIdInsuranceRecordsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPatientsByIdInsuranceRecordsError = GetAdminClinicalPatientsByIdInsuranceRecordsErrors[keyof GetAdminClinicalPatientsByIdInsuranceRecordsErrors]; export type GetAdminClinicalPatientsByIdInsuranceRecordsResponses = { /** * Success */ 200: { data?: ClinicalPatientInsurance; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPatientsByIdInsuranceRecordsResponse = GetAdminClinicalPatientsByIdInsuranceRecordsResponses[keyof GetAdminClinicalPatientsByIdInsuranceRecordsResponses]; export type DeleteAdminInvoicesContactsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/contacts/{id}"; }; export type DeleteAdminInvoicesContactsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminInvoicesContactsByIdError = DeleteAdminInvoicesContactsByIdErrors[keyof DeleteAdminInvoicesContactsByIdErrors]; export type DeleteAdminInvoicesContactsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminInvoicesContactsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/contacts/{id}"; }; export type GetAdminInvoicesContactsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminInvoicesContactsByIdError = GetAdminInvoicesContactsByIdErrors[keyof GetAdminInvoicesContactsByIdErrors]; export type GetAdminInvoicesContactsByIdResponses = { /** * Success */ 200: { data?: InvoicesContact; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminInvoicesContactsByIdResponse = GetAdminInvoicesContactsByIdResponses[keyof GetAdminInvoicesContactsByIdResponses]; export type PatchAdminInvoicesContactsByIdData = { /** * Request body for the /invoices/contacts/:id operation on invoices-contact resource */ body?: { data: { attributes?: { email?: string | null; metadata?: { [key: string]: unknown; } | null; name?: string | null; notes?: string | null; payment_terms_default?: string | null; phone?: string | null; tax_id?: string | null; type?: "customer" | "vendor" | "both"; }; id: string; relationships?: { [key: string]: never; }; type?: "invoices-contact"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invoices/contacts/{id}"; }; export type PatchAdminInvoicesContactsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvoicesContactsByIdError = PatchAdminInvoicesContactsByIdErrors[keyof PatchAdminInvoicesContactsByIdErrors]; export type PatchAdminInvoicesContactsByIdResponses = { /** * Success */ 200: { data?: InvoicesContact; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvoicesContactsByIdResponse = PatchAdminInvoicesContactsByIdResponses[keyof PatchAdminInvoicesContactsByIdResponses]; export type GetAdminClinicalClientSupplementsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; patient_id: string; }; url: "/admin/clinical/client-supplements"; }; export type GetAdminClinicalClientSupplementsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalClientSupplementsError = GetAdminClinicalClientSupplementsErrors[keyof GetAdminClinicalClientSupplementsErrors]; export type GetAdminClinicalClientSupplementsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-client-supplement */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalClientSupplementsResponse = GetAdminClinicalClientSupplementsResponses[keyof GetAdminClinicalClientSupplementsResponses]; export type PostAdminClinicalClientSupplementsData = { /** * Request body for the /clinical/client-supplements operation on clinical-client-supplement resource */ body: { data: { attributes?: { discontinued_at?: unknown; dosage?: string | null; frequency?: string | null; fullscript_product_id?: string | null; fullscript_treatment_plan_id?: string | null; fullscript_variant_id?: string | null; instructions?: string | null; interaction_flags?: Array | null; metadata?: { [key: string]: unknown; } | null; name: string; patient_id: string; prescribed_at?: unknown; protocol_template_id?: string | null; rationale_client?: string | null; rationale_clinical?: string | null; route?: string | null; source?: string | null; status?: "active" | "discontinued" | "on_hold"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-client-supplement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-supplements"; }; export type PostAdminClinicalClientSupplementsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalClientSupplementsError = PostAdminClinicalClientSupplementsErrors[keyof PostAdminClinicalClientSupplementsErrors]; export type PostAdminClinicalClientSupplementsResponses = { /** * Success */ 201: { data?: ClinicalClientSupplement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalClientSupplementsResponse = PostAdminClinicalClientSupplementsResponses[keyof PostAdminClinicalClientSupplementsResponses]; export type DeleteAdminCrmDealsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/deals/{id}"; }; export type DeleteAdminCrmDealsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrmDealsByIdError = DeleteAdminCrmDealsByIdErrors[keyof DeleteAdminCrmDealsByIdErrors]; export type DeleteAdminCrmDealsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCrmDealsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/deals/{id}"; }; export type GetAdminCrmDealsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmDealsByIdError = GetAdminCrmDealsByIdErrors[keyof GetAdminCrmDealsByIdErrors]; export type GetAdminCrmDealsByIdResponses = { /** * Success */ 200: { data?: CrmDeal; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmDealsByIdResponse = GetAdminCrmDealsByIdResponses[keyof GetAdminCrmDealsByIdResponses]; export type PatchAdminCrmDealsByIdData = { /** * Request body for the /crm/deals/:id operation on crm-deal resource */ body?: { data: { attributes?: { ai_forecast_category?: "pipeline" | "best_case" | "commit" | "closed"; ai_next_action?: string | null; ai_risk_score?: number | null; amount?: string | number | unknown; close_date?: string | null; company_id?: string | null; currency?: string | null; external_owner_id?: string | null; lost_reason?: string | null; name?: string | null; owner_id?: string | null; pipeline_id?: string | null; pipeline_stage_id?: string | null; probability?: number | null; properties?: { [key: string]: unknown; } | null; status?: "open" | "won" | "lost" | "abandoned"; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-deal"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/deals/{id}"; }; export type PatchAdminCrmDealsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmDealsByIdError = PatchAdminCrmDealsByIdErrors[keyof PatchAdminCrmDealsByIdErrors]; export type PatchAdminCrmDealsByIdResponses = { /** * Success */ 200: { data?: CrmDeal; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmDealsByIdResponse = PatchAdminCrmDealsByIdResponses[keyof PatchAdminCrmDealsByIdResponses]; export type GetAdminSocialCampaignsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/campaigns"; }; export type GetAdminSocialCampaignsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialCampaignsError = GetAdminSocialCampaignsErrors[keyof GetAdminSocialCampaignsErrors]; export type GetAdminSocialCampaignsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a social-campaign */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialCampaignsResponse = GetAdminSocialCampaignsResponses[keyof GetAdminSocialCampaignsResponses]; export type PostAdminSocialCampaignsData = { /** * Request body for the /social/campaigns operation on social-campaign resource */ body: { data: { attributes?: { brand_identity_id?: string | null; content_brief?: string | null; media_urls?: Array | null; name: string; seo_keywords?: Array | null; target_platforms?: Array | null; }; relationships?: { [key: string]: never; }; type?: "social-campaign"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/campaigns"; }; export type PostAdminSocialCampaignsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSocialCampaignsError = PostAdminSocialCampaignsErrors[keyof PostAdminSocialCampaignsErrors]; export type PostAdminSocialCampaignsResponses = { /** * Success */ 201: { data?: SocialCampaign; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSocialCampaignsResponse = PostAdminSocialCampaignsResponses[keyof PostAdminSocialCampaignsResponses]; export type GetAdminEmailMarketingUnsubscribersWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/unsubscribers/workspace/{workspace_id}"; }; export type GetAdminEmailMarketingUnsubscribersWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailMarketingUnsubscribersWorkspaceByWorkspaceIdError = GetAdminEmailMarketingUnsubscribersWorkspaceByWorkspaceIdErrors[keyof GetAdminEmailMarketingUnsubscribersWorkspaceByWorkspaceIdErrors]; export type GetAdminEmailMarketingUnsubscribersWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a email-unsubscriber */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailMarketingUnsubscribersWorkspaceByWorkspaceIdResponse = GetAdminEmailMarketingUnsubscribersWorkspaceByWorkspaceIdResponses[keyof GetAdminEmailMarketingUnsubscribersWorkspaceByWorkspaceIdResponses]; export type PatchAdminThreadsByIdMetadataData = { /** * Request body for the /threads/:id/metadata operation on chat-thread resource */ body?: { data: { attributes?: { metadata?: { [key: string]: unknown; } | null; }; id: string; relationships?: { [key: string]: never; }; type?: "chat-thread"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/threads/{id}/metadata"; }; export type PatchAdminThreadsByIdMetadataErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminThreadsByIdMetadataError = PatchAdminThreadsByIdMetadataErrors[keyof PatchAdminThreadsByIdMetadataErrors]; export type PatchAdminThreadsByIdMetadataResponses = { /** * Success */ 200: { data?: ChatThread; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminThreadsByIdMetadataResponse = PatchAdminThreadsByIdMetadataResponses[keyof PatchAdminThreadsByIdMetadataResponses]; export type PostAdminWebhookDeliveriesByIdRetryData = { /** * Request body for the /webhook-deliveries/:id/retry operation on webhook-delivery resource */ body?: { data: { attributes?: { [key: string]: never; }; relationships?: { [key: string]: never; }; type?: "webhook-delivery"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/webhook-deliveries/{id}/retry"; }; export type PostAdminWebhookDeliveriesByIdRetryErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminWebhookDeliveriesByIdRetryError = PostAdminWebhookDeliveriesByIdRetryErrors[keyof PostAdminWebhookDeliveriesByIdRetryErrors]; export type PostAdminWebhookDeliveriesByIdRetryResponses = { /** * Success */ 201: { data?: WebhookDelivery; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminWebhookDeliveriesByIdRetryResponse = PostAdminWebhookDeliveriesByIdRetryResponses[keyof PostAdminWebhookDeliveriesByIdRetryResponses]; export type PatchAdminEmailMarketingSenderProfilesByIdValidateDnsData = { /** * Request body for the /email-marketing/sender-profiles/:id/validate-dns operation on email-marketing-sender-profile resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "email-marketing-sender-profile"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/sender-profiles/{id}/validate-dns"; }; export type PatchAdminEmailMarketingSenderProfilesByIdValidateDnsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminEmailMarketingSenderProfilesByIdValidateDnsError = PatchAdminEmailMarketingSenderProfilesByIdValidateDnsErrors[keyof PatchAdminEmailMarketingSenderProfilesByIdValidateDnsErrors]; export type PatchAdminEmailMarketingSenderProfilesByIdValidateDnsResponses = { /** * Success */ 200: { data?: EmailMarketingSenderProfile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminEmailMarketingSenderProfilesByIdValidateDnsResponse = PatchAdminEmailMarketingSenderProfilesByIdValidateDnsResponses[keyof PatchAdminEmailMarketingSenderProfilesByIdValidateDnsResponses]; export type GetAdminUsersMeTenantsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/users/me/tenants"; }; export type GetAdminUsersMeTenantsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminUsersMeTenantsError = GetAdminUsersMeTenantsErrors[keyof GetAdminUsersMeTenantsErrors]; export type GetAdminUsersMeTenantsResponses = { /** * Success */ 200: { result: { [key: string]: unknown; }; }; }; export type GetAdminUsersMeTenantsResponse = GetAdminUsersMeTenantsResponses[keyof GetAdminUsersMeTenantsResponses]; export type GetAdminPipelinesByWorkflowTypeData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workflow_type: "build" | "troubleshoot" | "security_scan" | "analyze" | "evaluate" | "custom" | "clinical_session" | "clinical_intake"; }; url: "/admin/pipelines/by-workflow-type"; }; export type GetAdminPipelinesByWorkflowTypeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPipelinesByWorkflowTypeError = GetAdminPipelinesByWorkflowTypeErrors[keyof GetAdminPipelinesByWorkflowTypeErrors]; export type GetAdminPipelinesByWorkflowTypeResponses = { /** * Success */ 200: { /** * An array of resource objects representing a pipeline */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPipelinesByWorkflowTypeResponse = GetAdminPipelinesByWorkflowTypeResponses[keyof GetAdminPipelinesByWorkflowTypeResponses]; export type PatchAdminClinicalInsuranceAuthorizationsByIdIncrementData = { /** * Request body for the /clinical/insurance-authorizations/:id/increment operation on clinical-insurance-authorization resource */ body: { data: { attributes?: { units: number; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-insurance-authorization"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/insurance-authorizations/{id}/increment"; }; export type PatchAdminClinicalInsuranceAuthorizationsByIdIncrementErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalInsuranceAuthorizationsByIdIncrementError = PatchAdminClinicalInsuranceAuthorizationsByIdIncrementErrors[keyof PatchAdminClinicalInsuranceAuthorizationsByIdIncrementErrors]; export type PatchAdminClinicalInsuranceAuthorizationsByIdIncrementResponses = { /** * Success */ 200: { data?: ClinicalInsuranceAuthorization; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalInsuranceAuthorizationsByIdIncrementResponse = PatchAdminClinicalInsuranceAuthorizationsByIdIncrementResponses[keyof PatchAdminClinicalInsuranceAuthorizationsByIdIncrementResponses]; export type GetAdminClinicalDocumentsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/documents"; }; export type GetAdminClinicalDocumentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalDocumentsError = GetAdminClinicalDocumentsErrors[keyof GetAdminClinicalDocumentsErrors]; export type GetAdminClinicalDocumentsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-document */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalDocumentsResponse = GetAdminClinicalDocumentsResponses[keyof GetAdminClinicalDocumentsResponses]; export type PostAdminClinicalDocumentsData = { /** * Request body for the /clinical/documents operation on clinical-document resource */ body: { data: { attributes?: { contact_id?: string | null; document_type?: string | null; expires_at?: unknown; import_id?: string | null; patient_id: string; source_date?: string | null; source_platform: string; storage_file_id: string; title: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-document"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/documents"; }; export type PostAdminClinicalDocumentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalDocumentsError = PostAdminClinicalDocumentsErrors[keyof PostAdminClinicalDocumentsErrors]; export type PostAdminClinicalDocumentsResponses = { /** * Success */ 201: { data?: ClinicalDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalDocumentsResponse = PostAdminClinicalDocumentsResponses[keyof PostAdminClinicalDocumentsResponses]; export type PostAdminPaymentsData = { /** * Request body for the /payments operation on transaction resource */ body: { data: { attributes?: { amount: number; credits_added?: number | null; credits_used?: number | null; currency?: string | null; customer_id?: string | null; description?: string | null; error_message?: string | null; metadata?: { [key: string]: unknown; } | null; operation?: "subscription" | "topup" | "extraction" | "training" | "refund" | "addon"; payment_method_id?: string | null; provider_reference?: string | null; service_id?: string | null; source: string; status?: "pending" | "success" | "failed" | "refunded" | "voided"; tenant_id?: string | null; transaction_type?: "credit" | "debit"; type?: "sale" | "auth" | "refund" | "void"; }; relationships?: { [key: string]: never; }; type?: "transaction"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/payments"; }; export type PostAdminPaymentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminPaymentsError = PostAdminPaymentsErrors[keyof PostAdminPaymentsErrors]; export type PostAdminPaymentsResponses = { /** * Success */ 201: { data?: Transaction; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminPaymentsResponse = PostAdminPaymentsResponses[keyof PostAdminPaymentsResponses]; export type PatchAdminClinicalPracticeResourcesByIdArchiveData = { /** * Request body for the /clinical/practice-resources/:id/archive operation on clinical-practice-resource resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-practice-resource"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-resources/{id}/archive"; }; export type PatchAdminClinicalPracticeResourcesByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalPracticeResourcesByIdArchiveError = PatchAdminClinicalPracticeResourcesByIdArchiveErrors[keyof PatchAdminClinicalPracticeResourcesByIdArchiveErrors]; export type PatchAdminClinicalPracticeResourcesByIdArchiveResponses = { /** * Success */ 200: { data?: ClinicalPracticeResource; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalPracticeResourcesByIdArchiveResponse = PatchAdminClinicalPracticeResourcesByIdArchiveResponses[keyof PatchAdminClinicalPracticeResourcesByIdArchiveResponses]; export type GetAdminSupportCannedResponsesWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/canned-responses/workspace/{workspace_id}"; }; export type GetAdminSupportCannedResponsesWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSupportCannedResponsesWorkspaceByWorkspaceIdError = GetAdminSupportCannedResponsesWorkspaceByWorkspaceIdErrors[keyof GetAdminSupportCannedResponsesWorkspaceByWorkspaceIdErrors]; export type GetAdminSupportCannedResponsesWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a support-canned-response */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSupportCannedResponsesWorkspaceByWorkspaceIdResponse = GetAdminSupportCannedResponsesWorkspaceByWorkspaceIdResponses[keyof GetAdminSupportCannedResponsesWorkspaceByWorkspaceIdResponses]; export type PostAdminRecipesShoppingListsRegenerateData = { /** * Request body for the /recipes/shopping-lists/regenerate operation on recipes-shopping-list resource */ body: { data: { shopping_list_id: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/recipes/shopping-lists/regenerate"; }; export type PostAdminRecipesShoppingListsRegenerateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminRecipesShoppingListsRegenerateError = PostAdminRecipesShoppingListsRegenerateErrors[keyof PostAdminRecipesShoppingListsRegenerateErrors]; export type PostAdminRecipesShoppingListsRegenerateResponses = { /** * Success */ 201: RecipesShoppingListType; }; export type PostAdminRecipesShoppingListsRegenerateResponse = PostAdminRecipesShoppingListsRegenerateResponses[keyof PostAdminRecipesShoppingListsRegenerateResponses]; export type PatchAdminSocialAccountsByIdDeactivateData = { /** * Request body for the /social/accounts/:id/deactivate operation on social-account resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "social-account"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/accounts/{id}/deactivate"; }; export type PatchAdminSocialAccountsByIdDeactivateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSocialAccountsByIdDeactivateError = PatchAdminSocialAccountsByIdDeactivateErrors[keyof PatchAdminSocialAccountsByIdDeactivateErrors]; export type PatchAdminSocialAccountsByIdDeactivateResponses = { /** * Success */ 200: { data?: SocialAccount; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSocialAccountsByIdDeactivateResponse = PatchAdminSocialAccountsByIdDeactivateResponses[keyof PatchAdminSocialAccountsByIdDeactivateResponses]; export type GetAdminClinicalMealPlansByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/meal-plans/{id}"; }; export type GetAdminClinicalMealPlansByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalMealPlansByIdError = GetAdminClinicalMealPlansByIdErrors[keyof GetAdminClinicalMealPlansByIdErrors]; export type GetAdminClinicalMealPlansByIdResponses = { /** * Success */ 200: { data?: ClinicalMealPlan; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalMealPlansByIdResponse = GetAdminClinicalMealPlansByIdResponses[keyof GetAdminClinicalMealPlansByIdResponses]; export type PatchAdminClinicalMealPlansByIdData = { /** * Request body for the /clinical/meal-plans/:id operation on clinical-meal-plan resource */ body?: { data: { attributes?: { additional_tips?: Array | null; clinical_rationale?: string | null; food_group_targets?: Array<{ [key: string]: unknown; }> | null; goal_calories?: number | null; hand_portions?: { [key: string]: unknown; } | null; hydration_guidelines?: string | null; intro_paragraph?: string | null; meal_schedule_id?: string | null; metadata?: { [key: string]: unknown; } | null; next_steps?: Array | null; nutrition_targets?: { [key: string]: unknown; } | null; patient_notes?: string | null; plan_content?: string | null; plan_type?: "daily" | "weekly" | "monthly"; remember_message?: string | null; status?: "draft" | "approved" | "archived" | "sent_to_client"; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-meal-plan"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/meal-plans/{id}"; }; export type PatchAdminClinicalMealPlansByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalMealPlansByIdError = PatchAdminClinicalMealPlansByIdErrors[keyof PatchAdminClinicalMealPlansByIdErrors]; export type PatchAdminClinicalMealPlansByIdResponses = { /** * Success */ 200: { data?: ClinicalMealPlan; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalMealPlansByIdResponse = PatchAdminClinicalMealPlansByIdResponses[keyof PatchAdminClinicalMealPlansByIdResponses]; export type GetAdminUserProfilesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/user-profiles"; }; export type GetAdminUserProfilesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminUserProfilesError = GetAdminUserProfilesErrors[keyof GetAdminUserProfilesErrors]; export type GetAdminUserProfilesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a user-profile */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminUserProfilesResponse = GetAdminUserProfilesResponses[keyof GetAdminUserProfilesResponses]; export type PostAdminUserProfilesData = { /** * Request body for the /user-profiles operation on user-profile resource */ body: { data: { attributes?: { avatar_url?: string | null; bio?: string | null; first_name?: string | null; last_name?: string | null; preferences?: { [key: string]: unknown; } | null; social_links?: { [key: string]: unknown; } | null; user_id: string; }; relationships?: { [key: string]: never; }; type?: "user-profile"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/user-profiles"; }; export type PostAdminUserProfilesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminUserProfilesError = PostAdminUserProfilesErrors[keyof PostAdminUserProfilesErrors]; export type PostAdminUserProfilesResponses = { /** * Success */ 201: { data?: UserProfile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminUserProfilesResponse = PostAdminUserProfilesResponses[keyof PostAdminUserProfilesResponses]; export type PostAdminCrmCompaniesData = { /** * Request body for the /crm/companies operation on crm-company resource */ body: { data: { attributes?: { annual_revenue?: string | number | unknown; application_id?: string | null; description?: string | null; domain?: string | null; employee_count?: number | null; external_owner_id?: string | null; founded_date?: string | null; industry?: string | null; lifecycle_stage?: "lead" | "marketing_qualified" | "sales_qualified" | "opportunity" | "customer" | "evangelist" | "churned" | "discharged"; location?: string | null; name: string; owner_id?: string | null; properties?: { [key: string]: unknown; } | null; source?: "manual" | "import" | "channel" | "connector" | "ai_extracted" | "api"; /** * VAT/EIN for invoicing cross-domain use */ tax_id?: string | null; type?: "public" | "private" | "nonprofit" | "government" | "partnership" | "other"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "crm-company"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/companies"; }; export type PostAdminCrmCompaniesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrmCompaniesError = PostAdminCrmCompaniesErrors[keyof PostAdminCrmCompaniesErrors]; export type PostAdminCrmCompaniesResponses = { /** * Success */ 201: { data?: CrmCompany; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrmCompaniesResponse = PostAdminCrmCompaniesResponses[keyof PostAdminCrmCompaniesResponses]; export type PostAdminConnectorsFullscriptProductsMatchData = { /** * Request body for the /connectors/fullscript/products/match operation on connector-instance resource */ body: { data: { connector_id: string; queries: Array<{ [key: string]: unknown; }>; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/connectors/fullscript/products/match"; }; export type PostAdminConnectorsFullscriptProductsMatchErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsFullscriptProductsMatchError = PostAdminConnectorsFullscriptProductsMatchErrors[keyof PostAdminConnectorsFullscriptProductsMatchErrors]; export type PostAdminConnectorsFullscriptProductsMatchResponses = { /** * Success */ 201: Array<{ [key: string]: unknown; }>; }; export type PostAdminConnectorsFullscriptProductsMatchResponse = PostAdminConnectorsFullscriptProductsMatchResponses[keyof PostAdminConnectorsFullscriptProductsMatchResponses]; export type GetAdminLegalDocumentsByLocaleData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; locale: string; region?: string; }; url: "/admin/legal-documents/by-locale"; }; export type GetAdminLegalDocumentsByLocaleErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminLegalDocumentsByLocaleError = GetAdminLegalDocumentsByLocaleErrors[keyof GetAdminLegalDocumentsByLocaleErrors]; export type GetAdminLegalDocumentsByLocaleResponses = { /** * Success */ 200: { /** * An array of resource objects representing a legal-document */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminLegalDocumentsByLocaleResponse = GetAdminLegalDocumentsByLocaleResponses[keyof GetAdminLegalDocumentsByLocaleResponses]; export type GetAdminSchedulingBookingsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scheduling/bookings/{id}"; }; export type GetAdminSchedulingBookingsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingBookingsByIdError = GetAdminSchedulingBookingsByIdErrors[keyof GetAdminSchedulingBookingsByIdErrors]; export type GetAdminSchedulingBookingsByIdResponses = { /** * Success */ 200: { data?: SchedulingBooking; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingBookingsByIdResponse = GetAdminSchedulingBookingsByIdResponses[keyof GetAdminSchedulingBookingsByIdResponses]; export type PostAdminThreadsByIdCompleteData = { /** * Request body for the /threads/:id/complete operation on chat-thread resource */ body?: { data: { attributes?: { [key: string]: never; }; relationships?: { [key: string]: never; }; type?: "chat-thread"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/threads/{id}/complete"; }; export type PostAdminThreadsByIdCompleteErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminThreadsByIdCompleteError = PostAdminThreadsByIdCompleteErrors[keyof PostAdminThreadsByIdCompleteErrors]; export type PostAdminThreadsByIdCompleteResponses = { /** * Success */ 201: { data?: ChatThread; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminThreadsByIdCompleteResponse = PostAdminThreadsByIdCompleteResponses[keyof PostAdminThreadsByIdCompleteResponses]; export type GetAdminVoiceTranscriptionJobsMineData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/voice/transcription-jobs/mine"; }; export type GetAdminVoiceTranscriptionJobsMineErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminVoiceTranscriptionJobsMineError = GetAdminVoiceTranscriptionJobsMineErrors[keyof GetAdminVoiceTranscriptionJobsMineErrors]; export type GetAdminVoiceTranscriptionJobsMineResponses = { /** * Success */ 200: { /** * An array of resource objects representing a transcription-job */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminVoiceTranscriptionJobsMineResponse = GetAdminVoiceTranscriptionJobsMineResponses[keyof GetAdminVoiceTranscriptionJobsMineResponses]; export type PostAdminCustomersData = { /** * Request body for the /customers operation on customer resource */ body: { data: { attributes?: { billing_email?: string | null; gateway_customer_id: string; payment_method_status?: "valid" | "invalid" | "missing"; tenant_id: string; }; relationships?: { [key: string]: never; }; type?: "customer"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/customers"; }; export type PostAdminCustomersErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCustomersError = PostAdminCustomersErrors[keyof PostAdminCustomersErrors]; export type PostAdminCustomersResponses = { /** * Success */ 201: { data?: Customer; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCustomersResponse = PostAdminCustomersResponses[keyof PostAdminCustomersResponses]; export type DeleteAdminConnectorsOauthAppConfigsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/connectors/oauth-app-configs/{id}"; }; export type DeleteAdminConnectorsOauthAppConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminConnectorsOauthAppConfigsByIdError = DeleteAdminConnectorsOauthAppConfigsByIdErrors[keyof DeleteAdminConnectorsOauthAppConfigsByIdErrors]; export type DeleteAdminConnectorsOauthAppConfigsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminConnectorsOauthAppConfigsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/connectors/oauth-app-configs/{id}"; }; export type GetAdminConnectorsOauthAppConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminConnectorsOauthAppConfigsByIdError = GetAdminConnectorsOauthAppConfigsByIdErrors[keyof GetAdminConnectorsOauthAppConfigsByIdErrors]; export type GetAdminConnectorsOauthAppConfigsByIdResponses = { /** * Success */ 200: { data?: OauthAppConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminConnectorsOauthAppConfigsByIdResponse = GetAdminConnectorsOauthAppConfigsByIdResponses[keyof GetAdminConnectorsOauthAppConfigsByIdResponses]; export type PatchAdminConnectorsOauthAppConfigsByIdData = { /** * Request body for the /connectors/oauth-app-configs/:id operation on oauth-app-config resource */ body?: { data: { attributes?: { client_id?: string | null; client_secret?: string | null; scopes?: Array | null; }; id: string; relationships?: { [key: string]: never; }; type?: "oauth-app-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/connectors/oauth-app-configs/{id}"; }; export type PatchAdminConnectorsOauthAppConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminConnectorsOauthAppConfigsByIdError = PatchAdminConnectorsOauthAppConfigsByIdErrors[keyof PatchAdminConnectorsOauthAppConfigsByIdErrors]; export type PatchAdminConnectorsOauthAppConfigsByIdResponses = { /** * Success */ 200: { data?: OauthAppConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminConnectorsOauthAppConfigsByIdResponse = PatchAdminConnectorsOauthAppConfigsByIdResponses[keyof PatchAdminConnectorsOauthAppConfigsByIdResponses]; export type GetAdminSchedulingAvailabilityRulesByUserData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; user_id: string; }; url: "/admin/scheduling/availability-rules/by-user"; }; export type GetAdminSchedulingAvailabilityRulesByUserErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingAvailabilityRulesByUserError = GetAdminSchedulingAvailabilityRulesByUserErrors[keyof GetAdminSchedulingAvailabilityRulesByUserErrors]; export type GetAdminSchedulingAvailabilityRulesByUserResponses = { /** * Success */ 200: { /** * An array of resource objects representing a scheduling-availability-rule */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingAvailabilityRulesByUserResponse = GetAdminSchedulingAvailabilityRulesByUserResponses[keyof GetAdminSchedulingAvailabilityRulesByUserResponses]; export type GetAdminRecipesFavoritesRecipeByRecipeIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { recipe_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/favorites/recipe/{recipe_id}"; }; export type GetAdminRecipesFavoritesRecipeByRecipeIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesFavoritesRecipeByRecipeIdError = GetAdminRecipesFavoritesRecipeByRecipeIdErrors[keyof GetAdminRecipesFavoritesRecipeByRecipeIdErrors]; export type GetAdminRecipesFavoritesRecipeByRecipeIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a recipes-recipe-favorite */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesFavoritesRecipeByRecipeIdResponse = GetAdminRecipesFavoritesRecipeByRecipeIdResponses[keyof GetAdminRecipesFavoritesRecipeByRecipeIdResponses]; export type GetAdminClinicalClientResourceAssignmentsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; patient_id: string; }; url: "/admin/clinical/client-resource-assignments"; }; export type GetAdminClinicalClientResourceAssignmentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalClientResourceAssignmentsError = GetAdminClinicalClientResourceAssignmentsErrors[keyof GetAdminClinicalClientResourceAssignmentsErrors]; export type GetAdminClinicalClientResourceAssignmentsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-client-resource-assignment */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalClientResourceAssignmentsResponse = GetAdminClinicalClientResourceAssignmentsResponses[keyof GetAdminClinicalClientResourceAssignmentsResponses]; export type PostAdminClinicalClientResourceAssignmentsData = { /** * Request body for the /clinical/client-resource-assignments operation on clinical-client-resource-assignment resource */ body: { data: { attributes?: { assigned_at?: unknown; assigned_by_id?: string | null; metadata?: { [key: string]: unknown; } | null; notes?: string | null; patient_id: string; resource_id: string; status?: "assigned" | "in_progress" | "completed" | "dismissed"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-client-resource-assignment"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-resource-assignments"; }; export type PostAdminClinicalClientResourceAssignmentsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalClientResourceAssignmentsError = PostAdminClinicalClientResourceAssignmentsErrors[keyof PostAdminClinicalClientResourceAssignmentsErrors]; export type PostAdminClinicalClientResourceAssignmentsResponses = { /** * Success */ 201: { data?: ClinicalClientResourceAssignment; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalClientResourceAssignmentsResponse = PostAdminClinicalClientResourceAssignmentsResponses[keyof PostAdminClinicalClientResourceAssignmentsResponses]; export type PatchAdminExtractionResultsByIdSaveCorrectionsData = { /** * Request body for the /extraction/results/:id/save-corrections operation on extraction-result resource */ body: { data: { attributes?: { corrections: Array<{ [key: string]: unknown; }>; }; id: string; relationships?: { [key: string]: never; }; type?: "extraction-result"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/results/{id}/save-corrections"; }; export type PatchAdminExtractionResultsByIdSaveCorrectionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminExtractionResultsByIdSaveCorrectionsError = PatchAdminExtractionResultsByIdSaveCorrectionsErrors[keyof PatchAdminExtractionResultsByIdSaveCorrectionsErrors]; export type PatchAdminExtractionResultsByIdSaveCorrectionsResponses = { /** * Success */ 200: { data?: ExtractionResult; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminExtractionResultsByIdSaveCorrectionsResponse = PatchAdminExtractionResultsByIdSaveCorrectionsResponses[keyof PatchAdminExtractionResultsByIdSaveCorrectionsResponses]; export type DeleteAdminCrmPipelinesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/pipelines/{id}"; }; export type DeleteAdminCrmPipelinesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrmPipelinesByIdError = DeleteAdminCrmPipelinesByIdErrors[keyof DeleteAdminCrmPipelinesByIdErrors]; export type DeleteAdminCrmPipelinesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminCrmPipelinesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/pipelines/{id}"; }; export type GetAdminCrmPipelinesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrmPipelinesByIdError = GetAdminCrmPipelinesByIdErrors[keyof GetAdminCrmPipelinesByIdErrors]; export type GetAdminCrmPipelinesByIdResponses = { /** * Success */ 200: { data?: CrmPipeline; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrmPipelinesByIdResponse = GetAdminCrmPipelinesByIdResponses[keyof GetAdminCrmPipelinesByIdResponses]; export type PatchAdminCrmPipelinesByIdData = { /** * Request body for the /crm/pipelines/:id operation on crm-pipeline resource */ body?: { data: { attributes?: { is_default?: boolean | null; name?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-pipeline"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/pipelines/{id}"; }; export type PatchAdminCrmPipelinesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmPipelinesByIdError = PatchAdminCrmPipelinesByIdErrors[keyof PatchAdminCrmPipelinesByIdErrors]; export type PatchAdminCrmPipelinesByIdResponses = { /** * Success */ 200: { data?: CrmPipeline; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmPipelinesByIdResponse = PatchAdminCrmPipelinesByIdResponses[keyof PatchAdminCrmPipelinesByIdResponses]; export type GetAdminTrainingSessionsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/training-sessions"; }; export type GetAdminTrainingSessionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminTrainingSessionsError = GetAdminTrainingSessionsErrors[keyof GetAdminTrainingSessionsErrors]; export type GetAdminTrainingSessionsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a training-session */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminTrainingSessionsResponse = GetAdminTrainingSessionsResponses[keyof GetAdminTrainingSessionsResponses]; export type PostAdminTrainingSessionsData = { /** * Request body for the /training-sessions operation on training-session resource */ body: { data: { attributes?: { agent_id: string; confirmations_count?: number | null; corrections_count?: number | null; /** * Denormalized filename from the source document */ document_filename?: string | null; document_id: string; training_note?: string | null; user_id: string; }; relationships?: { [key: string]: never; }; type?: "training-session"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/training-sessions"; }; export type PostAdminTrainingSessionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminTrainingSessionsError = PostAdminTrainingSessionsErrors[keyof PostAdminTrainingSessionsErrors]; export type PostAdminTrainingSessionsResponses = { /** * Success */ 201: { data?: TrainingSession; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminTrainingSessionsResponse = PostAdminTrainingSessionsResponses[keyof PostAdminTrainingSessionsResponses]; export type PostAdminConnectorsCredentialsByIdRefreshData = { /** * Request body for the /connectors/credentials/:id/refresh operation on credential resource */ body: { data: { workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/connectors/credentials/{id}/refresh"; }; export type PostAdminConnectorsCredentialsByIdRefreshErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminConnectorsCredentialsByIdRefreshError = PostAdminConnectorsCredentialsByIdRefreshErrors[keyof PostAdminConnectorsCredentialsByIdRefreshErrors]; export type PostAdminConnectorsCredentialsByIdRefreshResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminConnectorsCredentialsByIdRefreshResponse = PostAdminConnectorsCredentialsByIdRefreshResponses[keyof PostAdminConnectorsCredentialsByIdRefreshResponses]; export type GetAdminAgentsUsageData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agents/usage"; }; export type GetAdminAgentsUsageErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAgentsUsageError = GetAdminAgentsUsageErrors[keyof GetAdminAgentsUsageErrors]; export type GetAdminAgentsUsageResponses = { /** * Success */ 200: { /** * An array of resource objects representing a agent-usage */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAgentsUsageResponse = GetAdminAgentsUsageResponses[keyof GetAdminAgentsUsageResponses]; export type PatchAdminCrmAddressesByIdSetPrimaryData = { /** * Request body for the /crm/addresses/:id/set-primary operation on crm-address resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-address"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/addresses/{id}/set-primary"; }; export type PatchAdminCrmAddressesByIdSetPrimaryErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmAddressesByIdSetPrimaryError = PatchAdminCrmAddressesByIdSetPrimaryErrors[keyof PatchAdminCrmAddressesByIdSetPrimaryErrors]; export type PatchAdminCrmAddressesByIdSetPrimaryResponses = { /** * Success */ 200: { data?: CrmAddress; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmAddressesByIdSetPrimaryResponse = PatchAdminCrmAddressesByIdSetPrimaryResponses[keyof PatchAdminCrmAddressesByIdSetPrimaryResponses]; export type PatchAdminWorkspacesByIdPopulateHashesData = { /** * Request body for the /workspaces/:id/populate-hashes operation on workspace resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "workspace"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/workspaces/{id}/populate-hashes"; }; export type PatchAdminWorkspacesByIdPopulateHashesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminWorkspacesByIdPopulateHashesError = PatchAdminWorkspacesByIdPopulateHashesErrors[keyof PatchAdminWorkspacesByIdPopulateHashesErrors]; export type PatchAdminWorkspacesByIdPopulateHashesResponses = { /** * Success */ 200: { data?: Workspace; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminWorkspacesByIdPopulateHashesResponse = PatchAdminWorkspacesByIdPopulateHashesResponses[keyof PatchAdminWorkspacesByIdPopulateHashesResponses]; export type GetAdminPermissionsPresetsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/permissions/presets/{id}"; }; export type GetAdminPermissionsPresetsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPermissionsPresetsByIdError = GetAdminPermissionsPresetsByIdErrors[keyof GetAdminPermissionsPresetsByIdErrors]; export type GetAdminPermissionsPresetsByIdResponses = { /** * Success */ 200: { data?: PermissionPreset; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPermissionsPresetsByIdResponse = GetAdminPermissionsPresetsByIdResponses[keyof GetAdminPermissionsPresetsByIdResponses]; export type PostAdminSocialTrendingHistoryData = { /** * Request body for the /social/trending/history operation on trending-snapshot resource */ body: { data: { attributes?: { enrichment_level?: "raw" | "scored" | "summarized" | "full"; fetched_at: unknown; item_count?: number | null; query?: string | null; source_breakdown?: { [key: string]: unknown; } | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "trending-snapshot"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/trending/history"; }; export type PostAdminSocialTrendingHistoryErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSocialTrendingHistoryError = PostAdminSocialTrendingHistoryErrors[keyof PostAdminSocialTrendingHistoryErrors]; export type PostAdminSocialTrendingHistoryResponses = { /** * Success */ 201: { data?: TrendingSnapshot; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSocialTrendingHistoryResponse = PostAdminSocialTrendingHistoryResponses[keyof PostAdminSocialTrendingHistoryResponses]; export type PatchAdminFormGenerationsByIdCancelData = { /** * Request body for the /form-generations/:id/cancel operation on form-generation-job resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "form-generation-job"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/form-generations/{id}/cancel"; }; export type PatchAdminFormGenerationsByIdCancelErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminFormGenerationsByIdCancelError = PatchAdminFormGenerationsByIdCancelErrors[keyof PatchAdminFormGenerationsByIdCancelErrors]; export type PatchAdminFormGenerationsByIdCancelResponses = { /** * Success */ 200: { data?: FormGenerationJob; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminFormGenerationsByIdCancelResponse = PatchAdminFormGenerationsByIdCancelResponses[keyof PatchAdminFormGenerationsByIdCancelResponses]; export type PostAdminClinicalClientSupplementsBulkData = { /** * Request body for the /clinical/client-supplements/bulk operation on clinical-client-supplement resource */ body: { data: { supplements: Array<{ dosage?: string | null; frequency?: string | null; fullscript_product_id?: string | null; fullscript_treatment_plan_id?: string | null; fullscript_variant_id?: string | null; instructions?: string | null; interaction_flags?: Array | null; metadata?: { [key: string]: unknown; } | null; name: string; patient_id: string; prescribed_at?: unknown; protocol_template_id?: string | null; rationale_client?: string | null; rationale_clinical?: string | null; route?: string | null; source?: string | null; }>; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/clinical/client-supplements/bulk"; }; export type PostAdminClinicalClientSupplementsBulkErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalClientSupplementsBulkError = PostAdminClinicalClientSupplementsBulkErrors[keyof PostAdminClinicalClientSupplementsBulkErrors]; export type PostAdminClinicalClientSupplementsBulkResponses = { /** * Success */ 201: Array<{ [key: string]: unknown; }>; }; export type PostAdminClinicalClientSupplementsBulkResponse = PostAdminClinicalClientSupplementsBulkResponses[keyof PostAdminClinicalClientSupplementsBulkResponses]; export type PostAdminSupportSlaPoliciesData = { /** * Request body for the /support/sla-policies operation on support-sla-policy resource */ body: { data: { attributes?: { application_id: string; business_hours_only?: boolean | null; first_response_target: number; name: string; priority_filter?: Array | null; resolution_target: number; }; relationships?: { [key: string]: never; }; type?: "support-sla-policy"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/sla-policies"; }; export type PostAdminSupportSlaPoliciesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSupportSlaPoliciesError = PostAdminSupportSlaPoliciesErrors[keyof PostAdminSupportSlaPoliciesErrors]; export type PostAdminSupportSlaPoliciesResponses = { /** * Success */ 201: { data?: SupportSlaPolicy; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSupportSlaPoliciesResponse = PostAdminSupportSlaPoliciesResponses[keyof PostAdminSupportSlaPoliciesResponses]; export type GetAdminRecipesWorkspaceByWorkspaceIdPublishedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/workspace/{workspace_id}/published"; }; export type GetAdminRecipesWorkspaceByWorkspaceIdPublishedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesWorkspaceByWorkspaceIdPublishedError = GetAdminRecipesWorkspaceByWorkspaceIdPublishedErrors[keyof GetAdminRecipesWorkspaceByWorkspaceIdPublishedErrors]; export type GetAdminRecipesWorkspaceByWorkspaceIdPublishedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a recipes-recipe */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesWorkspaceByWorkspaceIdPublishedResponse = GetAdminRecipesWorkspaceByWorkspaceIdPublishedResponses[keyof GetAdminRecipesWorkspaceByWorkspaceIdPublishedResponses]; export type PostAdminAgentsByIdValidateData = { /** * Request body for the /agents/:id/validate operation on agent resource */ body: { data: { attributes?: { sample_output: { [key: string]: unknown; }; }; relationships?: { [key: string]: never; }; type?: "agent"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { /** * Agent ID (from URL path parameter) */ id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/agents/{id}/validate"; }; export type PostAdminAgentsByIdValidateErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAgentsByIdValidateError = PostAdminAgentsByIdValidateErrors[keyof PostAdminAgentsByIdValidateErrors]; export type PostAdminAgentsByIdValidateResponses = { /** * Success */ 201: { data?: Agent; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAgentsByIdValidateResponse = PostAdminAgentsByIdValidateResponses[keyof PostAdminAgentsByIdValidateResponses]; export type PostAdminApplicationsByApplicationIdEmailTemplatesBySlugTestData = { /** * Request body for the /applications/:application_id/email-templates/:slug/test operation on email-template resource */ body: { data: { email: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { slug: string; application_id: string; }; query?: never; url: "/admin/applications/{application_id}/email-templates/{slug}/test"; }; export type PostAdminApplicationsByApplicationIdEmailTemplatesBySlugTestErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminApplicationsByApplicationIdEmailTemplatesBySlugTestError = PostAdminApplicationsByApplicationIdEmailTemplatesBySlugTestErrors[keyof PostAdminApplicationsByApplicationIdEmailTemplatesBySlugTestErrors]; export type PostAdminApplicationsByApplicationIdEmailTemplatesBySlugTestResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminApplicationsByApplicationIdEmailTemplatesBySlugTestResponse = PostAdminApplicationsByApplicationIdEmailTemplatesBySlugTestResponses[keyof PostAdminApplicationsByApplicationIdEmailTemplatesBySlugTestResponses]; export type GetAdminClinicalHealthMetricsArchivedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/health-metrics/archived"; }; export type GetAdminClinicalHealthMetricsArchivedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalHealthMetricsArchivedError = GetAdminClinicalHealthMetricsArchivedErrors[keyof GetAdminClinicalHealthMetricsArchivedErrors]; export type GetAdminClinicalHealthMetricsArchivedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-health-metric */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalHealthMetricsArchivedResponse = GetAdminClinicalHealthMetricsArchivedResponses[keyof GetAdminClinicalHealthMetricsArchivedResponses]; export type PatchAdminPlansByIdScheduleSunsetData = { /** * Request body for the /plans/:id/schedule-sunset operation on plan resource */ body?: { data: { attributes?: { /** * The plan subscribers will be migrated to when this plan reaches `sunset_at`. * Must reference a Plan in the same Application. Required when * `lifecycle_status == :sunset_pending`. * */ replacement_plan_id?: string | null; /** * Timestamp at which subscribers on this plan will be force-migrated to * `replacement_plan_id`. Required when `lifecycle_status == :sunset_pending`. * */ sunset_at?: unknown; }; id: string; relationships?: { [key: string]: never; }; type?: "plan"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/plans/{id}/schedule-sunset"; }; export type PatchAdminPlansByIdScheduleSunsetErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPlansByIdScheduleSunsetError = PatchAdminPlansByIdScheduleSunsetErrors[keyof PatchAdminPlansByIdScheduleSunsetErrors]; export type PatchAdminPlansByIdScheduleSunsetResponses = { /** * Success */ 200: { data?: Plan; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPlansByIdScheduleSunsetResponse = PatchAdminPlansByIdScheduleSunsetResponses[keyof PatchAdminPlansByIdScheduleSunsetResponses]; export type GetAdminClinicalMealPlansData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; session_id: string; }; url: "/admin/clinical/meal-plans"; }; export type GetAdminClinicalMealPlansErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalMealPlansError = GetAdminClinicalMealPlansErrors[keyof GetAdminClinicalMealPlansErrors]; export type GetAdminClinicalMealPlansResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-meal-plan */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalMealPlansResponse = GetAdminClinicalMealPlansResponses[keyof GetAdminClinicalMealPlansResponses]; export type PostAdminClinicalMealPlansData = { /** * Request body for the /clinical/meal-plans operation on clinical-meal-plan resource */ body: { data: { attributes?: { additional_tips?: Array | null; clinical_rationale?: string | null; food_group_targets?: Array<{ [key: string]: unknown; }> | null; goal_calories?: number | null; hand_portions?: { [key: string]: unknown; } | null; hydration_guidelines?: string | null; intro_paragraph?: string | null; meal_schedule_id?: string | null; metadata?: { [key: string]: unknown; } | null; next_steps?: Array | null; nutrition_targets?: { [key: string]: unknown; } | null; parent_plan_id?: string | null; patient_id?: string | null; patient_notes?: string | null; pipeline_execution_id?: string | null; plan_content?: string | null; plan_type?: "daily" | "weekly" | "monthly"; remember_message?: string | null; session_id?: string | null; status?: "draft" | "approved" | "archived" | "sent_to_client"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-meal-plan"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/meal-plans"; }; export type PostAdminClinicalMealPlansErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalMealPlansError = PostAdminClinicalMealPlansErrors[keyof PostAdminClinicalMealPlansErrors]; export type PostAdminClinicalMealPlansResponses = { /** * Success */ 201: { data?: ClinicalMealPlan; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalMealPlansResponse = PostAdminClinicalMealPlansResponses[keyof PostAdminClinicalMealPlansResponses]; export type DeleteAdminPipelinesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pipelines/{id}"; }; export type DeleteAdminPipelinesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminPipelinesByIdError = DeleteAdminPipelinesByIdErrors[keyof DeleteAdminPipelinesByIdErrors]; export type DeleteAdminPipelinesByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminPipelinesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pipelines/{id}"; }; export type GetAdminPipelinesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPipelinesByIdError = GetAdminPipelinesByIdErrors[keyof GetAdminPipelinesByIdErrors]; export type GetAdminPipelinesByIdResponses = { /** * Success */ 200: { data?: Pipeline; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPipelinesByIdResponse = GetAdminPipelinesByIdResponses[keyof GetAdminPipelinesByIdResponses]; export type PatchAdminPipelinesByIdData = { /** * Request body for the /pipelines/:id operation on pipeline resource */ body?: { data: { attributes?: { chat_agent_id?: string | null; description?: string | null; is_active?: boolean | null; name?: string | null; /** * Reactor-compatible node graph definition. Each entry: * "node_id" => %{ * "agent_id" => "uuid", * "inputs" => %{"arg" => "source_node.output"}, * "depends_on" => ["source_node"] * } * */ nodes?: { [key: string]: unknown; } | null; /** * How the pipeline is triggered. */ trigger_type?: "manual" | "event" | "schedule"; /** * Human-readable workflow label for display. */ workflow_label?: string | null; /** * Workflow classification for ISV portal routing. */ workflow_type?: "build" | "troubleshoot" | "security_scan" | "analyze" | "evaluate" | "custom" | "clinical_session" | "clinical_intake"; }; id: string; relationships?: { [key: string]: never; }; type?: "pipeline"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/pipelines/{id}"; }; export type PatchAdminPipelinesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPipelinesByIdError = PatchAdminPipelinesByIdErrors[keyof PatchAdminPipelinesByIdErrors]; export type PatchAdminPipelinesByIdResponses = { /** * Success */ 200: { data?: Pipeline; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPipelinesByIdResponse = PatchAdminPipelinesByIdResponses[keyof PatchAdminPipelinesByIdResponses]; export type GetAdminClinicalPatientsByIdSupplementsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/patients/{id}/supplements"; }; export type GetAdminClinicalPatientsByIdSupplementsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPatientsByIdSupplementsError = GetAdminClinicalPatientsByIdSupplementsErrors[keyof GetAdminClinicalPatientsByIdSupplementsErrors]; export type GetAdminClinicalPatientsByIdSupplementsResponses = { /** * Success */ 200: { data?: ClinicalClientSupplement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPatientsByIdSupplementsResponse = GetAdminClinicalPatientsByIdSupplementsResponses[keyof GetAdminClinicalPatientsByIdSupplementsResponses]; export type PatchAdminUserProfilesByIdAcceptLegalDocumentData = { /** * Request body for the /user-profiles/:id/accept-legal-document operation on user-profile resource */ body: { data: { attributes?: { /** * The legal document type being accepted (mirrors LegalAcceptance.document_type) */ document_type: "terms_of_service" | "privacy_policy" | "baa" | "dpa" | "scc" | "npp" | "security_policy" | "incident_response_plan" | "contingency_plan" | "access_control_policy" | "risk_management_plan" | "training_policy" | "sanction_policy" | "breach_notification_policy" | "system_activity_review" | "data_retention_policy" | "minimum_necessary_policy" | "authorization_form"; /** * The version of the document being accepted */ version: string; }; id: string; relationships?: { [key: string]: never; }; type?: "user-profile"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/user-profiles/{id}/accept-legal-document"; }; export type PatchAdminUserProfilesByIdAcceptLegalDocumentErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminUserProfilesByIdAcceptLegalDocumentError = PatchAdminUserProfilesByIdAcceptLegalDocumentErrors[keyof PatchAdminUserProfilesByIdAcceptLegalDocumentErrors]; export type PatchAdminUserProfilesByIdAcceptLegalDocumentResponses = { /** * Success */ 200: { data?: UserProfile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminUserProfilesByIdAcceptLegalDocumentResponse = PatchAdminUserProfilesByIdAcceptLegalDocumentResponses[keyof PatchAdminUserProfilesByIdAcceptLegalDocumentResponses]; export type PatchAdminClinicalNotesByIdRejectData = { /** * Request body for the /clinical/notes/:id/reject operation on clinical-note resource */ body: { data: { attributes?: { reviewed_by_id: string; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-note"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/notes/{id}/reject"; }; export type PatchAdminClinicalNotesByIdRejectErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalNotesByIdRejectError = PatchAdminClinicalNotesByIdRejectErrors[keyof PatchAdminClinicalNotesByIdRejectErrors]; export type PatchAdminClinicalNotesByIdRejectResponses = { /** * Success */ 200: { data?: ClinicalNote; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalNotesByIdRejectResponse = PatchAdminClinicalNotesByIdRejectResponses[keyof PatchAdminClinicalNotesByIdRejectResponses]; export type PatchAdminTrainingSessionsByIdRevertData = { /** * Request body for the /training-sessions/:id/revert operation on training-session resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "training-session"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/training-sessions/{id}/revert"; }; export type PatchAdminTrainingSessionsByIdRevertErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminTrainingSessionsByIdRevertError = PatchAdminTrainingSessionsByIdRevertErrors[keyof PatchAdminTrainingSessionsByIdRevertErrors]; export type PatchAdminTrainingSessionsByIdRevertResponses = { /** * Success */ 200: { data?: TrainingSession; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminTrainingSessionsByIdRevertResponse = PatchAdminTrainingSessionsByIdRevertResponses[keyof PatchAdminTrainingSessionsByIdRevertResponses]; export type GetAdminIsvPricingOverridesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/isv-pricing-overrides/{id}"; }; export type GetAdminIsvPricingOverridesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminIsvPricingOverridesByIdError = GetAdminIsvPricingOverridesByIdErrors[keyof GetAdminIsvPricingOverridesByIdErrors]; export type GetAdminIsvPricingOverridesByIdResponses = { /** * Success */ 200: { data?: IsvPricingOverride; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminIsvPricingOverridesByIdResponse = GetAdminIsvPricingOverridesByIdResponses[keyof GetAdminIsvPricingOverridesByIdResponses]; export type PatchAdminIsvPricingOverridesByIdData = { /** * Request body for the /isv-pricing-overrides/:id operation on isv-pricing-override resource */ body?: { data: { attributes?: { /** * Whether this override is active */ is_enabled?: boolean | null; /** * Custom margin % (NULL = use default) */ margin_percent?: number | null; /** * Admin notes about this override */ notes?: string | null; /** * Custom credit rate (NULL = use default from PlatformPricingConfig) */ rate_credits?: number | null; }; id: string; relationships?: { [key: string]: never; }; type?: "isv-pricing-override"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/isv-pricing-overrides/{id}"; }; export type PatchAdminIsvPricingOverridesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminIsvPricingOverridesByIdError = PatchAdminIsvPricingOverridesByIdErrors[keyof PatchAdminIsvPricingOverridesByIdErrors]; export type PatchAdminIsvPricingOverridesByIdResponses = { /** * Success */ 200: { data?: IsvPricingOverride; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminIsvPricingOverridesByIdResponse = PatchAdminIsvPricingOverridesByIdResponses[keyof PatchAdminIsvPricingOverridesByIdResponses]; export type DeleteAdminSocialPostsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/posts/{id}"; }; export type DeleteAdminSocialPostsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminSocialPostsByIdError = DeleteAdminSocialPostsByIdErrors[keyof DeleteAdminSocialPostsByIdErrors]; export type DeleteAdminSocialPostsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminSocialPostsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/posts/{id}"; }; export type GetAdminSocialPostsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialPostsByIdError = GetAdminSocialPostsByIdErrors[keyof GetAdminSocialPostsByIdErrors]; export type GetAdminSocialPostsByIdResponses = { /** * Success */ 200: { data?: SocialPost; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialPostsByIdResponse = GetAdminSocialPostsByIdResponses[keyof GetAdminSocialPostsByIdResponses]; export type PatchAdminSocialPostsByIdData = { /** * Request body for the /social/posts/:id operation on social-post resource */ body?: { data: { attributes?: { content?: string | null; hashtags?: Array | null; link_metadata?: { [key: string]: unknown; } | null; link_url?: string | null; media_urls?: Array | null; platform_metadata?: { [key: string]: unknown; } | null; }; id: string; relationships?: { [key: string]: never; }; type?: "social-post"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/posts/{id}"; }; export type PatchAdminSocialPostsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSocialPostsByIdError = PatchAdminSocialPostsByIdErrors[keyof PatchAdminSocialPostsByIdErrors]; export type PatchAdminSocialPostsByIdResponses = { /** * Success */ 200: { data?: SocialPost; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSocialPostsByIdResponse = PatchAdminSocialPostsByIdResponses[keyof PatchAdminSocialPostsByIdResponses]; export type DeleteAdminApplicationsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/applications/{id}"; }; export type DeleteAdminApplicationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminApplicationsByIdError = DeleteAdminApplicationsByIdErrors[keyof DeleteAdminApplicationsByIdErrors]; export type DeleteAdminApplicationsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminApplicationsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/applications/{id}"; }; export type GetAdminApplicationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminApplicationsByIdError = GetAdminApplicationsByIdErrors[keyof GetAdminApplicationsByIdErrors]; export type GetAdminApplicationsByIdResponses = { /** * Success */ 200: { data?: Application; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminApplicationsByIdResponse = GetAdminApplicationsByIdResponses[keyof GetAdminApplicationsByIdResponses]; export type PatchAdminApplicationsByIdData = { /** * Request body for the /applications/:id operation on application resource */ body?: { data: { attributes?: { /** * Multi-tier MFA enforcement policy for this application. * * * `:required` — every user must complete MFA at login * * `:tenant_choice` — defer to each tenant's `mfa_policy`; login-time * aggregate evaluates all user tenants under this application * * `:user_choice` — defer to per-user opt-in via MfaCredential.mfa_required (default) * */ mfa_policy?: "required" | "tenant_choice" | "user_choice"; /** * When true, authenticated users may create org tenants (is_personal: false) via this application */ allow_org_creation?: boolean | null; /** * Controls who can send invitations: :open (any member with invite permission) or :admin_only (tenant admins only) */ invitation_mode?: "open" | "admin_only"; oauth?: ApplicationOauthInputUpdateType; /** * Email sender address (falls back to system default) */ sender_email?: string | null; /** * Failed logins permitted per email per lockout window before lockout triggers. */ login_lockout_threshold?: number | null; /** * Platform-wide ceiling for concurrent tool execution per agent. Nil means no limit. */ max_parallel_tools_global?: number | null; /** * Maximum concurrent agent executions per workspace */ max_concurrent_executions_per_workspace?: number | null; /** * Maximum concurrent agent executions per tenant (aggregate across all workspaces) */ max_concurrent_executions_per_tenant?: number | null; /** * Default portal configuration for all tenants under this application */ portal_defaults?: { [key: string]: unknown; } | null; /** * When true, user registration requires invitation */ invite_only?: boolean | null; /** * ISV's base URL for email links (verification, password reset, magic links) */ base_url?: string | null; description?: string | null; name?: string | null; /** * Email sender display name (falls back to system default) */ sender_name?: string | null; /** * How the platform delivers auth-related emails (verification, invitation, * and future similar flows) to users for this Application. * * * `:link` - emails contain a click-through URL anchored on `base_url` * * `:code` - emails contain a paste-able 6-character code; no link * * Per-call override is available on each email-emitting action via that * action's own argument (verification: `confirmation_method`; invitation: * `email_method`); the per-call value takes precedence over this default * when set. * */ system_email_method?: "link" | "code"; /** * Sliding window (seconds) over which failed attempts are counted. */ login_lockout_window_seconds?: number | null; /** * Optional allowlist of source IPs permitted to mint Forms access tokens via POST /apps/:app_id/form-access-tokens. `nil` = no IP check. */ allowed_server_ips?: Array | null; badge_url?: string | null; /** * Workspace mode: single (auto-resolve) or multi (explicit) */ workspace_mode?: "single" | "multi"; /** * Soft-lockout duration (seconds) once the threshold is hit. */ login_lockout_duration_seconds?: number | null; /** * Memorable slug for vanity URLs */ vanity_slug?: string | null; /** * Additional ops/finance contacts for Layer 1 billing communications, * including overdraft warnings, account suspension notices, and payout * failures. Application owner delivery is handled separately. * */ billing_contact_emails?: Array | null; /** * Payment gateway provider for this application's tenants */ payment_provider?: "qorpay" | "stripe"; /** * Voice session auto-timeout in minutes. NULL falls back to platform default (30). */ voice_session_timeout_minutes?: number | null; /** * Per-capability configuration (encrypted at rest) */ capability_config?: unknown; /** * Per-workspace concurrent voice session cap. NULL falls back to platform default (10). */ voice_max_sessions_per_workspace?: number | null; /** * When true, password registration withholds JWT until email is verified */ require_email_verification?: boolean | null; slug?: string | null; /** * When true, the application's registry at /r/{app_slug}/ is publicly readable without a token. */ public_registry?: boolean | null; /** * DEPRECATED: Use Plan.initial_credits instead. Credits allocated to new tenants registering via this application */ default_free_credits?: number | null; /** * Bundles enabled for this application. Standard tier enabled by default; premium bundles require a premium plan. The app-wide opt-in `ai_workload_routing` is added by name, not by default. */ enabled_capabilities?: Array | null; logo_url?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "application"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/applications/{id}"; }; export type PatchAdminApplicationsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminApplicationsByIdError = PatchAdminApplicationsByIdErrors[keyof PatchAdminApplicationsByIdErrors]; export type PatchAdminApplicationsByIdResponses = { /** * Success */ 200: { data?: Application; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminApplicationsByIdResponse = PatchAdminApplicationsByIdResponses[keyof PatchAdminApplicationsByIdResponses]; export type PatchAdminInvitationsByIdDeclineData = { /** * Request body for the /invitations/:id/decline operation on invitation resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "invitation"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/invitations/{id}/decline"; }; export type PatchAdminInvitationsByIdDeclineErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminInvitationsByIdDeclineError = PatchAdminInvitationsByIdDeclineErrors[keyof PatchAdminInvitationsByIdDeclineErrors]; export type PatchAdminInvitationsByIdDeclineResponses = { /** * Success */ 200: { data?: Invitation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminInvitationsByIdDeclineResponse = PatchAdminInvitationsByIdDeclineResponses[keyof PatchAdminInvitationsByIdDeclineResponses]; export type GetAdminClinicalHealthMetricsByTypeData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; patient_id: string; metric_type: string; from_date?: string; to_date?: string; }; url: "/admin/clinical/health-metrics/by-type"; }; export type GetAdminClinicalHealthMetricsByTypeErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalHealthMetricsByTypeError = GetAdminClinicalHealthMetricsByTypeErrors[keyof GetAdminClinicalHealthMetricsByTypeErrors]; export type GetAdminClinicalHealthMetricsByTypeResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-health-metric */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalHealthMetricsByTypeResponse = GetAdminClinicalHealthMetricsByTypeResponses[keyof GetAdminClinicalHealthMetricsByTypeResponses]; export type PostAdminUsersAuthPasswordResetRequestData = { /** * Request body for the /users/auth/password-reset/request operation on user resource */ body: { data: { application_id?: string | null; email: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: never; url: "/admin/users/auth/password-reset/request"; }; export type PostAdminUsersAuthPasswordResetRequestErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminUsersAuthPasswordResetRequestError = PostAdminUsersAuthPasswordResetRequestErrors[keyof PostAdminUsersAuthPasswordResetRequestErrors]; export type PostAdminUsersAuthPasswordResetRequestResponses = { /** * Success */ 201: { [key: string]: unknown; }; }; export type PostAdminUsersAuthPasswordResetRequestResponse = PostAdminUsersAuthPasswordResetRequestResponses[keyof PostAdminUsersAuthPasswordResetRequestResponses]; export type GetAdminSchedulingEventTypesBySlugData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; slug: string; }; url: "/admin/scheduling/event-types/by-slug"; }; export type GetAdminSchedulingEventTypesBySlugErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSchedulingEventTypesBySlugError = GetAdminSchedulingEventTypesBySlugErrors[keyof GetAdminSchedulingEventTypesBySlugErrors]; export type GetAdminSchedulingEventTypesBySlugResponses = { /** * Success */ 200: { data?: SchedulingEventType; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSchedulingEventTypesBySlugResponse = GetAdminSchedulingEventTypesBySlugResponses[keyof GetAdminSchedulingEventTypesBySlugResponses]; export type DeleteAdminClinicalGoalTemplatesCatalogByIdPermanentData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/goal-templates/catalog/{id}/permanent"; }; export type DeleteAdminClinicalGoalTemplatesCatalogByIdPermanentErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminClinicalGoalTemplatesCatalogByIdPermanentError = DeleteAdminClinicalGoalTemplatesCatalogByIdPermanentErrors[keyof DeleteAdminClinicalGoalTemplatesCatalogByIdPermanentErrors]; export type DeleteAdminClinicalGoalTemplatesCatalogByIdPermanentResponses = { /** * Deleted successfully */ 200: unknown; }; export type PostAdminEmailMarketingCampaignsByIdSendData = { /** * Request body for the /email-marketing/campaigns/:id/send operation on campaign resource */ body: { data: { campaign_id: string; connector_id: string; connector_type: string; workspace_id: string; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: never; url: "/admin/email-marketing/campaigns/{id}/send"; }; export type PostAdminEmailMarketingCampaignsByIdSendErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminEmailMarketingCampaignsByIdSendError = PostAdminEmailMarketingCampaignsByIdSendErrors[keyof PostAdminEmailMarketingCampaignsByIdSendErrors]; export type PostAdminEmailMarketingCampaignsByIdSendResponses = { /** * Success */ 201: { result: { [key: string]: unknown; }; }; }; export type PostAdminEmailMarketingCampaignsByIdSendResponse = PostAdminEmailMarketingCampaignsByIdSendResponses[keyof PostAdminEmailMarketingCampaignsByIdSendResponses]; export type GetAdminScanResultsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/scan-results/{id}"; }; export type GetAdminScanResultsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminScanResultsByIdError = GetAdminScanResultsByIdErrors[keyof GetAdminScanResultsByIdErrors]; export type GetAdminScanResultsByIdResponses = { /** * Success */ 200: { data?: ScanResult; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminScanResultsByIdResponse = GetAdminScanResultsByIdResponses[keyof GetAdminScanResultsByIdResponses]; export type GetAdminRecipesNutritionSummariesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/nutrition-summaries/{id}"; }; export type GetAdminRecipesNutritionSummariesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesNutritionSummariesByIdError = GetAdminRecipesNutritionSummariesByIdErrors[keyof GetAdminRecipesNutritionSummariesByIdErrors]; export type GetAdminRecipesNutritionSummariesByIdResponses = { /** * Success */ 200: { data?: RecipesNutritionSummary; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesNutritionSummariesByIdResponse = GetAdminRecipesNutritionSummariesByIdResponses[keyof GetAdminRecipesNutritionSummariesByIdResponses]; export type PostAdminSupportQueueMembersData = { /** * Request body for the /support/queue-members operation on support-queue-member resource */ body: { data: { attributes?: { is_available?: boolean | null; max_concurrent_tickets?: number | null; queue_id: string; role?: "agent" | "lead" | "supervisor"; user_id: string; }; relationships?: { [key: string]: never; }; type?: "support-queue-member"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/queue-members"; }; export type PostAdminSupportQueueMembersErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminSupportQueueMembersError = PostAdminSupportQueueMembersErrors[keyof PostAdminSupportQueueMembersErrors]; export type PostAdminSupportQueueMembersResponses = { /** * Success */ 201: { data?: SupportQueueMember; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminSupportQueueMembersResponse = PostAdminSupportQueueMembersResponses[keyof PostAdminSupportQueueMembersResponses]; export type PatchAdminSettlementStatementsByIdMarkPaidData = { /** * Request body for the /settlement-statements/:id/mark-paid operation on settlement-statement resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "settlement-statement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/settlement-statements/{id}/mark-paid"; }; export type PatchAdminSettlementStatementsByIdMarkPaidErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSettlementStatementsByIdMarkPaidError = PatchAdminSettlementStatementsByIdMarkPaidErrors[keyof PatchAdminSettlementStatementsByIdMarkPaidErrors]; export type PatchAdminSettlementStatementsByIdMarkPaidResponses = { /** * Success */ 200: { data?: SettlementStatement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSettlementStatementsByIdMarkPaidResponse = PatchAdminSettlementStatementsByIdMarkPaidResponses[keyof PatchAdminSettlementStatementsByIdMarkPaidResponses]; export type GetAdminProcessingActivitiesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/processing-activities"; }; export type GetAdminProcessingActivitiesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminProcessingActivitiesError = GetAdminProcessingActivitiesErrors[keyof GetAdminProcessingActivitiesErrors]; export type GetAdminProcessingActivitiesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a processing-activity */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminProcessingActivitiesResponse = GetAdminProcessingActivitiesResponses[keyof GetAdminProcessingActivitiesResponses]; export type PostAdminProcessingActivitiesData = { /** * Request body for the /processing-activities operation on processing-activity resource */ body: { data: { attributes?: { /** * EphiAsset IDs linked to this processing activity */ asset_ids?: Array | null; /** * Categories of personal data processed */ data_categories?: Array | null; /** * Categories of data subjects */ data_subjects?: Array | null; /** * Whether this processing activity involves ePHI */ ephi_classification?: "contains_ephi" | "no_ephi"; /** * Last review date for this processing activity */ last_reviewed_at?: unknown; legal_basis?: "consent" | "contract" | "legal_obligation" | "vital_interests" | "public_task" | "legitimate_interest"; /** * HIPAA minimum necessary standard justification */ minimum_necessary_justification?: string | null; name: string; /** * Purpose of processing */ purpose: string; /** * Recipients or categories of recipients */ recipients?: Array | null; /** * How long data is retained */ retention_period?: string | null; /** * How often this activity should be reviewed (days) */ review_frequency_days?: number | null; /** * Description of technical and organizational security measures */ security_measures?: string | null; status?: "active" | "archived"; /** * Countries where data is transferred */ transfer_countries?: Array | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "processing-activity"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/processing-activities"; }; export type PostAdminProcessingActivitiesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminProcessingActivitiesError = PostAdminProcessingActivitiesErrors[keyof PostAdminProcessingActivitiesErrors]; export type PostAdminProcessingActivitiesResponses = { /** * Success */ 201: { data?: ProcessingActivity; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminProcessingActivitiesResponse = PostAdminProcessingActivitiesResponses[keyof PostAdminProcessingActivitiesResponses]; export type PostAdminEmailMarketingSenderProfilesData = { /** * Request body for the /email-marketing/sender-profiles operation on email-marketing-sender-profile resource */ body: { data: { attributes?: { address?: string | null; company?: string | null; email: string; is_default?: boolean | null; name: string; phone?: string | null; signature?: string | null; }; relationships?: { [key: string]: never; }; type?: "email-marketing-sender-profile"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email-marketing/sender-profiles"; }; export type PostAdminEmailMarketingSenderProfilesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminEmailMarketingSenderProfilesError = PostAdminEmailMarketingSenderProfilesErrors[keyof PostAdminEmailMarketingSenderProfilesErrors]; export type PostAdminEmailMarketingSenderProfilesResponses = { /** * Success */ 201: { data?: EmailMarketingSenderProfile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminEmailMarketingSenderProfilesResponse = PostAdminEmailMarketingSenderProfilesResponses[keyof PostAdminEmailMarketingSenderProfilesResponses]; export type PatchAdminReviewsByIdUnclaimData = { /** * Request body for the /reviews/:id/unclaim operation on review resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "review"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/reviews/{id}/unclaim"; }; export type PatchAdminReviewsByIdUnclaimErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminReviewsByIdUnclaimError = PatchAdminReviewsByIdUnclaimErrors[keyof PatchAdminReviewsByIdUnclaimErrors]; export type PatchAdminReviewsByIdUnclaimResponses = { /** * Success */ 200: { data?: Review; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminReviewsByIdUnclaimResponse = PatchAdminReviewsByIdUnclaimResponses[keyof PatchAdminReviewsByIdUnclaimResponses]; export type PatchAdminPaymentMethodsByIdDefaultData = { /** * Request body for the /payment-methods/:id/default operation on payment-method resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "payment-method"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/payment-methods/{id}/default"; }; export type PatchAdminPaymentMethodsByIdDefaultErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminPaymentMethodsByIdDefaultError = PatchAdminPaymentMethodsByIdDefaultErrors[keyof PatchAdminPaymentMethodsByIdDefaultErrors]; export type PatchAdminPaymentMethodsByIdDefaultResponses = { /** * Success */ 200: { data?: PaymentMethod; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminPaymentMethodsByIdDefaultResponse = PatchAdminPaymentMethodsByIdDefaultResponses[keyof PatchAdminPaymentMethodsByIdDefaultResponses]; export type GetAdminExtractionBatchesByIdUploadUrlsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; /** * Number of files to upload */ file_count?: number; /** * Optional list of filenames */ filenames?: Array; }; url: "/admin/extraction/batches/{id}/upload-urls"; }; export type GetAdminExtractionBatchesByIdUploadUrlsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminExtractionBatchesByIdUploadUrlsError = GetAdminExtractionBatchesByIdUploadUrlsErrors[keyof GetAdminExtractionBatchesByIdUploadUrlsErrors]; export type GetAdminExtractionBatchesByIdUploadUrlsResponses = { /** * Success */ 200: { data?: ExtractionBatch; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminExtractionBatchesByIdUploadUrlsResponse = GetAdminExtractionBatchesByIdUploadUrlsResponses[keyof GetAdminExtractionBatchesByIdUploadUrlsResponses]; export type GetAdminIsvPricingOverridesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/isv-pricing-overrides"; }; export type GetAdminIsvPricingOverridesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminIsvPricingOverridesError = GetAdminIsvPricingOverridesErrors[keyof GetAdminIsvPricingOverridesErrors]; export type GetAdminIsvPricingOverridesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a isv-pricing-override */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminIsvPricingOverridesResponse = GetAdminIsvPricingOverridesResponses[keyof GetAdminIsvPricingOverridesResponses]; export type PostAdminIsvPricingOverridesData = { /** * Request body for the /isv-pricing-overrides operation on isv-pricing-override resource */ body: { data: { attributes?: { /** * ISV Application this override applies to */ application_id: string; /** * Whether this override is active */ is_enabled?: boolean | null; /** * Custom margin % (NULL = use default) */ margin_percent?: number | null; /** * Admin notes about this override */ notes?: string | null; /** * Schedule A operation key being overridden */ operation_key: string; /** * Custom credit rate (NULL = use default from PlatformPricingConfig) */ rate_credits?: number | null; }; relationships?: { [key: string]: never; }; type?: "isv-pricing-override"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/isv-pricing-overrides"; }; export type PostAdminIsvPricingOverridesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminIsvPricingOverridesError = PostAdminIsvPricingOverridesErrors[keyof PostAdminIsvPricingOverridesErrors]; export type PostAdminIsvPricingOverridesResponses = { /** * Success */ 201: { data?: IsvPricingOverride; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminIsvPricingOverridesResponse = PostAdminIsvPricingOverridesResponses[keyof PostAdminIsvPricingOverridesResponses]; export type GetAdminCompliancePostureData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/compliance/posture"; }; export type GetAdminCompliancePostureErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCompliancePostureError = GetAdminCompliancePostureErrors[keyof GetAdminCompliancePostureErrors]; export type GetAdminCompliancePostureResponses = { /** * Success */ 200: { data?: CompliancePosture; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCompliancePostureResponse = GetAdminCompliancePostureResponses[keyof GetAdminCompliancePostureResponses]; export type PatchAdminSettlementsByIdReleaseData = { /** * Request body for the /settlements/:id/release operation on settlement resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "settlement"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/settlements/{id}/release"; }; export type PatchAdminSettlementsByIdReleaseErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSettlementsByIdReleaseError = PatchAdminSettlementsByIdReleaseErrors[keyof PatchAdminSettlementsByIdReleaseErrors]; export type PatchAdminSettlementsByIdReleaseResponses = { /** * Success */ 200: { data?: Settlement; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSettlementsByIdReleaseResponse = PatchAdminSettlementsByIdReleaseResponses[keyof PatchAdminSettlementsByIdReleaseResponses]; export type GetAdminTenantsByTenantIdStatsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { tenant_id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/tenants/{tenant_id}/stats"; }; export type GetAdminTenantsByTenantIdStatsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminTenantsByTenantIdStatsError = GetAdminTenantsByTenantIdStatsErrors[keyof GetAdminTenantsByTenantIdStatsErrors]; export type GetAdminTenantsByTenantIdStatsResponses = { /** * Success */ 200: { data?: TenantStats; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminTenantsByTenantIdStatsResponse = GetAdminTenantsByTenantIdStatsResponses[keyof GetAdminTenantsByTenantIdStatsResponses]; export type GetAdminCasePipelineLinksData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/case-pipeline-links"; }; export type GetAdminCasePipelineLinksErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCasePipelineLinksError = GetAdminCasePipelineLinksErrors[keyof GetAdminCasePipelineLinksErrors]; export type GetAdminCasePipelineLinksResponses = { /** * Success */ 200: { /** * An array of resource objects representing a case-pipeline-link */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCasePipelineLinksResponse = GetAdminCasePipelineLinksResponses[keyof GetAdminCasePipelineLinksResponses]; export type GetAdminRecipesEnrichmentJobsRecipeByRecipeIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { recipe_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/enrichment-jobs/recipe/{recipe_id}"; }; export type GetAdminRecipesEnrichmentJobsRecipeByRecipeIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesEnrichmentJobsRecipeByRecipeIdError = GetAdminRecipesEnrichmentJobsRecipeByRecipeIdErrors[keyof GetAdminRecipesEnrichmentJobsRecipeByRecipeIdErrors]; export type GetAdminRecipesEnrichmentJobsRecipeByRecipeIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a recipes-enrichment-job */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesEnrichmentJobsRecipeByRecipeIdResponse = GetAdminRecipesEnrichmentJobsRecipeByRecipeIdResponses[keyof GetAdminRecipesEnrichmentJobsRecipeByRecipeIdResponses]; export type DeleteAdminCrmSyncConfigsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/sync-configs/{id}"; }; export type DeleteAdminCrmSyncConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminCrmSyncConfigsByIdError = DeleteAdminCrmSyncConfigsByIdErrors[keyof DeleteAdminCrmSyncConfigsByIdErrors]; export type DeleteAdminCrmSyncConfigsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type PatchAdminCrmSyncConfigsByIdData = { /** * Request body for the /crm/sync-configs/:id operation on crm-sync-config resource */ body?: { data: { attributes?: { auto_create_contacts?: boolean | null; enabled?: boolean | null; entity_type_filters?: Array | null; pii_scan_enabled?: boolean | null; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-sync-config"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/sync-configs/{id}"; }; export type PatchAdminCrmSyncConfigsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmSyncConfigsByIdError = PatchAdminCrmSyncConfigsByIdErrors[keyof PatchAdminCrmSyncConfigsByIdErrors]; export type PatchAdminCrmSyncConfigsByIdResponses = { /** * Success */ 200: { data?: CrmSyncConfig; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmSyncConfigsByIdResponse = PatchAdminCrmSyncConfigsByIdResponses[keyof PatchAdminCrmSyncConfigsByIdResponses]; export type GetAdminClinicalSupplementTemplatesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/supplement-templates"; }; export type GetAdminClinicalSupplementTemplatesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalSupplementTemplatesError = GetAdminClinicalSupplementTemplatesErrors[keyof GetAdminClinicalSupplementTemplatesErrors]; export type GetAdminClinicalSupplementTemplatesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-supplement-template */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalSupplementTemplatesResponse = GetAdminClinicalSupplementTemplatesResponses[keyof GetAdminClinicalSupplementTemplatesResponses]; export type PostAdminClinicalSupplementTemplatesData = { /** * Request body for the /clinical/supplement-templates operation on clinical-supplement-template resource */ body: { data: { attributes?: { applicable_conditions?: Array | null; category?: string | null; description?: string | null; metadata?: { [key: string]: unknown; } | null; name: string; source_catalog_id?: string | null; supplements: Array<{ [key: string]: unknown; }>; tags?: Array | null; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "clinical-supplement-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/supplement-templates"; }; export type PostAdminClinicalSupplementTemplatesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminClinicalSupplementTemplatesError = PostAdminClinicalSupplementTemplatesErrors[keyof PostAdminClinicalSupplementTemplatesErrors]; export type PostAdminClinicalSupplementTemplatesResponses = { /** * Success */ 201: { data?: ClinicalSupplementTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminClinicalSupplementTemplatesResponse = PostAdminClinicalSupplementTemplatesResponses[keyof PostAdminClinicalSupplementTemplatesResponses]; export type GetAdminLlmAnalyticsCostsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/llm-analytics/costs"; }; export type GetAdminLlmAnalyticsCostsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminLlmAnalyticsCostsError = GetAdminLlmAnalyticsCostsErrors[keyof GetAdminLlmAnalyticsCostsErrors]; export type GetAdminLlmAnalyticsCostsResponses = { /** * Success */ 200: { data?: LlmAnalytics; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminLlmAnalyticsCostsResponse = GetAdminLlmAnalyticsCostsResponses[keyof GetAdminLlmAnalyticsCostsResponses]; export type GetAdminFormVersionsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/form-versions"; }; export type GetAdminFormVersionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminFormVersionsError = GetAdminFormVersionsErrors[keyof GetAdminFormVersionsErrors]; export type GetAdminFormVersionsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a form-version */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminFormVersionsResponse = GetAdminFormVersionsResponses[keyof GetAdminFormVersionsResponses]; export type PostAdminFormVersionsData = { /** * Request body for the /form-versions operation on form-version resource */ body: { data: { attributes?: { assistant_agent_version_id?: string | null; assistant_id?: string | null; changes_summary?: string | null; compliance_mode?: "standard" | "hipaa"; consent_required?: boolean | null; custom_css?: string | null; form_id: string; is_active?: boolean | null; layout_tree?: { [key: string]: unknown; } | null; logic_rules?: { [key: string]: unknown; } | null; output_schema?: { [key: string]: unknown; } | null; published_at?: unknown; published_by_id?: string | null; revision?: number | null; theme_id?: string | null; theme_overrides?: { [key: string]: unknown; } | null; version_number: number; }; relationships?: { [key: string]: never; }; type?: "form-version"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/form-versions"; }; export type PostAdminFormVersionsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminFormVersionsError = PostAdminFormVersionsErrors[keyof PostAdminFormVersionsErrors]; export type PostAdminFormVersionsResponses = { /** * Success */ 201: { data?: FormVersion; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminFormVersionsResponse = PostAdminFormVersionsResponses[keyof PostAdminFormVersionsResponses]; export type PostAdminUsersAuthRegisterWithOidcData = { /** * Request body for the /users/auth/register-with-oidc operation on user resource */ body: { data: { attributes?: { oauth_tokens: { [key: string]: unknown; }; user_info: { [key: string]: unknown; }; }; relationships?: { [key: string]: never; }; type?: "user"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/users/auth/register-with-oidc"; }; export type PostAdminUsersAuthRegisterWithOidcErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminUsersAuthRegisterWithOidcError = PostAdminUsersAuthRegisterWithOidcErrors[keyof PostAdminUsersAuthRegisterWithOidcErrors]; export type PostAdminUsersAuthRegisterWithOidcResponses = { /** * Success */ 201: { data?: User; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminUsersAuthRegisterWithOidcResponse = PostAdminUsersAuthRegisterWithOidcResponses[keyof PostAdminUsersAuthRegisterWithOidcResponses]; export type PatchAdminSupportTicketsByIdResolveData = { /** * Request body for the /support/tickets/:id/resolve operation on support-ticket resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "support-ticket"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/tickets/{id}/resolve"; }; export type PatchAdminSupportTicketsByIdResolveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminSupportTicketsByIdResolveError = PatchAdminSupportTicketsByIdResolveErrors[keyof PatchAdminSupportTicketsByIdResolveErrors]; export type PatchAdminSupportTicketsByIdResolveResponses = { /** * Success */ 200: { data?: SupportTicket; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminSupportTicketsByIdResolveResponse = PatchAdminSupportTicketsByIdResolveResponses[keyof PatchAdminSupportTicketsByIdResolveResponses]; export type GetAdminCdeScopeReportsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/cde-scope-reports"; }; export type GetAdminCdeScopeReportsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCdeScopeReportsError = GetAdminCdeScopeReportsErrors[keyof GetAdminCdeScopeReportsErrors]; export type GetAdminCdeScopeReportsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a cde-scope-report */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCdeScopeReportsResponse = GetAdminCdeScopeReportsResponses[keyof GetAdminCdeScopeReportsResponses]; export type PostAdminCdeScopeReportsData = { /** * Request body for the /cde-scope-reports operation on cde-scope-report resource */ body: { data: { attributes?: { assessor_notes?: string | null; data_flow_map?: { [key: string]: unknown; } | null; scope_boundary: "in_scope" | "out_of_scope" | "connected"; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "cde-scope-report"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/cde-scope-reports"; }; export type PostAdminCdeScopeReportsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCdeScopeReportsError = PostAdminCdeScopeReportsErrors[keyof PostAdminCdeScopeReportsErrors]; export type PostAdminCdeScopeReportsResponses = { /** * Success */ 201: { data?: CdeScopeReport; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCdeScopeReportsResponse = PostAdminCdeScopeReportsResponses[keyof PostAdminCdeScopeReportsResponses]; export type GetAdminCatalogViewsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/catalog/views/workspace/{workspace_id}"; }; export type GetAdminCatalogViewsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCatalogViewsWorkspaceByWorkspaceIdError = GetAdminCatalogViewsWorkspaceByWorkspaceIdErrors[keyof GetAdminCatalogViewsWorkspaceByWorkspaceIdErrors]; export type GetAdminCatalogViewsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a catalog-view */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCatalogViewsWorkspaceByWorkspaceIdResponse = GetAdminCatalogViewsWorkspaceByWorkspaceIdResponses[keyof GetAdminCatalogViewsWorkspaceByWorkspaceIdResponses]; export type PatchAdminStorageFilesByIdTagData = { /** * Request body for the /storage-files/:id/tag operation on storage-file resource */ body?: { data: { attributes?: { tags?: Array | null; }; id: string; relationships?: { [key: string]: never; }; type?: "storage-file"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/storage-files/{id}/tag"; }; export type PatchAdminStorageFilesByIdTagErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminStorageFilesByIdTagError = PatchAdminStorageFilesByIdTagErrors[keyof PatchAdminStorageFilesByIdTagErrors]; export type PatchAdminStorageFilesByIdTagResponses = { /** * Success */ 200: { data?: StorageFile; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminStorageFilesByIdTagResponse = PatchAdminStorageFilesByIdTagResponses[keyof PatchAdminStorageFilesByIdTagResponses]; export type PatchAdminCrmEmailAddressesByIdSetPrimaryData = { /** * Request body for the /crm/email-addresses/:id/set-primary operation on crm-email-address resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "crm-email-address"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crm/email-addresses/{id}/set-primary"; }; export type PatchAdminCrmEmailAddressesByIdSetPrimaryErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminCrmEmailAddressesByIdSetPrimaryError = PatchAdminCrmEmailAddressesByIdSetPrimaryErrors[keyof PatchAdminCrmEmailAddressesByIdSetPrimaryErrors]; export type PatchAdminCrmEmailAddressesByIdSetPrimaryResponses = { /** * Success */ 200: { data?: CrmEmailAddress; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminCrmEmailAddressesByIdSetPrimaryResponse = PatchAdminCrmEmailAddressesByIdSetPrimaryResponses[keyof PatchAdminCrmEmailAddressesByIdSetPrimaryResponses]; export type GetAdminAiConversationsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ai/conversations"; }; export type GetAdminAiConversationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminAiConversationsError = GetAdminAiConversationsErrors[keyof GetAdminAiConversationsErrors]; export type GetAdminAiConversationsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a chat-conversation */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminAiConversationsResponse = GetAdminAiConversationsResponses[keyof GetAdminAiConversationsResponses]; export type PostAdminAiConversationsData = { /** * Request body for the /ai/conversations operation on chat-conversation resource */ body: { data: { attributes?: { /** * Structured data providing context for this conversation (e.g., failed prediction results) */ context_data?: { [key: string]: unknown; } | null; tenant_id: string; title?: string | null; user_id: string; workspace_id?: string | null; }; relationships?: { [key: string]: never; }; type?: "chat-conversation"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ai/conversations"; }; export type PostAdminAiConversationsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAiConversationsError = PostAdminAiConversationsErrors[keyof PostAdminAiConversationsErrors]; export type PostAdminAiConversationsResponses = { /** * Success */ 201: { data?: ChatConversation; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAiConversationsResponse = PostAdminAiConversationsResponses[keyof PostAdminAiConversationsResponses]; export type DeleteAdminRecipesTagsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/tags/{id}"; }; export type DeleteAdminRecipesTagsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type DeleteAdminRecipesTagsByIdError = DeleteAdminRecipesTagsByIdErrors[keyof DeleteAdminRecipesTagsByIdErrors]; export type DeleteAdminRecipesTagsByIdResponses = { /** * Deleted successfully */ 200: unknown; }; export type GetAdminRecipesTagsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/tags/{id}"; }; export type GetAdminRecipesTagsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRecipesTagsByIdError = GetAdminRecipesTagsByIdErrors[keyof GetAdminRecipesTagsByIdErrors]; export type GetAdminRecipesTagsByIdResponses = { /** * Success */ 200: { data?: RecipesTag; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRecipesTagsByIdResponse = GetAdminRecipesTagsByIdResponses[keyof GetAdminRecipesTagsByIdResponses]; export type PatchAdminRecipesTagsByIdData = { /** * Request body for the /recipes/tags/:id operation on recipes-tag resource */ body?: { data: { attributes?: { category?: "cuisine" | "diet" | "health" | "course" | "technique" | "custom"; metadata?: { [key: string]: unknown; } | null; name?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "recipes-tag"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/recipes/tags/{id}"; }; export type PatchAdminRecipesTagsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminRecipesTagsByIdError = PatchAdminRecipesTagsByIdErrors[keyof PatchAdminRecipesTagsByIdErrors]; export type PatchAdminRecipesTagsByIdResponses = { /** * Success */ 200: { data?: RecipesTag; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminRecipesTagsByIdResponse = PatchAdminRecipesTagsByIdResponses[keyof PatchAdminRecipesTagsByIdResponses]; export type PatchAdminExtractionDocumentsByIdFinishUploadData = { /** * Request body for the /extraction/documents/:id/finish-upload operation on extraction-document resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "extraction-document"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/extraction/documents/{id}/finish-upload"; }; export type PatchAdminExtractionDocumentsByIdFinishUploadErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminExtractionDocumentsByIdFinishUploadError = PatchAdminExtractionDocumentsByIdFinishUploadErrors[keyof PatchAdminExtractionDocumentsByIdFinishUploadErrors]; export type PatchAdminExtractionDocumentsByIdFinishUploadResponses = { /** * Success */ 200: { data?: ExtractionDocument; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminExtractionDocumentsByIdFinishUploadResponse = PatchAdminExtractionDocumentsByIdFinishUploadResponses[keyof PatchAdminExtractionDocumentsByIdFinishUploadResponses]; export type GetAdminClinicalPracticeToolsByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-tools/{id}"; }; export type GetAdminClinicalPracticeToolsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPracticeToolsByIdError = GetAdminClinicalPracticeToolsByIdErrors[keyof GetAdminClinicalPracticeToolsByIdErrors]; export type GetAdminClinicalPracticeToolsByIdResponses = { /** * Success */ 200: { data?: ClinicalPracticeTool; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPracticeToolsByIdResponse = GetAdminClinicalPracticeToolsByIdResponses[keyof GetAdminClinicalPracticeToolsByIdResponses]; export type PatchAdminClinicalPracticeToolsByIdData = { /** * Request body for the /clinical/practice-tools/:id operation on clinical-practice-tool resource */ body?: { data: { attributes?: { app_store_url?: string | null; category?: string | null; description?: string | null; icon_url?: string | null; integrations?: Array | null; is_active?: boolean | null; logo_url?: string | null; metadata?: { [key: string]: unknown; } | null; name?: string | null; platform?: string | null; play_store_url?: string | null; pricing_model?: "free" | "freemium" | "paid" | "prescription"; privacy_rating?: "hipaa_compliant" | "hipaa_partial" | "standard" | "unknown"; rating?: string | number | unknown; supported_platforms?: Array | null; tags?: Array | null; tool_type?: string | null; url?: string | null; website_url?: string | null; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-practice-tool"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/practice-tools/{id}"; }; export type PatchAdminClinicalPracticeToolsByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalPracticeToolsByIdError = PatchAdminClinicalPracticeToolsByIdErrors[keyof PatchAdminClinicalPracticeToolsByIdErrors]; export type PatchAdminClinicalPracticeToolsByIdResponses = { /** * Success */ 200: { data?: ClinicalPracticeTool; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalPracticeToolsByIdResponse = PatchAdminClinicalPracticeToolsByIdResponses[keyof PatchAdminClinicalPracticeToolsByIdResponses]; export type GetAdminMeetingActionItemsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/meeting-action-items"; }; export type GetAdminMeetingActionItemsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminMeetingActionItemsError = GetAdminMeetingActionItemsErrors[keyof GetAdminMeetingActionItemsErrors]; export type GetAdminMeetingActionItemsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a meeting-action-item */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminMeetingActionItemsResponse = GetAdminMeetingActionItemsResponses[keyof GetAdminMeetingActionItemsResponses]; export type GetAdminClinicalDeliveriesByIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/deliveries/{id}"; }; export type GetAdminClinicalDeliveriesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalDeliveriesByIdError = GetAdminClinicalDeliveriesByIdErrors[keyof GetAdminClinicalDeliveriesByIdErrors]; export type GetAdminClinicalDeliveriesByIdResponses = { /** * Success */ 200: { data?: ClinicalDelivery; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalDeliveriesByIdResponse = GetAdminClinicalDeliveriesByIdResponses[keyof GetAdminClinicalDeliveriesByIdResponses]; export type PatchAdminClinicalDeliveriesByIdData = { /** * Request body for the /clinical/deliveries/:id operation on clinical-delivery resource */ body?: { data: { attributes?: { delivered_at?: unknown; email_message_id?: string | null; metadata?: { [key: string]: unknown; } | null; status?: "sent" | "delivered" | "failed" | "bounced"; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-delivery"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/deliveries/{id}"; }; export type PatchAdminClinicalDeliveriesByIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalDeliveriesByIdError = PatchAdminClinicalDeliveriesByIdErrors[keyof PatchAdminClinicalDeliveriesByIdErrors]; export type PatchAdminClinicalDeliveriesByIdResponses = { /** * Success */ 200: { data?: ClinicalDelivery; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalDeliveriesByIdResponse = PatchAdminClinicalDeliveriesByIdResponses[keyof PatchAdminClinicalDeliveriesByIdResponses]; export type GetAdminSupportSyncConfigsWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/support/sync-configs/workspace/{workspace_id}"; }; export type GetAdminSupportSyncConfigsWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSupportSyncConfigsWorkspaceByWorkspaceIdError = GetAdminSupportSyncConfigsWorkspaceByWorkspaceIdErrors[keyof GetAdminSupportSyncConfigsWorkspaceByWorkspaceIdErrors]; export type GetAdminSupportSyncConfigsWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a support-sync-config */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSupportSyncConfigsWorkspaceByWorkspaceIdResponse = GetAdminSupportSyncConfigsWorkspaceByWorkspaceIdResponses[keyof GetAdminSupportSyncConfigsWorkspaceByWorkspaceIdResponses]; export type GetAdminPlatformTonesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/platform-tones"; }; export type GetAdminPlatformTonesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminPlatformTonesError = GetAdminPlatformTonesErrors[keyof GetAdminPlatformTonesErrors]; export type GetAdminPlatformTonesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a platform-tone */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminPlatformTonesResponse = GetAdminPlatformTonesResponses[keyof GetAdminPlatformTonesResponses]; export type PostAdminPlatformTonesData = { /** * Request body for the /platform-tones operation on platform-tone resource */ body: { data: { attributes?: { brand_identity_id: string; call_to_action?: string | null; custom_instructions?: string | null; emoji_policy?: "none" | "minimal" | "moderate" | "heavy"; hashtag_count?: number | null; max_length?: number | null; platform: "facebook" | "instagram" | "threads" | "twitter" | "linkedin" | "reddit" | "bluesky"; tone?: "casual" | "professional" | "humorous" | "inspirational" | "educational" | "promotional"; }; relationships?: { [key: string]: never; }; type?: "platform-tone"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/platform-tones"; }; export type PostAdminPlatformTonesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminPlatformTonesError = PostAdminPlatformTonesErrors[keyof PostAdminPlatformTonesErrors]; export type PostAdminPlatformTonesResponses = { /** * Success */ 201: { data?: PlatformTone; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminPlatformTonesResponse = PostAdminPlatformTonesResponses[keyof PostAdminPlatformTonesResponses]; export type GetAdminSocialPostsAccountBySocialAccountIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { social_account_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/social/posts/account/{social_account_id}"; }; export type GetAdminSocialPostsAccountBySocialAccountIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminSocialPostsAccountBySocialAccountIdError = GetAdminSocialPostsAccountBySocialAccountIdErrors[keyof GetAdminSocialPostsAccountBySocialAccountIdErrors]; export type GetAdminSocialPostsAccountBySocialAccountIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a social-post */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminSocialPostsAccountBySocialAccountIdResponse = GetAdminSocialPostsAccountBySocialAccountIdResponses[keyof GetAdminSocialPostsAccountBySocialAccountIdResponses]; export type GetAdminRetentionPoliciesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/retention-policies"; }; export type GetAdminRetentionPoliciesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRetentionPoliciesError = GetAdminRetentionPoliciesErrors[keyof GetAdminRetentionPoliciesErrors]; export type GetAdminRetentionPoliciesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a retention-policy */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRetentionPoliciesResponse = GetAdminRetentionPoliciesResponses[keyof GetAdminRetentionPoliciesResponses]; export type PostAdminRetentionPoliciesData = { /** * Request body for the /retention-policies operation on retention-policy resource */ body: { data: { attributes?: { action_on_expiry: "delete" | "archive" | "anonymize"; /** * Category of data (e.g., chat_messages, documents, knowledge_files) */ data_type: string; enabled?: boolean | null; retention_days: number; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "retention-policy"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/retention-policies"; }; export type PostAdminRetentionPoliciesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminRetentionPoliciesError = PostAdminRetentionPoliciesErrors[keyof PostAdminRetentionPoliciesErrors]; export type PostAdminRetentionPoliciesResponses = { /** * Success */ 201: { data?: RetentionPolicy; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminRetentionPoliciesResponse = PostAdminRetentionPoliciesResponses[keyof PostAdminRetentionPoliciesResponses]; export type GetAdminCrawlerSchedulesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/schedules"; }; export type GetAdminCrawlerSchedulesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminCrawlerSchedulesError = GetAdminCrawlerSchedulesErrors[keyof GetAdminCrawlerSchedulesErrors]; export type GetAdminCrawlerSchedulesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a crawler-schedule */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminCrawlerSchedulesResponse = GetAdminCrawlerSchedulesResponses[keyof GetAdminCrawlerSchedulesResponses]; export type PostAdminCrawlerSchedulesData = { /** * Request body for the /crawler/schedules operation on crawler-schedule resource */ body: { data: { attributes?: { crawl_config?: { [key: string]: unknown; } | null; cron_expression?: string | null; frequency?: "hourly" | "daily" | "weekly" | "monthly"; mode?: "single" | "site" | "sitemap"; name: string; news_monitor_id?: string | null; next_run_at?: unknown; notify_on_change?: boolean | null; url: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "crawler-schedule"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/crawler/schedules"; }; export type PostAdminCrawlerSchedulesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminCrawlerSchedulesError = PostAdminCrawlerSchedulesErrors[keyof PostAdminCrawlerSchedulesErrors]; export type PostAdminCrawlerSchedulesResponses = { /** * Success */ 201: { data?: CrawlerSchedule; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminCrawlerSchedulesResponse = PostAdminCrawlerSchedulesResponses[keyof PostAdminCrawlerSchedulesResponses]; export type GetAdminEmailInboundReceivedWorkspaceByWorkspaceIdData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { workspace_id: string; }; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/email/inbound/received/workspace/{workspace_id}"; }; export type GetAdminEmailInboundReceivedWorkspaceByWorkspaceIdErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminEmailInboundReceivedWorkspaceByWorkspaceIdError = GetAdminEmailInboundReceivedWorkspaceByWorkspaceIdErrors[keyof GetAdminEmailInboundReceivedWorkspaceByWorkspaceIdErrors]; export type GetAdminEmailInboundReceivedWorkspaceByWorkspaceIdResponses = { /** * Success */ 200: { /** * An array of resource objects representing a email-inbound-email */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminEmailInboundReceivedWorkspaceByWorkspaceIdResponse = GetAdminEmailInboundReceivedWorkspaceByWorkspaceIdResponses[keyof GetAdminEmailInboundReceivedWorkspaceByWorkspaceIdResponses]; export type PostAdminAiEmbedData = { /** * Request body for the /ai/embed operation on embedding resource */ body: { data: { attributes?: { model?: string | null; text: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "embedding"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/ai/embed"; }; export type PostAdminAiEmbedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminAiEmbedError = PostAdminAiEmbedErrors[keyof PostAdminAiEmbedErrors]; export type PostAdminAiEmbedResponses = { /** * Success */ 201: { data?: Embedding; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminAiEmbedResponse = PostAdminAiEmbedResponses[keyof PostAdminAiEmbedResponses]; export type GetAdminReviewQueueMembershipsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/review-queue-memberships"; }; export type GetAdminReviewQueueMembershipsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminReviewQueueMembershipsError = GetAdminReviewQueueMembershipsErrors[keyof GetAdminReviewQueueMembershipsErrors]; export type GetAdminReviewQueueMembershipsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a review-queue-membership */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminReviewQueueMembershipsResponse = GetAdminReviewQueueMembershipsResponses[keyof GetAdminReviewQueueMembershipsResponses]; export type PostAdminReviewQueueMembershipsData = { /** * Request body for the /review-queue-memberships operation on review-queue-membership resource */ body: { data: { attributes?: { membership_role?: "member" | "supervisor"; queue_id: string; user_id: string; workspace_id: string; }; relationships?: { [key: string]: never; }; type?: "review-queue-membership"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/review-queue-memberships"; }; export type PostAdminReviewQueueMembershipsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminReviewQueueMembershipsError = PostAdminReviewQueueMembershipsErrors[keyof PostAdminReviewQueueMembershipsErrors]; export type PostAdminReviewQueueMembershipsResponses = { /** * Success */ 201: { data?: ReviewQueueMembership; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminReviewQueueMembershipsResponse = PostAdminReviewQueueMembershipsResponses[keyof PostAdminReviewQueueMembershipsResponses]; export type GetAdminClinicalPracticeToolsCategoriesCatalogData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; application_id?: string; }; url: "/admin/clinical/practice-tools/categories/catalog"; }; export type GetAdminClinicalPracticeToolsCategoriesCatalogErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalPracticeToolsCategoriesCatalogError = GetAdminClinicalPracticeToolsCategoriesCatalogErrors[keyof GetAdminClinicalPracticeToolsCategoriesCatalogErrors]; export type GetAdminClinicalPracticeToolsCategoriesCatalogResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-practice-tool-category */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalPracticeToolsCategoriesCatalogResponse = GetAdminClinicalPracticeToolsCategoriesCatalogResponses[keyof GetAdminClinicalPracticeToolsCategoriesCatalogResponses]; export type PatchAdminClinicalClientMedicationsByIdArchiveData = { /** * Request body for the /clinical/client-medications/:id/archive operation on clinical-client-medication resource */ body?: { data: { attributes?: { [key: string]: never; }; id: string; relationships?: { [key: string]: never; }; type?: "clinical-client-medication"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path: { id: string; }; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/clinical/client-medications/{id}/archive"; }; export type PatchAdminClinicalClientMedicationsByIdArchiveErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PatchAdminClinicalClientMedicationsByIdArchiveError = PatchAdminClinicalClientMedicationsByIdArchiveErrors[keyof PatchAdminClinicalClientMedicationsByIdArchiveErrors]; export type PatchAdminClinicalClientMedicationsByIdArchiveResponses = { /** * Success */ 200: { data?: ClinicalClientMedication; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PatchAdminClinicalClientMedicationsByIdArchiveResponse = PatchAdminClinicalClientMedicationsByIdArchiveResponses[keyof PatchAdminClinicalClientMedicationsByIdArchiveResponses]; export type GetAdminRolesData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/roles"; }; export type GetAdminRolesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminRolesError = GetAdminRolesErrors[keyof GetAdminRolesErrors]; export type GetAdminRolesResponses = { /** * Success */ 200: { /** * An array of resource objects representing a role */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminRolesResponse = GetAdminRolesResponses[keyof GetAdminRolesResponses]; export type PostAdminRolesData = { /** * Request body for the /roles operation on role resource */ body: { data: { attributes?: { application_id?: string | null; description?: string | null; is_system_default?: boolean | null; name: string; permissions?: Array | null; }; relationships?: { [key: string]: never; }; type?: "role"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/roles"; }; export type PostAdminRolesErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminRolesError = PostAdminRolesErrors[keyof PostAdminRolesErrors]; export type PostAdminRolesResponses = { /** * Success */ 201: { data?: Role; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminRolesResponse = PostAdminRolesResponses[keyof PostAdminRolesResponses]; export type GetAdminClinicalClientMedicationsArchivedData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; workspace_id: string; }; url: "/admin/clinical/client-medications/archived"; }; export type GetAdminClinicalClientMedicationsArchivedErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminClinicalClientMedicationsArchivedError = GetAdminClinicalClientMedicationsArchivedErrors[keyof GetAdminClinicalClientMedicationsArchivedErrors]; export type GetAdminClinicalClientMedicationsArchivedResponses = { /** * Success */ 200: { /** * An array of resource objects representing a clinical-client-medication */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminClinicalClientMedicationsArchivedResponse = GetAdminClinicalClientMedicationsArchivedResponses[keyof GetAdminClinicalClientMedicationsArchivedResponses]; export type PostAdminComplianceDocumentTemplatesCloneData = { /** * Request body for the /compliance-document-templates/clone operation on compliance-document-template resource */ body: { data: { attributes?: { application_id?: string | null; /** * Markdown/Mustache template with {{variables}} */ content_template: string; regulatory_framework: "hipaa" | "gdpr" | "pci_dss" | "sox"; required_variables?: Array | null; template_type: "baa" | "npp" | "privacy_policy" | "security_policy" | "incident_response_plan" | "contingency_plan" | "access_control_policy" | "risk_management_plan" | "training_policy" | "sanction_policy" | "breach_notification_policy" | "system_activity_review" | "data_retention_policy" | "minimum_necessary_policy" | "authorization_form" | "dpa"; title: string; version: string; }; relationships?: { [key: string]: never; }; type?: "compliance-document-template"; }; }; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/compliance-document-templates/clone"; }; export type PostAdminComplianceDocumentTemplatesCloneErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type PostAdminComplianceDocumentTemplatesCloneError = PostAdminComplianceDocumentTemplatesCloneErrors[keyof PostAdminComplianceDocumentTemplatesCloneErrors]; export type PostAdminComplianceDocumentTemplatesCloneResponses = { /** * Success */ 201: { data?: ComplianceDocumentTemplate; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type PostAdminComplianceDocumentTemplatesCloneResponse = PostAdminComplianceDocumentTemplatesCloneResponses[keyof PostAdminComplianceDocumentTemplatesCloneResponses]; export type GetAdminVoiceRecordingsData = { body?: never; headers: { /** * API key for authentication and application routing (e.g., sk_app_xxx, sk_srv_xxx) */ "x-application-key": string; }; path?: never; query?: { /** * JSON:API filter parameters (use flat query string format: filter[field][operator]=value) */ filter?: { [key: string]: unknown; }; /** * Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas. */ sort?: string; /** * JSON:API pagination parameters (use flat query string format: page[limit]=20&page[offset]=0) */ page?: { [key: string]: unknown; }; /** * Include related resources in the response. Comma-separated list of relationship names to eager-load. */ include?: string; /** * JSON:API sparse fieldsets (use flat query string format: fields[type]=field1,field2) */ fields?: { [key: string]: unknown; }; }; url: "/admin/voice/recordings"; }; export type GetAdminVoiceRecordingsErrors = { /** * Bad Request - Invalid input data or malformed request */ 400: ErrorResponse; /** * Unauthorized - Missing or invalid authentication token */ 401: ErrorResponse; /** * Forbidden - Authenticated but not authorized for this resource */ 403: ErrorResponse; /** * Not Found - Resource does not exist */ 404: ErrorResponse; /** * Too Many Requests - Rate limit exceeded */ 429: ErrorResponse; /** * Internal Server Error - Unexpected server error */ 500: ErrorResponse; /** * General Error */ default: Errors; }; export type GetAdminVoiceRecordingsError = GetAdminVoiceRecordingsErrors[keyof GetAdminVoiceRecordingsErrors]; export type GetAdminVoiceRecordingsResponses = { /** * Success */ 200: { /** * An array of resource objects representing a voice-recording */ data?: Array; included?: Array; meta?: { [key: string]: unknown; }; }; }; export type GetAdminVoiceRecordingsResponse = GetAdminVoiceRecordingsResponses[keyof GetAdminVoiceRecordingsResponses]; //# sourceMappingURL=types.gen.d.ts.map