@tellescope/types-models 1.87.0 → 1.89.0

package/src/index.ts

@@ -227,9 +227,12 @@ export type BasicWebhook = {
 }
 
 export type SyncDirection = "Bidirectional" | "From Tellescope" | "To Tellescope"
-export type FieldSync = {
+export type AthenaFieldSync = {
   field: string,
-  externalField: string,
+  externalField: {
+    id: string,
+    options: { id: string, value: string }[]
+  },
   direction: SyncDirection, 
 }
 
@@ -321,8 +324,9 @@ export interface Organization extends Organization_readonly, Organization_requir
   showCommunity?: boolean,
   phoneLabels?: { number: string, label: string }[];
   mfaxAccountId?: string,
-  athenaFieldsSync?: FieldSync[]
+  athenaFieldsSync?: AthenaFieldSync[]
   athenaSubscriptions?: AthenaSubscription[],
+  athenaDepartmentIds?: string[],
   fieldsToAdminNote?: string[],
   // _AIEnabled?: boolean,
 }
@@ -410,6 +414,7 @@ export interface UserSession extends Session, OrganizationLimits { // User joine
   eat?: boolean, // enableAccessTags
   lockedOutUntil?: number,
   duration?: number,
+  availablePhoneNumbers: string[],
 }
 
 export type StateCredentialInfo = {
@@ -483,6 +488,7 @@ export interface User extends User_required, User_readonly, User_updatesDisabled
   weeklyAvailabilities?: WeeklyAvailability[],
   autoReplyEnabled?: boolean,
   twilioNumber?: string;
+  availableFromNumbers?: string[],
   hashedPass?: string,
   pushNotificationIosTokens?: string[],
   pushNotificationDestinations?: string[],
@@ -1113,6 +1119,7 @@ export type TicketActionBuilder <T, I> = { type: T, info: I, optional?: boolean,
 export type TicketActions = {
   "Complete Form": TicketActionBuilder<'Complete Form', { formId: string, formResponseId?: string }>,
   "Create Prescription": TicketActionBuilder<'Create Prescription', { }>,
+  "Send SMS": TicketActionBuilder<'Send SMS', { templateId: string, smsId?: string }>,
 }
 export type TicketActionType = keyof TicketActions
 export type TicketAction = TicketActions[TicketActionType]
@@ -1185,6 +1192,7 @@ export interface Ticket extends Ticket_readonly, Ticket_required, Ticket_updates
   preserveContext?: boolean,
   phoneCallId?: string,
   calendarEventId?: string,
+  observationId?: string,
 }
 
 export type AttendeeInfo = {
@@ -1303,6 +1311,7 @@ export type FormFieldOptions = FormFieldValidation & {
   },
   useDatePicker?: boolean,
   sharedIntakeFields?: string[],
+  copyResponse?: boolean, // copy to related contacts when created
   disableGoBack?: boolean,
   disableNext?: boolean,
   customPriceMessage?: string,
@@ -1313,6 +1322,7 @@ export type FormFieldOptions = FormFieldValidation & {
 
   requirePredefinedInsurer?: boolean,
   addressFields?: string[], // supports specifying just 'state', for now
+  validStates?: string[],
   autoAdvance?: boolean,
   prefillSignature?: boolean,
 }
@@ -1418,6 +1428,8 @@ export interface Form extends Form_readonly, Form_required, Form_updatesDisabled
   tags?: string[]
   language?: string,
   isNonVisitElationNote?: boolean,
+  canvasId?: string,
+  canvasQuestionId?: string,
 }
 
 
@@ -1647,7 +1659,7 @@ export type FormResponseValue = {
   sharedWithEnduser?: boolean,
   isCalledOut?: boolean,
   isHighlightedOnTimeline?: boolean,
-  computedValueKey?: 'Height' | 'Weight',
+  computedValueKey?: 'Height' | 'Weight' | 'Date of Birth',
 }
 
 export type AnswerForType = {
@@ -1723,6 +1735,7 @@ export interface FormResponse extends FormResponse_readonly, FormResponse_requir
   carePlanId?: string,
   context?: string,
   calendarEventId?: string,
+  copiedFrom?: string,
 }
 
 export interface WebHook_readonly extends ClientRecord {}
@@ -2158,6 +2171,7 @@ export type SetEnduserStatusInfo = { status: string }
 interface AutomationActionBuilder <T extends string, V extends object> {
   type: T,
   info: V,
+  continueOnError?: boolean,
 }
 
 export type AssignToQueueInfo = {
@@ -2666,6 +2680,10 @@ export interface RoleBasedAccessPermission_updatesDisabled {}
 export interface RoleBasedAccessPermission extends RoleBasedAccessPermission_readonly, RoleBasedAccessPermission_required, RoleBasedAccessPermission_updatesDisabled {}
 
 export interface PhoneCall_readonly extends ClientRecord {
+}
+export interface PhoneCall_required {}
+export interface PhoneCall_updatesDisabled {}
+export interface PhoneCall extends PhoneCall_readonly, PhoneCall_required, PhoneCall_updatesDisabled {
   enduserId: string,
   externalId: string,
   from: string,
@@ -2679,10 +2697,6 @@ export interface PhoneCall_readonly extends ClientRecord {
   transcriptionId?: string,
   conferenceId?: string,
   conferenceAttendees?: string[],
-}
-export interface PhoneCall_required {}
-export interface PhoneCall_updatesDisabled {}
-export interface PhoneCall extends PhoneCall_readonly, PhoneCall_required, PhoneCall_updatesDisabled {
   unread?: boolean,
   transcription?: string,
   note?: string,
@@ -2696,6 +2710,7 @@ export interface PhoneCall extends PhoneCall_readonly, PhoneCall_required, Phone
   answeredAt?: Date,
   recordingCancelledAt?: Date,
   assignedTo?: string[],
+  timestamp?: Date,
 }
 
 export type AnalyticsQueryResultValue = {
@@ -2803,7 +2818,7 @@ export type AnalyticsQueryGroupingForType = {
     Cost?: boolean,
   } & EnduserGrouping & { Enduser: string },
   "Purchase Credits": {} & EnduserGrouping & { Enduser: string },
-  "Tickets": {} & EnduserGrouping & { Enduser: string },
+  "Tickets": { Owner: boolean } & EnduserGrouping & { Enduser: string },
   "Phone Calls": {} & EnduserGrouping & { Enduser: string },
   "SMS Messages": { 
     Score?: boolean,
@@ -2817,16 +2832,17 @@ type DefaultRangeKey = 'Created At' | 'Updated At'
 export type AnalyticsQueryRangeKeyForType = {
   "Endusers": DefaultRangeKey,// | 'Last Active At',
   "Calendar Events": DefaultRangeKey,
-  "Form Responses": DefaultRangeKey,
+  "Form Responses": DefaultRangeKey | "Submitted At",
   "Purchases": DefaultRangeKey,
   "Purchase Credits": DefaultRangeKey,
-  "Tickets": DefaultRangeKey,
+  "Tickets": DefaultRangeKey | "Closed At",
   "Phone Calls": DefaultRangeKey,
   "SMS Messages": DefaultRangeKey,
   "Emails": DefaultRangeKey,
   "Medications": DefaultRangeKey,
   "Files": DefaultRangeKey,
 }
+export type RangeKey = DefaultRangeKey | 'Submitted At' | "Closed At"
 
 export type AnalyticsQueryRangeInterval = 'Hourly' | 'Daily' | 'Weekly' | 'Monthly'
 export type AnalyticsQueryRange <R> = {
@@ -3875,6 +3891,7 @@ export type JourneyContext = {
   purchaseId?: string,
   templateId?: string,
   orderId?: string,
+  observationId?: string,
 }
 
 // https://gist.github.com/aviflax/a4093965be1cd008f172/