AppointmentReminders | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- AppointmentReminders

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AppointmentReminders(options: AppointmentRemindersOptions, http: Client): AppointmentReminders

Overrides ThBaseHandler.constructor
- Defined in src/v1/appointment_reminders.ts:52
Parameters
- options: AppointmentRemindersOptions
- http: Client
Returns AppointmentReminders

Properties

endpoint

endpoint: string

http

http: Client

options

options: AppointmentRemindersOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v1/notifications/appointment-reminders'

Methods

get

get(): Promise<AppointmentRemindersResponse>

- Defined in src/v1/appointment_reminders.ts:67
Returns Promise<AppointmentRemindersResponse>

patch

patch(id: string, appointmentReminder: AppointmentReminderEntity): Promise<AppointmentRemindersResponse>

- Defined in src/v1/appointment_reminders.ts:104
Parameters
- id: string
- appointmentReminder: AppointmentReminderEntity
Returns Promise<AppointmentRemindersResponse>

post

post(appointmentReminder: AppointmentReminderEntity): Promise<AppointmentRemindersResponse>

- Defined in src/v1/appointment_reminders.ts:87
Parameters
- appointmentReminder: AppointmentReminderEntity
Returns Promise<AppointmentRemindersResponse>

sendTestReminder

sendTestReminder(payload: AppointmentRemindersTestReminderPayload): Promise<AppointmentRemindersTestReminderResponse>

- Defined in src/v1/appointment_reminders.ts:122
Parameters
- payload: AppointmentRemindersTestReminderPayload
Returns Promise<AppointmentRemindersTestReminderResponse>

templates

templates(): AppointmentReminderTemplates

- Defined in src/v1/appointment_reminders.ts:136
Returns AppointmentReminderTemplates

Generated using TypeDoc