@tellescope/types-models 1.158.0 → 1.160.0

package/src/index.ts

@@ -800,6 +800,7 @@ export interface Enduser extends Enduser_readonly, Enduser_required, Enduser_upd
   stripeKey?: string,
   lastDoseSpotSyncAt?: Date,
   diagnoses?: EnduserDiagnosis[]
+  lockedFromPortal?: boolean,
   // unsubscribedFromEmail?: boolean,
   // unsubscribedFromSMS?: boolean,
 }
@@ -840,6 +841,7 @@ export interface EnduserMedication extends EnduserMedication_readonly, EnduserMe
   startedTakingAt?: Date | '',
   stoppedTakingAt?: Date | '',
   rxNormCode?: string,
+  fdbCode?: string,
   dispensing?: {
     quantity: number,
     unit?: string,
@@ -849,6 +851,7 @@ export interface EnduserMedication extends EnduserMedication_readonly, EnduserMe
     unit: string,
     quantity?: string,
     frequency?: string,
+    frequencyDescriptor?: string,
   },
   notes?: string,
   pharmacyName?: string,
@@ -1064,6 +1067,7 @@ export interface Email extends Email_required, Email_readonly, Email_updatesDisa
   ticketIds?: string[],
   alternateToAddress?: string,
   hiddenBy?: { [index: string] : Date | '' };
+  hiddenForAll?: boolean,
   suggestedReply?: string,
   tags?: string[],
   batchId?: string,
@@ -1104,6 +1108,7 @@ export interface SMSMessage extends SMSMessage_readonly, SMSMessage_required, SM
   userId?: string, // defaults to self, but should allow future options to send as other user
   readBy?: { [index: string] : Date };
   hiddenBy?: { [index: string] : Date | '' };
+  hiddenForAll?: boolean,
   error?: string,
   journeyContext?: JourneyContext,
   sendAt?: Date | '',
@@ -1195,6 +1200,7 @@ export interface ChatMessage extends ChatMessage_readonly, ChatMessage_required,
   html?: string,
   readBy?: { [index: string] : Date };
   hiddenBy?: { [index: string] : Date | '' };
+  hiddenForAll?: boolean,
   attachments?: ChatAttachment[]
   timestamp?: Date,
   ticketIds?: string[],
@@ -1512,6 +1518,7 @@ export type FormFieldOptions = FormFieldValidation & {
   saveIntakeOnPartial?: boolean,
   stripeKey?: string, // publishable key of custom stripe API keys
   dataSource?: string, // e.g. Canvas for Allergies
+  canvasDocumentCoding?: Pick<CanvasCoding, 'system' | 'code'>
 }
 export type MultipleChoiceOptions = Pick<FormFieldOptions, 'choices' | 'radio' | 'other'>
 
@@ -1800,21 +1807,28 @@ export type MedicationResponse = {
   otherDrug?: string,
   drugSynonym?: string,
   rxNormCode?: string,
+  fdbCode?: string,
   dosage?: {
     value: string,
     unit: string,
     quantity?: string, // how many per frequency
     frequency?: string,
+    frequencyDescriptor?: string,
   },
   NDCs?: string[],
   reasonForTaking?: string,
 }
 
