@tellescope/types-models 1.39.4 → 1.40.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/index.ts CHANGED
@@ -199,6 +199,8 @@ export interface Organization extends Organization_readonly, Organization_requir
199
199
  hasConnectedOpenAI?: boolean,
200
200
  hasConnectedHealthie?: boolean,
201
201
  replyToAllEmails?: string,
202
+ forwardAllIncomingEmailsTo?: string,
203
+ numCustomTypes?: number,
202
204
 
203
205
  _groupChatsEnabled?: boolean,
204
206
  _AIEnabled?: boolean,
@@ -446,10 +448,21 @@ export interface Enduser extends Enduser_readonly, Enduser_required, Enduser_upd
446
448
  unsubscribedFromPortalChatNotifications?: boolean,
447
449
  triggeredEvents?: Record<string, number>
448
450
  relationships?: EnduserRelationship[]
451
+ customTypeId?: string,
449
452
  // unsubscribedFromEmail?: boolean,
450
453
  // unsubscribedFromSMS?: boolean,
451
454
  }
452
455
 
456
+ export interface EnduserCustomType_readonly extends ClientRecord {}
457
+ export interface EnduserCustomType_required {
458
+ title: string,
459
+ }
460
+ export interface EnduserCustomType_updatesDisabled {}
461
+ export interface EnduserCustomType extends EnduserCustomType_readonly, EnduserCustomType_required, EnduserCustomType_updatesDisabled {
462
+ builtinFields?: EnduserBuiltInField[];
463
+ customFields?: CustomEnduserField[];
464
+ }
465
+
453
466
  export interface EnduserStatusUpdate_readonly extends ClientRecord {}
454
467
  export interface EnduserStatusUpdate_required {
455
468
  enduserId: string,
@@ -782,7 +795,7 @@ export interface Note extends Note_readonly, Note_required, Note_updatesDisabled
782
795
  }
783
796
 
784
797
  export type FormFieldLiteralType = 'description' | 'string' | 'stringLong' | 'number' | 'email' | 'phone' | 'date' /* date + time */ | 'dateString' | 'rating' | 'Time'
785
- export type FormFieldComplexType = "multiple_choice" | "file" | "signature" | 'ranking' | 'Question Group' | 'Table Input' | "Address" | "Stripe"
798
+ export type FormFieldComplexType = "multiple_choice" | "file" | "signature" | 'ranking' | 'Question Group' | 'Table Input' | "Address" | "Stripe" | "Dropdown"
786
799
  export type FormFieldType = FormFieldLiteralType | FormFieldComplexType
787
800
 
788
801
  export type PreviousFormFieldType = 'root' | 'after' | 'previousEquals'
