@corti/sdk 2.2.0-rc.2 → 3.0.0

package/dist/cjs/api/types/GuidedShallowTemplateVersionResponse.d.ts

@@ -0,0 +1,16 @@
+import type * as Corti from "../index.js";
+/**
+ * Template version with raw authored values — no inheritance resolution applied.
+ * Sections are returned as references (IDs), not fully resolved objects.
+ * Use this to inspect what was explicitly set on this version versus inherited.
+ * Returned by GET, LIST, and POST version endpoints.
+ */
+export interface GuidedShallowTemplateVersionResponse {
+    /** The UUID of the version. */
+    id: string;
+    /** Starts at 0 and auto-increments. */
+    versionNumber: number;
+    /** Present when the template version has been deleted. */
+    deletedAt?: Date | null;
+    generation: Corti.GuidedShallowTemplateGeneration;
+}

package/dist/cjs/api/types/GuidedSourceFilter.d.ts

@@ -0,0 +1,6 @@
+/** Filter by content source. */
+export declare const GuidedSourceFilter: {
+    readonly User: "user";
+    readonly Corti: "corti";
+};
+export type GuidedSourceFilter = (typeof GuidedSourceFilter)[keyof typeof GuidedSourceFilter];

package/dist/cjs/api/types/GuidedSourceFilter.js

@@ -0,0 +1,9 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GuidedSourceFilter = void 0;
+/** Filter by content source. */
+exports.GuidedSourceFilter = {
+    User: "user",
+    Corti: "corti",
+};

package/dist/cjs/api/types/GuidedStringNode.d.ts

@@ -0,0 +1,11 @@
+export interface GuidedStringNode {
+    type: "string";
+    /** Can be used to prompt the LLM with more guidance in addition to the section.instructions */
+    description?: string;
+    /** The default to output if nothing to output. */
+    default?: string | null;
+    /** Can be used to prompt the LLM with specific values to output. */
+    enum?: string[];
+    /** Can be used to prompt the LLM for a specific output pattern. */
+    pattern?: string | null;
+}

package/dist/cjs/api/types/GuidedTemplate.d.ts

@@ -0,0 +1,33 @@
+import type * as Corti from "../index.js";
+export interface GuidedTemplate {
+    /** The UUID of the template. */
+    id: string;
+    /** Reference to the template to inherit template instructions and sections from. Inherits from published version by default. */
+    inheritedFromId?: string | null;
+    /** True if the template was auto-generated based on the section-composed POST /documents request. */
+    autoGenerated?: boolean;
+    /** Whether this template was created by the user or is a Corti standard resource. */
+    source?: Corti.GuidedTemplateSource;
+    /** The name of this template. Not passed to the LLM. */
+    name: string;
+    /** A description for this template. Not passed to the LLM. */
+    description?: string;
+    /** BCP 47 language tags this template has been tweaked for (e.g. `["fr", "de", "en-GB"]`). Empty means no language-specific tweaks. */
+    languages: string[];
+    /** ISO 3166-1 alpha-3 country codes this template has been tweaked for (e.g. `["BEL"]`). Empty means no region-specific tweaks. */
+    regions: string[];
+    /** Clinical specialties this template has been tweaked for. Empty means no specialty-specific tweaks. */
+    specialties: string[];
+    /** The available labels to use as query param filter in the LIST /templates endpoint. */
+    labels: Corti.GuidedLabel[];
+    /** Access policies for this template. */
+    policies?: Corti.GuidedTemplatePolicy[];
+    /** The currently published version with inheritance fully resolved. Present when a version has been published. */
+    publishedVersion?: Corti.GuidedTemplateVersion;
+    /** The original timestamp when the template was created. */
+    createdAt: Date;
+    /** The original timestamp when the template was last updated. */
+    updatedAt: Date;
+    /** Present when the template has been deleted. GET by ID still returns the full resource with this field populated. */
+    deletedAt?: Date | null;
+}

package/dist/cjs/api/types/GuidedTemplateGeneration.d.ts

