node-calendly
Version:
Node module to access calendly api.
36 lines • 1.3 kB
TypeScript
/******************************************
* Author : Dr. Sebastian Herden
* Created On : Fri Sep 16 2022
* File : EventTypes.ts
*******************************************/
import CalendlyApiEndpoint from './CalendlyApiEndpoint';
import User from './types/User';
/**
* The event types endpoint.
* @export default
* @class EventTypes
* @extends {CalendlyApiEndpoint}
* @see https://developer.calendly.com/api-docs/ff9832c5a6640-get-user
*/
export default class Users extends CalendlyApiEndpoint {
/**
* Returns basic information about your user account.
* @returns {Promise<User>} The current user.
* @see https://developer.calendly.com/api-docs/005832c83aeae-get-current-user
* @example const user = await calendly.users.getCurrentUser();
*
*/
getCurrentUser(): Promise<User>;
/**
* Returns information about a specified User.
* @param params The request parameters.
* @returns {Promise<User>} The user.
* @see https://developer.calendly.com/api-docs/ff9832c5a6640-get-user
* @example const user = await calendly.users.getUser({ uuid: 'user-uuid' });
*/
getUser(params: UserQueryParameters): Promise<User>;
}
export declare type UserQueryParameters = {
uuid: string;
};
//# sourceMappingURL=Users.d.ts.map