Safety Net Blueprint — Client Reference: Scheduling

Methods (5)

▶ listAppointments() You can provide a client instance returned by `createClient()` instead of API ref → #

scheduling.listAppointments({
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})

Parameters

q search →	string	query	optional
limit	number	query	optional
offset	number	query	optional
sort	string	query	optional

▶ createAppointment() Create an appointment API ref → #

scheduling.createAppointment({ body: { ... } })

Parameters

body

object

body

required

▶ deleteAppointment(appointmentId) Delete an appointment API ref → #

scheduling.deleteAppointment({ path: { appointmentId: string } })

Parameters

appointmentId

string

path

required

▶ getAppointment(appointmentId) Get an appointment API ref → #

scheduling.getAppointment({ path: { appointmentId: string } })

Parameters

appointmentId

string

path

required

▶ updateAppointment(appointmentId) Update an appointment API ref → #

scheduling.updateAppointment({
  path: { appointmentId: string },
  body: { ... },
})

Parameters

appointmentId	string	path	required
body	object	body	required

Constants (1)

▶ AppointmentStatus enum (4 values) #

'scheduled'
'completed'
'canceled'
'no_show'

Types (6)

▶ Appointment 7 fields #

interface Appointment {
  startAt: string
  endAt: string
  appointmentType: string
  status: enum: "scheduled", "completed", "canceled", "no_show"
  personId: string
  assignedToId?: string
  notes?: string
}

▶ AppointmentCreate 7 fields #

interface AppointmentCreate {
  startAt?: string
  endAt?: string
  appointmentType?: string
  status?: enum: "scheduled", "completed", "canceled", "no_show"
  personId?: string
  assignedToId?: string
  notes?: string
}

▶ AppointmentUpdate 7 fields #

interface AppointmentUpdate {
  startAt?: string
  endAt?: string
  appointmentType?: string
  status?: enum: "scheduled", "completed", "canceled", "no_show"
  personId?: string
  assignedToId?: string
  notes?: string
}

▶ AppointmentList 4 fields #

interface AppointmentList {
  total: number
  limit: number
  offset: number
  hasNext?: boolean
}

▶ AppointmentWritable 7 fields #

interface AppointmentWritable {
  startAt: string
  endAt: string
  appointmentType: string
  status: enum: "scheduled", "completed", "canceled", "no_show"
  personId: string
  assignedToId?: string
  notes?: string
}

▶ AppointmentListWritable 4 fields #

interface AppointmentListWritable {
  total: number
  limit: number
  offset: number
  hasNext?: boolean
}