@@ -0,0 +1,9 @@
+import type * as Corti from "../index.js";
+/**
+ * Fully resolved template generation. Sections are expanded with their own inheritance applied.
+ */
+export interface GuidedTemplateGeneration {
+    instructions: Corti.GuidedTemplateInstructions;
+    /** Fully resolved sections with inheritance applied. */
+    sections?: Corti.GuidedSection[];
+}

package/dist/cjs/api/types/GuidedTemplateInstructions.d.ts

@@ -0,0 +1,4 @@
+export interface GuidedTemplateInstructions {
+    /** Template-level prompt instructions that apply generally to all sections. */
+    prompt: string;
+}

package/dist/cjs/api/types/GuidedTemplateInstructionsPartial.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Partial form of GuidedTemplateInstructions used when inheriting from another template. Any field omitted is inherited.
+ */
+export interface GuidedTemplateInstructionsPartial {
+    /** Override the inherited template-level prompt instructions. */
+    prompt?: string;
+}

package/dist/cjs/api/types/GuidedTemplateOverrides.d.ts

@@ -1,7 +1,7 @@
 import type * as Corti from "../index.js";
 export interface GuidedTemplateOverrides {
     /** Replaces the template-level instructions for this call. */
-    instructions?: Corti.TemplateInstructions;
+    instructions?: Corti.GuidedTemplateInstructions;
     /** Per-section override patches. Each entry must reference a section already linked to the base template version. */
     sections?: Corti.GuidedSectionOverride[];
 }

package/dist/cjs/api/types/GuidedTemplatePolicy.d.ts

@@ -0,0 +1,16 @@
+import type * as Corti from "../index.js";
+export interface GuidedTemplatePolicy {
+    /** The UUID of the policy. */
+    id: string;
+    kind: Corti.GuidedTemplatePolicyKind;
+    /** Present when `kind` is `customers`. Lists the customer tenant identifiers that have access. */
+    customerIds?: string[] | null;
+    /** The UUID of the template this policy belongs to. */
+    templateId: string;
+    /** The UUID of the user who created this policy. */
+    createdBy: string;
+    /** Timestamp when the policy was created. */
+    createdAt: Date;
+    /** Timestamp when the policy was last updated. */
+    updatedAt: Date;
+}

package/dist/cjs/api/types/GuidedTemplatePolicyKind.d.ts

@@ -0,0 +1,6 @@
+/** The kind of access policy. `project` restricts to the owning project; `customers` grants access to the listed customer tenants. */
+export declare const GuidedTemplatePolicyKind: {
+    readonly Project: "project";
+    readonly Customers: "customers";
+};
+export type GuidedTemplatePolicyKind = (typeof GuidedTemplatePolicyKind)[keyof typeof GuidedTemplatePolicyKind];

package/dist/cjs/api/types/GuidedTemplatePolicyKind.js

@@ -0,0 +1,9 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GuidedTemplatePolicyKind = void 0;
+/** The kind of access policy. `project` restricts to the owning project; `customers` grants access to the listed customer tenants. */
+exports.GuidedTemplatePolicyKind = {
+    Project: "project",
+    Customers: "customers",
+};

package/dist/cjs/api/types/GuidedTemplateSource.d.ts

@@ -0,0 +1,6 @@
+/** Whether this template was created by the user or is a Corti standard resource. */
+export declare const GuidedTemplateSource: {
+    readonly User: "user";
+    readonly Corti: "corti";
+};
+export type GuidedTemplateSource = (typeof GuidedTemplateSource)[keyof typeof GuidedTemplateSource];

package/dist/cjs/api/types/GuidedTemplateSource.js

@@ -0,0 +1,9 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GuidedTemplateSource = void 0;
+/** Whether this template was created by the user or is a Corti standard resource. */
+exports.GuidedTemplateSource = {
+    User: "user",
+    Corti: "corti",
+};

package/dist/cjs/api/types/GuidedTemplateVersion.d.ts

