Class CalendarsClient

Hierarchy

GhlClient
- CalendarsClient

Constructors

constructor

new CalendarsClient(accessToken: string): CalendarsClient
Parameters
- accessToken: string
Returns CalendarsClient
Overrides GhlClient.constructor
- Defined in calendars/calendars.client.ts:40

Methods

find

find(params: CalendarSearchParams): Promise<ListCalendarsResponse>
Parameters
- params: CalendarSearchParams
Returns Promise<ListCalendarsResponse>
- Defined in calendars/calendars.client.ts:44

findById

findById(id: string): Promise<GetCalendarResponse>
Parameters
- id: string
Returns Promise<GetCalendarResponse>
- Defined in calendars/calendars.client.ts:50

create

create(dto: CreateCalendarDto): Promise<GetCalendarResponse>
Parameters
- dto: CreateCalendarDto
Returns Promise<GetCalendarResponse>
- Defined in calendars/calendars.client.ts:54

update

update(id: string, dto: UpdateCalendarDto): Promise<GetCalendarResponse>
Parameters
- id: string
- dto: UpdateCalendarDto
Returns Promise<GetCalendarResponse>
- Defined in calendars/calendars.client.ts:58

remove

remove(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in calendars/calendars.client.ts:65

findFreeSlots

findFreeSlots(calendarId: string): Promise<GetCalendarSlotsResponse>
Parameters
- calendarId: string
Returns Promise<GetCalendarSlotsResponse>
- Defined in calendars/calendars.client.ts:69

findGroups

findGroups(calendarId: string): Promise<ListCalendarGroupsResponse>
Parameters
- calendarId: string
Returns Promise<ListCalendarGroupsResponse>
- Defined in calendars/calendars.client.ts:77

createGroup

createGroup(
dto: CreateCalendarGroupDto,
): Promise<CreateUpdateCalendarGroupResponse>
Parameters
- dto: CreateCalendarGroupDto
Returns Promise<CreateUpdateCalendarGroupResponse>
- Defined in calendars/calendars.client.ts:85

validateGroupSlug

validateGroupSlug(
dto: ValidateCalendarGroupSlugDto,
): Promise<ValidateCalendarGroupSlugResponse>
Parameters
- dto: ValidateCalendarGroupSlugDto
Returns Promise<ValidateCalendarGroupSlugResponse>
- Defined in calendars/calendars.client.ts:94

removeGroup

removeGroup(groupId: string): Promise<SuccessDeleteResponse>
Parameters
- groupId: string
Returns Promise<SuccessDeleteResponse>
- Defined in calendars/calendars.client.ts:103

updateGroup

updateGroup(
groupId: string,
dto: UpdateCalendarGroupDto,
): Promise<CreateUpdateCalendarGroupResponse>
Parameters
- groupId: string
- dto: UpdateCalendarGroupDto
Returns Promise<CreateUpdateCalendarGroupResponse>
- Defined in calendars/calendars.client.ts:107

updateGroupStatus

updateGroupStatus(
groupId: string,
isActive: boolean,
): Promise<UpdateCalendarGroupStatusResponse>
Parameters
- groupId: string
- isActive: boolean
Returns Promise<UpdateCalendarGroupStatusResponse>
- Defined in calendars/calendars.client.ts:117

findEvents

findEvents(
params: CalendarEventSearchParams,
): Promise<ListCalendarEventsResponse>
Parameters
- params: CalendarEventSearchParams
Returns Promise<ListCalendarEventsResponse>
- Defined in calendars/calendars.client.ts:127

findBlockedSlots

findBlockedSlots(
params: CalendarEventSearchParams,
): Promise<ListCalendarEventsResponse>
Parameters
- params: CalendarEventSearchParams
Returns Promise<ListCalendarEventsResponse>
- Defined in calendars/calendars.client.ts:135

findAppointmentById

findAppointmentById(eventId: string): Promise<GetCalendarEventResponse>
Parameters
- eventId: string
Returns Promise<GetCalendarEventResponse>
- Defined in calendars/calendars.client.ts:143

updateAppointment

updateAppointment(
eventId: string,
dto: AppointmentCreateUpdateDto,
): Promise<AppointmentCreateUpdateResponse>
Parameters
- eventId: string
- dto: AppointmentCreateUpdateDto
Returns Promise<AppointmentCreateUpdateResponse>
- Defined in calendars/calendars.client.ts:151

createAppointment

createAppointment(
dto: AppointmentCreateUpdateDto,
): Promise<AppointmentCreateUpdateResponse>
Parameters
- dto: AppointmentCreateUpdateDto
Returns Promise<AppointmentCreateUpdateResponse>
- Defined in calendars/calendars.client.ts:161

createBlockSlot

createBlockSlot(dto: CreateBlockSlotDto): Promise<BlockSlotCreateUpdateResponse>
Parameters
- dto: CreateBlockSlotDto
Returns Promise<BlockSlotCreateUpdateResponse>
- Defined in calendars/calendars.client.ts:170

updateBlockSlot

updateBlockSlot(
eventId: string,
dto: UpdateBlockSlotDto,
): Promise<BlockSlotCreateUpdateResponse>
Parameters
- eventId: string
- dto: UpdateBlockSlotDto
Returns Promise<BlockSlotCreateUpdateResponse>
- Defined in calendars/calendars.client.ts:179

removeEvent

removeEvent(eventId: string): Promise<SuccededDeleteResponse>
Parameters
- eventId: string
Returns Promise<SuccededDeleteResponse>
- Defined in calendars/calendars.client.ts:189

findAppointmentNotes

findAppointmentNotes(
appointmentId: string,
): Promise<ListAppointmentNotesResponse>
Parameters
- appointmentId: string
Returns Promise<ListAppointmentNotesResponse>
- Defined in calendars/calendars.client.ts:193

createAppointmentNote

createAppointmentNote(
appointmentId: string,
dto: AppointmentNoteDto,
): Promise<AppointmentNoteResponse>
Parameters
- appointmentId: string
- dto: AppointmentNoteDto
Returns Promise<AppointmentNoteResponse>
- Defined in calendars/calendars.client.ts:201

updateAppointmentNote

updateAppointmentNote(
    appointmentId: string,
    noteId: string,
    dto: AppointmentNoteDto,
): Promise<AppointmentNoteResponse>
Parameters
- appointmentId: string
- noteId: string
- dto: AppointmentNoteDto
Returns Promise<AppointmentNoteResponse>
- Defined in calendars/calendars.client.ts:211

removeAppointmentNote

removeAppointmentNote(
appointmentId: string,
noteId: string,
): Promise<SuccessDeleteResponse>
Parameters
- appointmentId: string
- noteId: string
Returns Promise<SuccessDeleteResponse>
- Defined in calendars/calendars.client.ts:222

findResourceById

findResourceById(
resourceId: string,
resourceType: CalendarResourceType,
): Promise<CalendarResourceResponse>
Parameters
- resourceId: string
- resourceType: CalendarResourceType
Returns Promise<CalendarResourceResponse>
- Defined in calendars/calendars.client.ts:231

updateResource

updateResource(
    resourceId: string,
    resourceType: CalendarResourceType,
    dto: UpdateCalendarResourceDto,
): Promise<CalendarResourceResponse>
Parameters
- resourceId: string
- resourceType: CalendarResourceType
- dto: UpdateCalendarResourceDto
Returns Promise<CalendarResourceResponse>
- Defined in calendars/calendars.client.ts:240

deleteResource

deleteResource(
resourceId: string,
resourceType: CalendarResourceType,
): Promise<SuccessDeleteResponse>
Parameters
- resourceId: string
- resourceType: CalendarResourceType
Returns Promise<SuccessDeleteResponse>
- Defined in calendars/calendars.client.ts:251

findResourcesByType

findResourcesByType(
resourceType: CalendarResourceType,
params: CalendarResourceSearchParams,
): Promise<CalendarResourceResponse[]>
Parameters
- resourceType: CalendarResourceType
- params: CalendarResourceSearchParams
Returns Promise<CalendarResourceResponse[]>
- Defined in calendars/calendars.client.ts:260

createCalendarResource

createCalendarResource(
resourceType: CalendarResourceType,
dto: CreateCalendarResourceDto,
): Promise<CalendarResourceResponse>
Parameters
- resourceType: CalendarResourceType
- dto: CreateCalendarResourceDto
Returns Promise<CalendarResourceResponse>
- Defined in calendars/calendars.client.ts:270

findNotifications

findNotifications(
calendarId: string,
params: CalendarNotificationSearchParams,
): Promise<CalendarNotificationDetails[]>
Parameters
- calendarId: string
- params: CalendarNotificationSearchParams
Returns Promise<CalendarNotificationDetails[]>
- Defined in calendars/calendars.client.ts:280

createNotifications

createNotifications(
calendarId: string,
dto: CalendarNotificationDto[],
): Promise<CalendarNotificationDetails[]>
Parameters
- calendarId: string
- dto: CalendarNotificationDto[]
Returns Promise<CalendarNotificationDetails[]>
- Defined in calendars/calendars.client.ts:290

findNotificationById

findNotificationById(
calendarId: string,
notificationId: string,
): Promise<CalendarNotificationDetails>
Parameters
- calendarId: string
- notificationId: string
Returns Promise<CalendarNotificationDetails>
- Defined in calendars/calendars.client.ts:300

updateNotification

updateNotification(
    calendarId: string,
    notificationId: string,
    dto: CalendarNotificationDto,
): Promise<CalendarNotificationOperationResponse>
Parameters
- calendarId: string
- notificationId: string
- dto: CalendarNotificationDto
Returns Promise<CalendarNotificationOperationResponse>
- Defined in calendars/calendars.client.ts:309

removeNotification

removeNotification(
calendarId: string,
notificationId: string,
): Promise<CalendarNotificationOperationResponse>
Parameters
- calendarId: string
- notificationId: string
Returns Promise<CalendarNotificationOperationResponse>
- Defined in calendars/calendars.client.ts:320