@vercel/sdk
Version:
<p align="center"> <a href="https://vercel.com"> <img src="https://assets.vercel.com/image/upload/v1588805858/repositories/vercel/logo.png" height="96"> <h3 align="center">Vercel</h3> </a> <p align="center">Develop. Preview. Ship.</p> </p>
37 lines • 1.95 kB
TypeScript
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
import { GetAuthUserResponseBody } from "../models/getauthuserop.js";
import { ListEventTypesRequest } from "../models/listeventtypesop.js";
import { ListEventTypesResponse } from "../models/listeventtypesresponse.js";
import { ListUserEventsRequest, ListUserEventsResponseBody } from "../models/listusereventsop.js";
import { RequestDeleteRequestBody, RequestDeleteResponseBody } from "../models/requestdeleteop.js";
export declare class User extends ClientSDK {
/**
* List User Events
*
* @remarks
* Retrieves a list of "events" generated by the User on Vercel. Events are generated when the User performs a particular action, such as logging in, creating a deployment, and joining a Team (just to name a few). When the `teamId` parameter is supplied, then the events that are returned will be in relation to the Team that was specified.
*/
listUserEvents(request: ListUserEventsRequest, options?: RequestOptions): Promise<ListUserEventsResponseBody>;
/**
* List Event Types
*
* @remarks
* Returns the list of user-facing event types with descriptions.
*/
listEventTypes(request: ListEventTypesRequest, options?: RequestOptions): Promise<ListEventTypesResponse>;
/**
* Get the User
*
* @remarks
* Retrieves information related to the currently authenticated User.
*/
getAuthUser(options?: RequestOptions): Promise<GetAuthUserResponseBody | undefined>;
/**
* Delete User Account
*
* @remarks
* Initiates the deletion process for the currently authenticated User, by sending a deletion confirmation email. The email contains a link that the user needs to visit in order to proceed with the deletion process.
*/
requestDelete(request: RequestDeleteRequestBody, options?: RequestOptions): Promise<RequestDeleteResponseBody>;
}
//# sourceMappingURL=user.d.ts.map