Skip to main content

AvailabilityClass

Stentor API Reference

Stentor API Reference / stentor-models/src / AvailabilityClass

Interface: AvailabilityClass

Defined in: packages/stentor-models/src/Services/CrmService.ts:18

Properties​

id​

id: string

Defined in: packages/stentor-models/src/Services/CrmService.ts:22

ID for the availability class, typically the slugged name.

name​

name: string

Defined in: packages/stentor-models/src/Services/CrmService.ts:26

Human readable name of the availability class

summary​

summary: string

Defined in: packages/stentor-models/src/Services/CrmService.ts:30

Summary of the availability class. This is used to describe the availability class so the AI can match it to user input. It contains high level description as well as examples of input that would match to this class.

numberOfDaysOut?​

optional numberOfDaysOut?: number

Defined in: packages/stentor-models/src/Services/CrmService.ts:38

Minimum number of days out that can be scheduled for this type.

This is independent of if the day is available or not.

Value of 0 is the default if not provided, meaning same day could be available.

appointmentsPerDay?​

optional appointmentsPerDay?: number

Defined in: packages/stentor-models/src/Services/CrmService.ts:44

Maximum number of appointments that can be scheduled per day for this type.

If not provided, it is assumed to be unlimited.

leadOnly?​

optional leadOnly?: boolean

Defined in: packages/stentor-models/src/Services/CrmService.ts:48

If true, this availability class is only for leads and not for appointments as they typically require more information and followup.

currentDayAvailableUntil?​

optional currentDayAvailableUntil?: string

Defined in: packages/stentor-models/src/Services/CrmService.ts:59

The current day stays available until this time, in HH:MM (24-hour) format, wall-clock in the business timezone.

For example, "16:00" lets a job in this class still be booked for today up to 4:00 PM; at or after 4:00 PM, today is no longer offered. Same meaning as BusyDayDescription.currentDayAvailableUntil, which this overrides for jobs resolved to this class.

Only meaningful when numberOfDaysOut is 0 or absent (i.e. same-day is possible at all).