@@ -865,6 +878,7 @@ export type FormScoring = {
865
878
  export type FormType = 'note' | 'enduserFacing'
866
879
  export type FormCustomization = {
867
880
  publicFormSubmitHTMLDescription?: string,
881
+ publicLabelPrefix?: string,
868
882
  hideProgressBar?: boolean,
869
883
  }
870
884
  export interface Form_readonly extends ClientRecord {
@@ -1029,6 +1043,7 @@ export type FormResponseAnswerSignature = FormResponseValueAnswerBuilder<'signat
1029
1043
 
1030
1044
  export type FormResponseAnswerMultipleChoiceValue = string[]
1031
1045
  export type FormResponseAnswerMultipleChoice = FormResponseValueAnswerBuilder<'multiple_choice', FormResponseAnswerMultipleChoiceValue>
1046
+ export type FormResponseAnswerDropdown = FormResponseValueAnswerBuilder<'Dropdown', FormResponseAnswerMultipleChoiceValue>
1032
1047
  export type FormResponseAnswerRanking = FormResponseValueAnswerBuilder<'ranking', FormResponseAnswerMultipleChoiceValue>
1033
1048
 
1034
1049
  export type FormResponseAnswerFileValue = {
@@ -1057,6 +1072,7 @@ export type FormResponseValueAnswer = (
1057
1072
  | FormResponseAnswerAddress
1058
1073
  | FormResponseAnswerTime
1059
1074
  | FormResponseAnswerStripe
1075
+ | FormResponseAnswerDropdown
1060
1076
  )
1061
1077
 
1062
1078
  export type FormResponseValue = {
@@ -1077,6 +1093,7 @@ export type AnswerForType = {
1077
1093
  'stringLong': FormResponseAnswerStringLong['value'],
1078
1094
  'signature': FormResponseAnswerSignature['value'],
1079
1095
  'multiple_choice': FormResponseAnswerMultipleChoice['value'],
1096
+ 'Dropdown': FormResponseAnswerMultipleChoice['value'],
1080
1097
  'file': FormResponseAnswerFile['value'],
1081
1098
  'date': FormResponseAnswerDate['value'],
1082
1099
  'rating': FormResponseAnswerRating['value'],
@@ -1118,6 +1135,7 @@ export interface FormResponse extends FormResponse_readonly, FormResponse_requir
1118
1135
  }[],
1119
1136
  source?: string,
1120
1137
  pinnedAt?: Date | '',
1138
+ publicIdentifier?: string,
1121
1139
  }
1122
1140
 
1123
1141
  export interface WebHook_readonly extends ClientRecord {}
@@ -1229,6 +1247,7 @@ export interface CalendarEvent extends CalendarEvent_readonly, CalendarEvent_req
1229
1247
  timezone?: Timezone
1230
1248
  copiedFrom?: string,
1231
1249
  sequence?: number,
1250
+ internalNotes?: string,
1232
1251
  // isAllDay?: boolean,
1233
1252
  }
1234
1253
 
@@ -1507,6 +1526,10 @@ export type CreateTicketAssignmentStrategies = {
1507
1526
  type: 'care-team-primary',
1508
1527
  info: {},
1509
1528
  },
1529
+ 'by-tags': {
1530
+ type: 'by-tags',
1531
+ info: ListOfStringsWithQualifier,
1532
+ },
1510
1533
  'default': {
1511
1534
  type: 'default',
1512
1535
  info: {},
@@ -1518,6 +1541,7 @@ export type CreateTicketActionInfo = {
1518
1541
  title: string,
1519
1542
  assignmentStrategy: CreateTicketAssignmentStrategy, // add or options with new types for CreateTicketAssignmentStrategy
1520
1543
  defaultAssignee: string,
1544
+ restrictByState?: boolean,
1521
1545
  closeReasons?: string[],
1522
1546
  forCarePlan?: boolean,
1523
1547
  hiddenFromTickets?: boolean,
@@ -1525,6 +1549,11 @@ export type CreateTicketActionInfo = {
1525
1549
  }
1526
1550
 
1527
1551
  export type SendEmailAutomationAction = AutomationActionBuilder<'sendEmail', AutomationForMessage>
1552
+ export type NotifyTeamAutomationAction = AutomationActionBuilder<'notifyTeam', {
1553
+ templateId: string,
1554
+ forAssigned: boolean,
1555
+ roles?: string[],
1556
+ }>
1528
1557
  export type SendSMSAutomationAction = AutomationActionBuilder<'sendSMS', AutomationForMessage>
1529
1558
  export type SendFormAutomationAction = AutomationActionBuilder<'sendForm', AutomationForFormRequest>
1530
1559
  export type SetEnduserStatusAutomationAction = AutomationActionBuilder<'setEnduserStatus', SetEnduserStatusInfo>
@@ -1561,6 +1590,7 @@ export type AutomationActionForType = {
1561
1590
  'setEnduserStatus': SetEnduserStatusAutomationAction,
1562
1591
  'setEnduserFields': SetEnduserFieldsAutomationAction,
1563
1592
  'shareContent': ShareContentAutomationAction,
1593
+ 'notifyTeam': NotifyTeamAutomationAction,
1564
1594
  }
1565
1595
  export type AutomationActionType = keyof AutomationActionForType
1566
1596
  export type AutomationAction = AutomationActionForType[AutomationActionType]
@@ -1929,6 +1959,9 @@ export type AnalyticsQueryInfoForType = {
1929
1959
  "Purchases": { Total: AnalyticsQueryInfoBuilder<'Total', undefined> },
1930
1960
  "Purchase Credits": { Total: AnalyticsQueryInfoBuilder<'Total', undefined> },
1931
1961
  "Tickets": { Total: AnalyticsQueryInfoBuilder<'Total', undefined> },
1962
+ "Emails": { Total: AnalyticsQueryInfoBuilder<'Total', undefined> },
1963
+ "SMS Messages": { Total: AnalyticsQueryInfoBuilder<'Total', undefined> },
1964
+ "Phone Calls": { Total: AnalyticsQueryInfoBuilder<'Total', undefined> },
1932
1965
  }
1933
1966
  export type AnalyticsQueryInfoType = keyof AnalyticsQueryInfoForType
1934
1967
  export type AnalyticsQueryInfo = AnalyticsQueryInfoForType[AnalyticsQueryInfoType]
@@ -1967,6 +2000,9 @@ export type AnalyticsQueryFilterForType = {
1967
2000
  "Purchases": { },
1968
2001
  "Purchase Credits": { },
1969
2002
  "Tickets": { },
2003
+ "Phone Calls": { },
2004
+ "SMS Messages": { },
2005
+ Emails: { },
1970
2006
  }
1971
2007
 
1972
2008
  export type EnduserGrouping = {
@@ -1994,6 +2030,18 @@ export type AnalyticsQueryGroupingForType = {
1994
2030
  "Tickets": {
1995
2031
  /* by joining on Endusers */
1996
2032
  } & EnduserGrouping,
2033
+ "Phone Calls": {
2034
+ // Cost?: boolean,
2035
+ /* by joining on Endusers */
2036
+ } & EnduserGrouping,
2037
+ "SMS Messages": {
2038
+ // Cost?: boolean,
2039
+ /* by joining on Endusers */
2040
+ } & EnduserGrouping,
2041
+ "Emails": {
2042
+ // Cost?: boolean,
2043
+ /* by joining on Endusers */
2044
+ } & EnduserGrouping,
1997
2045
  }
1998
2046
 
1999
2047
  type DefaultRangeKey = 'Created At' | 'Updated At'
@@ -2004,6 +2052,9 @@ export type AnalyticsQueryRangeKeyForType = {
2004
2052
  "Purchases": DefaultRangeKey,
2005
2053
  "Purchase Credits": DefaultRangeKey,
2006
2054
  "Tickets": DefaultRangeKey,
2055
+ "Phone Calls": DefaultRangeKey,
2056
+ "SMS Messages": DefaultRangeKey,
2057
+ "Emails": DefaultRangeKey,
2007
2058
  }
2008
2059
 
2009
2060
  export type AnalyticsQueryRangeInterval = 'Daily' | 'Weekly' | 'Monthly'
@@ -2062,6 +2113,27 @@ export type AnalyticsQueryForType = {
2062
2113
  AnalyticsQueryGroupingForType['Tickets'],
2063
2114
  AnalyticsQueryRangeKeyForType['Tickets']
2064
2115
  >,
2116
+ "Phone Calls": AnalyticsQueryBuilder<
2117
+ "Phone Calls",
2118
+ AnalyticsQueryInfoForType['Phone Calls'][keyof AnalyticsQueryInfoForType['Phone Calls']],
2119
+ AnalyticsQueryFilterForType['Phone Calls'],
2120
+ AnalyticsQueryGroupingForType['Phone Calls'],
2121
+ AnalyticsQueryRangeKeyForType['Phone Calls']
2122
+ >,
2123
+ "Emails": AnalyticsQueryBuilder<
2124
+ "Emails",
2125
+ AnalyticsQueryInfoForType['Emails'][keyof AnalyticsQueryInfoForType['Emails']],
2126
+ AnalyticsQueryFilterForType['Emails'],
2127
+ AnalyticsQueryGroupingForType['Emails'],
2128
+ AnalyticsQueryRangeKeyForType['Emails']
2129
+ >,
2130
+ "SMS Messages": AnalyticsQueryBuilder<
2131
+ "SMS Messages",
2132
+ AnalyticsQueryInfoForType['SMS Messages'][keyof AnalyticsQueryInfoForType['SMS Messages']],
2133
+ AnalyticsQueryFilterForType['SMS Messages'],
2134
+ AnalyticsQueryGroupingForType['SMS Messages'],
2135
+ AnalyticsQueryRangeKeyForType['SMS Messages']
2136
+ >,
2065
2137
  }
2066
2138
  export type AnalyticsQueryType = keyof AnalyticsQueryForType
2067
2139
  export type AnalyticsQuery = AnalyticsQueryForType[AnalyticsQueryType]
@@ -2073,6 +2145,9 @@ export const resource_to_modelName: { [K in AnalyticsQueryType] : ModelName } =
2073
2145
  Purchases: 'purchases',
2074
2146
  "Purchase Credits": 'purchase_credits',
2075
2147
  Tickets: 'tickets',
2148
+ "Phone Calls": 'phone_calls',
2149
+ "SMS Messages": 'sms_messages',
2150
+ Emails: "emails",
2076
2151
  }
2077
2152
 
2078
2153
  export type AnalyticsQueryOptions = {
@@ -2134,11 +2209,19 @@ export interface EnduserProfileView_required {
2134
2209
  export interface EnduserProfileView_updatesDisabled {}
2135
2210
  export interface EnduserProfileView extends EnduserProfileView_readonly, EnduserProfileView_required, EnduserProfileView_updatesDisabled {}
2136
2211
 
2212
+ export type ListOfStringsWithQualifier = {
2213
+ qualifier: ListQueryQualifier,
2214
+ values: string[],
2215
+ }
2216
+
2137
2217
  export type AutomationTriggerActionBuilder <T, I> = { type: T, info: I }
2138
2218
  export type AutomationTriggerActions = {
2139
2219
  "Add To Journey": AutomationTriggerActionBuilder<'Add To Journey', { journeyId: string }>,
2140
2220
  "Add Tags": AutomationTriggerActionBuilder<'Add Tags', { tags: string[] }>,
2141
2221
  "Move To Step": AutomationTriggerActionBuilder<'Move To Step', { }>, // journeyId and automationStepId stored as part of trigger for better dependency deletion
2222
+ "Assign Care Team": AutomationTriggerActionBuilder<'Assign Care Team', {
2223
+ tags: ListOfStringsWithQualifier
2224
+ }>,
2142
2225
  }
2143
2226
  export type AutomationTriggerActionType = keyof AutomationTriggerActions
2144
2227
  export type AutomationTriggerAction = AutomationTriggerActions[AutomationTriggerActionType]
@@ -2146,7 +2229,7 @@ export type AutomationTriggerAction = AutomationTriggerActions[AutomationTrigger
2146
2229
  export type AutomationTriggerEventBuilder <T, I, C> = { type: T, info: I, conditions?: C }
2147
2230
 
2148
2231
  export type AutomationTriggerEvents = {
2149
- 'Form Submitted': AutomationTriggerEventBuilder<"Form Submitted", { formId: string }, {}>,
2232
+ 'Form Submitted': AutomationTriggerEventBuilder<"Form Submitted", { formId: string, publicIdentifier?: string }, {}>,
2150
2233
  'Form Unsubmitted': AutomationTriggerEventBuilder<"Form Unsubmitted", { formId: string, intervalInMS: number }, {}>,
2151
2234
  'Purchase Made': AutomationTriggerEventBuilder<"Purchase Made", { }, {}>,
2152
2235
  'Appointment No-Showed': AutomationTriggerEventBuilder<"Appointment No-Showed", { }, {}>,
@@ -2301,6 +2384,7 @@ export interface PhoneTree extends PhoneTree_readonly, PhoneTree_required, Phone
2301
2384
  }
2302
2385
 
2303
2386
  export type ModelForName_required = {
2387
+ enduser_custom_types: EnduserCustomType_required,
2304
2388
  phone_trees: PhoneTree_required,
2305
2389
  referral_providers: ReferralProvider_required,
2306
2390
  superbill_providers: SuperbillProvider_required,
@@ -2364,6 +2448,7 @@ export type ModelForName_required = {
2364
2448
  export type ClientModel_required = ModelForName_required[keyof ModelForName_required]
2365
2449
 
2366
2450
  export interface ModelForName_readonly {
2451
+ enduser_custom_types: EnduserCustomType_readonly,
2367
2452
  phone_trees: PhoneTree_readonly,
2368
2453
  enduser_medications: EnduserMedication_readonly,
2369
2454
  referral_providers: ReferralProvider_readonly,
@@ -2427,6 +2512,7 @@ export interface ModelForName_readonly {
2427
2512
  export type ClientModel_readonly = ModelForName_readonly[keyof ModelForName_readonly]
2428
2513
 
2429
2514
  export interface ModelForName_updatesDisabled {
2515
+ enduser_custom_types: EnduserCustomType_updatesDisabled,
2430
2516
  phone_trees: PhoneTree_updatesDisabled,
2431
2517
  enduser_medications: EnduserMedication_updatesDisabled,
2432
2518
  referral_providers: ReferralProvider_updatesDisabled,
@@ -2490,6 +2576,7 @@ export interface ModelForName_updatesDisabled {
2490
2576
  export type ClientModel_updatesDisabled = ModelForName_updatesDisabled[keyof ModelForName_updatesDisabled]
2491
2577
 
2492
2578
  export interface ModelForName extends ModelForName_required, ModelForName_readonly {
2579
+ enduser_custom_types: EnduserCustomType,
2493
2580
  phone_trees: PhoneTree,
2494
2581
  enduser_medications: EnduserMedication,
2495
2582
  referral_providers: ReferralProvider,
@@ -2563,6 +2650,7 @@ export interface UserActivityInfo {
2563
2650
  export type UserActivityStatus = 'Active' | 'Away' | 'Unavailable'
2564
2651
 
2565
2652
  export const modelNameChecker: { [K in ModelName] : true } = {
2653
+ enduser_custom_types: true,
2566
2654
  phone_trees: true,
2567
2655
  referral_providers: true,
2568
2656
  enduser_medications: true,