@@ -0,0 +1,15 @@
+import type * as Corti from "../index.js";
+/**
+ * Template version with fully resolved (inherited) values. Template-level and section-level
+ * inheritance chains are walked. Used in Template.publishedVersion
+ * on resource-level endpoints (GET/POST template).
+ */
+export interface GuidedTemplateVersion {
+    /** The UUID of the version. */
+    id: string;
+    /** Starts at 0 and auto-increments. */
+    versionNumber: number;
+    /** Present when the template version has been deleted. */
+    deletedAt?: Date | null;
+    generation: Corti.GuidedTemplateGeneration;
+}

package/dist/cjs/api/types/GuidedTemplateVersionSectionRef.d.ts

@@ -0,0 +1,6 @@
+export interface GuidedTemplateVersionSectionRef {
+    /** The UUID of the section linked to this template version. */
+    sectionId: string;
+    /** The ordering position of the section within the template version. */
+    orderIndex: number;
+}

package/dist/cjs/api/types/GuidedTemplatesCreateBase.d.ts

@@ -0,0 +1,19 @@
+import type * as Corti from "../index.js";
+export interface GuidedTemplatesCreateBase {
+    /** The name of this template. Not passed to the LLM. */
+    name: string;
+    /** A description for this template. Not passed to the LLM. */
+    description?: string;
+    /** BCP 47 language tags this template has been tweaked for (e.g. `["fr", "de", "en-GB"]`). */
+    languages?: string[];
+    /** ISO 3166-1 alpha-3 country codes this template has been tweaked for (e.g. `["BEL"]`). */
+    regions?: string[];
+    /** Clinical specialties this template has been tweaked for. */
+    specialties?: string[];
+    /** Labels work as query param filter in the LIST /templates endpoint. */
+    labels?: Corti.GuidedLabel[];
+    /** Defaults to true when omitted. Set this to false if you do not want the template to automatically show up in LIST templates. */
+    publish?: boolean;
+    /** Access policies to apply to the template on creation. */
+    policies?: Corti.GuidedTemplatesCreatePolicyRequest[];
+}

package/dist/cjs/api/types/GuidedTemplatesCreateFromInheritanceRequest.d.ts

@@ -0,0 +1,10 @@
+import type * as Corti from "../index.js";
+/**
+ * Creates a template that inherits from another template. Any fields omitted in `generation` are inherited from the referenced template's published version; any fields provided override the inherited values.
+ */
+export interface GuidedTemplatesCreateFromInheritanceRequest extends Corti.GuidedTemplatesCreateBase {
+    /** Reference to the template to inherit instructions and sections from. Inherits from the published version of the referenced template. */
+    inheritFromId: string;
+    /** Partial overrides applied on top of the inherited template. All inner fields are optional. Any field omitted is inherited from the referenced template. */
+    generation?: Corti.GuidedTemplatesCreateFromInheritanceRequestGeneration;
+}

package/dist/cjs/api/types/GuidedTemplatesCreateFromInheritanceRequestGeneration.d.ts

@@ -0,0 +1,8 @@
+import type * as Corti from "../index.js";
+/**
+ * Partial overrides applied on top of the inherited template. All inner fields are optional. Any field omitted is inherited from the referenced template.
+ */
+export interface GuidedTemplatesCreateFromInheritanceRequestGeneration {
+    instructions?: Corti.GuidedTemplateInstructionsPartial;
+    sections?: Corti.GuidedTemplatesVersionSectionRequest[];
+}

package/dist/cjs/api/types/GuidedTemplatesCreateFromScratchRequest.d.ts

@@ -0,0 +1,7 @@
+import type * as Corti from "../index.js";
+/**
+ * Creates a template from scratch. `generation.instructions` is required and the template fully specifies its own instructions and sections.
+ */
+export interface GuidedTemplatesCreateFromScratchRequest extends Corti.GuidedTemplatesCreateBase {
+    generation: Corti.GuidedTemplatesCreateFromScratchRequestGeneration;
+}

package/dist/cjs/api/types/GuidedTemplatesCreateFromScratchRequestGeneration.d.ts

@@ -0,0 +1,5 @@
+import type * as Corti from "../index.js";
+export interface GuidedTemplatesCreateFromScratchRequestGeneration {
+    instructions: Corti.GuidedTemplateInstructions;
+    sections?: Corti.GuidedTemplatesVersionSectionRequest[];
+}

