@tellescope/types-models 1.171.1 → 1.173.0

package/src/index.ts

@@ -385,6 +385,7 @@ export interface Organization extends Organization_readonly, Organization_requir
   defaultDoseSpotPharmacies?: { id: string, name: string }[]
   groups?: string[],
   observationInvalidationReasons?: string[],
+  chargebeeEnvironments?: string[],
   // _AIEnabled?: boolean,
 }
 export type OrganizationTheme = {
@@ -811,6 +812,9 @@ export interface Enduser extends Enduser_readonly, Enduser_required, Enduser_upd
   lastDoseSpotSyncAt?: Date,
   diagnoses?: EnduserDiagnosis[]
   lockedFromPortal?: boolean,
+  chargebeeEnvironment?: string,
+  chargebeeId?: string,
+  healthieSyncError?: string,
   // unsubscribedFromEmail?: boolean,
   // unsubscribedFromSMS?: boolean,
 }
@@ -1065,7 +1069,7 @@ export interface Email extends Email_required, Email_readonly, Email_updatesDisa
   replyTo?: string | null;  
   isBounce?: boolean,
   via?: string,
-  readBy?: { [index: string] : Date };
+  readBy?: { [index: string] : Date | '' };
   journeyContext?: JourneyContext,
   sendAt?: Date | '',
   pinnedAt?: Date | '',
@@ -1117,7 +1121,7 @@ export interface SMSMessage extends SMSMessage_readonly, SMSMessage_required, SM
   autoResolveToFrom?: boolean,
   isAutoreply?: boolean,
   userId?: string, // defaults to self, but should allow future options to send as other user
-  readBy?: { [index: string] : Date };
+  readBy?: { [index: string] : Date | '' };
   hiddenBy?: { [index: string] : Date | '' };
   hiddenForAll?: boolean,
   error?: string,
@@ -1152,6 +1156,7 @@ export interface ChatRoom_readonly extends ClientRecord {
 }
 export type ChatRoomUserInfo = {
   unreadCount: number
+  markedUnread?: boolean,
 }
 export interface ChatRoom_required {}
 export interface ChatRoom_updatesDisabled {}
