@gohighlevel/api-client/dist/lib/code/calendars/calendars.d.ts

Official SDK for HighLevel Public APIs

import { AxiosInstance, AxiosRequestConfig } from 'axios';
import * as Models from './models/calendars';
/**
 * Calendars Service
 * Documentation for Calendars API
 */
export declare class Calendars {
    private client;
    constructor(httpClient: AxiosInstance);
    /**
     * Get Groups
     * Get all calendar groups in a location.
     */
    getGroups(params: {
        locationId: string;
    }, options?: AxiosRequestConfig): Promise<Models.AllGroupsSuccessfulResponseDTO>;
    /**
     * Create Calendar Group
     * Create Calendar Group
     */
    createCalendarGroup(requestBody: Models.GroupCreateDTO, options?: AxiosRequestConfig): Promise<Models.GroupCreateSuccessfulResponseDTO>;
    /**
     * Validate group slug
     * Validate if group slug is available or not.
     */
    validateGroupsSlug(requestBody: Models.ValidateGroupSlugPostBody, options?: AxiosRequestConfig): Promise<Models.ValidateGroupSlugSuccessResponseDTO>;
    /**
     * Delete Group
     * Delete Group
     */
    deleteGroup(params: {
        groupId: string;
    }, options?: AxiosRequestConfig): Promise<Models.GroupSuccessfulResponseDTO>;
    /**
     * Update Group
     * Update Group by group ID
     */
    editGroup(params: {
        groupId: string;
    }, requestBody: Models.GroupUpdateDTO, options?: AxiosRequestConfig): Promise<Models.GroupCreateSuccessfulResponseDTO>;
    /**
     * Disable Group
     * Disable Group
     */
    disableGroup(params: {
        groupId: string;
    }, requestBody: Models.GroupStatusUpdateParams, options?: AxiosRequestConfig): Promise<Models.GroupSuccessfulResponseDTO>;
    /**
     * Create appointment
     * Create appointment
     */
    createAppointment(requestBody: Models.AppointmentCreateSchema, options?: AxiosRequestConfig): Promise<Models.AppointmentSchemaResponse>;
    /**
     * Update Appointment
     * Update appointment
     */
    editAppointment(params: {
        eventId: string;
    }, requestBody: Models.AppointmentEditSchema, options?: AxiosRequestConfig): Promise<Models.AppointmentSchemaResponse>;
    /**
     * Get Appointment
     * Get appointment by ID
     */
    getAppointment(params: {
        eventId: string;
    }, options?: AxiosRequestConfig): Promise<Models.GetCalendarEventSuccessfulResponseDTO>;
    /**
     * Get Calendar Events
     * Get Calendar Events
     */
    getCalendarEvents(params: {
        locationId: string;
        userId?: string;
        calendarId?: string;
        groupId?: string;
        startTime: string;
        endTime: string;
    }, options?: AxiosRequestConfig): Promise<Models.GetCalendarEventsSuccessfulResponseDTO>;
    /**
     * Get Blocked Slots
     * Get Blocked Slots
     */
    getBlockedSlots(params: {
        locationId: string;
        userId?: string;
        calendarId?: string;
        groupId?: string;
        startTime: string;
        endTime: string;
    }, options?: AxiosRequestConfig): Promise<Models.GetCalendarEventsSuccessfulResponseDTO>;
    /**
     * Create Block Slot
     * Create block slot
     */
    createBlockSlot(requestBody: Models.BlockSlotCreateRequestDTO, options?: AxiosRequestConfig): Promise<Models.BlockedSlotSuccessfulResponseDto>;
    /**
     * Update Block Slot
     * Update block slot by ID
     */
    editBlockSlot(params: {
        eventId: string;
    }, requestBody: Models.BlockSlotEditRequestDTO, options?: AxiosRequestConfig): Promise<Models.BlockedSlotSuccessfulResponseDto>;
    /**
     * Get Free Slots
     * Get free slots for a calendar between a date range. Optionally a consumer can also request free slots in a particular timezone and also for a particular user.
     */
    getSlots(params: {
        calendarId: string;
        startDate: number;
        endDate: number;
        timezone?: string;
        userId?: string;
        userIds?: string[];
    }, options?: AxiosRequestConfig): Promise<Models.GetSlotsSuccessfulResponseDto>;
    /**
     * Update Calendar
     * Update calendar by ID.
     */
    updateCalendar(params: {
        calendarId: string;
    }, requestBody: Models.CalendarUpdateDTO, options?: AxiosRequestConfig): Promise<Models.CalendarByIdSuccessfulResponseDTO>;
    /**
     * Get Calendar
     * Get calendar by ID
     */
    getCalendar(params: {
        calendarId: string;
    }, options?: AxiosRequestConfig): Promise<Models.CalendarByIdSuccessfulResponseDTO>;
    /**
     * Delete Calendar
     * Delete calendar by ID
     */
    deleteCalendar(params: {
        calendarId: string;
    }, options?: AxiosRequestConfig): Promise<Models.CalendarDeleteSuccessfulResponseDTO>;
    /**
     * Delete Event
     * Delete event by ID
     */
    deleteEvent(params: {
        eventId: string;
    }, requestBody: Models.DeleteAppointmentSchema, options?: AxiosRequestConfig): Promise<Models.DeleteEventSuccessfulResponseDto>;
    /**
     * Get Notes
     * Get Appointment Notes
     */
    getAppointmentNotes(params: {
        limit: number;
        offset: number;
        appointmentId: string;
    }, options?: AxiosRequestConfig): Promise<Models.GetNotesListSuccessfulResponseDto>;
    /**
     * Create Note
     * Create Note
     */
    createAppointmentNote(params: {
        appointmentId: string;
    }, requestBody: Models.NotesDTO, options?: AxiosRequestConfig): Promise<Models.GetCreateUpdateNoteSuccessfulResponseDto>;
    /**
     * Update Note
     * Update Note
     */
    updateAppointmentNote(params: {
        appointmentId: string;
    }, requestBody: Models.NotesDTO, options?: AxiosRequestConfig): Promise<Models.GetCreateUpdateNoteSuccessfulResponseDto>;
    /**
     * Delete Note
     * Delete Note
     */
    deleteAppointmentNote(params: {
        appointmentId: string;
    }, options?: AxiosRequestConfig): Promise<Models.DeleteNoteSuccessfulResponseDto>;
    /**
     * Get Calendar Resource
     * Get calendar resource by ID
     */
    getCalendarResource(params: {
        resourceType: string;
        id: string;
    }, options?: AxiosRequestConfig): Promise<Models.CalendarResourceByIdResponseDTO>;
    /**
     * Update Calendar Resource
     * Update calendar resource by ID
     */
    updateCalendarResource(params: {
        resourceType: string;
        id: string;
    }, requestBody: Models.UpdateCalendarResourceDTO, options?: AxiosRequestConfig): Promise<Models.CalendarResourceResponseDTO>;
    /**
     * Delete Calendar Resource
     * Delete calendar resource by ID
     */
    deleteCalendarResource(params: {
        resourceType: string;
        id: string;
    }, options?: AxiosRequestConfig): Promise<Models.ResourceDeleteResponseDTO>;
    /**
     * List Calendar Resources
     * List calendar resources by resource type and location ID
     */
    fetchCalendarResources(params: {
        resourceType: string;
        locationId: string;
        limit: number;
        skip: number;
    }, options?: AxiosRequestConfig): Promise<Models.CalendarResourceByIdResponseDTO[]>;
    /**
     * Create Calendar Resource
     * Create calendar resource by resource type
     */
    createCalendarResource(params: {
        resourceType: string;
    }, requestBody: Models.CreateCalendarResourceDTO, options?: AxiosRequestConfig): Promise<Models.CalendarResourceByIdResponseDTO>;
    /**
     * Get notifications
     * Get calendar notifications based on query
     */
    getEventNotification(params: {
        calendarId: string;
        isActive?: boolean;
        deleted?: boolean;
        limit?: number;
        skip?: number;
    }, options?: AxiosRequestConfig): Promise<Models.CalendarNotificationResponseDTO[]>;
    /**
     * Create notification
     * Create Calendar notifications, either one or multiple. All notification settings must be for single calendar only
     */
    createEventNotification(params: {
        calendarId: string;
    }, requestBody: Models.CreateCalendarNotificationDTO[], options?: AxiosRequestConfig): Promise<Models.CalendarNotificationResponseDTO[]>;
    /**
     * Get notification
     * Find Event notification by notificationId
     */
    findEventNotification(params: {
        calendarId: string;
        notificationId: string;
    }, options?: AxiosRequestConfig): Promise<Models.CalendarNotificationResponseDTO>;
    /**
     * Update notification
     * Update Event notification by id
     */
    updateEventNotification(params: {
        calendarId: string;
        notificationId: string;
    }, requestBody: Models.UpdateCalendarNotificationsDTO, options?: AxiosRequestConfig): Promise<Models.CalendarNotificationDeleteResponseDTO>;
    /**
     * Delete Notification
     * Delete notification
     */
    deleteEventNotification(params: {
        calendarId: string;
        notificationId: string;
    }, options?: AxiosRequestConfig): Promise<Models.CalendarNotificationDeleteResponseDTO>;
    /**
     * Get Calendars
     * Get all calendars in a location.
     */
    getCalendars(params: {
        locationId: string;
        groupId?: string;
        showDrafted?: boolean;
    }, options?: AxiosRequestConfig): Promise<Models.CalendarsGetSuccessfulResponseDTO>;
    /**
     * Create Calendar
     * Create calendar in a location.
     */
    createCalendar(requestBody: Models.CalendarCreateDTO, options?: AxiosRequestConfig): Promise<Models.CalendarByIdSuccessfulResponseDTO>;
}
export default Calendars;
//# sourceMappingURL=calendars.d.ts.map