@tellescope/types-models 1.71.4 → 1.72.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
@@ -251,8 +251,10 @@ export interface Organization extends Organization_readonly, Organization_requir
251
251
  hasConnectedIterable?: boolean,
252
252
  hasConnectedZendesk?: boolean,
253
253
  hasConnectedZus?: boolean,
254
+ hasConnectedCanvas?: boolean,
254
255
  hasTicketQueues?: boolean,
255
256
  vitalTeamId?: string,
257
+ altVitalTeamIds?: { teamId: string, label: string }[],
256
258
  zendeskSettings?: { priorityGroups?: string[], resolutionFieldId?: string, resolutionFieldOptions?: string[] }
257
259
  replyToAllEmails?: string,
258
260
  forwardAllIncomingEmailsTo?: string,
@@ -473,7 +475,7 @@ export type ScheduledJourney = {
473
475
  }
474
476
 
475
477
  export type EnduserRelationship = {
476
- type: 'Parent' | 'Child' | 'Spouse' | 'Sibling' | 'Relates To' | 'Grandparent' | 'Grandchild' | 'Caregiver' | 'Caretaker' | 'Care Recipient'
478
+ type: 'Parent' | 'Child' | 'Spouse' | 'Partner' | 'Sibling' | 'Relates To' | 'Grandparent' | 'Grandchild' | 'Caregiver' | 'Caretaker' | 'Care Recipient'
477
479
  id: string,
478
480
  }
479
481
  export type Language = {
@@ -481,6 +483,53 @@ export type Language = {
481
483
  iso6391: string,
482
484
  }
483
485
 
486
+
487
+ export type InsuranceRelationship = (
488
+ "Spouse" |
489
+ "Grandfather or Grandmother" |
490
+ "Grandson or Grandaughter" |
491
+ "Nephew or Niece" |
492
+ "Foster Child" |
493
+ "Ward of the Court" |
494
+ "Stepson or Stepdaughter" |
495
+ "Self" |
496
+ "Child" |
497
+ "Employee" |
498
+ "Unknown" |
499
+ "Handicapped/Dependent" |
500
+ "Sponsored Dependent" |
501
+ "Dependent of Minor Dependent" |
502
+ "Significant Other" |
503
+ "Mother" |
504
+ "Father" |
505
+ "Emancipated Minor" |
506
+ "Organ Donor" |
507
+ "Cadaver Donor" |
508
+ "Injured Plaintiff" |
509
+ "Child Where Insured Has No Financial Responsibility" |
510
+ "Life Partner" |
511
+ "Other Relationship"
512
+ )
513
+
514
+ export type EnduserInsurance = {
515
+ memberId?: string,
516
+ payerId?: string,
517
+ payerName?: string,
518
+ cardFront?: string,
519
+ cardBack?: string,
520
+ eligible?: boolean,
521
+ eligibilityRanAt?: Date,
522
+ canvasId?: string,
523
+ relationship?: InsuranceRelationship,
524
+ relationshipDetails?: {
525
+ fname?: string,
526
+ lname?: string,
527
+ phone?: string,
528
+ email?: string,
529
+ address?: Partial<Address>,
530
+ }
531
+ }
532
+
484
533
  export type TellescopeGender = "Male" | "Female" | "Other" | "Unknown"
485
534
  export interface Enduser_readonly extends UserActivityInfo, ClientRecord, EnduserEngagementTimestamps {
486
535
  lastCommunication?: Date;
@@ -553,6 +602,7 @@ export interface Enduser extends Enduser_readonly, Enduser_required, Enduser_upd
553
602
  lastZendeskSyncAt?: Date,
554
603
  accessTags?: string[],
555
604
  unsubscribedFromMarketing?: boolean,
605
+ insurance?: EnduserInsurance,
556
606
  // unsubscribedFromEmail?: boolean,
557
607
  // unsubscribedFromSMS?: boolean,
558
608
  }
@@ -1085,7 +1135,7 @@ export interface Note extends Note_readonly, Note_required, Note_updatesDisabled
1085
1135
  }