-export type AllergyResponse = {
+export type BaseResponse = {
   display: string,
   code: string,
   system?: string,
 }
+export type AllergyResponse = BaseResponse & {
+  severity?: string,
+  note?: string,
+}
+export type ConditionResponse = BaseResponse
 
 export type FormResponseAnswerTable = FormResponseValueAnswerBuilder<'Table Input', TableInputCell[][]>
 export type FormResponseAnswerGroup = FormResponseValueAnswerBuilder<'Question Group', FormSubField[]>
@@ -1837,7 +1851,7 @@ export type FormResponseAnswerInsurance = FormResponseValueAnswerBuilder<'Insura
 export type FormResponseAnswerHeight = FormResponseValueAnswerBuilder<'Height', { feet: number, inches: number }>
 export type FormResponseAnswerRedirect = FormResponseValueAnswerBuilder<'Redirect', string>
 export type FormResponseAnswerAllergies = FormResponseValueAnswerBuilder<'Allergies', AllergyResponse[]>
-export type FormResponseAnswerConditions = FormResponseValueAnswerBuilder<'Conditions', AllergyResponse[]>
+export type FormResponseAnswerConditions = FormResponseValueAnswerBuilder<'Conditions', ConditionResponse[]>
 
 export type FormResponseAnswerSignatureValue = {
   fullName: string,
@@ -1950,6 +1964,11 @@ export type Addendum = {
   userId: string,
   text: string,
 }
+export type FormResponseFollowup = {
+  formId: string,
+  formResponseId?: string,
+  completedAt?: Date,
+}
 
 export interface FormResponse_readonly extends ClientRecord {
   openedAt?: Date,
@@ -1975,6 +1994,7 @@ export interface FormResponse_required {
   dateOfBirth?: string,
   gender?: TellescopeGender,
   customTypeId?: string,
+  followups?: FormResponseFollowup[],
 }
 export interface FormResponse_updatesDisabled {
   submissionExpiresAt?: number,
@@ -2024,7 +2044,8 @@ export interface FormResponse extends FormResponse_readonly, FormResponse_requir
   discussionRoomId?: string,
   formsort?: string,
   hideAfterUnsubmittedInMS?: number,
-  addenda?: Addendum[]
+  addenda?: Addendum[],
+  canvasEncounterId?: string,
 }
 
 export interface WebHook_readonly extends ClientRecord {}
@@ -2174,6 +2195,8 @@ export interface CalendarEvent extends CalendarEvent_readonly, CalendarEvent_req
   dontBlockAvailability?: boolean,
   previousStartTimes?: (number | string)[],
   requirePortalCancelReason?: boolean,
+  startLinkToken?: string,
+  canvasEncounterId?: string,
   // isAllDay?: boolean,
 }
 
@@ -2651,6 +2674,7 @@ export type HealthieSendChatAutomationAction = AutomationActionBuilder<'healthie
 export type CompleteTicketsAutomationAction = AutomationActionBuilder<'completeTickets', { journeyIds?: string[] }>
 export type ChangeContactTypeAutomationAction = AutomationActionBuilder<'changeContactType', { type: string }>
 export type ActiveCampaignSyncAutomationAction = AutomationActionBuilder<'activeCampaignSync', { }>
+export type ActiveCampaignAddToListsAutomationAction = AutomationActionBuilder<'activeCampaignAddToLists', { listIds: string[] }>
 export type SwitchToRelatedContactAutomationAction = AutomationActionBuilder<'switchToRelatedContact', { type: string, otherTypes?: string[] }>
 export type ElationSyncAutomationAction = AutomationActionBuilder<'elationSync', { }>
 export type CanvasSyncAutomationAction = AutomationActionBuilder<'canvasSync', {}>
@@ -2714,6 +2738,7 @@ export type AutomationActionForType = {
   'completeTickets': CompleteTicketsAutomationAction,
   'changeContactType': ChangeContactTypeAutomationAction,
   activeCampaignSync: ActiveCampaignSyncAutomationAction,
+  activeCampaignAddToLists: ActiveCampaignAddToListsAutomationAction,
   switchToRelatedContact: SwitchToRelatedContactAutomationAction,
   'elationSync': ElationSyncAutomationAction,
   canvasSync: CanvasSyncAutomationAction,
@@ -3145,6 +3170,7 @@ export interface PhoneCall extends PhoneCall_readonly, PhoneCall_required, Phone
   pinnedAt?: Date | '',
   readBy?: { [index: string] : Date | '' };
   hiddenBy?: { [index: string] : Date | '' };
+  hiddenForAll?: boolean,
   ticketIds?: string[],
   tags?: string[],
   inputs?: string[],
@@ -3197,6 +3223,7 @@ export type AnalyticsQueryInfoForType = {
     Total: AnalyticsQueryInfoBuilder<'Total', undefined>,
     Duration: AnalyticsQueryInfoBuilder<'Duration', undefined>,
   },
+  "Journey Logs": { Total:  AnalyticsQueryInfoBuilder<'Total', undefined> },
 }
 export type AnalyticsQueryInfoType = keyof AnalyticsQueryInfoForType
 export type AnalyticsQueryInfo = AnalyticsQueryInfoForType[AnalyticsQueryInfoType]
@@ -3252,6 +3279,9 @@ export type AnalyticsQueryFilterForType = {
   Files: { 
     names?: string[],
   },
+  "Journey Logs": { 
+    automationStepIds?: string[],
+  },
 }
 
 export type EnduserGrouping = {
@@ -3290,6 +3320,7 @@ export type AnalyticsQueryGroupingForType = {
   "Emails": {} & EnduserGrouping & { Enduser: string },
   "Medications": {} & EnduserGrouping & { Enduser: string },
   "Files": {} & EnduserGrouping & { Enduser: string },
+  "Journey Logs": {} & EnduserGrouping & { Enduser: string },
   "Meetings": { Host?: boolean },  
 }
 
@@ -3307,6 +3338,7 @@ export type AnalyticsQueryRangeKeyForType = {
   "Medications": DefaultRangeKey,
   "Files": DefaultRangeKey,
   "Meetings": DefaultRangeKey,
+  "Journey Logs": DefaultRangeKey,
 }
 export type RangeKey = DefaultRangeKey | 'Submitted At' | "Closed At"
 
@@ -3408,6 +3440,13 @@ export type AnalyticsQueryForType = {
     AnalyticsQueryGroupingForType['Meetings'],
     AnalyticsQueryRangeKeyForType['Meetings']
   >,
+  "Journey Logs": AnalyticsQueryBuilder<
+    "Journey Logs", 
+    AnalyticsQueryInfoForType['Journey Logs'][keyof AnalyticsQueryInfoForType['Journey Logs']],
+    AnalyticsQueryFilterForType['Journey Logs'],
+    AnalyticsQueryGroupingForType['Journey Logs'],
+    AnalyticsQueryRangeKeyForType['Journey Logs']
+  >,
 }
 export type AnalyticsQueryType = keyof AnalyticsQueryForType
 export type AnalyticsQuery = AnalyticsQueryForType[AnalyticsQueryType]
@@ -3425,6 +3464,7 @@ export const resource_to_modelName: { [K in AnalyticsQueryType] : ModelName } =
   Medications: "enduser_medications",
   Files: "files",
   Meetings: "meetings",
+  "Journey Logs": "automated_actions",
 }
 
 export type AnalyticsQueryOptions = {
@@ -3459,6 +3499,8 @@ export interface AnalyticsFrame extends
   truncationLength?: number,
   showEllipsis?: boolean,
   orderedLabels?: string[],
+  visibleForRoles?: string[],
+  visibleForUserIds?: string[],
 }
 
 
@@ -3525,6 +3567,7 @@ export type EnduserProfileViewBlocks = {
   "Labs": EnduserProfileViewBlockBuilder<"Labs", { title: string }>,
   "Medications": EnduserProfileViewBlockBuilder<"Medications", { title: string }>,
   "Diagnoses": EnduserProfileViewBlockBuilder<"Diagnoses", { title: string }>,
+  "Timeline": EnduserProfileViewBlockBuilder<"Timeline", { title: string }>,
 }
 export type EnduserProfileViewBlockType = keyof EnduserProfileViewBlocks
 export type EnduserProfileViewBlock = EnduserProfileViewBlocks[EnduserProfileViewBlockType]
@@ -3565,6 +3608,9 @@ export type AutomationTriggerActions = {
   "Remove Care Team": AutomationTriggerActionBuilder<'Remove Care Team', { 
     tags: ListOfStringsWithQualifier,
   }>, 
+  "Require Form Followups": AutomationTriggerActionBuilder<'Require Form Followups', { 
+    formIds: string[],
+  }>, 
 }
 export type AutomationTriggerActionType = keyof AutomationTriggerActions
 export type AutomationTriggerAction = AutomationTriggerActions[AutomationTriggerActionType]
@@ -3871,6 +3917,7 @@ export interface TicketThreadComment extends TicketThreadComment_readonly, Ticke
     transcription?: string,
   },
   hiddenBy?: { [index: string] : Date | '' };
+  hiddenForAll?: boolean,
   ticketIds?: string[], 
   tags?: string[],
 }
@@ -4037,6 +4084,7 @@ export interface GroupMMSConversation_readonly extends ClientRecord {
   tags?: string[]
   suggestedReply?: string,
   hiddenBy?: { [index: string] : Date | '' };
+  hiddenForAll?: boolean,
   assignedTo?: string[],
 }
 export interface GroupMMSConversation_updatesDisabled {}