package/dist/cjs/api/types/GuidedTemplatesCreatePolicyRequest.d.ts

@@ -0,0 +1,6 @@
+import type * as Corti from "../index.js";
+export interface GuidedTemplatesCreatePolicyRequest {
+    kind: Corti.GuidedTemplatePolicyKind;
+    /** Required when `kind` is `customers`. List of customer tenant identifiers that should have access. */
+    customerIds?: string[] | null;
+}

package/dist/cjs/api/types/GuidedTemplatesCreateRequest.d.ts

@@ -0,0 +1,2 @@
+import type * as Corti from "../index.js";
+export type GuidedTemplatesCreateRequest = Corti.GuidedTemplatesCreateFromScratchRequest | Corti.GuidedTemplatesCreateFromInheritanceRequest;

package/dist/cjs/api/types/GuidedTemplatesVersionGeneration.d.ts

@@ -0,0 +1,8 @@
+import type * as Corti from "../index.js";
+/**
+ * When the template inherits from another template, all inner fields are optional. Any field omitted is inherited from the parent's published version.
+ */
+export interface GuidedTemplatesVersionGeneration {
+    instructions?: Corti.GuidedTemplateInstructionsPartial;
+    sections?: Corti.GuidedTemplatesVersionSectionRequest[];
+}

package/dist/cjs/api/types/GuidedTemplatesVersionSectionRequest.d.ts

@@ -0,0 +1,6 @@
+export interface GuidedTemplatesVersionSectionRequest {
+    /** The UUID of the section to include in the template version. */
+    sectionId: string;
+    /** Sets the order of this section within this template. Starts at 0. */
+    orderIndex?: number;
+}

package/dist/cjs/api/types/index.d.ts

@@ -52,14 +52,12 @@ export * from "./AgentsTaskStatusState.js";
 export * from "./AgentsTextPart.js";
 export * from "./AgentsTextPartKind.js";
 export * from "./AgentsUpdateExpertReference.js";
-export * from "./ArrayNode.js";
 export * from "./AuthTokenRequestAuthorizationCode.js";
 export * from "./AuthTokenRequestAuthorizationPkce.js";
 export * from "./AuthTokenRequestClientCredentials.js";
 export * from "./AuthTokenRequestRefresh.js";
 export * from "./AuthTokenRequestRopc.js";
 export * from "./AuthTokenResponse.js";
-export * from "./BoolNode.js";
 export * from "./CodesFilter.js";
 export * from "./CodesGeneralReadResponse.js";
 export * from "./CodesGeneralReadResponseAlternativesItem.js";
@@ -67,32 +65,18 @@ export * from "./CodesGeneralReadResponseEvidencesItem.js";
 export * from "./CodesGeneralResponse.js";
 export * from "./CommonAiContext.js";
 export * from "./CommonCodingSystemEnum.js";
+export * from "./CommonDocumentationEvidence.js";
 export * from "./CommonDocumentIdContext.js";
 export * from "./CommonDocumentIdContextType.js";
+export * from "./CommonFactsContext.js";
 export * from "./CommonSortingDirectionEnum.js";
 export * from "./CommonSourceEnum.js";
+export * from "./CommonStatusResponse.js";
 export * from "./CommonTextContext.js";
-export * from "./CommonTextContextType.js";
+export * from "./CommonTranscriptContext.js";
 export * from "./CommonTranscriptRequest.js";
 export * from "./CommonTranscriptResponse.js";
 export * from "./CommonUsageInfo.js";
-export * from "./ContextFacts.js";
-export * from "./ContextText.js";
-export * from "./ContextTranscript.js";
-export * from "./CreateEphemeralDocumentResponse.js";
-export * from "./CreateSectionBase.js";
-export * from "./CreateSectionFromInheritanceRequest.js";
-export * from "./CreateSectionFromScratchRequest.js";
-export * from "./CreateSectionPolicyRequest.js";
-export * from "./CreateSectionRequest.js";
-export * from "./CreateTemplateBase.js";
-export * from "./CreateTemplateFromInheritanceRequest.js";
-export * from "./CreateTemplateFromInheritanceRequestGeneration.js";
-export * from "./CreateTemplateFromScratchRequest.js";
-export * from "./CreateTemplateFromScratchRequestGeneration.js";
-export * from "./CreateTemplatePolicyRequest.js";
-export * from "./CreateTemplateRequest.js";
-export * from "./DocumentationEvidence.js";
 export * from "./DocumentsContext.js";
 export * from "./DocumentsContextWithFacts.js";
 export * from "./DocumentsContextWithFactsType.js";
