@tellescope/schema 1.3.46 → 1.4.0

package/src/schema.ts

@@ -31,6 +31,7 @@ import {
   MeetingInfo,
   PreviousFormField,
   OrganizationTheme,
+  AvailabilityBlock,
 } from "@tellescope/types-models"
 
 import {
@@ -128,6 +129,15 @@ import {
   databaseFieldsValidator,
   databaseRecordValuesValidator,
   automationEventsValidator,
+  portalPageValidator,
+  portalBlocksValidator,
+  enduserFormResponsesForEventValidator,
+  enduserTasksForEventValidator,
+  stateCredentialsValidator,
+  stateValidator,
+  availabilityBlocksValidator,
+  weeklyAvailabilitiesValidator,
+  timezoneValidator,
 } from "@tellescope/validation"
 
 import {
@@ -137,6 +147,7 @@ import {
   ENDUSER_SESSION_TYPE,
   USER_SESSION_TYPE,
 } from "@tellescope/constants"
+import { response } from "express"
 
 export type RelationshipConstraint<T> = {
   explanation: string; // human readable, for documentation purposes
@@ -345,7 +356,9 @@ export type CustomActions = {
     file_download_URL: CustomAction<{ secureName: string }, { downloadURL: string }>,
   },
   form_responses: {
-    prepare_form_response: CustomAction<{ formId: string, enduserId: string, automationStepId?: string }, { accessCode: string, url: string }>,
+    prepare_form_response: CustomAction<{ formId: string, enduserId: string, automationStepId?: string, expireAt?: Date }, 
+      { accessCode: string, url: string, response: FormResponse,  }>
+    ,
     submit_form_response: CustomAction<{ accessCode: string, responses: FormResponseValue[], automationStepId?: string  }, { formResponse: FormResponse }>,
     info_for_access_code: CustomAction<{ accessCode: string }, {
       form: Form, 
@@ -417,7 +430,17 @@ export type CustomActions = {
     sync_integrations: CustomAction<{ enduserEmail: string }, { newEmails: Email[] }>, 
   },
   calendar_events: {
-    get_external_events_for_user: CustomAction<{ userId: string, from: Date, limit?: number }, { events: CalendarEvent[] }>, 
+    get_events_for_user: CustomAction<{ userId: string, from: Date, to?: Date, limit?: number }, { events: CalendarEvent[] }>, 
+    get_appointment_availability: CustomAction<{ 
+      from: Date, calendarEventTemplateId: string, to?: Date, restrictedByState?: boolean, limit?: number,
+    }, { 
+      availabilityBlocks: AvailabilityBlock[],
+    }>,
+    book_appointment: CustomAction<{ 
+      userId: string, startTime: Date, calendarEventTemplateId: string,
+    }, { 
+      createdEvent: CalendarEvent,
+    }>,
   },
 } 
 
@@ -605,6 +628,7 @@ export const schema: SchemaV1 = build_schema({
           },
         ]
       },
+      state: { validator: stateValidator },
       // recentMessagePreview: { 
       //   validator: stringValidator,
       // },
@@ -1469,7 +1493,7 @@ export const schema: SchemaV1 = build_schema({
       }],
     },
     defaultActions: { 
-      create: { adminOnly: true }, delete: { adminOnly: true },
+      create: { adminOnly: true }, createMany: { adminOnly: true }, delete: { adminOnly: true },
       read: {}, readMany: {}, update: { description: "Users can only be updated by self or an organization admin"} 
     },
     enduserActions: { display_info: {}, read: {}, readMany: {} },
@@ -1567,6 +1591,7 @@ export const schema: SchemaV1 = build_schema({
       lname: {
         validator: nameValidator,
       },
+      suffixes: { validator: listOfStringsValidatorEmptyOk },
       organization: {
         validator: mongoIdStringValidator,
         updatesDisabled: true,
@@ -1611,6 +1636,11 @@ export const schema: SchemaV1 = build_schema({
           },
         ]
       },
+      credentialedStates: {
+        validator: stateCredentialsValidator,
+      },
+      timezone: { validator: timezoneValidator },
+      weeklyAvailabilities: { validator: weeklyAvailabilitiesValidator },
     }
   },
   templates: {
@@ -2125,10 +2155,12 @@ export const schema: SchemaV1 = build_schema({
           formId: { validator: mongoIdStringValidator, required: true },
           enduserId: { validator: mongoIdStringValidator, required: true },
           automationStepId: { validator: mongoIdStringValidator },
+          expireAt: { validator: dateValidator },
         },
         returns: {
           accessCode: { validator: stringValidator250, required: true },
           url: { validator: stringValidator250, required: true },
+          response: { validator: 'form_response' as any, required: true }
         },
       },
       submit_form_response: {
@@ -2312,22 +2344,53 @@ export const schema: SchemaV1 = build_schema({
     },
     defaultActions: DEFAULT_OPERATIONS,
     customActions: {
-      get_external_events_for_user: {
+      get_events_for_user: {
         op: "custom", access: 'read', method: "get",
-        name: 'Get External Events for User',
-        path: '/external-events-for-user',
-        description: "Gets events from external calendars, formatted as a Tellescope event",
+        name: 'Get Events for User (Including Integrations)',
+        path: '/events-for-user',
+        description: "Combines internal and external events, formatted as a Tellescope events",
         parameters: { 
           userId: { validator: mongoIdStringValidator, required: true },
           from: { validator: dateValidator, required: true },
+          to: { validator: dateValidator },
           limit: { validator: nonNegNumberValidator },
         },
         returns: { 
           events: { validator: 'calendar_events' as any }
         },
       },
+      get_appointment_availability: {
+        op: "custom", access: 'read', method: "get",
+        name: 'Get Appointment Availability for a Calendar Event Type',
+        path: '/calendar-availability',
+        description: "Gets availability blocks for different users based on their internal and external calendars",
+        parameters: {  
+          calendarEventTemplateId: { validator: mongoIdStringValidator, required: true },
+          from: { validator: dateValidator, required: true },
+          restrictedByState: { validator: booleanValidator },
+          to: { validator: dateValidator },
+          limit: { validator: nonNegNumberValidator },
+        },
+        returns: { 
+          availabilityBlocks: { validator: availabilityBlocksValidator }
+        },
+      },
+      book_appointment: {
+        op: "custom", access: 'create', method: "post",
+        name: 'Book Appointment',
+        path: '/book-appointment',
+        description: "Books an appointment with a given user if available",
+        parameters: {  
+          calendarEventTemplateId: { validator: mongoIdStringValidator, required: true }, 
+          userId: { validator: mongoIdStringValidator, required: true },
+          startTime: { validator: dateValidator, required: true },
+        },
+        returns: { 
+          createdEvent: { validator: 'calenar_event' as any },
+        },
+      },
     },
-    enduserActions: { read: {}, readMany: {} },
+    enduserActions: { read: {}, readMany: {}, get_appointment_availability: {}, book_appointment: {} },
     fields: {
       ...BuiltInFields, 
       title: {
@@ -2358,6 +2421,15 @@ export const schema: SchemaV1 = build_schema({
           onDependencyDelete: 'setNull',
         }]
       },
+      carePlanId: { 
+        validator: mongoIdStringValidator,
+        dependencies: [{
+          dependsOn: ['care_plans'],
+          dependencyField: '_id',
+          relationship: 'foreignKey',
+          onDependencyDelete: 'setNull',
+        }]
+      },
       attendees: { 
         validator: listOfUserIndentitiesValidator,
         initializer: () => [],
@@ -2372,7 +2444,7 @@ export const schema: SchemaV1 = build_schema({
           dependsOn: ['calendar_event_templates'],
           dependencyField: '_id',
           relationship: 'foreignKey',
-          onDependencyDelete: 'delete',
+          onDependencyDelete: 'nop',
         }]
       }, 
       publicRead: { validator: booleanValidator }, 
@@ -2380,6 +2452,11 @@ export const schema: SchemaV1 = build_schema({
       fields: { validator: fieldsValidator }, 
       numRSVPs: { validator: nonNegNumberValidator },
       image: { validator: stringValidator5000 },
+      sharedContentIds: { validator: listOfMongoIdStringValidatorEmptyOk },
+      enduserFormResponses: { validator: enduserFormResponsesForEventValidator },
+      enduserTasks: { validator: enduserTasksForEventValidator },
+      location: { validator: stringValidator1000 },
+      phone: { validator: stringValidator100 }, // leave more generous than phone validator in favor of lower friction
     }
   },
   calendar_event_templates: {
@@ -2455,25 +2532,6 @@ export const schema: SchemaV1 = build_schema({
       }
     }
   },
-  sequence_automations: {
-    info: {},
-    constraints: {
-      unique: [], 
-      relationship: [],
-      access: []
-    },
-    defaultActions: DEFAULT_OPERATIONS,
-    customActions: { },
-    enduserActions: { },
-    fields: {
-      ...BuiltInFields, 
-      title: {
-        validator: stringValidator250,
-        required: true,
-        examples: ['Automation Title']
-      }
-    }
-  }, 
   automation_steps: {
     info: {},
     constraints: {
@@ -2757,6 +2815,9 @@ export const schema: SchemaV1 = build_schema({
         required: true,
         examples: ["Template Name"],
       },
+      category: {
+        validator: stringValidator100,
+      },
       description: {
         validator: stringValidator5000,
         examples: ["Template Subject"],
@@ -3180,6 +3241,118 @@ export const schema: SchemaV1 = build_schema({
       },
     },
   }, 
+  portal_customizations: {
+    info: {},
+    constraints: {
+      unique: [
+        'page' // prevents duplicate customizations for the same page (may need to combine with a version number / draft status later to allow drafting)
+      ], 
+      relationship: [
+        {
+          explanation: 'One of email or phone is required',
+          evaluate: ({ page, disabled  }) => {
+            if (page === 'Home' && disabled)
+              return 'Home page cannot be disabled'
+            } 
+        },
+      ],
+      access: []
+    },
+    defaultActions: DEFAULT_OPERATIONS,
+    customActions: { },
+    enduserActions: { readMany: {} },
+    fields: {
+      ...BuiltInFields, 
+      title: {
+        validator: stringValidator1000,
+        examples: ['Example Title']
+      },
+      page: {
+        validator: portalPageValidator,
+        required: true,
+        examples: ['Home']
+      },
+      blocks: {
+        required: true,
+        examples: [[]],
+        validator: portalBlocksValidator,
+      },
+      disabled: { validator: booleanValidator },
+      mobileBottomNavigationPosition: { validator: nonNegNumberValidator },
+    },
+  }, 
+  enduser_tasks: {
+    info: {},
+    constraints: {
+      unique: [
+        ['enduserId', 'title']
+      ], 
+      relationship: [],
+      access: []
+    },
+    defaultActions: DEFAULT_OPERATIONS,
+    customActions: { },
+    enduserActions: { update: {}, read: {}, readMany: {} },
+    fields: {
+      ...BuiltInFields, 
+      title: {
+        validator: stringValidator1000,
+        required: true,
+        examples: ['Example Title']
+      },
+      enduserId: { 
+        validator: mongoIdStringValidator,
+        examples: [PLACEHOLDER_ID],
+        required: true,
+        dependencies: [{
+          dependsOn: ['endusers'],
+          dependencyField: '_id',
+          relationship: 'foreignKey',
+          onDependencyDelete: 'delete',
+        }]
+      },
+      completedAt: { validator: dateValidator },
+      description: { validator: stringValidator1000 },
+    },
+  },
+  care_plans: {
+    info: {},
+    constraints: {
+      unique: [
+        ['enduserId', 'title']
+      ], 
+      relationship: [],
+      access: []
+    },
+    defaultActions: DEFAULT_OPERATIONS,
+    customActions: { },
+    enduserActions: { read: {}, readMany: {} },
+    fields: {
+      ...BuiltInFields, 
+      title: {
+        validator: stringValidator1000,
+        required: true,
+        examples: ['Example Title']
+      },
+      enduserId: { 
+        validator: mongoIdStringValidator,
+        examples: [PLACEHOLDER_ID],
+        required: true,
+        dependencies: [{
+          dependsOn: ['endusers'],
+          dependencyField: '_id',
+          relationship: 'foreignKey',
+          onDependencyDelete: 'delete',
+        }]
+      },
+      description: {
+        validator: stringValidator1000,
+      },
+      eventIds: {
+        validator: listOfMongoIdStringValidatorEmptyOk,
+      }
+    },
+  }, 
 })
 
 // export type SchemaType = typeof schema