@hydradb/sdk 2.1.3 → 2.1.5

package/dist/api/types/GraphSubgraphSource.d.ts

@@ -0,0 +1,28 @@
+export interface GraphSubgraphSource {
+    /** Provider-assigned identifier for this source (e.g. Slack channel ID). */
+    appExternalId?: string;
+    /** App integration category, populated for connector-synced sources. */
+    appKind?: string;
+    /** Provider name for app-sourced items (e.g. `slack`, `github`). */
+    appProvider?: string;
+    /** Depth is the BFS distance from the seed (0 for the seed itself). */
+    depth?: number;
+    discoveredRelation?: string;
+    /**
+     * DiscoveredVia and DiscoveredRelation record the traversal provenance:
+     * which already-admitted source this member was first reached from, and
+     * through which mechanism — a RELATES_TO relation_type (reply_to,
+     * child_of, ...), same_thread, parent or child. Empty on the seed.
+     */
+    discoveredVia?: string;
+    /**
+     * Hydration carries the same resolved/stub/placeholder classification
+     * Entity.Hydration documents: a RELATES_TO target may be a MERGE-created
+     * forward reference to a document that has not been ingested yet.
+     */
+    hydration?: string;
+    sourceId?: string;
+    threadId?: string;
+    /** Title or name of the source. */
+    title?: string;
+}

package/dist/api/types/GraphSubgraphSource.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/GraphTripletWithEvidence.d.ts

@@ -6,4 +6,11 @@ export interface GraphTripletWithEvidence {
     relations?: HydraDB.GraphRelationEvidence[];
     source?: HydraDB.GraphEntity;
     target?: HydraDB.GraphEntity;
+    /**
+     * Truncated is set on auxiliary triplets whose fan-out hit a per-node cap,
+     * so a caller can tell "this source has no more comments" from "we stopped
+     * counting". Omitted (false) on entity relations, which are bounded by the
+     * request's own limit/cursor instead.
+     */
+    truncated?: boolean;
 }

package/dist/api/types/HandlerCatalogConnector.d.ts

@@ -7,5 +7,20 @@ export interface HandlerCatalogConnector {
     provider?: string;
     /** Rank is the dashboard display order (lower first); null means unranked. */
     rank?: number;
+    rbacDescription?: string;
+    /**
+     * RBACSupport reports whether document-level ACL capture (PRO-1684) is
+     * enabled for this provider (the acl_supported control-plane flag), and
+     * RBACDescription says in one sentence WHAT is captured, so the dashboard
+     * can explain the capability instead of showing a bare boolean.
+     */
+    rbacSupport?: boolean;
     supported?: boolean;
+    /**
+     * WebhookSupport marks a provider fed by an inbound webhook. The dashboard
+     * needs it to pick the credential form: it otherwise reads moveit_support=false
+     * as "classic", and renders the single-token form instead of the provider's
+     * declared credential schema.
+     */
+    webhookSupport?: boolean;
 }

package/dist/api/types/HandlerConnectorApiView.d.ts