@@ -111,7 +95,6 @@ export * from "./DocumentsSectionOverride.js";
 export * from "./DocumentsTemplate.js";
 export * from "./DocumentsTemplateWithSectionKeys.js";
 export * from "./DocumentsTemplateWithSections.js";
-export * from "./EphemeralDocument.js";
 export * from "./ErrorResponse.js";
 export * from "./FactsBatchUpdateInput.js";
 export * from "./FactsBatchUpdateItem.js";
@@ -129,24 +112,69 @@ export * from "./FactsFactGroupsListResponse.js";
 export * from "./FactsListItem.js";
 export * from "./FactsListResponse.js";
 export * from "./FactsUpdateResponse.js";
-export * from "./FieldDefinition.js";
+export * from "./GuidedArrayNode.js";
 export * from "./GuidedAssemblyRequest.js";
 export * from "./GuidedAssemblySectionRef.js";
-export * from "./GuidedDocumentBase.js";
-export * from "./GuidedDocumentByAssembly.js";
-export * from "./GuidedDocumentByDynamic.js";
-export * from "./GuidedDocumentByTemplateRef.js";
+export * from "./GuidedBoolNode.js";
 export * from "./GuidedDocumentContext.js";
 export * from "./GuidedDocumentFactMinimal.js";
-export * from "./GuidedDocumentRequest.js";
+export * from "./GuidedDocumentsCreateEphemeralResponse.js";
+export * from "./GuidedDocumentsGenerateBase.js";
+export * from "./GuidedDocumentsGenerateByAssembly.js";
+export * from "./GuidedDocumentsGenerateByDynamic.js";
+export * from "./GuidedDocumentsGenerateByTemplateRef.js";
+export * from "./GuidedDocumentsGenerateRequest.js";
 export * from "./GuidedDocumentTranscriptMetadataMinimal.js";
 export * from "./GuidedDocumentTranscriptMinimal.js";
 export * from "./GuidedDocumentTranscriptSegmentMinimal.js";
 export * from "./GuidedDynamicInline.js";
 export * from "./GuidedDynamicRequest.js";
+export * from "./GuidedEphemeralDocument.js";
+export * from "./GuidedFieldDefinition.js";
+export * from "./GuidedLabel.js";
+export * from "./GuidedNumberNode.js";
+export * from "./GuidedObjectNode.js";
+export * from "./GuidedOutputSchema.js";
+export * from "./GuidedSection.js";
+export * from "./GuidedSectionGeneration.js";
+export * from "./GuidedSectionGenerationPartial.js";
+export * from "./GuidedSectionInstructions.js";
+export * from "./GuidedSectionInstructionsOverride.js";
+export * from "./GuidedSectionInstructionsPartial.js";
 export * from "./GuidedSectionOverride.js";
+export * from "./GuidedSectionOverrides.js";
+export * from "./GuidedSectionPolicy.js";
+export * from "./GuidedSectionSource.js";
+export * from "./GuidedSectionsCreateBase.js";
+export * from "./GuidedSectionsCreateFromInheritanceRequest.js";
+export * from "./GuidedSectionsCreateFromScratchRequest.js";
+export * from "./GuidedSectionsCreatePolicyRequest.js";
+export * from "./GuidedSectionsCreateRequest.js";
+export * from "./GuidedSectionVersion.js";
+export * from "./GuidedShallowTemplateGeneration.js";
+export * from "./GuidedShallowTemplateVersionResponse.js";
+export * from "./GuidedSourceFilter.js";
+export * from "./GuidedStringNode.js";
+export * from "./GuidedTemplate.js";
+export * from "./GuidedTemplateGeneration.js";
+export * from "./GuidedTemplateInstructions.js";
+export * from "./GuidedTemplateInstructionsPartial.js";
 export * from "./GuidedTemplateOverrides.js";
