@tellescope/schema 1.247.0 → 1.249.0

package/src/schema.ts

@@ -74,6 +74,8 @@ import {
   Addendum,
   GroupCancellation,
   FormResponseFollowup,
+  FormResponseProcedureCode,
+  FormResponseDiagnosisCode,
   DevelopHealthRunBenefitVerificationBaseArguments,
   WeeklyAvailability,
   CanvasCreateNoteAutomationAction,
@@ -140,6 +142,7 @@ import {
   phoneValidator,
   nameValidator,
   nonNegNumberValidator,
+  nonNegNumberValidatorOptional,
   mongoIdValidator,
   mongoIdStringRequired as mongoIdStringValidator,
   listOfMongoIdStringValidator,
@@ -275,6 +278,7 @@ import {
   listValidator,
   userCallRoutingBehaviorValidator,
   userUIRestrictionsValidator,
+  userFieldRedactionsValidator,
   externalChatGPTMessagesValidator,
   enduserProfileViewBlocksValidator,
   customDashboardBlocksValidator,
@@ -728,6 +732,8 @@ export type CustomActions = {
         groupInstance?: string,
         groupPosition?: number,
         startedViaPinnedForm?: boolean,
+        procedureCodes?: FormResponseProcedureCode[],
+        diagnosisCodes?: FormResponseDiagnosisCode[],
       },
       { accessCode: string, url: string, response: FormResponse, fullURL: string }>
     ,
@@ -995,6 +1001,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[] }>,
@@ -1184,7 +1192,11 @@ export type CustomActions = {
   },
   purchases: {
     charge_card_on_file: CustomAction<
-      { enduserId: string, productIds?: string[], priceIds?: string[], cost?: Purchase['cost'], stripeKey?: string, description?: string, subscriptionPriceId?: string }, 
+      { enduserId: string, productIds?: string[], priceIds?: string[], cost?: Purchase['cost'], stripeKey?: string, description?: string, subscriptionPriceId?: string },
+      { }
+    >,
+    chargebee_charge_card_on_file: CustomAction<
+      { enduserId: string, chargebeeEnvironment: string, chargeType: string, itemPriceId?: string, quantity?: number, couponIds?: string[], cost?: Purchase['cost'], description?: string },
       { }
     >,
   },
@@ -1402,6 +1414,18 @@ export type SchemaV1 = Schema & {
 
 export const build_schema = <T extends Schema>(schema: T) => schema
 
+const procedureCodesValidator = listValidatorOptionalOrEmptyOk(objectValidator<FormResponseProcedureCode>({
+  code: stringValidator100,
+  units: nonNegNumberValidator,
+  feeCents: nonNegNumberValidatorOptional,
+  modifiers: listOfStringsValidatorOptionalOrEmptyOk,
+}))
+
+const diagnosisCodesValidator = listValidatorOptionalOrEmptyOk(objectValidator<FormResponseDiagnosisCode>({
+  code: stringValidator100,
+  description: stringValidatorOptionalEmptyOkay,
+}))
+
 export const schema: SchemaV1 = build_schema({
   endusers: {
     info: {
@@ -1443,6 +1467,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
@@ -1573,6 +1608,7 @@ export const schema: SchemaV1 = build_schema({
         validator: dateValidator,
       },
       lastLogout: { validator: dateValidator },
+      invalidateSessionsBefore: { validator: dateValidator },
       termsSigned: { validator: dateValidator },
       termsVersion: { validator: stringValidator100 },
       lastCommunication: { 
@@ -2203,6 +2239,10 @@ export const schema: SchemaV1 = build_schema({
         validator: stringValidator,
         readonly: true,
       },
+      approvedBusinessIds: {
+        validator: listOfMongoIdStringValidator,
+        readonly: true,
+      },
     },
     constraints: { unique: [], relationship: [], access: [{ type: CREATOR_ONLY_ACCESS }] },
     defaultActions: { read: {}, readMany: {}, delete: {} },
@@ -2508,6 +2548,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: {
@@ -4616,6 +4682,7 @@ export const schema: SchemaV1 = build_schema({
       belugaVerificationId: { validator: stringValidator },
       belugaPharmacyMappings: {
         validator: listValidatorOptionalOrEmptyOk(objectValidator<BelugaPharmacyMapping>({
+          title: stringValidatorOptionalEmptyOkay,
           pharmacyId: stringValidator100,
           patientPreference: stringValidator5000,
           conditions: compoundFilterValidator,
@@ -4627,6 +4694,8 @@ export const schema: SchemaV1 = build_schema({
         }))
       },
       autoMergeOnSubmission: { validator: booleanValidator },
+      procedureCodes: { validator: procedureCodesValidator },
+      diagnosisCodes: { validator: diagnosisCodesValidator },
       gtmTag: { validator: stringValidator100EscapeHTML },
       dontSyncToCanvasOnSubmission: { validator: booleanValidator },
       archivedAt: { validator: dateOptionalOrEmptyStringValidator },
@@ -4909,9 +4978,11 @@ export const schema: SchemaV1 = build_schema({
         }))
       },
       startedViaPinnedForm: { validator: booleanValidator },
+      procedureCodes: { validator: procedureCodesValidator },
+      diagnosisCodes: { validator: diagnosisCodesValidator },
     },
     defaultActions: DEFAULT_OPERATIONS,
-    enduserActions: { 
+    enduserActions: {
       prepare_form_response: {}, info_for_access_code: {}, submit_form_response: {}, stripe_details: {}, chargebee_details: {},
       read: {}, readMany: {}, save_field_response: {},
       update: { } /* allows for hiding from client portal, storing partial responses while submitting form */ 
@@ -4939,6 +5010,8 @@ export const schema: SchemaV1 = build_schema({
           groupInstance: { validator: stringValidator100 },
           groupPosition: { validator: nonNegNumberValidator },
           startedViaPinnedForm: { validator: booleanValidator },
+          procedureCodes: { validator: procedureCodesValidator },
+          diagnosisCodes: { validator: diagnosisCodesValidator },
         },
         returns: {
           accessCode: { validator: stringValidator250, required: true },
@@ -7001,6 +7074,7 @@ export const schema: SchemaV1 = build_schema({
       subdomain: {
         validator: slugValidator,
         required: true,
+        readonly: true, // mutated only by Tellescope (internal); see CloudFront portal-v2 alias safety
         examples: ["subdomain"],
       },
       limits: { 
@@ -7065,6 +7139,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 }>({
@@ -7112,6 +7188,7 @@ export const schema: SchemaV1 = build_schema({
       },
       groups: { validator: listOfStringsValidatorUniqueOptionalOrEmptyOkay },
       canvasURL: { validator: stringValidator },
+      healthiePortalURL: { validator: stringValidator },
       observationInvalidationReasons: { validator: listOfStringsValidatorUniqueOptionalOrEmptyOkay },
       customNotificationTypes: { validator: listOfStringsValidatorUniqueOptionalOrEmptyOkay },
       customerIOFields: { validator: listOfStringsValidatorUniqueOptionalOrEmptyOkay },
@@ -7123,15 +7200,18 @@ export const schema: SchemaV1 = build_schema({
       skipActivePatientBilling: { validator: booleanValidator },
       portalV2SchemaURL: { validator: stringValidator },
       timeTrackingPrograms: {
-        validator: listValidatorOptionalOrEmptyOk(objectValidator<{ title: string, billingCodes: { billingCode: string, timeInMinutes: number }[], forms?: { id: string }[] }>({
+        validator: listValidatorOptionalOrEmptyOk(objectValidator<{ title: string, billingCodes: { billingCode: string, timeInMinutes: number, repeatable?: boolean, feeCents?: number }[], forms?: { id: string }[], summaryFormId?: string }>({
           title: stringValidator100,
-          billingCodes: listValidatorEmptyOk(objectValidator<{ billingCode: string, timeInMinutes: number }>({
+          billingCodes: listValidatorEmptyOk(objectValidator<{ billingCode: string, timeInMinutes: number, repeatable?: boolean, feeCents?: number }>({
             billingCode: stringValidator100,
             timeInMinutes: nonNegNumberValidator,
+            repeatable: booleanValidatorOptional,
+            feeCents: nonNegNumberValidatorOptional,
           })),
           forms: listValidatorOptionalOrEmptyOk(objectValidator<{ id: string }>({
             id: mongoIdStringRequired,
           })),
+          summaryFormId: mongoIdStringOptional,
         }))
       },
     },
@@ -7363,6 +7443,7 @@ export const schema: SchemaV1 = build_schema({
         ]
       },
       uiRestrictions: { validator: userUIRestrictionsValidator },
+      fieldRedactions: { validator: userFieldRedactionsValidator },
     }
   },
   appointment_booking_pages: {
@@ -7577,11 +7658,11 @@ export const schema: SchemaV1 = build_schema({
     defaultActions: DEFAULT_OPERATIONS,
     customActions: {
       charge_card_on_file: {
-        op: "custom", access: 'create', method: "post", 
+        op: "custom", access: 'create', method: "post",
         name: 'Charge Stripe Card on File',
         path: '/purchases/charge-card',
         description: "Charges an existing card on file (if saved), otherwise throws an error",
-        parameters: { 
+        parameters: {
           enduserId: { validator: mongoIdStringValidator, required: true },
           productIds: { validator: listOfMongoIdStringValidatorEmptyOk },
           priceIds: { validator: listOfStringsValidatorOptionalOrEmptyOk }, // stripe price IDs, not Tellescope ids
@@ -7593,7 +7674,25 @@ export const schema: SchemaV1 = build_schema({
         returns: {
 
         },
-      }, 
+      },
+      chargebee_charge_card_on_file: {
+        op: "custom", access: 'create', method: "post",
+        name: 'Charge Chargebee Card on File',
+        path: '/purchases/chargebee-charge-card',
+        description: "Charges a Chargebee customer's card on file",
+        parameters: {
+          enduserId: { validator: mongoIdStringValidator, required: true },
+          chargebeeEnvironment: { validator: stringValidator, required: true },
+          chargeType: { validator: stringValidator, required: true },
+          itemPriceId: { validator: stringValidator100 },
+          quantity: { validator: numberValidator },
+          couponIds: { validator: listOfStringsValidatorOptionalOrEmptyOk },
+          cost: { validator: costValidator },
+          description: { validator: stringValidator },
+        },
+        returns: {
+        },
+      },
     },
     enduserActions: { read: {}, readMany: {} },
     fields: {
@@ -8566,6 +8665,9 @@ If a voicemail is left, it is indicated by recordingURI, transcription, or recor
       },
       customFields: {
         validator: customEnduserFieldsValidatorOptionalOrEmpty,
+      },
+      createEnduserForms: {
+        validator: listOfMongoIdStringValidatorOptionalOrEmptyOk,
       }
     }
   },
@@ -9160,6 +9262,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: {