@@ -1209,7 +1214,7 @@ export interface ChatMessage_updatesDisabled {
 export interface ChatMessage extends ChatMessage_readonly, ChatMessage_required, ChatMessage_updatesDisabled, TextCommunication {
   senderId: string | null;
   html?: string,
-  readBy?: { [index: string] : Date };
+  readBy?: { [index: string] : Date | '' };
   hiddenBy?: { [index: string] : Date | '' };
   hiddenForAll?: boolean,
   attachments?: ChatAttachment[]
@@ -1427,7 +1432,7 @@ export interface Note extends Note_readonly, Note_required, Note_updatesDisabled
 }
 
 export type FormFieldLiteralType = 'Rich Text' | 'description' | 'string' | 'stringLong' | 'number' | 'email' | 'phone' | 'date' /* date + time */ | 'dateString' | 'rating' | 'Time'
-export type FormFieldComplexType = "Conditions" | "Allergies" | "Emotii" | "Hidden Value" | "Redirect" | "Height" | "Appointment Booking" | "multiple_choice" | "file" | 'files' | "signature" | 'ranking' | 'Question Group' | 'Table Input' | "Address" | "Stripe" | "Dropdown" | "Database Select" | "Medications" | "Related Contacts" | "Insurance"
+export type FormFieldComplexType = "Conditions" | "Allergies" | "Emotii" | "Hidden Value" | "Redirect" | "Height" | "Appointment Booking" | "multiple_choice" | "file" | 'files' | "signature" | 'ranking' | 'Question Group' | 'Table Input' | "Address" | "Chargebee" | "Stripe" | "Dropdown" | "Database Select" | "Medications" | "Related Contacts" | "Insurance"
 export type FormFieldType = FormFieldLiteralType | FormFieldComplexType
 
 export type PreviousFormFieldType = 'root' | 'after' | 'previousEquals' | 'compoundLogic'
@@ -1458,6 +1463,7 @@ export type TableInputChoices = {
   Text: TableChoiceBuilder<'Text', {}>
   Select: TableChoiceBuilder<'Select', { choices: string[] }>
   Date: TableChoiceBuilder<'Date', { }> // dateString not datetime
+  Database: TableChoiceBuilder<'Database', { databaseId: string, databaseLabel: string }>
 }
 
 export type TableInputChoiceType = keyof TableInputChoices
@@ -1538,6 +1544,8 @@ export type FormFieldOptions = FormFieldValidation & {
   observationDisplay?: string,
   observationUnit?: string,
   autoUploadFiles?: boolean,
+  chargebeeEnvironment?: string,
+  chargebeePlanId?: string,
 }
 export type MultipleChoiceOptions = Pick<FormFieldOptions, 'choices' | 'radio' | 'other'>
 
@@ -1887,6 +1895,7 @@ export type FormResponseAnswerHeight = FormResponseValueAnswerBuilder<'Height',
 export type FormResponseAnswerRedirect = FormResponseValueAnswerBuilder<'Redirect', string>
 export type FormResponseAnswerAllergies = FormResponseValueAnswerBuilder<'Allergies', AllergyResponse[]>
 export type FormResponseAnswerConditions = FormResponseValueAnswerBuilder<'Conditions', ConditionResponse[]>
+export type FormResponseAnswerChargebee = FormResponseValueAnswerBuilder<'Chargebee', { url: string }>
 
 export type FormResponseAnswerSignatureValue = {
   fullName: string,
@@ -1945,6 +1954,7 @@ export type FormResponseValueAnswer = (
   | FormResponseAnswerEmotii
   | FormResponseAnswerAllergies
   | FormResponseAnswerConditions
+  | FormResponseAnswerChargebee
 )
 
 export type FormResponseValue = {
@@ -1988,6 +1998,7 @@ export type AnswerForType = {
   'Related Contacts': FormResponseAnswerRelatedContacts['value']
   'Insurance': FormResponseAnswerInsurance['value']
   'Appointment Booking': FormResponseAnswerAppointmentBooking['value']
+  'Chargebee': FormResponseAnswerChargebee['value']
   'Height': FormResponseAnswerHeight['value']
   'Redirect': FormResponseAnswerRedirect['value']
   'Hidden Value': FormResponseAnswerHiddenValue['value']
@@ -2688,10 +2699,11 @@ export type SendWebhookAutomationAction = AutomationActionBuilder<'sendWebhook',
 export type ShareContentAutomationAction = AutomationActionBuilder<'shareContent', {
   managedContentRecordIds: string[],
 }>
-export type AddEnduserTagsAutomationAction = AutomationActionBuilder<'addEnduserTags', { tags: string[] }>
+export type AddEnduserTagsAutomationAction = AutomationActionBuilder<'addEnduserTags', { tags: string[], replaceExisting?: boolean }>
 export type RemoveEnduserTagsAutomationAction = AutomationActionBuilder<'removeEnduserTags', { tags: string[] }>
 export type AddToJourneyAutomationAction = AutomationActionBuilder<'addToJourney', { journeyId: string }>
 export type RemoveFromJourneyAutomationAction = AutomationActionBuilder<'removeFromJourney', { journeyId: string }>
+export type RemoveFromAllJourneysAutomationAction = AutomationActionBuilder<'removeFromAllJourneys', { }>
 export type IterableSendEmailAutomationAction = AutomationActionBuilder<'iterableSendEmail', { campaignId: string }>
 export type ZendeskCreateTicketAutomationAction = AutomationActionBuilder<'zendeskCreateTicket', { 
   templateId: string,
@@ -2729,6 +2741,12 @@ export type ActiveCampaignAddToListsAutomationAction = AutomationActionBuilder<'
 export type SwitchToRelatedContactAutomationAction = AutomationActionBuilder<'switchToRelatedContact', { type: string, otherTypes?: string[] }>
 export type ElationSyncAutomationAction = AutomationActionBuilder<'elationSync', { }>
 export type CanvasSyncAutomationAction = AutomationActionBuilder<'canvasSync', {}>
+export type DevelopHealthMedicationEligibilityAutomationAction = AutomationActionBuilder<'developHealthMedEligibility', {
+  drugs: DevelopHealthDrug[],
+  diagnoses: DevelopHealthDiagnosis[],
+  providerUserId: string,
+  mock_result?: DevelopHealthMockResult,
+}>
 
 export type IterableFieldsMapping = {
   iterable: string,
@@ -2775,6 +2793,7 @@ export type AutomationActionForType = {
   'removeEnduserTags': RemoveEnduserTagsAutomationAction,
   'addToJourney': AddToJourneyAutomationAction,
   'removeFromJourney': RemoveFromJourneyAutomationAction,
+  removeFromAllJourneys: RemoveFromAllJourneysAutomationAction,
   'iterableSendEmail': IterableSendEmailAutomationAction,
   'iterableCustomEvent': IterableCustomEventAutomationAction,
   'zendeskCreateTicket': ZendeskCreateTicketAutomationAction,
@@ -2795,6 +2814,7 @@ export type AutomationActionForType = {
   'elationSync': ElationSyncAutomationAction,
   canvasSync: CanvasSyncAutomationAction,
   pushFormsToPortal: PushFormsAutomationAction,
+  developHealthMedEligibility: DevelopHealthMedicationEligibilityAutomationAction,
 }
 export type AutomationActionType = keyof AutomationActionForType
 export type AutomationAction = AutomationActionForType[AutomationActionType]
@@ -3305,6 +3325,7 @@ export type AnalyticsQueryFilterForType = {
     }, 
     born?: DateRange,
     tags?: ListOfStringsWithQualifier,
+    entityTypes?: string[],
   },  
   "Calendar Events": {
     userIds?: string[],
@@ -3656,7 +3677,7 @@ export type AutomationTriggerActions = {
   "Add To Journey": AutomationTriggerActionBuilder<'Add To Journey', { journeyId: string, doNotRestart?: boolean }>,
   "Remove From Journey": AutomationTriggerActionBuilder<'Remove From Journey', { journeyId: string }>,
   "Remove From All Journeys": AutomationTriggerActionBuilder<'Remove From All Journeys', { }>,
-  "Add Tags": AutomationTriggerActionBuilder<'Add Tags', { tags: string[] }>,
+  "Add Tags": AutomationTriggerActionBuilder<'Add Tags', { tags: string[], replaceExisting?: boolean }>,
   "Remove Tags": AutomationTriggerActionBuilder<'Remove Tags', { tags: string[] }>,
   "Add Access Tags": AutomationTriggerActionBuilder<'Add Access Tags', { tags: string[] }>,
   "Set Fields": AutomationTriggerActionBuilder<'Set Fields', { fields: EnduserFieldSetter[] }>,
@@ -3672,7 +3693,7 @@ export type AutomationTriggerActions = {
   }>, 
   "Require Form Followups": AutomationTriggerActionBuilder<'Require Form Followups', { 
     formIds: string[],
-  }>, 
+  }>,
 }
 export type AutomationTriggerActionType = keyof AutomationTriggerActions
 export type AutomationTriggerAction = AutomationTriggerActions[AutomationTriggerActionType]
@@ -3746,6 +3767,9 @@ export type AutomationTriggerEvents = {
   }, {}>,
   'Database Entry Added': AutomationTriggerEventBuilder<"Database Entry Added", { databaseId: string }, {}>,
   'Form Started': AutomationTriggerEventBuilder<"Form Started", { formIds?: string[] }, {}>,
+  "Eligibility Result Received": AutomationTriggerActionBuilder<'Eligibility Result Received', { 
+    source: string,
+  }>,
 }
 export type AutomationTriggerEventType = keyof AutomationTriggerEvents
 export type AutomationTriggerEvent = AutomationTriggerEvents[AutomationTriggerEventType]
@@ -3866,6 +3890,7 @@ export type PhoneTreeActions = {
     playback?: Partial<PhonePlayback>,
     duration?: number,
     addToCareTeam?: boolean,
+    dialRecentAgent?: boolean,
   }>
   "Select Care Team Member": PhoneTreeActionBuilder<"Select Care Team Member", { 
     playback?: Partial<PhonePlayback>,
@@ -3876,6 +3901,7 @@ export type PhoneTreeActions = {
     timezone?: Timezone,
     weeklyAvailabilities?: WeeklyAvailability[],
     hasCareTeam?: boolean,
+    hasOneCareTeamMember?: boolean,
   }>
   'Add to Queue': PhoneTreeActionBuilder<"Add to Queue", { queueId: string, playback?: Partial<PhonePlayback>, }>
 }
@@ -3963,7 +3989,7 @@ export interface TicketThreadComment_readonly extends ClientRecord {
   externalId?: string,
   source?: string,
   references?: RelatedRecord[]
-  readBy?: { [index: string] : Date };
+  readBy?: { [index: string] : Date | '' };
   timestamp?: Date,
   group?: string,
 }
@@ -4141,6 +4167,7 @@ export type GroupMMSMessage = {
 export type GroupMMSUserState = {
   id: string,
   numUnread: number,
+  markedUnread?: boolean,
 }
 
 // lots of readonly as we use custom endpoint to create and send messages
@@ -4812,6 +4839,7 @@ export type JourneyContext = {
   emailId?: string,
   databaseRecordId?: string,
   databaseRecordCreator?: string,
+  eligibilityResultId?: string,
 }
 
 // https://gist.github.com/aviflax/a4093965be1cd008f172/ 
@@ -5554,12 +5582,21 @@ export type TwilioQueue = {
   averageWaitTime: number,
 }
 
+export type DevelopHealthDrug = {
+  name: string, 
+  dosage: string,
+  quantity: number,
+}
+export type DevelopHealthMockResult = {
+  status: string, // e.g. "completed",
+  case: string, // e.g. "drugs_covered__prior_auth_required__has_copay"
+}
+export type DevelopHealthDiagnosis = {
+  code: string, // ICD-10
+}
+
 export type DevelopHealthRunBenefitVerificationBaseArguments = {
-  drugs: {
-    name: string, 
-    dosage: string,
-    quantity: number,
-  }[],
+  drugs: DevelopHealthDrug[],
   drug_history: {
     currently_taking_drugs: {
       name: string,
@@ -5568,13 +5605,8 @@ export type DevelopHealthRunBenefitVerificationBaseArguments = {
       name: string,
     }[],
   },
-  diagnoses: {
-    code: string, // ICD-10
-  }[],
-  mock_result?: {
-    status: string, // e.g. "completed",
-    case: string, // e.g. "drugs_covered__prior_auth_required__has_copay"
-  },
+  diagnoses: DevelopHealthDiagnosis[],
+  mock_result?: DevelopHealthMockResult,
   use_patient_plan_fund_source_check?: boolean,
 }