@tellescope/schema 1.246.2 → 1.248.0

package/src/schema.ts

@@ -275,6 +275,7 @@ import {
   listValidator,
   userCallRoutingBehaviorValidator,
   userUIRestrictionsValidator,
+  userFieldRedactionsValidator,
   externalChatGPTMessagesValidator,
   enduserProfileViewBlocksValidator,
   customDashboardBlocksValidator,
@@ -384,6 +385,7 @@ export const get_next_reminder_timestamp_for_ticket = ({ dueDateInMS, reminders,
 export type RelationshipConstraintOptions<T> = {
   updates?: Partial<T>
   original?: T,
+  replaceObjectFields?: boolean,
 }
 export type RelationshipConstraint<T> = {
   explanation: string; // human readable, for documentation purposes
@@ -994,6 +996,8 @@ export type CustomActions = {
     update_zoom: CustomAction<{ clientId?: string, clientSecret?: string }, { }>,
     proxy_read: CustomAction<{ integration: string, type: string, id?: string, query?: string }, { data: any }>,
     proxy_write: CustomAction<{ integration: string, type: string, id?: string, query?: Record<string, any> }, { data: any }>,
+    load_redacted: CustomAction<{}, { integrations: Integration[] }>,
+    update_settings: CustomAction<{ id: string, updates: Partial<Integration> }, { integration: Integration }>,
   },
   emails: {
     sync_integrations: CustomAction<{ enduserEmail: string, allUsers?: boolean }, { newEmails: Email[] }>,
@@ -1052,11 +1056,12 @@ export type CustomActions = {
     get_enduser_report: CustomAction<{ range?: DateRange, groupBy?: string, countDuplicates?: boolean, templateIds?: string[], enduserGroupBy?: string, enduserFields: Record<string, any> }, { report: Report }>,
     // for getting statuses of events (cancelled, rescheduled, etc.)
     get_status_report: CustomAction<{ range?: DateRange, groupBy?: string }, { report: Report }>,
-    // bulk operations on recurring event series (cancel for attendee, remove attendee, cancel, delete)
+    // bulk operations on recurring event series or a set of specific events
     bulk_update: CustomAction<
       {
-        recurringEventId: string,
-        action: 'cancel_for_attendee' | 'remove_attendee' | 'cancel' | 'delete' | 'uncancel_for_attendee' | 'uncancel',
+        recurringEventId?: string,
+        ids?: string[],
+        action: 'cancel_for_attendee' | 'remove_attendee' | 'cancel' | 'delete' | 'uncancel_for_attendee' | 'uncancel' | 'confirm' | 'no_show' | 'un_no_show',
         scope?: 'this_and_future' | 'all',
         enduserId?: string,
         cancelReason?: string,
@@ -1441,6 +1446,17 @@ export const schema: SchemaV1 = build_schema({
 
             return "Enduser organizationIds can only be updated by users"
           }
+        }, {
+          explanation: 'invalidateSessionsBefore can only be set forward in time, never backwards',
+          evaluate: (_v, _deps, _session, method, { updates, original }) => {
+            if (method === 'create') return
+            if (!updates?.invalidateSessionsBefore) return
+            const orig = original as any
+            if (!orig?.invalidateSessionsBefore) return
+            if (new Date(updates.invalidateSessionsBefore) < new Date(orig.invalidateSessionsBefore)) {
+              return "invalidateSessionsBefore can only be set forward in time"
+            }
+          }
         }
       ],
       access: [ // for non-admins, limit access to endusers the user is assigned to, by default
@@ -1571,6 +1587,7 @@ export const schema: SchemaV1 = build_schema({
         validator: dateValidator,
       },
       lastLogout: { validator: dateValidator },
+      invalidateSessionsBefore: { validator: dateValidator },
       termsSigned: { validator: dateValidator },
       termsVersion: { validator: stringValidator100 },
       lastCommunication: { 
@@ -2506,6 +2523,32 @@ export const schema: SchemaV1 = build_schema({
           next_page_token: { validator: stringValidator }
         },
       },
+      load_redacted: {
+        op: 'custom', access: 'read', method: 'get',
+        path: '/integrations/load-redacted',
+        name: 'Load Redacted Integrations',
+        description: "Loads all integrations for the organization with sensitive fields removed",
+        parameters: {},
+        returns: {
+          integrations: {
+            validator: listValidatorEmptyOk(optionalAnyObjectValidator as any),
+            required: true,
+          },
+        },
+      },
+      update_settings: {
+        op: 'custom', access: 'update', method: 'post',
+        path: '/integrations/update-settings',
+        name: 'Update Integration Settings',
+        description: "Updates non-sensitive integration settings",
+        parameters: {
+          id: { validator: mongoIdStringRequired, required: true },
+          updates: { validator: objectAnyFieldsAnyValuesValidator, required: true },
+        },
+        returns: {
+          integration: { validator: optionalAnyObjectValidator as any, required: true },
+        },
+      },
     }
   },
   engagement_events: {
@@ -4614,6 +4657,7 @@ export const schema: SchemaV1 = build_schema({
       belugaVerificationId: { validator: stringValidator },
       belugaPharmacyMappings: {
         validator: listValidatorOptionalOrEmptyOk(objectValidator<BelugaPharmacyMapping>({
+          title: stringValidatorOptionalEmptyOkay,
           pharmacyId: stringValidator100,
           patientPreference: stringValidator5000,
           conditions: compoundFilterValidator,
@@ -4973,14 +5017,15 @@ export const schema: SchemaV1 = build_schema({
         path: '/form-responses/create-canvasnote',
         description: "Compiles FormResponses and creates a Note in Canvas",
         warnings: ['This returns early as the sync process can take a while for many form responses'],
-        parameters: { 
+        parameters: {
           enduserId: { validator: mongoIdStringValidator, required: true },
           formIds: { validator: listOfMongoIdStringValidator, required: true },
           noteCoding: { validator: canvasCodingValidator, required: true },
-          matchCareTeamTagsForCanvasPractitionerResolution: { 
+          matchCareTeamTagsForCanvasPractitionerResolution: {
             validator: listOfStringsWithQualifierValidator,
             required: true,
           },
+          syncAllFormResponses: { validator: booleanValidatorOptional },
         },
         returns: { },
       },
@@ -5577,10 +5622,11 @@ export const schema: SchemaV1 = build_schema({
         op: "custom", access: 'update', method: "patch",
         name: 'Bulk Update Recurring Events',
         path: '/calendar-events/bulk-update',
-        description: "Performs bulk operations on a recurring event series starting from the given event",
+        description: "Performs bulk operations on a recurring event series starting from the given event, or a set of specific events",
         parameters: {
-          recurringEventId: { validator: mongoIdStringValidator, required: true },
-          action: { validator: exactMatchValidator(['cancel_for_attendee', 'remove_attendee', 'cancel', 'delete', 'uncancel_for_attendee', 'uncancel']), required: true },
+          recurringEventId: { validator: mongoIdStringValidator },
+          ids: { validator: listOfMongoIdStringValidator },
+          action: { validator: exactMatchValidator(['cancel_for_attendee', 'remove_attendee', 'cancel', 'delete', 'uncancel_for_attendee', 'uncancel', 'confirm', 'no_show', 'un_no_show']), required: true },
           scope: { validator: exactMatchValidatorOptional<"this_and_future" | "all">(['this_and_future', 'all']) },
           enduserId: { validator: mongoIdStringValidator },
           cancelReason: { validator: stringValidator5000 },
@@ -6794,6 +6840,58 @@ export const schema: SchemaV1 = build_schema({
             if (!session.isa) return "Not allowed"
           }
         },
+        {
+          explanation: 'Nested list fields in settings must not contain duplicates',
+          evaluate: (updated, lookup, session, type, options) => {
+            if (type !== 'update') return
+            if (!options.updates?.settings) return
+
+            const updateSettings = (options.updates as Partial<Organization>).settings
+            const originalSettings = (options.original as Organization | undefined)?.settings
+            if (!updateSettings) return
+
+            const isReplace = !!options.replaceObjectFields
+
+            const checkStringArray = (newArr: string[] | undefined, oldArr: string[] | undefined, label: string) => {
+              if (!newArr) return
+              const hasDupesWithin = newArr.length !== new Set(newArr).size
+              if (isReplace) {
+                // Only reject if replacement has internal dupes AND grows the array
+                if (hasDupesWithin && newArr.length > (oldArr || []).length) return `Duplicate value in ${label}`
+              } else {
+                // Merge: reject if new values have internal dupes or overlap with existing
+                if (hasDupesWithin) return `Duplicate value in ${label}`
+                if (oldArr) {
+                  const oldSet = new Set(oldArr)
+                  if (newArr.some(v => oldSet.has(v))) return `Duplicate value in ${label}`
+                }
+              }
+            }
+
+            const checkObjectArray = (newArr: { [k: string]: any }[] | undefined, oldArr: { [k: string]: any }[] | undefined, key: string, label: string) => {
+              if (!newArr) return
+              const newValues = newArr.map(item => item[key])
+              const hasDupesWithin = newValues.length !== new Set(newValues).size
+              if (isReplace) {
+                if (hasDupesWithin && newArr.length > (oldArr || []).length) return `Duplicate ${key} in ${label}`
+              } else {
+                if (hasDupesWithin) return `Duplicate ${key} in ${label}`
+                if (oldArr) {
+                  const oldKeys = new Set(oldArr.map(item => item[key]))
+                  if (newValues.some(v => oldKeys.has(v))) return `Duplicate ${key} in ${label}`
+                }
+              }
+            }
+
+            return (
+              checkObjectArray(updateSettings.endusers?.customFields, originalSettings?.endusers?.customFields, 'field', 'settings.endusers.customFields')
+              || checkObjectArray(updateSettings.endusers?.builtinFields, originalSettings?.endusers?.builtinFields, 'field', 'settings.endusers.builtinFields')
+              || checkStringArray(updateSettings.endusers?.tags, originalSettings?.endusers?.tags, 'settings.endusers.tags')
+              || checkStringArray(updateSettings.endusers?.dontRecordCallsToPhone, originalSettings?.endusers?.dontRecordCallsToPhone, 'settings.endusers.dontRecordCallsToPhone')
+              || checkStringArray(updateSettings.calendar?.cancelReasons, originalSettings?.calendar?.cancelReasons, 'settings.calendar.cancelReasons')
+            )
+          }
+        },
       ],
     },
     defaultActions: { read: { }, readMany: { }, update: { }, 
@@ -7009,6 +7107,8 @@ export const schema: SchemaV1 = build_schema({
           number: stringValidator100,
         }))
       },
+      faxCoverPageEnabled: { validator: booleanValidator },
+      faxCoverPageId: { validator: stringValidator250 },
       athenaFieldsSync: { validator: fieldsSyncValidator },
       athenaDepartments: { 
         validator: listValidatorOptionalOrEmptyOk(objectValidator<{ id: string, timezone: Timezone }>({
@@ -7307,6 +7407,7 @@ export const schema: SchemaV1 = build_schema({
         ]
       },
       uiRestrictions: { validator: userUIRestrictionsValidator },
+      fieldRedactions: { validator: userFieldRedactionsValidator },
     }
   },
   appointment_booking_pages: {
@@ -7375,8 +7476,9 @@ export const schema: SchemaV1 = build_schema({
       backgroundColor: { validator: stringValidator100 },
       primaryColor: { validator: stringValidator100 },
       secondaryColor: { validator: stringValidator100 },
-      intakeTitle: { validator: stringValidator1000 }, 
-      intakeDescription: { validator: stringValidator1000 }, 
+      intakeTitle: { validator: stringValidator1000 },
+      intakeDescription: { validator: stringValidator1000 },
+      portalDescription: { validator: stringValidator1000 },
       thankYouRedirectURL: { validator: stringValidator1000 },
       thankYouTitle: { validator: stringValidator1000 },
       thankYouDescription: { validator: stringValidator1000 }, 
@@ -8509,6 +8611,9 @@ If a voicemail is left, it is indicated by recordingURI, transcription, or recor
       },
       customFields: {
         validator: customEnduserFieldsValidatorOptionalOrEmpty,
+      },
+      createEnduserForms: {
+        validator: listOfMongoIdStringValidatorOptionalOrEmptyOk,
       }
     }
   },
@@ -9103,6 +9208,7 @@ If a voicemail is left, it is indicated by recordingURI, transcription, or recor
       cancellationReason: { validator: stringValidatorOptional },
       medication: { validator: stringValidatorOptional },
       medicationSku: { validator: stringValidatorOptional },
+      protocol: { validator: stringValidator1000 },
     }
   },
   vital_configurations: {