Skip to main content

CrmServiceAvailabilityOptions

Stentor API Reference


Stentor API Reference / stentor-models/src / CrmServiceAvailabilityOptions

Interface: CrmServiceAvailabilityOptions

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

Settings for the availability of the CRM service.

Extends​

Properties​

availableDays?​

optional availableDays?: DayOfWeek[]

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

The days of the week they are available to schedule appointments through the scheduler.

Inherited from​

CrmServiceAvailabilitySettings.availableDays


blockedDays?​

optional blockedDays?: DateTime[]

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

These are holidays or any other days specific to the business that they are not available for appointments.

Inherited from​

CrmServiceAvailabilitySettings.blockedDays


maxTotalDailyAppointments?​

optional maxTotalDailyAppointments?: number

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

Maximum total number of appointments a day that can be scheduled through the scheduler.

Inherited from​

CrmServiceAvailabilitySettings.maxTotalDailyAppointments


delayedJobTypes?​

optional delayedJobTypes?: string[]

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

Job types, where we only schedule a few days (3) ahead

Inherited from​

CrmServiceAvailabilitySettings.delayedJobTypes


availabilityClasses?​

optional availabilityClasses?: AvailabilityClass[]

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

The customer specific "availability classes" that describes the scheduling strategy for job types.

Inherited from​

CrmServiceAvailabilitySettings.availabilityClasses


defaultAvailabilityClass?​

optional defaultAvailabilityClass?: string

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

The default availability class (when the AI cannot figure it out)

Inherited from​

CrmServiceAvailabilitySettings.defaultAvailabilityClass


defaultBusyDays?​

optional defaultBusyDays?: BusyDayDescription

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

The default busy days for the business. This is used when the FSM/Scheduling backend does not provide busy days

Inherited from​

CrmServiceAvailabilitySettings.defaultBusyDays


jobTypeClasses?​

optional jobTypeClasses?: JobTypeAvailabilityClass[]

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

Deterministic job type -> class mapping. Beats the LLM's guess.

Inherited from​

CrmServiceAvailabilitySettings.jobTypeClasses


forceAvailabilityClass?​

optional forceAvailabilityClass?: string

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

Forces every booking in this scope into the given class, regardless of job type.

This is deliberately NOT defaultAvailabilityClass: that field is a fallback (it loses to jobType.class), so it cannot express "force". Used by campaign booking widgets, which carry their own availability settings.

Inherited from​

CrmServiceAvailabilitySettings.forceAvailabilityClass


jobType?​

optional jobType?: CrmServiceJobType

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

Job Type to filter availability by.

This allows to display availability for a specific job type, which can be different.