+export * from "./GuidedTemplatePolicy.js";
+export * from "./GuidedTemplatePolicyKind.js";
 export * from "./GuidedTemplateRef.js";
+export * from "./GuidedTemplateSource.js";
+export * from "./GuidedTemplatesCreateBase.js";
+export * from "./GuidedTemplatesCreateFromInheritanceRequest.js";
+export * from "./GuidedTemplatesCreateFromInheritanceRequestGeneration.js";
+export * from "./GuidedTemplatesCreateFromScratchRequest.js";
+export * from "./GuidedTemplatesCreateFromScratchRequestGeneration.js";
+export * from "./GuidedTemplatesCreatePolicyRequest.js";
+export * from "./GuidedTemplatesCreateRequest.js";
+export * from "./GuidedTemplatesVersionGeneration.js";
+export * from "./GuidedTemplatesVersionSectionRequest.js";
+export * from "./GuidedTemplateVersion.js";
+export * from "./GuidedTemplateVersionSectionRef.js";
 export * from "./InteractionsCreateResponse.js";
 export * from "./InteractionsEncounterCreateRequest.js";
 export * from "./InteractionsEncounterPeriod.js";
@@ -158,27 +186,10 @@ export * from "./InteractionsGenderEnum.js";
 export * from "./InteractionsGetResponse.js";
 export * from "./InteractionsListResponse.js";
 export * from "./InteractionsPatient.js";
-export * from "./Label.js";
 export * from "./LanguagesListResponse.js";
-export * from "./NumberNode.js";
 export * from "./OAuthTokenRequest.js";
-export * from "./ObjectNode.js";
-export * from "./OutputSchema.js";
 export * from "./RecordingsCreateResponse.js";
 export * from "./RecordingsListResponse.js";
-export * from "./Section.js";
-export * from "./SectionGeneration.js";
-export * from "./SectionGenerationPartial.js";
-export * from "./SectionInstructions.js";
-export * from "./SectionInstructionsOverride.js";
-export * from "./SectionInstructionsPartial.js";
-export * from "./SectionOverrides.js";
-export * from "./SectionPolicy.js";
-export * from "./SectionSource.js";
-export * from "./SectionVersion.js";
-export * from "./ShallowTemplateGeneration.js";
-export * from "./ShallowTemplateVersionResponse.js";
-export * from "./StatusResponse.js";
 export * from "./StreamAudioEventData.js";
 export * from "./StreamAudioEventDataEvent.js";
 export * from "./StreamAudioEventMessage.js";
@@ -209,14 +220,6 @@ export * from "./StreamTranscript.js";
 export * from "./StreamTranscriptMessage.js";
 export * from "./StreamTranscriptTime.js";
 export * from "./StreamUsageMessage.js";
-export * from "./StringNode.js";
-export * from "./Template.js";
-export * from "./TemplateGeneration.js";
-export * from "./TemplateInstructions.js";
-export * from "./TemplateInstructionsPartial.js";
-export * from "./TemplatePolicy.js";
-export * from "./TemplatePolicyKind.js";
-export * from "./TemplateSource.js";
 export * from "./TemplatesDocumentationModeEnum.js";
 export * from "./TemplatesFormatRule.js";
 export * from "./TemplatesItem.js";
@@ -227,9 +230,6 @@ export * from "./TemplatesSectionSorted.js";
 export * from "./TemplatesSectionTranslation.js";
 export * from "./TemplatesTranslation.js";
 export * from "./TemplatesWritingStyle.js";
-export * from "./TemplateVersion.js";
-export * from "./TemplateVersionSectionRef.js";
-export * from "./TemplateVersionSectionRequest.js";
 export * from "./TranscribeAudioEventData.js";
 export * from "./TranscribeAudioEventDataEvent.js";
 export * from "./TranscribeAudioEventMessage.js";