@tellescope/types-models 1.255.18 → 1.256.0

package/src/index.ts

@@ -593,6 +593,9 @@ export interface Organization extends Organization_readonly, Organization_requir
   customerIOFields?: string[],
   customerIOIdField?: string,
   createEnduserForms?: string[],
+  // Journey containing a "Generate Patient Summary" action; enables the Regenerate button on the
+  // AI Summary panel of the patient profile. Unset automatically if the journey is deleted.
+  defaultSummaryJourneyId?: string,
   creditCount?: number,
   creditTrialStartedAt?: Date,
   hasIntegrations?: string[],
@@ -642,16 +645,24 @@ export interface RecordInfo {
 
 export interface ClientRecord extends RecordInfo { id: string }
 
-export interface WithAllowedPaths {
-  allowedPaths?: string[],
+// Ids a session scope pins itself to, substituted into the scope's route shapes server-side.
+export interface SessionScopeContext {
+  calendarEventId?: string,
 }
-  
-export interface Session {
+
+export interface WithSessionConfinement {
+  sessionScopes?: SessionScope[], // named scopes, resolved to routes server-side
+  scopeContext?: SessionScopeContext,
+  allowedPaths?: string[], // LEGACY — superseded by sessionScopes, honored until old tokens expire
+}
+
+export interface WithAllowedPaths extends WithSessionConfinement {}
+
+export interface Session extends WithSessionConfinement {
   type: "user" | "enduser",
   businessId: string,
   iat: number,
   exp: number,
-  allowedPaths?: string[],
   requiresMFA?: boolean,
 }
   
@@ -1249,6 +1260,23 @@ export const FORM_INGESTION_API_KEY_SCOPE = 'form-ingestion' as const
 export const API_KEY_SCOPES = [FORM_INGESTION_API_KEY_SCOPE] as const
 export type APIKeyScope = typeof API_KEY_SCOPES[number]
 
+/**
+ * Confinement scopes for limited-purpose SESSIONS (video links, public forms, booking pages, ics
+ * links). Each name resolves server-side to a fixed set of method+path grants.
+ *
+ * Distinct from APIKeyScope above, and NOT interchangeable — note the inverted empty-array
+ * semantics: `scopes: []` on an API key means unrestricted, whereas a session confined to no scopes
+ * reaches nothing. The route table is intentionally backend-only; only the names are public.
+ */
+export const SESSION_SCOPES = [
+  'video-join-link',
+  'video-start-link',
+  'public-form',
+  'appointment-booking',
+  'ics-download',
+] as const
+export type SessionScope = typeof SESSION_SCOPES[number]
+
 export interface APIKey_readonly extends ClientRecord {
   hashedKey: string, // stored as hash
   key?: string, // deprecated
@@ -1527,6 +1555,8 @@ export interface SMSMessage extends SMSMessage_readonly, SMSMessage_required, SM
   replyToTemplateId?: string,
   assignedTo?: string[],
   templatedMessage?: string,
+  // AI translations of the message body, keyed by language code (inbound messages, Timeline)
+  translations?: Translations<'message'>,
   canvasId?: string,
   discussionRoomId?: string,
   mediaURLs?: string[],
@@ -2660,6 +2690,12 @@ export interface FormResponse_required {
   formTitle: string,
   responses?: FormResponseValue[], // some cases where undefined (not intended but now need to handle)
   publicSubmit?: boolean,
+  // Backend-managed. When set, `email` and `phone` are not written from this response's intake
+  // answers; all other intake fields are unaffected. Set when the response is attached to a contact
+  // that already existed, and left unset when the response created the contact. Once set it stays
+  // set for the life of the response. Intentionally absent from schema.ts, so it cannot be set or
+  // cleared through the API.
+  authFieldIntakeDisabled?: boolean,
   submittedBy?: string,
   submittedByIsPlaceholder?: boolean,
   markedAsSubmitted?: boolean,
@@ -5101,6 +5137,23 @@ export type PhonePlaybackInfo = {
 export type PhonePlaybackType = keyof PhonePlaybackInfo
 export type PhonePlayback = PhonePlaybackInfo[PhonePlaybackType]
 
+// Capabilities granted to an 'AI Agent' node — each entry enables tool(s) the agent may use
+// mid-call (e.g. collecting and submitting a form). Extensible the same way PhoneTreeActions is:
+// future capabilities (e.g. appointment booking) are new entries in PhoneTreeAgentTools.
+export type PhoneTreeAgentToolBuilder <T extends string, V> = { type: T, info: V }
+export type PhoneTreeAgentTools = {
+  'Submit Form': PhoneTreeAgentToolBuilder<'Submit Form', {
+    formId: string,
+    useWhen?: string, // guidance for when the agent should collect this form (disambiguates when several forms are configured)
+  }>,
+  'Book Appointment': PhoneTreeAgentToolBuilder<'Book Appointment', {
+    appointmentBookingPageId: string,
+    useWhen?: string, // guidance for when the agent should offer booking
+  }>,
+}
+export type PhoneTreeAgentToolType = keyof PhoneTreeAgentTools
+export type PhoneTreeAgentTool = PhoneTreeAgentTools[PhoneTreeAgentToolType]
+
 export type PhoneTreeActionBuilder <T, V> = { type: T, info: V }
 export type PhoneTreeActions = {
   // 'Play': PhoneTreeActionBuilder<"Play", { playback: PhonePlayback }>
@@ -5168,6 +5221,7 @@ export type PhoneTreeActions = {
     maxCreditsPerCall?: number, // per-call spend circuit breaker, default from constants
     model?: string, // friendly AI model name, see SELECTABLE_AI_MODELS (constants); defaults to Claude Sonnet 5
     outcomes: { value: string, description: string }[], // the agent must end with one of these
+    tools?: PhoneTreeAgentTool[], // capabilities the agent may use mid-call (e.g. 'Submit Form')
   }>
 }
 export type PhoneTreeActionType = keyof PhoneTreeActions
@@ -7071,6 +7125,7 @@ export type DataSyncRecord = {
   data: 'deleted' | string, // when not deleted, stringified JSON
   userIds: string[], // Default access
   enduserIds: string[], // Assigned access
+  visibleToAllUsers?: boolean, // 'visibleToAllUsers' schema access constraint (staff users only)
 }
 
 export type InsuranceType = "Primary" | "Secondary"