1086
1136
 
1087
1137
  export type FormFieldLiteralType = 'description' | 'string' | 'stringLong' | 'number' | 'email' | 'phone' | 'date' /* date + time */ | 'dateString' | 'rating' | 'Time'
1088
- export type FormFieldComplexType = "multiple_choice" | "file" | 'files' | "signature" | 'ranking' | 'Question Group' | 'Table Input' | "Address" | "Stripe" | "Dropdown" | "Database Select" | "Medications" | "Related Contacts"
1138
+ export type FormFieldComplexType = "multiple_choice" | "file" | 'files' | "signature" | 'ranking' | 'Question Group' | 'Table Input' | "Address" | "Stripe" | "Dropdown" | "Database Select" | "Medications" | "Related Contacts" | "Insurance"
1089
1139
  export type FormFieldType = FormFieldLiteralType | FormFieldComplexType
1090
1140
 
1091
1141
  export type PreviousFormFieldType = 'root' | 'after' | 'previousEquals' | 'compoundLogic'
@@ -1405,6 +1455,7 @@ export type FormResponseAnswerStripe = FormResponseValueAnswerBuilder<'Stripe',
1405
1455
  export type FormResponseAnswerDatabaseSelect = FormResponseValueAnswerBuilder<'Database Select', DatabaseSelectResponse[]>
1406
1456
  export type FormResponseAnswerMedications = FormResponseValueAnswerBuilder<'Medications', MedicationResponse[]>
1407
1457
  export type FormResponseAnswerRelatedContacts = FormResponseValueAnswerBuilder<'Related Contacts', Partial<Enduser>[]>
1458
+ export type FormResponseAnswerInsurance = FormResponseValueAnswerBuilder<'Insurance', Partial<EnduserInsurance>>
1408
1459
 
