@nivaro/sdk 0.1.17 → 0.1.19

package/README.md

@@ -24,6 +24,14 @@ The `@nivaro/sdk` package is a fully-typed TypeScript client for the Nivaro REST
 pnpm add @nivaro/sdk
 ```
 
+#### MCP server (Claude Code, Claude Desktop, Cursor)
+
+The companion package `@nivaro/mcp` wraps the SDK as a Model Context Protocol server, so an AI coding assistant can read and write an instance directly: collection schemas, record reads and aggregates, rehearsed creates, updates, deletes with an explicit confirm, pipeline state and transitions, and the instance's own ask-your-data assistant. It authenticates with an `nvk_` API key, so role permissions, row-level security and user scopes apply unchanged; a sandbox key is read-only by construction. Install and client config snippets live in the package README (`packages/mcp/README.md`).
+
+```typescript
+claude mcp add nivaro -e NIVARO_URL=https://nivaro.example.com -e NIVARO_TOKEN=nvk_... -- npx -y @nivaro/mcp
+```
+
 #### Create a client
 
 ```typescript
@@ -2446,6 +2454,92 @@ await nivaro.request(createHierarchyConfig({
 
 ---
 
+## SDK — Help Videos
+
+Tutorial recordings: upload, edit, version, publish, choose where they show, require viewing and track progress. Authoring commands need an author (an administrator or a role in the author setting); reading and progress need only visibility.
+
+```typescript
+import {
+  openHelpVideoUpload, finalizeHelpVideoUpload, createHelpVideo,
+  setHelpVideoContexts, publishHelpVideo, helpVideosFor,
+} from '@nivaro/sdk'
+
+// 1. Open an upload, send the bytes, finalize, create the video
+const { data: up } = await nivaro.request(openHelpVideoUpload('video/webm'))
+let part = up.next_part
+for (const chunk of chunks) {
+  // Raw PUT — not a Command, because Commands JSON-encode their bodies.
+  await fetch(`${baseUrl}/api/help-videos/uploads/${up.id}/parts/${part++}`, {
+    method: 'PUT',
+    headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/octet-stream' },
+    body: chunk, // at most 8 MB per part; the response is the upload session
+  })
+}
+await nivaro.request(finalizeHelpVideoUpload(up.id, { duration_ms }))
+const { data: video } = await nivaro.request(createHelpVideo({ upload_id: up.id, title: 'Raise a PO' }))
+
+// 2. Say where it shows, then publish
+await nivaro.request(setHelpVideoContexts(video.id, [{ kind: 'page', key: 'inbox', state_key: null }]))
+await nivaro.request(publishHelpVideo(video.id))
+
+// 3. Show the right videos on a screen
+const { data } = await nivaro.request(helpVideosFor({ collection: 'purchase_orders', item: 42 }))
+```
+
+#### Response notes
+
+- `stream_url`, `captions_url` and `poster_url` are ticketed (`?st=`): hand them to `<video>`, `<track>` and `<img>` as-is. Authors also get `draft_stream_url` and `draft_captions_url`.
+- `published.playable` is `false` when a viewer’s stream would answer 409 (the video is still being prepared); authors always get `true`.
+- `required` is true when the video is required for the caller’s own role. Authors also get `required_role_ids`. `my_progress` is the caller’s own progress (or `null`).
+- `recordHelpVideoProgress` takes `buckets` as a 20-character `0`/`1` string (the 5% sections seen) and answers `{ data: { completed } }`, or no body (204) for a masquerade session.
+- `listHelpVideos` and `helpVideosFor` carry `can_author`, so a screen can offer "Add a video" without a second call.
+
+#### Errors callers must handle
+
+| Status | code | When |
+| --- | --- | --- |
+| 409 | `HELP_VIDEO_PROCESSING` | A viewer requested `stream_url` before a current render exists and the original cannot be shown. Check `published.playable`, retry later. |
+| 409 | `HELP_VIDEO_EDITS_CONFLICT` | `saveHelpVideoDraft` with a stale `base_hash`. The body carries `current_hash`; reload the draft and merge. |
+| 409 | `UPLOAD_CLOSED` | The upload is already finalized or finishing; or, on discard, already used by a video or discarded. |
+| 422 | `UPLOAD_NOT_VIDEO` | A part is not a WebM or MP4 recording. |
+| 422 | `UPLOAD_TOO_LONG` | The recording is longer than 30 minutes (on finalize). |
+| 422 | `HELP_VIDEO_NOT_READY` | `publishHelpVideo` before the checklist is done; the body lists `missing`. |
+| 409 | `HELP_VIDEO_NOTHING_TO_PUBLISH` | `publishHelpVideo` with no draft, or a draft that is exactly the published version (`draft_matches_published`). With `watch_again` on a video someone must watch, it re-asks them instead. |
+| 422 | `HELP_VIDEO_EDITS_INVALID` | `saveHelpVideoDraft` with edits that cannot be kept, such as cuts that leave less than a second. The message says why; the stored draft is unchanged. |
+| 409 | `HELP_VIDEO_NOTHING_TO_RENDER` | `rerenderHelpVideo` for a version that does not exist. |
+| 403 | `HELP_VIDEO_AUTHOR_ONLY` | An authoring command by a non-author. |
+| 404 | `HELP_VIDEO_NOT_FOUND` | Unknown id, or a video the caller may not see. |
+
+| Command | Route | Auth |
+| --- | --- | --- |
+| listHelpVideos(params?) | GET /help-videos | Authenticated |
+| readHelpVideo(id) | GET /help-videos/:id | Authenticated |
+| helpVideosFor(params) | GET /help-videos/for | Authenticated |
+| createHelpVideo(body) | POST /help-videos | Author |
+| updateHelpVideo(id, body) | PATCH /help-videos/:id | Author |
+| setHelpVideoContexts(id, contexts) | PUT /help-videos/:id/contexts | Author |
+| setHelpVideoRequirements(id, role_ids) | PUT /help-videos/:id/requirements | Author |
+| archiveHelpVideo(id, opts?) | DELETE /help-videos/:id | Author (purge: admin, archived videos only) |
+| readHelpVideoDraft(id) | GET /help-videos/:id/draft/edits | Author |
+| saveHelpVideoDraft(id, edits, base_hash?) | PUT /help-videos/:id/draft/edits | Author |
+| publishHelpVideo(id, opts?) | POST /help-videos/:id/publish | Author |
+| rerecordHelpVideo(id, upload_id) | POST /help-videos/:id/rerecord | Author |
+| listHelpVideoVersions(id) | GET /help-videos/:id/versions | Author |
+| restoreHelpVideoVersion(id, versionId) | POST /help-videos/:id/versions/:vid/restore | Author |
+| rerenderHelpVideo(id, opts?) | POST /help-videos/:id/render | Author |
+| recordHelpVideoProgress(id, body) | POST /help-videos/:id/progress | Authenticated |
+| readRequiredHelpVideos() | GET /help-videos/required/mine | Authenticated |
+| readHelpVideoAnalytics(id) | GET /help-videos/:id/analytics | Author |
+| readHelpVideoWalk(id) | GET /help-videos/:id/walk | Authenticated |
+| openHelpVideoUpload(mime) | POST /help-videos/uploads | Author |
+| finalizeHelpVideoUpload(id, meta?) | POST /help-videos/uploads/:id/finalize | Author |
+| listMyHelpVideoUploads() | GET /help-videos/uploads/mine | Author |
+| abandonHelpVideoUpload(id) | DELETE /help-videos/uploads/:id | Author |
+| listHelpVideoPages() | GET /help-videos/pages | Authenticated |
+| registerHelpVideoPage(body) | POST /help-videos/pages | Author |
+
+---
+
 ## SDK Coverage: 300+ Typed Commands
 
 The @nivaro/sdk command surface now covers every feature area — roughly 175 typed `Command<T>` factories spanning items, files, workflows, pipelines, flows, comments, webhooks, rules, custom queries, trees and hierarchies, submission forms, field watches, notification subscriptions, imports, SLA, alerts, AI endpoints (generate, summarize, validate, check-duplicates), translations, drafts, scheduled changes, record templates, saved views, API keys, widget feeds, sync jobs, ERP submissions, PDF templates, pages, queues (worklists, items, claims, saved views, trends, workload), roles & policies (RBAC/RLS), user management + out-of-office delegation, file management (list/meta/presign/transform URLs), dashboard widgets, extension item/bulk actions, throughput reporting, and more. If a REST route exists, there is a typed command for it.

package/dist/index.d.ts

@@ -4492,6 +4492,366 @@ declare function fileTransformPath(id: string, options?: {
     quality?: number;
 }): string;
 
+/**
+ * Help videos: tutorial recordings with edits, versions, where they show,
+ * required viewing and progress. Upload parts are raw octet-stream PUTs to
+ * /help-videos/uploads/:id/parts/:n (see README); everything else is here.
+ *
+ * Error codes callers must handle (all JSON `{ error, code }`):
+ * - 409 `HELP_VIDEO_PROCESSING`: a viewer's `stream_url` answers this while the
+ *   video is still being rendered (check `published.playable` first).
+ * - 409 `HELP_VIDEO_EDITS_CONFLICT`: `saveHelpVideoDraft` with a stale
+ *   `base_hash`; the body also carries `current_hash`.
+ * - 409 `UPLOAD_CLOSED`: the upload was already finalized or is finishing.
+ * - 422 `UPLOAD_NOT_VIDEO`: a part is not a WebM or MP4 recording.
+ * - 422 `UPLOAD_TOO_LONG`: the recording is over 30 minutes (finalize).
+ * Also: 403 `HELP_VIDEO_AUTHOR_ONLY` on any authoring command by a non-author,
+ * 404 `HELP_VIDEO_NOT_FOUND` for an unknown or invisible video.
+ */
+
+type HelpVideoContext = {
+    kind: 'collection' | 'page';
+    key: string;
+    state_key: string | null;
+};
+type HelpVideoVisibility = {
+    mode: 'everyone' | 'roles';
+    role_ids: string[];
+};
+interface HelpVideoVersion {
+    id: string;
+    version: number;
+    edits: Record<string, unknown>;
+    edits_hash: string;
+    source_duration_ms: number | null;
+    width: number | null;
+    height: number | null;
+    render_status: 'none' | 'queued' | 'rendering' | 'ready' | 'failed' | 'unavailable';
+    render_progress: number | null;
+    render_error: string | null;
+    rendered_current: boolean;
+    /** Published version only: false when a non-author would get a 409 HELP_VIDEO_PROCESSING. */
+    playable?: boolean;
+    note: string | null;
+    created_at: string;
+    /** Draft, re-record and restore results only (recorder data). Clicks on the
+     *  recorded tab: `t_ms` source time, `x`/`y` fractions (0–1) of the frame. */
+    clicks?: HelpVideoClick[] | null;
+    /** Microphone loudness 0–1, one value per 100 ms of source time. */
+    levels?: number[] | null;
+}
+/**
+ * One recorded click. Recorded on the author's own tab, a click also says
+ * what was clicked: `label` (accessible name, ≤ 80 chars, never an input's
+ * value), `role` (button, link, tab…), `hook` (nearest `data-*` attribute as
+ * `data-name` or `data-name=value`), `page_key` (the help-video page key of
+ * the screen, when one is registered), `path` (no query string) and `origin`.
+ */
+interface HelpVideoClick {
+    t_ms: number;
+    x: number;
+    y: number;
+    label?: string;
+    role?: string;
+    hook?: string;
+    page_key?: string;
+    path?: string;
+    /** The app's origin (`https://host`) the click happened on. */
+    origin?: string;
+}
+/** One step of "Show me on this page": a labelled click of the published version. */
+interface HelpVideoWalkStep {
+    label: string;
+    role: string | null;
+    hook: string | null;
+    page_key: string | null;
+    path: string | null;
+    origin: string | null;
+    /** Where the step happens in the finished video (edited time). */
+    edited_ms: number;
+    /** The callout or box text shown around the click, else null. */
+    text: string | null;
+}
+/** Ticketed download links (`attachment`), relative to the API origin. */
+interface HelpVideoDownloadUrls {
+    video: string;
+    captions_vtt: string | null;
+    captions_srt: string | null;
+}
+interface HelpVideoProgress {
+    position_ms: number;
+    completed: boolean;
+    percent: number;
+}
+interface HelpVideo {
+    id: string;
+    title: string;
+    description: string | null;
+    category: string | null;
+    status: 'draft' | 'published' | 'archived';
+    duration_ms: number | null;
+    /** Ticketed URLs (`?st=`): play them as-is, do not rebuild them. */
+    poster_url: string | null;
+    stream_url: string | null;
+    captions_url: string | null;
+    contexts: HelpVideoContext[];
+    /** Required for THIS viewer's role (not for the video in general). */
+    required: boolean;
+    published: HelpVideoVersion | null;
+    /** Authors only. */
+    visibility?: HelpVideoVisibility;
+    required_role_ids?: string[];
+    draft?: HelpVideoVersion | null;
+    /** Author-only: the draft is exactly the published version; publishing it
+     *  answers 409 `HELP_VIDEO_NOTHING_TO_PUBLISH`. */
+    draft_matches_published?: boolean;
+    draft_stream_url?: string | null;
+    draft_captions_url?: string | null;
+    /** Author-only: viewers may download (authors always may). */
+    allow_downloads?: boolean;
+    /** Author-only: the draft's downloads. */
+    draft_download_urls?: HelpVideoDownloadUrls | null;
+    created_by_name?: string | null;
+    /** Null when this person may not download the published version. */
+    download_urls: HelpVideoDownloadUrls | null;
+    updated_at: string;
+    my_progress: HelpVideoProgress | null;
+}
+/** An upload session, as returned by open, each part PUT and "my uploads". */
+interface HelpVideoUploadSession {
+    id: string;
+    mime: string;
+    bytes_received: number;
+    next_part: number;
+    /** `open` while parts arrive; `finalized` once uploaded (listed by
+     *  `listMyHelpVideoUploads` only while no video uses it). */
+    status: string;
+    /** Probed length of a finalized recording; null while open. */
+    duration_ms: number | null;
+    created_at: string;
+    updated_at: string;
+}
+interface HelpVideoFinalizedUpload {
+    file_id: string;
+    duration_ms: number | null;
+    width: number | null;
+    height: number | null;
+    has_audio: boolean;
+    clicks: unknown;
+    levels: unknown;
+}
+declare function listHelpVideos(params?: {
+    search?: string;
+    category?: string;
+    status?: string;
+    page?: number;
+    limit?: number;
+}): Command<{
+    data: HelpVideo[];
+    total: number;
+    categories: string[];
+    can_author: boolean;
+}>;
+declare function readHelpVideo(id: string): Command<{
+    data: HelpVideo;
+}>;
+declare function helpVideosFor(params: {
+    collection?: string;
+    item?: string | number;
+    state?: string;
+    page?: string;
+}): Command<{
+    data: HelpVideo[];
+    can_author: boolean;
+    state: string | null;
+}>;
+declare function createHelpVideo(body: {
+    upload_id: string;
+    title?: string;
+    contexts?: HelpVideoContext[];
+}): Command<{
+    data: HelpVideo;
+}>;
+declare function updateHelpVideo(id: string, body: {
+    title?: string;
+    description?: string | null;
+    category?: string | null;
+    visibility?: HelpVideoVisibility;
+    /** Viewers may download (authors always may). */
+    allow_downloads?: boolean;
+}): Command<{
+    data: HelpVideo;
+}>;
+declare function setHelpVideoContexts(id: string, contexts: HelpVideoContext[]): Command<{
+    data: {
+        ok: true;
+    };
+}>;
+declare function setHelpVideoRequirements(id: string, role_ids: string[]): Command<{
+    data: {
+        ok: true;
+        added: string[];
+    };
+}>;
+/** Archives the video; `purge: true` deletes it for good (administrators only, and only once it is archived). */
+declare function archiveHelpVideo(id: string, opts?: {
+    purge?: boolean;
+}): Command<void>;
+/**
+ * The guided walk of the published version: its labelled clicks that viewers
+ * see, in order. Same visibility as watching; a draft is never walked, so a
+ * video without a published version (or recorded without labels) has none.
+ */
+declare function readHelpVideoWalk(id: string): Command<{
+    data: {
+        version_id: string | null;
+        steps: HelpVideoWalkStep[];
+    };
+}>;
+declare function readHelpVideoDraft(id: string): Command<{
+    data: HelpVideoVersion;
+}>;
+/** 409 `HELP_VIDEO_EDITS_CONFLICT` (body carries `current_hash`) when `base_hash` is stale. */
+declare function saveHelpVideoDraft(id: string, edits: Record<string, unknown>, base_hash?: string): Command<{
+    data: HelpVideoVersion;
+}>;
+/** 422 `HELP_VIDEO_NOT_READY` (body lists `missing`) or 409 `HELP_VIDEO_NOTHING_TO_PUBLISH`
+ *  (no draft, or the draft equals what is published). With `watch_again` on an
+ *  unchanged video someone must watch, the requirement is re-armed instead: no
+ *  new version, no render. */
+declare function publishHelpVideo(id: string, opts?: {
+    watch_again?: boolean;
+}): Command<{
+    data: HelpVideo;
+}>;
+declare function rerecordHelpVideo(id: string, upload_id: string): Command<{
+    data: HelpVideoVersion;
+}>;
+declare function listHelpVideoVersions(id: string): Command<{
+    data: Array<HelpVideoVersion & {
+        is_published: boolean;
+        is_draft: boolean;
+        created_by_name: string | null;
+    }>;
+}>;
+declare function restoreHelpVideoVersion(id: string, versionId: string): Command<{
+    data: HelpVideoVersion;
+}>;
+/** Re-queue the render of the published version (or the draft with `draft`).
+ *  409 `HELP_VIDEO_NOTHING_TO_RENDER` when that version does not exist. */
+declare function rerenderHelpVideo(id: string, opts?: {
+    draft?: boolean;
+}): Command<{
+    data: {
+        ok: true;
+    };
+}>;
+/** `buckets` is a 20-character string of 0/1: the 5% sections watched so far.
+ *  Resolves with no body (204) for a masquerade session, which is never tracked. */
+declare function recordHelpVideoProgress(id: string, body: {
+    position_ms: number;
+    watched_ms_delta: number;
+    buckets: string;
+    version_id?: string;
+}): Command<{
+    data: {
+        completed: boolean;
+    };
+} | undefined>;
+declare function readRequiredHelpVideos(): Command<{
+    data: HelpVideo[];
+}>;
+declare function readHelpVideoAnalytics(id: string): Command<{
+    data: {
+        views: number;
+        unique_viewers: number;
+        completion_rate: number;
+        drop_off: number[];
+        watched_hours: number;
+    };
+}>;
+declare function openHelpVideoUpload(mime: string): Command<{
+    data: HelpVideoUploadSession;
+}>;
+/** 409 `UPLOAD_CLOSED`, 422 `UPLOAD_TOO_LONG`, 422 `UPLOAD_EMPTY`, 422 `UPLOAD_UNREADABLE`. */
+declare function finalizeHelpVideoUpload(id: string, meta?: {
+    duration_ms?: number;
+    clicks?: unknown;
+    levels?: unknown;
+}): Command<{
+    data: HelpVideoFinalizedUpload;
+}>;
+/** Your unfinished uploads and finished recordings never saved as a video
+ *  (save one with `createHelpVideo` / `rerecordHelpVideo`, no finalize). */
+declare function listMyHelpVideoUploads(): Command<{
+    data: HelpVideoUploadSession[];
+}>;
+/** Discards an open upload, or a finished recording no video uses (its file
+ *  is deleted). 409 `UPLOAD_CLOSED` for anything else. */
+declare function abandonHelpVideoUpload(id: string): Command<void>;
+declare function listHelpVideoPages(): Command<{
+    data: Array<{
+        key: string;
+        label: string;
+        app: string | null;
+    }>;
+}>;
+declare function registerHelpVideoPage(body: {
+    key: string;
+    label: string;
+    app?: string;
+}): Command<void>;
+/** A fresh ticketed download link for the published version (or the draft,
+ *  authors only). The link answers with the file as an attachment: the
+ *  current render, or the original only when the edits hide nothing; 409
+ *  `HELP_VIDEO_PROCESSING` while a viewer's video is being prepared.
+ *  403 `HELP_VIDEO_DOWNLOAD_OFF` when downloads are off for this viewer. */
+declare function readHelpVideoDownloadLink(id: string, opts?: {
+    file?: 'video' | 'captions.vtt' | 'captions.srt';
+    draft?: boolean;
+}): Command<{
+    data: {
+        url: string;
+    };
+}>;
+/** Administrators: a 10-minute link to a package (tar) of these published
+ *  videos — files plus a manifest — to import on another instance. */
+declare function exportHelpVideoPackage(ids: string[]): Command<{
+    data: {
+        url: string;
+        count: number;
+    };
+}>;
+/** Administrators: start an import. Send the package as raw
+ *  application/octet-stream PUTs of at most 8 MB to
+ *  /help-videos/packages/imports/:id/parts/:n (n from 0), then preview. */
+declare function openHelpVideoPackageImport(): Command<{
+    data: {
+        id: string;
+        next_part: number;
+        max_bytes: number;
+    };
+}>;
+/** Checks the uploaded package and says what applying it would do; writes nothing.
+ *  422 `HELP_VIDEO_PACKAGE_INVALID` when the package is unusable as a whole. */
+declare function previewHelpVideoPackageImport(id: string): Command<{
+    data: unknown;
+}>;
+/** Applies a previewed package (every usable video, or only `video_ids`). */
+declare function applyHelpVideoPackageImport(id: string, video_ids?: string[]): Command<{
+    data: {
+        results: Array<{
+            id: string;
+            title: string;
+            outcome: 'created' | 'updated' | 'failed' | 'skipped';
+            version?: number;
+            render?: 'reused' | 'queued';
+            error?: string;
+        }>;
+    };
+}>;
+declare function discardHelpVideoPackageImport(id: string): Command<void>;
+
 interface ImportTemplateSummary {
     id: string;
     name: string;
@@ -7192,4 +7552,4 @@ declare function submitFormItem(collection: string, values: Record<string, unkno
     data: Record<string, unknown>;
 }>;
 
-export { type AccessAudit, type AccessAuditFinding, type AccessAuditRun, type AccessAuditSubject, type AccessReason, type ActivityEntry, type ActivityQuery, type ActivityReportQuery, type ActivityReportRow, type ActivityReportSummary, type Addendum, type AddendumStatus, type AggregateQuery, type AggregateRow, type AiChatTraceEntry, type AiCollectionSettings, type AiColumnMapping, type AiDuplicateMatch, type AiQueryFilter, type AiQueryResult, type AiReviewFinding, type AiViolation, type AlertDefinition, type AlertLogEntry, type AlertSubscription, type AnomalyDefinition, type AnomalyRule, type ApiAnalyticsBucket, type ApiAnalyticsCollection, type ApiAnalyticsPath, type ApiAnalyticsSummary, type ApiErrorLog, type ApiKey, type ApiKeyScope, type ApprovalBrief, type ApprovalChain, type ApprovalChainStep, type ApprovalDecision, type ApprovalInstance, type ApprovalInstanceDetail, type ApprovalStatus, type ApprovalStepInput, type AtRiskCondition, type AtRiskOp, type AtRiskResult, type AtRiskRule, type AtRiskSummaryEntry, type AttributeDefinition, type AttributeValue, type BatchRead, type BatchReadResult, type BlackoutDate, type BoolFilterOps, type CMSCollection, type CascadeFilterRule, type ChangeOrder, type ChatChannel, type ChatChannelMember, type ChatDirectoryChannel, type ChatMessage, type ChatPin, type ChatReaction, type ChatRoomKind, type ChatRoomSummary, type ChatRoomType, type ChatSearchHit, type CollectionLayout, type CollectionPresetSummary, type Command, type Comment, type ConfigSnapshot, type ConfigTableClassification, type ContentBundle, type ContentExportFormat, type ContentExportOptions, type CoverageGapItem, type CoverageGapOwner, type CoverageGapReport, type CronJob, type CustomQuery, type DataQualityRule, type DataQualityRuleResult, type DataQualityRuleType, type DataQualityRun, type DataQualitySeverity, type DeadLetter, type DraftPublishConfig, type DraftStatus, type DryRunReport, type ErpSubmission, type ErpSubmissionStatus, type ExtensionManifest, type ExternalApi, type ExternalApiEndpoint, type ExternalApiSchema, type ExternalApiSlotContext, type ExternalApiSpecImportResult, type ExternalApiTestResult, type FieldChangeEntry, type FieldCondition, type FieldConfig, type FieldDependencyConfig, type FieldFilter, type FieldGroup, type FieldTranslations, type FieldVisibilityRules, type FieldWatch, type FileRecord, type FileUploadResult, type FileUsageEntry, type Filter, type FlowReplayResult, type FlowRun, type FlowTestStep, type FormFieldDescriptor, type FormFieldRelation, type FormGroupDescriptor, type FormLockCondition, type FormSchema, type FormValidationRule, type FormVisibilityRule, type GlobalSearchRecord, type GlobalSearchResults, type GraphQLResponse, type HierarchyConfigDef, type HierarchyFlatNode, type HierarchyLevelDef, type HierarchyNestedNode, type IDFilterOps, type ISODate, type ImportDefinition, type ImportJob, type ImportParseResponse, type ImportPreview, type ImportPreviewDiff, type ImportTemplateSummary, type InstanceOwner, type IntegrationApiHealth, type InternalWidget, type Issue, type IssueSeverity, type IssueStatus, type IssueSummary, type ItemLock, type LastTouch, type LayoutAssignment, type LayoutGroup, type LayoutVersion, type ListResponse, type ManagedUser, type MetricAlertRule, type MetricAlertSubscription, type MetricDefinition, type MyTask, type MyWorkOwnedEntry, type MyWorkSla, type MyWorkSummary, type NivaroClient, type NivaroClientOptions, type NivaroExtensionPlugin, type NivaroRealtime, type NivaroRuntime, type NotificationItem, type NotificationPage, type NotificationSubscription, type NumberFilterOps, type OmniSearchHit, type OnlinePresenceConfig, type OnlinePresenceUser, type Page, type PageLayout, type PageSlotKey, type PageWidget, type PdfTemplate, type PermissionSimulation, type PersistedQuery, type PickerExclusionStatus, type PipelineFlowEdge, type PipelineFlowState, type PipelineImpactResult, type PipelineOwnerGroup, type PipelineOwnerGroupUser, type PipelineSimulation, type PipelineState, type PipelineVersionEntry, type PluginSlots, type Policy, type PreflightCheck, type PreflightReport, type PreflightSeverity, type PresenceClient, type PresenceOptions, type PresenceSession, type PresenceSessionInfo, type PresenceViewer, type PromotionApplyResult, type PromotionPreview, type Query, type Queue, type QueueColumnPrefs, type QueueCondition, type QueueDetail, type QueueDisplayConfig, type QueueItem, type QueueItemsResult, type QueueOwner, type QueueRowClickMode, type QueueScope, type QueueSource, type QueueSourceType, type QueueStats, type QueueTrendPoint, type QueueView, type QueueViewKind, type QueueWorkloadRow, READ_MANY_MAX, type RealtimeEvent, type RecordGraphEdge, type RecordGraphNode, type RecordLink, type RecordLinkType, type RecordTemplate, type RecordViewRecap, type RegisteredAction, type RelatedCommentEntry, type RelationFilter, type RelationOption, type ReportAlert, type ReportAlertCondition, type ReportAlertLogEntry, type ReportAnnotation, type ReportColumnFormat, type ReportDateRange, type ReportDef, type ReportEntityFilter, type ReportFilterPreset, type ReportQueryColumn, type ReportQueryWidgetConfig, type ReportSnapshotEntry, type ReportSubscription, type ReportTemplateEntry, type ReportVersionEntry, type ReportWidget, type ReportWidgetConfig, type ReportWidgetData, type ReportWidgetPreset, type ReportWidgetType, type RequestTrace, type ResolvedOwner, type RetentionPolicy, type RetentionRun, type RetentionRunResult, type Revision, type Role, type Rule, type SavedView, type ScheduledChange, type ScheduledReport, type ScopeDimension, type ScopeDimensionInfo, type SemanticSearchMatch, type SessionRecording, type ShareLink, type SlaBatchStatus, type SlaRule, type SlaStatus, type StagedImportRun, type StagedImportStats, type StringFilterOps, type SubRow, type SubRowTemplate, type SyncJob, type Task, type TaskDoneWhenRule, type TaskPriority, type TaskStatus, type TimelineEvent, type TraceSpan, type TreeFlatNode, type TreeNestedNode, type TreeNodeConfig, type TreePermission, type TreePermissionAction, type UUID, type UserActivityEntry, type UserActivitySummary, type UserScopesInfo, type ViewSubscription, type VirtualCollection, type Webhook, type WebhookDelivery, type WidgetFeed, type WorkflowBinding, type WorkflowHistoryEntry, type WorkflowInstance, type WorkflowInstanceData, type WorkflowState, type WorkflowTransition, type Workspace, type WorkspaceQuotas, type WorkspaceTemplate, type WorkspaceUsage, _and, _contains, _ends_with, _eq, _gt, _gte, _in, _lt, _lte, _ncontains, _neq, _nin, _nnull, _none, _null, _or, _some, _starts_with, acquireItemLock, activateLayout, addChatChannelMember, addInstanceOwner, addSubRow, aggregateItems, aiBrief, aiBuildReport, aiChat, aiCheckDuplicates, aiGenerate, aiMapColumns, aiQuery, aiReportFilters, aiReview, aiSummarize, aiValidate, appendSessionRecordingEvents, applyContentBundle, applyRecordTemplate, applySubRowTemplate, approveAddendum, approveAiProposal, asc, backupExportPath, batchPickerExclusionStatus, bulkPickerExclusion, callExternalApi, callExternalApiEndpoint, cancelScheduledChange, cancelStagedImport, cascadeFieldDependencies, checkBlackoutDate, claimQueueItem, claimTask, clearTraces, cloneItem, cloneLayout, cloneReport, compareConfigSnapshot, completeTask, copyReportWidget, createAccessAudit, createAddendum, createAlertDefinition, createAlertSubscription, createAnomalyRule, createApiKey, createApprovalChain, createAtRiskRule, createAttributeDefinition, createBlackoutDate, createChatChannel, createChatRoomType, createCollectionLayout, createComment, createDataQualityRule, createExternalApi, createExternalApiEndpoint, createFieldGroup, createFieldWatch, createGroupDm, createHierarchyConfig, createImportDefinition, createImportJob, createImportJobFromUrl, createInternalWidget, createIssue, createItem, createMetricAlertRule, createNivaro, createNotification, createNotificationSubscription, createPage, createPdfTemplate, createPersistedQuery, createPresence, createQueue, createQueueView, createRealtime, createRecordLink, createRecordTemplate, createReport, createReportAlert, createReportAnnotation, createReportFromTemplate, createReportSnapshot, createReportWidgetPreset, createRetentionPolicy, createRole, createRolePolicy, createRule, createSavedView, createScheduledChange, createScheduledReport, createShareLink, createSlaRule, createSubRowTemplate, createSyncJob, createTask, createTreePermission, createUser, createViewSubscription, createVirtualCollection, createWebhook, createWidgetFeed, createWorkspace, createWorkspaceTemplate, decideApproval, deleteAccessAudit, deleteAddendum, deleteAlertDefinition, deleteAlertSubscription, deleteAnomalyRule, deleteApiKey, deleteApprovalChain, deleteAtRiskRule, deleteAttributeDefinition, deleteBlackoutDate, deleteChatMessage, deleteCollectionLayout, deleteComment, deleteDataQualityRule, deleteExternalApi, deleteExternalApiEndpoint, deleteExternalApiSchema, deleteFieldGroup, deleteFieldTranslations, deleteFieldWatch, deleteFile, deleteHierarchyConfig, deleteImportJob, deleteInternalWidget, deleteIssue, deleteItem, deleteMetricAlertRule, deleteNotification, deleteNotificationSubscription, deletePage, deletePdfTemplate, deletePersistedQuery, deleteQueue, deleteQueueView, deleteRecordLink, deleteRecordTemplate, deleteReport, deleteReportAlert, deleteReportAnnotation, deleteReportFilterPreset, deleteReportSnapshot, deleteReportTemplate, deleteReportWidgetPreset, deleteRetentionPolicy, deleteRole, deleteRolePolicy, deleteRule, deleteSavedView, deleteScheduledReport, deleteSessionRecording, deleteSlaRule, deleteSubRow, deleteSubRowTemplate, deleteSyncJob, deleteTask, deleteTreePermission, deleteUser, deleteViewSubscription, deleteVirtualCollection, deleteWebhook, deleteWidgetFeed, deleteWorkspace, deleteWorkspaceTemplate, deployImportProcedure, desc, disableTwoFactor, drillReportRow, editChatMessage, endSessionRecording, evaluateAlerts, evaluateAtRisk, evaluateFieldDefaults, evaluateFieldLock, evaluateFieldRules, evaluateFieldVisibility, excludeFromPicker, executeBulkAction, executeCustomQuery, executeImportTemplate, executeItemAction, executeScheduledChange, explainRecordAccess, explainReportTrend, exportBlueprint, exportConfigSnapshot, exportContent, exportContentBundle, exportSchemaSnapshot, fetchFormSchema, fileDownloadPath, fileTransformPath, generateToken, generateUserToken, getAlertDefinition, getAttributeValues, getBrunoCollection, getExternalApi, getExternalApiEndpoint, getFieldTranslations, getFlowRun, getLocales, getOpenApi, getPickerExclusionStatus, getPostmanCollection, getPresence, getRetentionPolicy, getSlaRule, getSlaStatus, getTranslations, getTypes, getWebhook, globalSearch, heartbeatItemLock, importExternalApiSpec, importSchemaSnapshot, includeInPicker, installBlueprint, installCollectionPreset, invokeInternalWidgetAction, isPageSlot, joinChatRoom, leaveChatRoom, listAccessAuditRuns, listAccessAudits, listActiveAtRiskRules, listActivePresence, listAddendums, listAlertDefinitions, listAlertSubscriptions, listAllNotificationSubscriptions, listAnomalyDefinitions, listAnomalyRules, listApiKeys, listApprovalChains, listApprovalInstances, listAtRiskRules, listAttributeDefinitions, listBlackoutDates, listBulkActions, listChangeOrders, listChatChannelMembers, listChatMessages, listChatPins, listChatRoles, listChatRoomTypes, listChatRooms, listCollectionPresets, listCollectionRecordTemplates, listComments, listCronJobs, listCustomQueries, listDataQualityRules, listDataQualityRuns, listDeadLetters, listExternalApiEndpoints, listExternalApiSchemas, listExternalApis, listFieldGroups, listFieldWatches, listFiles, listFlowRuns, listHierarchyConfigs, listImportDefinitionVersions, listImportDefinitions, listImportJobs, listImportTemplates, listInternalWidgets, listIssues, listItemActions, listItemScheduledChanges, listLayoutVersions, listMetricAlertRules, listMetricAlertSubscriptions, listMetricDefinitions, listMyTasks, listNotificationSubscriptions, listNotifications, listOrphanFiles, listPages, listPdfTemplates, listPersistedQueries, listPinnedItems, listPipelineVersions, listQueueViews, listQueues, listRecordLinks, listRecordTemplates, listRegisteredExtensions, listRegisteredFlowOperations, listRegisteredFlowTriggers, listRelatedComments, listReportAlerts, listReportAnnotations, listReportFilterPresets, listReportSnapshots, listReportTemplates, listReportVersions, listReportWidgetPresets, listReports, listRequestedTasks, listRetentionPolicies, listRetentionRuns, listRolePolicies, listRoleUsers, listRoles, listRules, listSavedViews, listScheduledChanges, listScheduledReports, listScopeDimensions, listSessionRecordings, listShareLinks, listSlaRules, listStagedImports, listSubRowTemplates, listSubRows, listSyncJobs, listTasks, listTeamTasks, listThroughputCollections, listTraces, listTreePermissions, listViewSubscriptions, listVirtualCollections, listWebhookDeliveries, listWebhooks, listWidgetFeeds, listWorkspaceTemplates, listWorkspaces, markAllNotificationsRead, markChatRoomRead, markNotificationRead, markNotificationsRead, moveTreeNode, nudgeTask, omniSearch, presignFileUpload, previewContentBundle, previewImportJob, previewReportWidget, publishItem, queryVirtualCollection, readAccessAuditFindings, readActiveLayout, readActivity, readActivityReportSummary, readAddendum, readAiSettings, readAlertLog, readAllStateOwners, readAnomalyLog, readApiAnalyticsErrors, readApiAnalyticsSummary, readApiAnalyticsTimeseries, readApiAnalyticsTopCollections, readApiAnalyticsTopPaths, readApiKey, readApprovalBrief, readApprovalChain, readAtRiskSummary, readBackupManifest, readChatConfig, readChatDirectory, readChatPeerRead, readCollection, readCollectionLayout, readCollectionLayouts, readCollections, readConfigInventory, readCoverageGaps, readDataQualityRun, readDetailLayout, readDistinctValues, readDraftPublishConfig, readErpSubmissionHistory, readFieldChangeHistory, readFieldConfig, readFieldImpact, readFieldWatch, readFileMeta, readFileUsage, readHierarchyConfig, readHierarchyNodeAncestors, readHierarchyNodeChildren, readHierarchyNodes, readHierarchyTree, readImportJob, readImportProcedure, readInstanceOwners, readIntegrationHealth, readInternalWidget, readIssue, readIssueSummary, readItem, readItemLock, readItemLockConfig, readItems, readLastTouch, readLayoutAssignments, readLayoutGroups, readMany, readMe, readMetricAlertLog, readMyScopes, readMyWork, readNotificationCount, readNotificationSubscriptionStats, readOnlinePresence, readOwnerGroups, readPage, readPageWidgetData, readPdfTemplate, readPersistedQuery, readPipelineFlowMap, readPipelineReplay, readPipelineTemplate, readPipelineTemplates, readPipelineVersion, readPreflight, readQueue, readQueueCollectionStates, readQueueColumnPrefs, readQueueItems, readQueueTrends, readQueueWorkload, readRecordGraph, readRelationOptions, readReport, readReportAlertLog, readReportAlertsLog, readReportFilterOptions, readReportFiring, readReportSnapshot, readReportSubscription, readReportUsage, readReportWidgetData, readRevision, readRevisions, readRole, readScopeDimensionCoverage, readSessionRecordingEvents, readSettings, readSingleton, readSlaStatusBatch, readStagedImport, readStagedImportStats, readStateOwnerGroups, readStateOwners, readStateOwnersBatch, readSyncJob, readTask, readTaskCounts, readTaskHistory, readThroughputReport, readTimeline, readTrace, readTreeAncestors, readTreeChildren, readTreeConfig, readTreeDescendants, readTreeNested, readTreeNodes, readTwoFactorStatus, readUnreadNotificationCount, readUser, readUserActivity, readUserActivitySummary, readUserCard, readUserScopes, readUsers, readWorkflowBindings, readWorkflowInstance, readWorkflowInstances, readWorkspace, readWorkspaceUsage, rebuildTreePaths, rehearseCreateItem, reindexSemanticSearch, rejectAddendum, rejectAiProposal, releaseItemLock, releaseQueueItem, rematerializeQueue, removeChatChannelMember, removeInstanceOwner, renderInternalWidget, renderPdfTemplate, reorderFieldGroups, reorderSubRows, reorderTreeSiblings, replaceSubRows, replayActivityEvent, replayFlow, reportClientError, requestRecordAccess, requeueStagedImport, resetReportCache, resolveReportAlert, restoreImportDefinitionVersion, restoreLayoutVersion, restorePipelineVersion, restoreReportVersion, retryDeadLetter, retryErpSubmission, retryWebhookDelivery, revokeApiKey, revokeShareLink, revokeToken, revokeUserToken, rollbackRevision, rotateWidgetFeedToken, runAccessAudit, runActivityReport, runActivityReportCsv, runCronJob, runDataQuality, runRetentionPolicy, runScheduledReport, runSyncJob, saveMyScopeDefaults, saveReportFilterPreset, saveReportTemplate, saveReportWidgets, saveUserScope, searchChatMessages, semanticSearch, sendBulkNotification, sendChatMessage, sendTestMail, sessionRecordingEnabled, setMyDelegate, setQueueDefaultView, setReportSubscription, setTranslations, setupTwoFactor, simulatePermissions, simulatePipeline, simulatePipelineImpact, startApproval, startMasquerade, startSessionRecording, startWorkflow, stopMasquerade, submitAddendum, submitFormItem, submitItemForReview, submitToErp, subscribeFieldWatch, subscribeMetricAlert, suggestImportValidation, suggestQueueLabels, switchWorkspace, testExternalApi, testFlow, testWebhook, toggleChatPin, toggleChatReaction, togglePinnedItem, toggleReportAlert, touchRecordView, transitionWorkflow, unpublishItem, unsubscribeFieldWatch, unsubscribeMetricAlert, updateAccessAudit, updateAddendum, updateAiSettings, updateAlertDefinition, updateAnomalyLogEntry, updateAnomalyRule, updateApiKey, updateApprovalChain, updateAtRiskRule, updateAttributeDefinition, updateAttributeValues, updateChatChannel, updateChatRoom, updateChatRoomType, updateCollectionLayout, updateComment, updateDataQualityRule, updateDraftPublishConfig, updateErpSubmissionStatus, updateExternalApi, updateExternalApiEndpoint, updateFieldConfig, updateFieldGroup, updateFieldWatch, updateFileMeta, updateHierarchyConfig, updateImportDefinition, updateInternalWidget, updateIssue, updateItem, updateItemLockConfig, updateLayoutAssignments, updateLayoutUngroupedSort, updateMe, updateMetricAlertRule, updateMetricAlertSubscription, updateNotificationSubscription, updatePage, updatePdfTemplate, updatePersistedQuery, updateQueue, updateQueueSources, updateQueueView, updateRecordTemplate, updateReport, updateReportAlert, updateReportWidgetPreset, updateRetentionPolicy, updateRole, updateRolePolicy, updateRoleUiPermissions, updateRule, updateSavedView, updateScheduledReport, updateSettings, updateSingleton, updateSlaRule, updateSyncJob, updateTask, updateTreePermission, updateUser, updateVirtualCollection, updateWebhook, updateWidgetFeed, updateWorkflowBinding, updateWorkspace, validateVirtualCollectionSql, verifyTwoFactor };
+export { type AccessAudit, type AccessAuditFinding, type AccessAuditRun, type AccessAuditSubject, type AccessReason, type ActivityEntry, type ActivityQuery, type ActivityReportQuery, type ActivityReportRow, type ActivityReportSummary, type Addendum, type AddendumStatus, type AggregateQuery, type AggregateRow, type AiChatTraceEntry, type AiCollectionSettings, type AiColumnMapping, type AiDuplicateMatch, type AiQueryFilter, type AiQueryResult, type AiReviewFinding, type AiViolation, type AlertDefinition, type AlertLogEntry, type AlertSubscription, type AnomalyDefinition, type AnomalyRule, type ApiAnalyticsBucket, type ApiAnalyticsCollection, type ApiAnalyticsPath, type ApiAnalyticsSummary, type ApiErrorLog, type ApiKey, type ApiKeyScope, type ApprovalBrief, type ApprovalChain, type ApprovalChainStep, type ApprovalDecision, type ApprovalInstance, type ApprovalInstanceDetail, type ApprovalStatus, type ApprovalStepInput, type AtRiskCondition, type AtRiskOp, type AtRiskResult, type AtRiskRule, type AtRiskSummaryEntry, type AttributeDefinition, type AttributeValue, type BatchRead, type BatchReadResult, type BlackoutDate, type BoolFilterOps, type CMSCollection, type CascadeFilterRule, type ChangeOrder, type ChatChannel, type ChatChannelMember, type ChatDirectoryChannel, type ChatMessage, type ChatPin, type ChatReaction, type ChatRoomKind, type ChatRoomSummary, type ChatRoomType, type ChatSearchHit, type CollectionLayout, type CollectionPresetSummary, type Command, type Comment, type ConfigSnapshot, type ConfigTableClassification, type ContentBundle, type ContentExportFormat, type ContentExportOptions, type CoverageGapItem, type CoverageGapOwner, type CoverageGapReport, type CronJob, type CustomQuery, type DataQualityRule, type DataQualityRuleResult, type DataQualityRuleType, type DataQualityRun, type DataQualitySeverity, type DeadLetter, type DraftPublishConfig, type DraftStatus, type DryRunReport, type ErpSubmission, type ErpSubmissionStatus, type ExtensionManifest, type ExternalApi, type ExternalApiEndpoint, type ExternalApiSchema, type ExternalApiSlotContext, type ExternalApiSpecImportResult, type ExternalApiTestResult, type FieldChangeEntry, type FieldCondition, type FieldConfig, type FieldDependencyConfig, type FieldFilter, type FieldGroup, type FieldTranslations, type FieldVisibilityRules, type FieldWatch, type FileRecord, type FileUploadResult, type FileUsageEntry, type Filter, type FlowReplayResult, type FlowRun, type FlowTestStep, type FormFieldDescriptor, type FormFieldRelation, type FormGroupDescriptor, type FormLockCondition, type FormSchema, type FormValidationRule, type FormVisibilityRule, type GlobalSearchRecord, type GlobalSearchResults, type GraphQLResponse, type HelpVideo, type HelpVideoClick, type HelpVideoContext, type HelpVideoDownloadUrls, type HelpVideoFinalizedUpload, type HelpVideoProgress, type HelpVideoUploadSession, type HelpVideoVersion, type HelpVideoVisibility, type HelpVideoWalkStep, type HierarchyConfigDef, type HierarchyFlatNode, type HierarchyLevelDef, type HierarchyNestedNode, type IDFilterOps, type ISODate, type ImportDefinition, type ImportJob, type ImportParseResponse, type ImportPreview, type ImportPreviewDiff, type ImportTemplateSummary, type InstanceOwner, type IntegrationApiHealth, type InternalWidget, type Issue, type IssueSeverity, type IssueStatus, type IssueSummary, type ItemLock, type LastTouch, type LayoutAssignment, type LayoutGroup, type LayoutVersion, type ListResponse, type ManagedUser, type MetricAlertRule, type MetricAlertSubscription, type MetricDefinition, type MyTask, type MyWorkOwnedEntry, type MyWorkSla, type MyWorkSummary, type NivaroClient, type NivaroClientOptions, type NivaroExtensionPlugin, type NivaroRealtime, type NivaroRuntime, type NotificationItem, type NotificationPage, type NotificationSubscription, type NumberFilterOps, type OmniSearchHit, type OnlinePresenceConfig, type OnlinePresenceUser, type Page, type PageLayout, type PageSlotKey, type PageWidget, type PdfTemplate, type PermissionSimulation, type PersistedQuery, type PickerExclusionStatus, type PipelineFlowEdge, type PipelineFlowState, type PipelineImpactResult, type PipelineOwnerGroup, type PipelineOwnerGroupUser, type PipelineSimulation, type PipelineState, type PipelineVersionEntry, type PluginSlots, type Policy, type PreflightCheck, type PreflightReport, type PreflightSeverity, type PresenceClient, type PresenceOptions, type PresenceSession, type PresenceSessionInfo, type PresenceViewer, type PromotionApplyResult, type PromotionPreview, type Query, type Queue, type QueueColumnPrefs, type QueueCondition, type QueueDetail, type QueueDisplayConfig, type QueueItem, type QueueItemsResult, type QueueOwner, type QueueRowClickMode, type QueueScope, type QueueSource, type QueueSourceType, type QueueStats, type QueueTrendPoint, type QueueView, type QueueViewKind, type QueueWorkloadRow, READ_MANY_MAX, type RealtimeEvent, type RecordGraphEdge, type RecordGraphNode, type RecordLink, type RecordLinkType, type RecordTemplate, type RecordViewRecap, type RegisteredAction, type RelatedCommentEntry, type RelationFilter, type RelationOption, type ReportAlert, type ReportAlertCondition, type ReportAlertLogEntry, type ReportAnnotation, type ReportColumnFormat, type ReportDateRange, type ReportDef, type ReportEntityFilter, type ReportFilterPreset, type ReportQueryColumn, type ReportQueryWidgetConfig, type ReportSnapshotEntry, type ReportSubscription, type ReportTemplateEntry, type ReportVersionEntry, type ReportWidget, type ReportWidgetConfig, type ReportWidgetData, type ReportWidgetPreset, type ReportWidgetType, type RequestTrace, type ResolvedOwner, type RetentionPolicy, type RetentionRun, type RetentionRunResult, type Revision, type Role, type Rule, type SavedView, type ScheduledChange, type ScheduledReport, type ScopeDimension, type ScopeDimensionInfo, type SemanticSearchMatch, type SessionRecording, type ShareLink, type SlaBatchStatus, type SlaRule, type SlaStatus, type StagedImportRun, type StagedImportStats, type StringFilterOps, type SubRow, type SubRowTemplate, type SyncJob, type Task, type TaskDoneWhenRule, type TaskPriority, type TaskStatus, type TimelineEvent, type TraceSpan, type TreeFlatNode, type TreeNestedNode, type TreeNodeConfig, type TreePermission, type TreePermissionAction, type UUID, type UserActivityEntry, type UserActivitySummary, type UserScopesInfo, type ViewSubscription, type VirtualCollection, type Webhook, type WebhookDelivery, type WidgetFeed, type WorkflowBinding, type WorkflowHistoryEntry, type WorkflowInstance, type WorkflowInstanceData, type WorkflowState, type WorkflowTransition, type Workspace, type WorkspaceQuotas, type WorkspaceTemplate, type WorkspaceUsage, _and, _contains, _ends_with, _eq, _gt, _gte, _in, _lt, _lte, _ncontains, _neq, _nin, _nnull, _none, _null, _or, _some, _starts_with, abandonHelpVideoUpload, acquireItemLock, activateLayout, addChatChannelMember, addInstanceOwner, addSubRow, aggregateItems, aiBrief, aiBuildReport, aiChat, aiCheckDuplicates, aiGenerate, aiMapColumns, aiQuery, aiReportFilters, aiReview, aiSummarize, aiValidate, appendSessionRecordingEvents, applyContentBundle, applyHelpVideoPackageImport, applyRecordTemplate, applySubRowTemplate, approveAddendum, approveAiProposal, archiveHelpVideo, asc, backupExportPath, batchPickerExclusionStatus, bulkPickerExclusion, callExternalApi, callExternalApiEndpoint, cancelScheduledChange, cancelStagedImport, cascadeFieldDependencies, checkBlackoutDate, claimQueueItem, claimTask, clearTraces, cloneItem, cloneLayout, cloneReport, compareConfigSnapshot, completeTask, copyReportWidget, createAccessAudit, createAddendum, createAlertDefinition, createAlertSubscription, createAnomalyRule, createApiKey, createApprovalChain, createAtRiskRule, createAttributeDefinition, createBlackoutDate, createChatChannel, createChatRoomType, createCollectionLayout, createComment, createDataQualityRule, createExternalApi, createExternalApiEndpoint, createFieldGroup, createFieldWatch, createGroupDm, createHelpVideo, createHierarchyConfig, createImportDefinition, createImportJob, createImportJobFromUrl, createInternalWidget, createIssue, createItem, createMetricAlertRule, createNivaro, createNotification, createNotificationSubscription, createPage, createPdfTemplate, createPersistedQuery, createPresence, createQueue, createQueueView, createRealtime, createRecordLink, createRecordTemplate, createReport, createReportAlert, createReportAnnotation, createReportFromTemplate, createReportSnapshot, createReportWidgetPreset, createRetentionPolicy, createRole, createRolePolicy, createRule, createSavedView, createScheduledChange, createScheduledReport, createShareLink, createSlaRule, createSubRowTemplate, createSyncJob, createTask, createTreePermission, createUser, createViewSubscription, createVirtualCollection, createWebhook, createWidgetFeed, createWorkspace, createWorkspaceTemplate, decideApproval, deleteAccessAudit, deleteAddendum, deleteAlertDefinition, deleteAlertSubscription, deleteAnomalyRule, deleteApiKey, deleteApprovalChain, deleteAtRiskRule, deleteAttributeDefinition, deleteBlackoutDate, deleteChatMessage, deleteCollectionLayout, deleteComment, deleteDataQualityRule, deleteExternalApi, deleteExternalApiEndpoint, deleteExternalApiSchema, deleteFieldGroup, deleteFieldTranslations, deleteFieldWatch, deleteFile, deleteHierarchyConfig, deleteImportJob, deleteInternalWidget, deleteIssue, deleteItem, deleteMetricAlertRule, deleteNotification, deleteNotificationSubscription, deletePage, deletePdfTemplate, deletePersistedQuery, deleteQueue, deleteQueueView, deleteRecordLink, deleteRecordTemplate, deleteReport, deleteReportAlert, deleteReportAnnotation, deleteReportFilterPreset, deleteReportSnapshot, deleteReportTemplate, deleteReportWidgetPreset, deleteRetentionPolicy, deleteRole, deleteRolePolicy, deleteRule, deleteSavedView, deleteScheduledReport, deleteSessionRecording, deleteSlaRule, deleteSubRow, deleteSubRowTemplate, deleteSyncJob, deleteTask, deleteTreePermission, deleteUser, deleteViewSubscription, deleteVirtualCollection, deleteWebhook, deleteWidgetFeed, deleteWorkspace, deleteWorkspaceTemplate, deployImportProcedure, desc, disableTwoFactor, discardHelpVideoPackageImport, drillReportRow, editChatMessage, endSessionRecording, evaluateAlerts, evaluateAtRisk, evaluateFieldDefaults, evaluateFieldLock, evaluateFieldRules, evaluateFieldVisibility, excludeFromPicker, executeBulkAction, executeCustomQuery, executeImportTemplate, executeItemAction, executeScheduledChange, explainRecordAccess, explainReportTrend, exportBlueprint, exportConfigSnapshot, exportContent, exportContentBundle, exportHelpVideoPackage, exportSchemaSnapshot, fetchFormSchema, fileDownloadPath, fileTransformPath, finalizeHelpVideoUpload, generateToken, generateUserToken, getAlertDefinition, getAttributeValues, getBrunoCollection, getExternalApi, getExternalApiEndpoint, getFieldTranslations, getFlowRun, getLocales, getOpenApi, getPickerExclusionStatus, getPostmanCollection, getPresence, getRetentionPolicy, getSlaRule, getSlaStatus, getTranslations, getTypes, getWebhook, globalSearch, heartbeatItemLock, helpVideosFor, importExternalApiSpec, importSchemaSnapshot, includeInPicker, installBlueprint, installCollectionPreset, invokeInternalWidgetAction, isPageSlot, joinChatRoom, leaveChatRoom, listAccessAuditRuns, listAccessAudits, listActiveAtRiskRules, listActivePresence, listAddendums, listAlertDefinitions, listAlertSubscriptions, listAllNotificationSubscriptions, listAnomalyDefinitions, listAnomalyRules, listApiKeys, listApprovalChains, listApprovalInstances, listAtRiskRules, listAttributeDefinitions, listBlackoutDates, listBulkActions, listChangeOrders, listChatChannelMembers, listChatMessages, listChatPins, listChatRoles, listChatRoomTypes, listChatRooms, listCollectionPresets, listCollectionRecordTemplates, listComments, listCronJobs, listCustomQueries, listDataQualityRules, listDataQualityRuns, listDeadLetters, listExternalApiEndpoints, listExternalApiSchemas, listExternalApis, listFieldGroups, listFieldWatches, listFiles, listFlowRuns, listHelpVideoPages, listHelpVideoVersions, listHelpVideos, listHierarchyConfigs, listImportDefinitionVersions, listImportDefinitions, listImportJobs, listImportTemplates, listInternalWidgets, listIssues, listItemActions, listItemScheduledChanges, listLayoutVersions, listMetricAlertRules, listMetricAlertSubscriptions, listMetricDefinitions, listMyHelpVideoUploads, listMyTasks, listNotificationSubscriptions, listNotifications, listOrphanFiles, listPages, listPdfTemplates, listPersistedQueries, listPinnedItems, listPipelineVersions, listQueueViews, listQueues, listRecordLinks, listRecordTemplates, listRegisteredExtensions, listRegisteredFlowOperations, listRegisteredFlowTriggers, listRelatedComments, listReportAlerts, listReportAnnotations, listReportFilterPresets, listReportSnapshots, listReportTemplates, listReportVersions, listReportWidgetPresets, listReports, listRequestedTasks, listRetentionPolicies, listRetentionRuns, listRolePolicies, listRoleUsers, listRoles, listRules, listSavedViews, listScheduledChanges, listScheduledReports, listScopeDimensions, listSessionRecordings, listShareLinks, listSlaRules, listStagedImports, listSubRowTemplates, listSubRows, listSyncJobs, listTasks, listTeamTasks, listThroughputCollections, listTraces, listTreePermissions, listViewSubscriptions, listVirtualCollections, listWebhookDeliveries, listWebhooks, listWidgetFeeds, listWorkspaceTemplates, listWorkspaces, markAllNotificationsRead, markChatRoomRead, markNotificationRead, markNotificationsRead, moveTreeNode, nudgeTask, omniSearch, openHelpVideoPackageImport, openHelpVideoUpload, presignFileUpload, previewContentBundle, previewHelpVideoPackageImport, previewImportJob, previewReportWidget, publishHelpVideo, publishItem, queryVirtualCollection, readAccessAuditFindings, readActiveLayout, readActivity, readActivityReportSummary, readAddendum, readAiSettings, readAlertLog, readAllStateOwners, readAnomalyLog, readApiAnalyticsErrors, readApiAnalyticsSummary, readApiAnalyticsTimeseries, readApiAnalyticsTopCollections, readApiAnalyticsTopPaths, readApiKey, readApprovalBrief, readApprovalChain, readAtRiskSummary, readBackupManifest, readChatConfig, readChatDirectory, readChatPeerRead, readCollection, readCollectionLayout, readCollectionLayouts, readCollections, readConfigInventory, readCoverageGaps, readDataQualityRun, readDetailLayout, readDistinctValues, readDraftPublishConfig, readErpSubmissionHistory, readFieldChangeHistory, readFieldConfig, readFieldImpact, readFieldWatch, readFileMeta, readFileUsage, readHelpVideo, readHelpVideoAnalytics, readHelpVideoDownloadLink, readHelpVideoDraft, readHelpVideoWalk, readHierarchyConfig, readHierarchyNodeAncestors, readHierarchyNodeChildren, readHierarchyNodes, readHierarchyTree, readImportJob, readImportProcedure, readInstanceOwners, readIntegrationHealth, readInternalWidget, readIssue, readIssueSummary, readItem, readItemLock, readItemLockConfig, readItems, readLastTouch, readLayoutAssignments, readLayoutGroups, readMany, readMe, readMetricAlertLog, readMyScopes, readMyWork, readNotificationCount, readNotificationSubscriptionStats, readOnlinePresence, readOwnerGroups, readPage, readPageWidgetData, readPdfTemplate, readPersistedQuery, readPipelineFlowMap, readPipelineReplay, readPipelineTemplate, readPipelineTemplates, readPipelineVersion, readPreflight, readQueue, readQueueCollectionStates, readQueueColumnPrefs, readQueueItems, readQueueTrends, readQueueWorkload, readRecordGraph, readRelationOptions, readReport, readReportAlertLog, readReportAlertsLog, readReportFilterOptions, readReportFiring, readReportSnapshot, readReportSubscription, readReportUsage, readReportWidgetData, readRequiredHelpVideos, readRevision, readRevisions, readRole, readScopeDimensionCoverage, readSessionRecordingEvents, readSettings, readSingleton, readSlaStatusBatch, readStagedImport, readStagedImportStats, readStateOwnerGroups, readStateOwners, readStateOwnersBatch, readSyncJob, readTask, readTaskCounts, readTaskHistory, readThroughputReport, readTimeline, readTrace, readTreeAncestors, readTreeChildren, readTreeConfig, readTreeDescendants, readTreeNested, readTreeNodes, readTwoFactorStatus, readUnreadNotificationCount, readUser, readUserActivity, readUserActivitySummary, readUserCard, readUserScopes, readUsers, readWorkflowBindings, readWorkflowInstance, readWorkflowInstances, readWorkspace, readWorkspaceUsage, rebuildTreePaths, recordHelpVideoProgress, registerHelpVideoPage, rehearseCreateItem, reindexSemanticSearch, rejectAddendum, rejectAiProposal, releaseItemLock, releaseQueueItem, rematerializeQueue, removeChatChannelMember, removeInstanceOwner, renderInternalWidget, renderPdfTemplate, reorderFieldGroups, reorderSubRows, reorderTreeSiblings, replaceSubRows, replayActivityEvent, replayFlow, reportClientError, requestRecordAccess, requeueStagedImport, rerecordHelpVideo, rerenderHelpVideo, resetReportCache, resolveReportAlert, restoreHelpVideoVersion, restoreImportDefinitionVersion, restoreLayoutVersion, restorePipelineVersion, restoreReportVersion, retryDeadLetter, retryErpSubmission, retryWebhookDelivery, revokeApiKey, revokeShareLink, revokeToken, revokeUserToken, rollbackRevision, rotateWidgetFeedToken, runAccessAudit, runActivityReport, runActivityReportCsv, runCronJob, runDataQuality, runRetentionPolicy, runScheduledReport, runSyncJob, saveHelpVideoDraft, saveMyScopeDefaults, saveReportFilterPreset, saveReportTemplate, saveReportWidgets, saveUserScope, searchChatMessages, semanticSearch, sendBulkNotification, sendChatMessage, sendTestMail, sessionRecordingEnabled, setHelpVideoContexts, setHelpVideoRequirements, setMyDelegate, setQueueDefaultView, setReportSubscription, setTranslations, setupTwoFactor, simulatePermissions, simulatePipeline, simulatePipelineImpact, startApproval, startMasquerade, startSessionRecording, startWorkflow, stopMasquerade, submitAddendum, submitFormItem, submitItemForReview, submitToErp, subscribeFieldWatch, subscribeMetricAlert, suggestImportValidation, suggestQueueLabels, switchWorkspace, testExternalApi, testFlow, testWebhook, toggleChatPin, toggleChatReaction, togglePinnedItem, toggleReportAlert, touchRecordView, transitionWorkflow, unpublishItem, unsubscribeFieldWatch, unsubscribeMetricAlert, updateAccessAudit, updateAddendum, updateAiSettings, updateAlertDefinition, updateAnomalyLogEntry, updateAnomalyRule, updateApiKey, updateApprovalChain, updateAtRiskRule, updateAttributeDefinition, updateAttributeValues, updateChatChannel, updateChatRoom, updateChatRoomType, updateCollectionLayout, updateComment, updateDataQualityRule, updateDraftPublishConfig, updateErpSubmissionStatus, updateExternalApi, updateExternalApiEndpoint, updateFieldConfig, updateFieldGroup, updateFieldWatch, updateFileMeta, updateHelpVideo, updateHierarchyConfig, updateImportDefinition, updateInternalWidget, updateIssue, updateItem, updateItemLockConfig, updateLayoutAssignments, updateLayoutUngroupedSort, updateMe, updateMetricAlertRule, updateMetricAlertSubscription, updateNotificationSubscription, updatePage, updatePdfTemplate, updatePersistedQuery, updateQueue, updateQueueSources, updateQueueView, updateRecordTemplate, updateReport, updateReportAlert, updateReportWidgetPreset, updateRetentionPolicy, updateRole, updateRolePolicy, updateRoleUiPermissions, updateRule, updateSavedView, updateScheduledReport, updateSettings, updateSingleton, updateSlaRule, updateSyncJob, updateTask, updateTreePermission, updateUser, updateVirtualCollection, updateWebhook, updateWidgetFeed, updateWorkflowBinding, updateWorkspace, validateVirtualCollectionSql, verifyTwoFactor };

package/dist/index.js

@@ -1372,6 +1372,109 @@ function fileTransformPath(id, options = {}) {
   return `/api/files/${id}/transform${qs ? `?${qs}` : ""}`;
 }
 
+// src/commands/help-videos.ts
+function listHelpVideos(params) {
+  return cmd("GET", "/help-videos", params);
+}
+function readHelpVideo(id) {
+  return cmd("GET", `/help-videos/${id}`);
+}
+function helpVideosFor(params) {
+  return cmd("GET", "/help-videos/for", params);
+}
+function createHelpVideo(body) {
+  return cmd("POST", "/help-videos", void 0, body);
+}
+function updateHelpVideo(id, body) {
+  return cmd("PATCH", `/help-videos/${id}`, void 0, body);
+}
+function setHelpVideoContexts(id, contexts) {
+  return cmd("PUT", `/help-videos/${id}/contexts`, void 0, { contexts });
+}
+function setHelpVideoRequirements(id, role_ids) {
+  return cmd("PUT", `/help-videos/${id}/requirements`, void 0, { role_ids });
+}
+function archiveHelpVideo(id, opts) {
+  return cmd("DELETE", `/help-videos/${id}`, opts?.purge ? { purge: 1 } : void 0);
+}
+function readHelpVideoWalk(id) {
+  return cmd("GET", `/help-videos/${id}/walk`);
+}
+function readHelpVideoDraft(id) {
+  return cmd("GET", `/help-videos/${id}/draft/edits`);
+}
+function saveHelpVideoDraft(id, edits, base_hash) {
+  return cmd("PUT", `/help-videos/${id}/draft/edits`, void 0, { edits, base_hash });
+}
+function publishHelpVideo(id, opts) {
+  return cmd("POST", `/help-videos/${id}/publish`, void 0, opts ?? {});
+}
+function rerecordHelpVideo(id, upload_id) {
+  return cmd("POST", `/help-videos/${id}/rerecord`, void 0, { upload_id });
+}
+function listHelpVideoVersions(id) {
+  return cmd("GET", `/help-videos/${id}/versions`);
+}
+function restoreHelpVideoVersion(id, versionId) {
+  return cmd("POST", `/help-videos/${id}/versions/${versionId}/restore`);
+}
+function rerenderHelpVideo(id, opts) {
+  return cmd("POST", `/help-videos/${id}/render`, opts?.draft ? { draft: 1 } : void 0);
+}
+function recordHelpVideoProgress(id, body) {
+  return cmd("POST", `/help-videos/${id}/progress`, void 0, body);
+}
+function readRequiredHelpVideos() {
+  return cmd("GET", "/help-videos/required/mine");
+}
+function readHelpVideoAnalytics(id) {
+  return cmd("GET", `/help-videos/${id}/analytics`);
+}
+function openHelpVideoUpload(mime) {
+  return cmd("POST", "/help-videos/uploads", void 0, { mime });
+}
+function finalizeHelpVideoUpload(id, meta) {
+  return cmd("POST", `/help-videos/uploads/${id}/finalize`, void 0, meta ?? {});
+}
+function listMyHelpVideoUploads() {
+  return cmd("GET", "/help-videos/uploads/mine");
+}
+function abandonHelpVideoUpload(id) {
+  return cmd("DELETE", `/help-videos/uploads/${id}`);
+}
+function listHelpVideoPages() {
+  return cmd("GET", "/help-videos/pages");
+}
+function registerHelpVideoPage(body) {
+  return cmd("POST", "/help-videos/pages", void 0, body);
+}
+function readHelpVideoDownloadLink(id, opts) {
+  return cmd("GET", `/help-videos/${id}/download-link`, {
+    file: opts?.file ?? "video",
+    ...opts?.draft ? { draft: 1 } : {}
+  });
+}
+function exportHelpVideoPackage(ids) {
+  return cmd("POST", "/help-videos/packages", void 0, { ids });
+}
+function openHelpVideoPackageImport() {
+  return cmd("POST", "/help-videos/packages/imports");
+}
+function previewHelpVideoPackageImport(id) {
+  return cmd("POST", `/help-videos/packages/imports/${id}/preview`);
+}
+function applyHelpVideoPackageImport(id, video_ids) {
+  return cmd(
+    "POST",
+    `/help-videos/packages/imports/${id}/apply`,
+    void 0,
+    video_ids ? { video_ids } : {}
+  );
+}
+function discardHelpVideoPackageImport(id) {
+  return cmd("DELETE", `/help-videos/packages/imports/${id}`);
+}
+
 // src/commands/import-templates.ts
 var listImportTemplates = (collection) => cmd("GET", "/import-templates", { collection });
 var executeImportTemplate = (id, payload) => cmd("POST", `/import-templates/${id}/execute`, void 0, payload);
@@ -2573,6 +2676,7 @@ export {
   _or,
   _some,
   _starts_with,
+  abandonHelpVideoUpload,
   acquireItemLock,
   activateLayout,
   addChatChannelMember,
@@ -2592,10 +2696,12 @@ export {
   aiValidate,
   appendSessionRecordingEvents,
   applyContentBundle,
+  applyHelpVideoPackageImport,
   applyRecordTemplate,
   applySubRowTemplate,
   approveAddendum,
   approveAiProposal,
+  archiveHelpVideo,
   asc,
   backupExportPath,
   batchPickerExclusionStatus,
@@ -2635,6 +2741,7 @@ export {
   createFieldGroup,
   createFieldWatch,
   createGroupDm,
+  createHelpVideo,
   createHierarchyConfig,
   createImportDefinition,
   createImportJob,
@@ -2748,6 +2855,7 @@ export {
   deployImportProcedure,
   desc,
   disableTwoFactor,
+  discardHelpVideoPackageImport,
   drillReportRow,
   editChatMessage,
   endSessionRecording,
@@ -2769,10 +2877,12 @@ export {
   exportConfigSnapshot,
   exportContent,
   exportContentBundle,
+  exportHelpVideoPackage,
   exportSchemaSnapshot,
   fetchFormSchema,
   fileDownloadPath,
   fileTransformPath,
+  finalizeHelpVideoUpload,
   generateToken,
   generateUserToken,
   getAlertDefinition,
@@ -2795,6 +2905,7 @@ export {
   getWebhook,
   globalSearch,
   heartbeatItemLock,
+  helpVideosFor,
   importExternalApiSpec,
   importSchemaSnapshot,
   includeInPicker,
@@ -2843,6 +2954,9 @@ export {
   listFieldWatches,
   listFiles,
   listFlowRuns,
+  listHelpVideoPages,
+  listHelpVideoVersions,
+  listHelpVideos,
   listHierarchyConfigs,
   listImportDefinitionVersions,
   listImportDefinitions,
@@ -2856,6 +2970,7 @@ export {
   listMetricAlertRules,
   listMetricAlertSubscriptions,
   listMetricDefinitions,
+  listMyHelpVideoUploads,
   listMyTasks,
   listNotificationSubscriptions,
   listNotifications,
@@ -2918,10 +3033,14 @@ export {
   moveTreeNode,
   nudgeTask,
   omniSearch,
+  openHelpVideoPackageImport,
+  openHelpVideoUpload,
   presignFileUpload,
   previewContentBundle,
+  previewHelpVideoPackageImport,
   previewImportJob,
   previewReportWidget,
+  publishHelpVideo,
   publishItem,
   queryVirtualCollection,
   readAccessAuditFindings,
@@ -2963,6 +3082,11 @@ export {
   readFieldWatch,
   readFileMeta,
   readFileUsage,
+  readHelpVideo,
+  readHelpVideoAnalytics,
+  readHelpVideoDownloadLink,
+  readHelpVideoDraft,
+  readHelpVideoWalk,
   readHierarchyConfig,
   readHierarchyNodeAncestors,
   readHierarchyNodeChildren,
@@ -3018,6 +3142,7 @@ export {
   readReportSubscription,
   readReportUsage,
   readReportWidgetData,
+  readRequiredHelpVideos,
   readRevision,
   readRevisions,
   readRole,
@@ -3058,6 +3183,8 @@ export {
   readWorkspace,
   readWorkspaceUsage,
   rebuildTreePaths,
+  recordHelpVideoProgress,
+  registerHelpVideoPage,
   rehearseCreateItem,
   reindexSemanticSearch,
   rejectAddendum,
@@ -3078,8 +3205,11 @@ export {
   reportClientError,
   requestRecordAccess,
   requeueStagedImport,
+  rerecordHelpVideo,
+  rerenderHelpVideo,
   resetReportCache,
   resolveReportAlert,
+  restoreHelpVideoVersion,
   restoreImportDefinitionVersion,
   restoreLayoutVersion,
   restorePipelineVersion,
@@ -3101,6 +3231,7 @@ export {
   runRetentionPolicy,
   runScheduledReport,
   runSyncJob,
+  saveHelpVideoDraft,
   saveMyScopeDefaults,
   saveReportFilterPreset,
   saveReportTemplate,
@@ -3112,6 +3243,8 @@ export {
   sendChatMessage,
   sendTestMail,
   sessionRecordingEnabled,
+  setHelpVideoContexts,
+  setHelpVideoRequirements,
   setMyDelegate,
   setQueueDefaultView,
   setReportSubscription,
@@ -3171,6 +3304,7 @@ export {
   updateFieldGroup,
   updateFieldWatch,
   updateFileMeta,
+  updateHelpVideo,
   updateHierarchyConfig,
   updateImportDefinition,
   updateInternalWidget,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nivaro/sdk",
-  "version": "0.1.17",
+  "version": "0.1.19",
   "description": "TypeScript SDK for Nivaro CMS — typed REST client, GraphQL, realtime subscriptions, and presence.",
   "type": "module",
   "main": "./dist/index.js",