@@ -1,4 +1,13 @@
 export interface HandlerConnectorApiView {
+    /**
+     * ACLChangesCursor is the provider permission-change feed's persisted
+     * cursor (PRO-1684; e.g. the Drive changes.list page token). Empty means
+     * uninitialized: the next cycle fetches a baseline and starts from now.
+     * Advanced ONLY after every reported change was applied, so a failed
+     * apply replays the same changes next cycle (at-least-once; the writes
+     * are idempotent full replacements).
+     */
+    aclChangesCursor?: string;
     /**
      * ActiveResourceCount mirrors the number of non-disabled resource rows so
      * list responses can distinguish "no resources configured yet"
@@ -11,6 +20,12 @@ export interface HandlerConnectorApiView {
     collection?: string;
     /** Connector this resource belongs to. */
     connectorId?: string;
+    /**
+     * CustomInstructions is optional free-text guidance applied when this
+     * connector's documents are ingested: it steers how content is interpreted
+     * and indexed. Max 4000 characters; changes apply from the next sync cycle.
+     */
+    customInstructions?: string;
     /**
      * Database/Collection are the canonical v2 names for the deprecated
      * tenant_id/sub_tenant_id wire fields. They mirror the same values so a v2
@@ -60,6 +75,21 @@ export interface HandlerConnectorApiView {
     needsReauthReason?: string;
     /** RFC3339 timestamp when the next scheduled sync will run. */
     nextSyncAt?: string;
+    /**
+     * Paused marks a connector its owner deliberately stopped (PRO-1762). It
+     * parks next_sync_at as SyncBlocked does, but stays a separate field:
+     * blocking clears itself once the cause is fixed, whereas only an explicit
+     * resume lifts a pause. Resources keep their committed provider_cursor, so
+     * resuming continues from where each stream stopped.
+     */
+    paused?: boolean;
+    pausedAt?: string;
+    /**
+     * PausedNextSyncAt preserves the schedule the pause displaced. Resume makes
+     * the connector due immediately, so this is read back only to recover from
+     * a pause applied by mistake.
+     */
+    pausedNextSyncAt?: string;
     /** External provider being synced (e.g. `slack`, `github`, `linear`, `notion`, `gmail`). */
     provider?: string;
     /** Identifier for the external account (e.g. Slack workspace ID, GitHub org name). Must be distinct across connectors for the same provider. */

package/dist/api/types/HandlerConnectorCreateResponse.d.ts

@@ -1,4 +1,13 @@
 export interface HandlerConnectorCreateResponse {
+    /**
+     * ACLChangesCursor is the provider permission-change feed's persisted
+     * cursor (PRO-1684; e.g. the Drive changes.list page token). Empty means
+     * uninitialized: the next cycle fetches a baseline and starts from now.
+     * Advanced ONLY after every reported change was applied, so a failed
+     * apply replays the same changes next cycle (at-least-once; the writes
+     * are idempotent full replacements).
+     */
+    aclChangesCursor?: string;
     /**
      * ActiveResourceCount mirrors the number of non-disabled resource rows so
      * list responses can distinguish "no resources configured yet"
@@ -11,6 +20,12 @@ export interface HandlerConnectorCreateResponse {
     collection?: string;
     /** Connector this resource belongs to. */
     connectorId?: string;
+    /**
+     * CustomInstructions is optional free-text guidance applied when this
+     * connector's documents are ingested: it steers how content is interpreted
+     * and indexed. Max 4000 characters; changes apply from the next sync cycle.
+     */
+    customInstructions?: string;
     /**
      * Database/Collection are the canonical v2 names for the deprecated
      * tenant_id/sub_tenant_id wire fields. They mirror the same values so a v2
@@ -64,6 +79,21 @@ export interface HandlerConnectorCreateResponse {
     needsReauthReason?: string;
     /** RFC3339 timestamp when the next scheduled sync will run. */
     nextSyncAt?: string;
+    /**
+     * Paused marks a connector its owner deliberately stopped (PRO-1762). It
+     * parks next_sync_at as SyncBlocked does, but stays a separate field:
+     * blocking clears itself once the cause is fixed, whereas only an explicit
+     * resume lifts a pause. Resources keep their committed provider_cursor, so
+     * resuming continues from where each stream stopped.
+     */
+    paused?: boolean;
+    pausedAt?: string;
+    /**
+     * PausedNextSyncAt preserves the schedule the pause displaced. Resume makes
+     * the connector due immediately, so this is read back only to recover from
+     * a pause applied by mistake.
+     */
+    pausedNextSyncAt?: string;
     /** External provider being synced (e.g. `slack`, `github`, `linear`, `notion`, `gmail`). */
     provider?: string;
     /** Identifier for the external account (e.g. Slack workspace ID, GitHub org name). Must be distinct across connectors for the same provider. */

package/dist/api/types/HandlerConnectorListResponse.d.ts

@@ -3,9 +3,13 @@ export interface HandlerConnectorListResponse {
     connectors?: HydraDB.HandlerConnectorApiView[];
     /**
      * Health maps connector_id to its rollup (healthy | degraded | failed |
-     * checking), present only when the caller asks for `?include=health`.
-     * A connector missing from the map has an unknown rollup — its resources
-     * could not be read — which clients must not render as a failure.
+     * checking | capped), present only when the caller asks for
+     * `?include=health`. A connector missing from the map has an unknown
+     * rollup — its resources could not be read — which clients must not
+     * render as a failure. `capped` is not a rollup of the connector: it is
+     * overlaid on a healthy, degraded or checking one when the org is at a
+     * plan cap, and PlanCap says which.
      */
     health?: Record<string, string>;
+    planCap?: HydraDB.HandlerPlanCapView;
 }

package/dist/api/types/HandlerConnectorPauseResponse.d.ts

@@ -0,0 +1,6 @@
+export interface HandlerConnectorPauseResponse {
+    /** Connector this resource belongs to. */
+    connectorId?: string;
+    paused?: boolean;
+    pausedAt?: string;
+}

package/dist/api/types/HandlerConnectorPauseResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/HandlerConnectorResourceStatus.d.ts

@@ -1,4 +1,22 @@
 export interface HandlerConnectorResourceStatus {
+    /**
+     * ACLWarning explains why permission capture could not read this
+     * resource. Capture fails OPEN, so while this is set the resource is
+     * readable by EVERY caller regardless of the ACL they send. Deliberately
+     * not folded into Status: the resource is syncing fine and its content is
+     * current, so calling it failed would be wrong and would train people to
+     * ignore a red badge. It is a separate signal because it needs a separate
+     * reaction (grant the missing permission, or set an access rule).
+     */
+    aclWarning?: string;
+    /**
+     * ACLWarningAt is when this warning was last CHANGED (RFC3339), not when
+     * the failure was last observed. An unchanged warning is deliberately not
+     * rewritten every cycle, so treat this as "open since", not "checked at".
+     */
+    aclWarningAt?: string;
+    /** Action is what the user must do, when there is something they can do. */
+    action?: string;
     checkedAt?: string;
     /** Human-readable name for this resource. */
     displayName?: string;
@@ -8,6 +26,17 @@ export interface HandlerConnectorResourceStatus {
     lastRowCount?: number;
     /** Message is the provider's own words when Status is failed. */
     message?: string;
+    /**
+     * PageACLWarning reports that individual PAGES inside this resource could
+     * not have their own restrictions resolved and were opened to every caller.
+     * Distinct from ACLWarning above, which is about the resource itself: a
+     * resource can capture perfectly while pages inside it fail, and a healthy
+     * resource capture clears ACLWarning, so sharing one field would blank this
+     * every cycle and report all-clear while pages are still open.
+     */
+    pageAclWarning?: string;
+    /** PageACLWarningAt is when PageACLWarning last CHANGED (RFC3339). */
+    pageAclWarningAt?: string;
     /** Resource identifier from the Discover endpoint. */
     resourceId?: string;
     /**
@@ -18,4 +47,18 @@ export interface HandlerConnectorResourceStatus {
     retryable?: boolean;
     /** Status is one of ok | empty | failed | checking | unknown. */
     status?: string;
+    /**
+     * SyncBlocked reports that this resource has stopped syncing. Distinct from
+     * a failed status: a resource can fail a cycle and be retried, and the
+     * difference between "failing" and "given up on" is the one a user needs to
+     * act on.
+     */
+    syncBlocked?: boolean;
+    /** SyncBlockedAt is when it stopped (RFC3339). */
+    syncBlockedAt?: string;
+    /**
+     * SyncBlockedReason is why it stopped, preserved from the failure that
+     * stopped it so it survives later syncs overwriting the health block.
+     */
+    syncBlockedReason?: string;
 }

package/dist/api/types/HandlerConnectorStatusError.d.ts

@@ -1,7 +1,8 @@
 /**
- * Error is the connector-level failure, set when Status is failed. Absent
- * when the trouble is confined to individual resources — those carry their
- * own messages below.
+ * Error is the connector-level failure: a rejected credential, a blocked
+ * connector, or a latest sync cycle that failed as a whole. Absent when the
+ * trouble is confined to individual resources — those carry their own
+ * messages below.
  */
 export interface HandlerConnectorStatusError {
     /** Action is what the user must do, when there is something they can do. */

package/dist/api/types/HandlerConnectorStatusResponse.d.ts

@@ -17,6 +17,7 @@ export interface HandlerConnectorStatusResponse {
     lifecycle?: string;
     /** RFC3339 timestamp when the next scheduled sync will run. */
     nextSyncAt?: string;
+    planCap?: HydraDB.HandlerPlanCapView;
     /** External provider being synced (e.g. `slack`, `github`, `linear`, `notion`, `gmail`). */
     provider?: string;
     /**
@@ -25,8 +26,10 @@ export interface HandlerConnectorStatusResponse {
      */
     resources?: HydraDB.HandlerConnectorResourceStatus[];
     /**
-     * Status is the rollup: healthy | degraded | failed | checking. It is the
-     * worst of the credential state and every resource state.
+     * Status is the rollup: healthy | degraded | failed | checking, or capped
+     * when the org is at an enforced plan cap and the rollup was healthy,
+     * degraded or checking (PlanCap then says which cap). It is the worst of
+     * the credential state and every resource state.
      */
     status?: string;
     /**

package/dist/api/types/HandlerConnectorUpdateResponse.d.ts

@@ -6,6 +6,11 @@ export interface HandlerConnectorUpdateResponse {
      * re-written (and any needs-reauth flag cleared) by this request.
      */
     credentialsUpdated?: boolean;
+    /**
+     * CustomInstructionsUpdated reports that the steering text was rewritten
+     * (or cleared) by this request; it takes effect from the next sync cycle.
+     */
+    customInstructionsUpdated?: boolean;
     /** Largest sync_interval_seconds this connector's provider allows. */
     maxSyncIntervalSeconds?: number;
     /** Smallest sync_interval_seconds this connector's provider allows. Values below it are rejected, never clamped. */

package/dist/api/types/HandlerEnvelopeGraphSourceSubgraphResponse.d.ts

@@ -0,0 +1,9 @@
+import type * as HydraDB from "../index.js";
+export interface HandlerEnvelopeGraphSourceSubgraphResponse {
+    data?: HydraDB.GraphSourceSubgraphResponse;
+    /** Error message, empty string on success. */
+    error?: HydraDB.HandlerApiError;
+    meta?: HydraDB.HandlerResponseMeta;
+    /** Whether the request succeeded. */
+    success?: boolean;
+}

package/dist/api/types/HandlerEnvelopeGraphSourceSubgraphResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/HandlerEnvelopeHandlerSupabaseWebhookAck.d.ts

@@ -0,0 +1,9 @@
+import type * as HydraDB from "../index.js";
+export interface HandlerEnvelopeHandlerSupabaseWebhookAck {
+    data?: HydraDB.HandlerSupabaseWebhookAck;
+    /** Error message, empty string on success. */
+    error?: HydraDB.HandlerApiError;
+    meta?: HydraDB.HandlerResponseMeta;
+    /** Whether the request succeeded. */
+    success?: boolean;
+}

package/dist/api/types/HandlerEnvelopeHandlerSupabaseWebhookAck.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/HandlerEnvelopeSearchChunkInspectResult.d.ts

@@ -0,0 +1,9 @@
+import type * as HydraDB from "../index.js";
+export interface HandlerEnvelopeSearchChunkInspectResult {
+    data?: HydraDB.SearchChunkInspectResult;
+    /** Error message, empty string on success. */
+    error?: HydraDB.HandlerApiError;
+    meta?: HydraDB.HandlerResponseMeta;
+    /** Whether the request succeeded. */
+    success?: boolean;
+}

package/dist/api/types/HandlerEnvelopeSearchChunkInspectResult.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/HandlerEnvelopeSearchEntityProfileView.d.ts

@@ -0,0 +1,9 @@
+import type * as HydraDB from "../index.js";
+export interface HandlerEnvelopeSearchEntityProfileView {
+    data?: HydraDB.SearchEntityProfileView;
+    /** Error message, empty string on success. */
+    error?: HydraDB.HandlerApiError;
+    meta?: HydraDB.HandlerResponseMeta;
+    /** Whether the request succeeded. */
+    success?: boolean;
+}

package/dist/api/types/HandlerEnvelopeSearchEntityProfileView.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/HandlerEnvelopeTenantsSubTenantDeleteResponse.d.ts

@@ -0,0 +1,9 @@
+import type * as HydraDB from "../index.js";
+export interface HandlerEnvelopeTenantsSubTenantDeleteResponse {
+    data?: HydraDB.TenantsSubTenantDeleteResponse;
+    /** Error message, empty string on success. */
+    error?: HydraDB.HandlerApiError;
+    meta?: HydraDB.HandlerResponseMeta;
+    /** Whether the request succeeded. */
+    success?: boolean;
+}

package/dist/api/types/HandlerEnvelopeTenantsSubTenantDeleteResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/HandlerEnvelopeTenantsTenantRenameResponse.d.ts

@@ -0,0 +1,9 @@
+import type * as HydraDB from "../index.js";
+export interface HandlerEnvelopeTenantsTenantRenameResponse {
+    data?: HydraDB.TenantsTenantRenameResponse;
+    /** Error message, empty string on success. */
+    error?: HydraDB.HandlerApiError;
+    meta?: HydraDB.HandlerResponseMeta;
+    /** Whether the request succeeded. */
+    success?: boolean;
+}

package/dist/api/types/HandlerEnvelopeTenantsTenantRenameResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/HandlerInstructionsResponse.d.ts

@@ -0,0 +1,13 @@
+export interface HandlerInstructionsResponse {
+    /** Collections maps collection name to that collection's own instructions. */
+    collections?: Record<string, string>;
+    /** CustomInstructions applies to every document ingested into the database. */
+    customInstructions?: string;
+    /** Owning database. Formerly `tenant_id`; the `tenant_id` alias is still accepted (deprecated). */
+    database?: string;
+    /**
+     * TenantID mirrors Database as a deprecated alias, matching every other v2
+     * tenant response.
+     */
+    tenantId?: string;
+}

package/dist/api/types/HandlerInstructionsResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/HandlerPlanCapView.d.ts

@@ -0,0 +1,11 @@
+/**
+ * PlanCap is present when the org is at a plan cap the caps mode
+ * enforces; every sync is skipped until the month resets or the plan
+ * changes.
+ */
+export interface HandlerPlanCapView {
+    /** Human-readable result message. */
+    message?: string;
+    meter?: string;
+    plan?: string;
+}

package/dist/api/types/HandlerPlanCapView.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/HandlerResourceMapping.d.ts

@@ -1,5 +1,12 @@
 import type * as HydraDB from "../index.js";
 export interface HandlerResourceMapping {
+    /**
+     * ACL restricts every object synced from this resource to the listed
+     * principals (emails, or prefixed principals, see the query-side
+     * user_email parameter). Omitted means unrestricted. An explicitly empty
+     * list means private (visible only to unfiltered queries).
+     */
+    acl?: string[];
     /**
      * AdditionalMetadata is merged into the additional_metadata layer of every
      * object synced from this resource. Provider-generated fields take precedence.
@@ -13,6 +20,13 @@ export interface HandlerResourceMapping {
      * Configure before toResource runs.
      */
     collection?: string;
+    /**
+     * CustomInstructions optionally steers how documents synced from this
+     * resource are ingested and indexed. When set it replaces the
+     * connector-level custom_instructions for this resource; empty inherits
+     * the connector's value. Max 4000 characters.
+     */
+    customInstructions?: string;
     /**
      * Database is the canonical v2 name for the per-resource tenant override:
      * routes synced objects from this resource into a specific database.

package/dist/api/types/HandlerSupabaseWebhookAck.d.ts

@@ -0,0 +1,7 @@
+export interface HandlerSupabaseWebhookAck {
+    /** Unique identifier for this resource. */
+    id?: string;
+    /** Current lifecycle or processing state. */
+    status?: string;
+    table?: string;
+}

package/dist/api/types/HandlerSupabaseWebhookAck.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/HandlerVaultCredentialEntry.d.ts

@@ -0,0 +1,13 @@
+export interface HandlerVaultCredentialEntry {
+    /** Collection scope. Defaults to the default collection when omitted. Formerly `sub_tenant_id`; the `sub_tenant_id` alias is still accepted (deprecated). */
+    collection?: string;
+    /** Connector this resource belongs to. */
+    connectorId?: string;
+    credentialId?: string;
+    /** Owning database. Formerly `tenant_id`; the `tenant_id` alias is still accepted (deprecated). */
+    database?: string;
+    fields?: string[];
+    label?: string;
+    /** External provider being synced (e.g. `slack`, `github`, `linear`, `notion`, `gmail`). */
+    provider?: string;
+}

package/dist/api/types/HandlerVaultCredentialEntry.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/HandlerVaultCredentialListResponse.d.ts

@@ -0,0 +1,8 @@
+import type * as HydraDB from "../index.js";
+export interface HandlerVaultCredentialListResponse {
+    /** Total number of items returned. */
+    count?: number;
+    /** Provider-specific credentials (typically `{"api_token": "..."}` or `{"access_token": "..."}`). */
+    credentials?: HydraDB.HandlerVaultCredentialEntry[];
+    unavailableCount?: number;
+}

package/dist/api/types/HandlerVaultCredentialListResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/HandlerVaultCredentialRevealResponse.d.ts

@@ -0,0 +1,7 @@
+export interface HandlerVaultCredentialRevealResponse {
+    credentialId?: string;
+    field?: string;
+    /** External provider being synced (e.g. `slack`, `github`, `linear`, `notion`, `gmail`). */
+    provider?: string;
+    value?: unknown;
+}

package/dist/api/types/HandlerVaultCredentialRevealResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/HandlerVaultCredentialUpdateResponse.d.ts

@@ -0,0 +1,5 @@
+export interface HandlerVaultCredentialUpdateResponse {
+    credentialId?: string;
+    /** Whether the source metadata was updated. */
+    updated?: boolean;
+}

package/dist/api/types/HandlerVaultCredentialUpdateResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/MemoriesConversationTurn.d.ts

@@ -0,0 +1,7 @@
+export interface MemoriesConversationTurn {
+    /** Extracted text content of the source document. */
+    content?: string;
+    /** Human-readable label for this resource. */
+    name?: string;
+    role?: string;
+}

package/dist/api/types/MemoriesConversationTurn.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/MemoriesIngestItem.d.ts

@@ -0,0 +1,56 @@
+import type * as HydraDB from "../index.js";
+export interface MemoriesIngestItem {
+    /**
+     * ACL is the item's access-control list (PRO-1684), the same contract as
+     * an app_knowledge item's `acl` on a split database: bare emails,
+     * user_email:/group:/domain: principals, or the __public__/__private__
+     * sentinels. Omitted (nil) leaves the context unrestricted; an explicitly
+     * empty list stores __private__. Normalised here, all-or-nothing, so a
+     * malformed principal is a 400 on the request rather than a silently
+     * mis-scoped context. Enforced by every read that takes `acl`.
+     */
+    acl?: string[];
+    attributes?: Record<string, unknown>;
+    /** Extracted text content of the source document. */
+    content?: string;
+    /**
+     * ContextCategory files this context under one of the three buckets
+     * (PRO-1618). Omitted or "auto" leaves it to HydraDB; naming a bucket pins
+     * it and inference will not overwrite it. See
+     * domain/ingestion/context_category.go.
+     */
+    contextCategory?: HydraDB.MemoriesIngestItemContextCategory;
+    contextId?: string;
+    /**
+     * Conversation is the canonical name; `messages` is accepted as an alias.
+     * Both are the shape a developer already builds for OpenAI or Anthropic.
+     */
+    conversation?: HydraDB.MemoriesConversationTurn[];
+    customAttributes?: Record<string, unknown>;
+    customInstructions?: string;
+    enrich?: boolean;
+    happenedAt?: string;
+    /**
+     * IsMarkdown tells the pipeline the text is markdown, so it is chunked on
+     * structure rather than as flat prose. The split memories[] path has always
+     * carried it; a unified database has no other ingest shape, so without it
+     * here a markdown sync has nowhere to say so.
+     */
+    isMarkdown?: boolean;
+    messages?: HydraDB.MemoriesConversationTurn[];
+    /** Text is the canonical name; `content` is accepted as an alias. */
+    text?: string;
+    /**
+     * Title names the context. It becomes the context's document title, and it
+     * is what distinguishes two items whose text is identical: the document id
+     * is generated from the title, so without one they collide.
+     */
+    title?: string;
+    /**
+     * UserName is the speaker identity for a TEXT item. A conversation names
+     * its speaker per turn instead, and that stays authoritative: this field
+     * only fills in when the turns supplied none. Empty ends up as "User",
+     * matching the split path, so the pipeline is never handed a blank.
+     */
+    userName?: string;
+}

package/dist/api/types/MemoriesIngestItem.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/MemoriesIngestItemContextCategory.d.ts

@@ -0,0 +1,13 @@
+/**
+ * ContextCategory files this context under one of the three buckets
+ * (PRO-1618). Omitted or "auto" leaves it to HydraDB; naming a bucket pins
+ * it and inference will not overwrite it. See
+ * domain/ingestion/context_category.go.
+ */
+export declare const MemoriesIngestItemContextCategory: {
+    readonly Auto: "auto";
+    readonly UserPreference: "user_preference";
+    readonly BusinessKnowledge: "business_knowledge";
+    readonly DecisionTrace: "decision_trace";
+};
+export type MemoriesIngestItemContextCategory = (typeof MemoriesIngestItemContextCategory)[keyof typeof MemoriesIngestItemContextCategory];