node-calendly/lib/Calendly.d.ts

Node module to access calendly api.

/******************************************
 *  Author : Dr. Sebastian Herden
 *  Created On : Fri Sep 16 2022
 *******************************************/
import ActivityLog from './endpoints/ActivityLog';
import { Options } from './endpoints/CalendlyApiEndpoint';
import DataCompliance from './endpoints/DataCompliance';
import EventTypes from './endpoints/EventTypes';
import { MeProvider, OrganizationProvider } from './endpoints/Provider';
import ScheduledEvents from './endpoints/ScheduledEvents';
import Users from './endpoints/Users';
/**
 * The gateway to the Calendly API.
 * @export
 * @class Calendly
 * @see https://developer.calendly.com/api-docs/d7755e2f9e5fe-calendly-api
 * @implements {OrganizationProvider}
 * @implements {MeProvider}
 */
export default class Calendly implements OrganizationProvider, MeProvider {
    /**
     * The access token to use for the API calls.
     * @type {string}
     * @memberof Calendly
     * @private
     * @readonly
     * @see https://developer.calendly.com/when-to-choose-between-personal-access-tokens-and-oauth
     */
    private ACCESS_TOKEN;
    /**
     * The users endpoint.
     * @type {Users}
     * @memberof Calendly
     * @see https://developer.calendly.com/api-docs/ff9832c5a6640-get-user
     */
    users: Users;
    /**
     * The activity log endpoint.
     * @type {ActivityLog}
     * @memberof Calendly
     * @see https://developer.calendly.com/api-docs/d37c7f031f339-list-activity-log-entries
     */
    activityLog: ActivityLog;
    /**
     * The data compliance endpoint.
     * @type {DataCompliance}
     * @memberof Calendly
     * @see https://developer.calendly.com/api-docs/4cf896120a018-delete-invitee-data
     */
    dataCompliance: DataCompliance;
    /**
     * The event types endpoint.
     * @type {EventTypes}
     * @memberof Calendly
     * @see https://developer.calendly.com/api-docs/25a4ece03c1bc-list-user-s-event-types
     */
    eventTypes: EventTypes;
    /**
     * The scheduled events endpoint.
     * @type {ScheduledEvents}
     * @memberof Calendly
     * @see https://developer.calendly.com/api-docs/eb8ee72701f99-list-event-invitees
     */
    scheduledEvents: ScheduledEvents;
    /**
     * Creates an instance of Calendly. After creation you can use the endpoints to access the API.
     * @param ACCESS_TOKEN The access token to use for the API calls.
     * @memberof Calendly
     */
    constructor(ACCESS_TOKEN: string, params?: Options);
    /**
     * Get the current user.
     * @returns {Promise<string>} The URI of the current user.
     */
    getMe(): Promise<string>;
    /**
     * Get the organization of the current user.
     * @returns {Promise<string>} The URI of the current organization.
     */
    getOrganizationUri(): Promise<string>;
    /**
     * Get the uuid from a URI.
     * @param resourceUri The URI of the resource.
     * @returns  The UUID of the resource.
     */
    static getUuidFromUri(resourceUri: string): string | undefined;
}
//# sourceMappingURL=Calendly.d.ts.map