nylas/lib/types/resources/events.d.ts

A NodeJS wrapper for the Nylas REST API for email, contacts, and calendar.

import { Overrides } from '../config.js';
import { CreateEventQueryParams, CreateEventRequest, DestroyEventQueryParams, Event, FindEventQueryParams, ListImportEventQueryParams, ListEventQueryParams, SendRsvpQueryParams, SendRsvpRequest, SendRsvpResponse, UpdateEventQueryParams, UpdateEventRequest } from '../models/events.js';
import { NylasBaseResponse, NylasResponse, NylasListResponse } from '../models/response.js';
import { AsyncListResponse, Resource } from './resource.js';
/**
 * @property eventId The id of the Event to retrieve.
 * @property identifier The identifier of the grant to act upon
 * @property queryParams The query parameters to include in the request
 */
export interface FindEventParams {
    identifier: string;
    eventId: string;
    queryParams: FindEventQueryParams;
}
/**
 * @property identifier The identifier of the grant to act upon
 * @property queryParams The query parameters to include in the request
 */
export interface ListEventParams {
    identifier: string;
    queryParams: ListEventQueryParams;
}
/**
 * @property identifier The identifier of the grant to act upon
 * @property queryParams The query parameters to include in the request
 * @property requestBody The values to create the Event with
 */
export interface CreateEventParams {
    identifier: string;
    requestBody: CreateEventRequest;
    queryParams: CreateEventQueryParams;
}
/**
 * @property identifier The identifier of the grant to act upon
 * @property eventId The id of the Event to retrieve.
 * @property requestBody The values to update the Event with
 * @property queryParams The query parameters to include in the request
 */
export interface UpdateEventParams {
    identifier: string;
    eventId: string;
    requestBody: UpdateEventRequest;
    queryParams: UpdateEventQueryParams;
}
/**
 * @property identifier The identifier of the grant to act upon
 * @property eventId The id of the Event to retrieve.
 * @property queryParams The query parameters to include in the request
 */
export interface DestroyEventParams {
    identifier: string;
    eventId: string;
    queryParams: DestroyEventQueryParams;
}
/**
 * @property identifier The identifier of the grant to act upon
 * @property queryParams The query parameters to include in the request
 */
export interface ListImportEventParams {
    identifier: string;
    queryParams: ListImportEventQueryParams;
}
/**
 * @property identifier The identifier of the grant to act upon
 * @property eventId The id of the Event to update.
 * @property queryParams The query parameters to include in the request
 * @property requestBody The values to send the RSVP with
 */
interface SendRsvpParams {
    identifier: string;
    eventId: string;
    queryParams: SendRsvpQueryParams;
    requestBody: SendRsvpRequest;
}
/**
 * Nylas Events API
 *
 * The Nylas Events API allows you to create, update, and delete events on user calendars.
 */
export declare class Events extends Resource {
    /**
     * Return all Events
     * @return The list of Events
     */
    list({ identifier, queryParams, overrides, }: ListEventParams & Overrides): AsyncListResponse<NylasListResponse<Event>>;
    /**
     * (Beta) Import events from a calendar within a given time frame
     * This is useful when you want to import, store, and synchronize events from the time frame to your application
     * @return The list of imported Events
     */
    listImportEvents({ identifier, queryParams, overrides, }: ListImportEventParams & Overrides): AsyncListResponse<NylasListResponse<Event>>;
    /**
     * Return an Event
     * @return The Event
     */
    find({ identifier, eventId, queryParams, overrides, }: FindEventParams & Overrides): Promise<NylasResponse<Event>>;
    /**
     * Create an Event
     * @return The created Event
     */
    create({ identifier, requestBody, queryParams, overrides, }: CreateEventParams & Overrides): Promise<NylasResponse<Event>>;
    /**
     * Update an Event
     * @return The updated Event
     */
    update({ identifier, eventId, requestBody, queryParams, overrides, }: UpdateEventParams & Overrides): Promise<NylasResponse<Event>>;
    /**
     * Delete an Event
     * @return The deletion response
     */
    destroy({ identifier, eventId, queryParams, overrides, }: DestroyEventParams & Overrides): Promise<NylasBaseResponse>;
    /**
     * Send RSVP. Allows users to respond to events they have been added to as an attendee.
     * You cannot send RSVP as an event owner/organizer.
     * You cannot directly update events as an invitee, since you are not the owner/organizer.
     * @return The send-rsvp response
     */
    sendRsvp({ identifier, eventId, requestBody, queryParams, overrides, }: SendRsvpParams & Overrides): Promise<SendRsvpResponse>;
}
export {};