1409
1460
  export type FormResponseAnswerSignatureValue = {
1410
1461
  fullName: string,
@@ -1452,6 +1503,7 @@ export type FormResponseValueAnswer = (
1452
1503
  | FormResponseAnswerDatabaseSelect
1453
1504
  | FormResponseAnswerMedications
1454
1505
  | FormResponseAnswerRelatedContacts
1506
+ | FormResponseAnswerInsurance
1455
1507
  )
1456
1508
 
1457
1509
  export type FormResponseValue = {
@@ -1489,6 +1541,7 @@ export type AnswerForType = {
1489
1541
  'Database Select': FormResponseAnswerDatabaseSelect['value']
1490
1542
  'Medications': FormResponseAnswerMedications['value']
1491
1543
  'Related Contacts': FormResponseAnswerRelatedContacts['value']
1544
+ 'Insurance': FormResponseAnswerInsurance['value']
1492
1545
  }
1493
1546
 
1494
1547
  export interface FormResponse_readonly extends ClientRecord {
@@ -2415,6 +2468,8 @@ export interface PhoneCall_readonly extends ClientRecord {
2415
2468
  recordingId?: string,
2416
2469
  recordingDurationInSeconds?: number,
2417
2470
  transcriptionId?: string,
2471
+ conferenceId?: string,
2472
+ conferenceAttendees?: string[],
2418
2473
  }
2419
2474
  export interface PhoneCall_required {}
2420
2475
  export interface PhoneCall_updatesDisabled {}
@@ -2458,6 +2513,7 @@ export type AnalyticsQueryInfoForType = {
2458
2513
  "Tickets": { Total: AnalyticsQueryInfoBuilder<'Total', undefined> },
2459
2514
  "Emails": { Total: AnalyticsQueryInfoBuilder<'Total', undefined> },
2460
2515
  "SMS Messages": { Total: AnalyticsQueryInfoBuilder<'Total', undefined> },
2516
+ "Medications": { Total: AnalyticsQueryInfoBuilder<'Total', undefined> },
2461
2517
  "Phone Calls": {
2462
2518
  Total: AnalyticsQueryInfoBuilder<'Total', undefined>,
2463
2519
  Duration: AnalyticsQueryInfoBuilder<'Duration', undefined>,
@@ -2504,6 +2560,7 @@ export type AnalyticsQueryFilterForType = {
2504
2560
  "Phone Calls": { },
2505
2561
  "SMS Messages": { },
2506
2562
  Emails: { },
2563
+ Medications: { },
2507
2564
  }
2508
2565
 
2509
2566
  export type EnduserGrouping = {
@@ -2520,6 +2577,7 @@ export type AnalyticsQueryGroupingForType = {
2520
2577
  Type: boolean,
2521
2578
  },
2522
2579
  "Form Responses": {
2580
+ "Public Identifier"?: boolean,
2523
2581
  /* by joining on Endusers */
2524
2582
  } & EnduserGrouping & { Enduser: string },
2525
2583
  "Purchases": {
@@ -2537,13 +2595,17 @@ export type AnalyticsQueryGroupingForType = {
2537
2595
  /* by joining on Endusers */
2538
2596
  } & EnduserGrouping & { Enduser: string },
2539
2597
  "SMS Messages": {
2540
- // Cost?: boolean,
2598
+ Score?: boolean,
2541
2599
  /* by joining on Endusers */
2542
2600
  } & EnduserGrouping & { Enduser: string },
2543
2601
  "Emails": {
2544
2602
  // Cost?: boolean,
2545
2603
  /* by joining on Endusers */
2546
2604
  } & EnduserGrouping & { Enduser: string },
2605
+ "Medications": {
2606
+ // Cost?: boolean,
2607
+ /* by joining on Endusers */
2608
+ } & EnduserGrouping & { Enduser: string },
2547
2609
  }
2548
2610
 
2549
2611
  type DefaultRangeKey = 'Created At' | 'Updated At'
@@ -2557,6 +2619,7 @@ export type AnalyticsQueryRangeKeyForType = {
2557
2619
  "Phone Calls": DefaultRangeKey,
2558
2620
  "SMS Messages": DefaultRangeKey,
2559
2621
  "Emails": DefaultRangeKey,
2622
+ "Medications": DefaultRangeKey,
2560
2623
  }
2561
2624
 
2562
2625
  export type AnalyticsQueryRangeInterval = 'Daily' | 'Weekly' | 'Monthly'
@@ -2636,6 +2699,13 @@ export type AnalyticsQueryForType = {
2636
2699
  AnalyticsQueryGroupingForType['SMS Messages'],
2637
2700
  AnalyticsQueryRangeKeyForType['SMS Messages']
2638
2701
  >,
2702
+ "Medications": AnalyticsQueryBuilder<
2703
+ "Medications",
2704
+ AnalyticsQueryInfoForType['Medications'][keyof AnalyticsQueryInfoForType['Medications']],
2705
+ AnalyticsQueryFilterForType['Medications'],
2706
+ AnalyticsQueryGroupingForType['Medications'],
2707
+ AnalyticsQueryRangeKeyForType['Medications']
2708
+ >,
2639
2709
  }
2640
2710
  export type AnalyticsQueryType = keyof AnalyticsQueryForType
2641
2711
  export type AnalyticsQuery = AnalyticsQueryForType[AnalyticsQueryType]
@@ -2650,6 +2720,7 @@ export const resource_to_modelName: { [K in AnalyticsQueryType] : ModelName } =
2650
2720
  "Phone Calls": 'phone_calls',
2651
2721
  "SMS Messages": 'sms_messages',
2652
2722
  Emails: "emails",
2723
+ Medications: "enduser_medications",
2653
2724
  }
2654
2725
 
2655
2726
  export type AnalyticsQueryOptions = {
@@ -3022,9 +3093,29 @@ export interface TicketQueue_required {
3022
3093
  title: string,
3023
3094
  userIds: string[]
3024
3095
  }
3025
- export interface TicketQueue extends TicketQueue_readonly, TicketQueue_required, TicketQueue_updatesDisabled {
3096
+ export interface TicketQueue extends TicketQueue_readonly, TicketQueue_required, TicketQueue_updatesDisabled {}
3097
+
3098
+ export interface EnduserOrder_readonly extends ClientRecord {}
3099
+ export interface EnduserOrder_updatesDisabled {}
3100
+ export interface EnduserOrder_required {}
3101
+ export interface EnduserOrder extends EnduserOrder_readonly, EnduserOrder_required, EnduserOrder_updatesDisabled {
3102
+ externalId: string,
3103
+ source: string,
3104
+ title: string,
3105
+ status: string,
3106
+ enduserId: string,
3107
+ userId?: string,
3108
+ }
3026
3109
 
3110
+ export interface TicketQueue_readonly extends ClientRecord {
3111
+ count?: number,
3112
+ }
3113
+ export interface TicketQueue_updatesDisabled {}
3114
+ export interface TicketQueue_required {
3115
+ title: string,
3116
+ userIds: string[]
3027
3117
  }
3118
+ export interface TicketQueue extends TicketQueue_readonly, TicketQueue_required, TicketQueue_updatesDisabled {}
3028
3119
 
3029
3120
  export type ImageAttachment = {
3030
3121
  url: string,
@@ -3063,6 +3154,7 @@ export interface GroupMMSConversation extends GroupMMSConversation_readonly, Gro
3063
3154
  }
3064
3155
 
3065
3156
  export type ModelForName_required = {
3157
+ enduser_orders: EnduserOrder_required,
3066
3158
  group_mms_conversations: GroupMMSConversation_required,
3067
3159
  ticket_queues: TicketQueue_required,
3068
3160
  ticket_threads: TicketThread_required,
@@ -3134,6 +3226,7 @@ export type ModelForName_required = {
3134
3226
  export type ClientModel_required = ModelForName_required[keyof ModelForName_required]
3135
3227
 
3136
3228
  export interface ModelForName_readonly {
3229
+ enduser_orders: EnduserOrder_readonly,
3137
3230
  group_mms_conversations: GroupMMSConversation_readonly,
3138
3231
  ticket_queues: TicketQueue_readonly,
3139
3232
  configurations: Configuration_readonly,
@@ -3205,6 +3298,7 @@ export interface ModelForName_readonly {
3205
3298
  export type ClientModel_readonly = ModelForName_readonly[keyof ModelForName_readonly]
3206
3299
 
3207
3300
  export interface ModelForName_updatesDisabled {
3301
+ enduser_orders: EnduserOrder_updatesDisabled,
3208
3302
  group_mms_conversations: GroupMMSConversation_updatesDisabled,
3209
3303
  ticket_queues: TicketQueue_updatesDisabled,
3210
3304
  configurations: Configuration_updatesDisabled,
@@ -3276,6 +3370,7 @@ export interface ModelForName_updatesDisabled {
3276
3370
  export type ClientModel_updatesDisabled = ModelForName_updatesDisabled[keyof ModelForName_updatesDisabled]
3277
3371
 
3278
3372
  export interface ModelForName extends ModelForName_required, ModelForName_readonly {
3373
+ enduser_orders: EnduserOrder,
3279
3374
  group_mms_conversations: GroupMMSConversation,
3280
3375
  ticket_queues: TicketQueue,
3281
3376
  configurations: Configuration,
@@ -3357,6 +3452,7 @@ export interface UserActivityInfo {
3357
3452
  export type UserActivityStatus = 'Active' | 'Away' | 'Unavailable'
3358
3453
 
3359
3454
  export const modelNameChecker: { [K in ModelName] : true } = {
3455
+ enduser_orders: true,
3360
3456
  group_mms_conversations: true,
3361
3457
  ticket_queues: true,
3362
3458
  configurations: true,