@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>
75 lines • 2.68 kB
TypeScript
import * as z from "zod/v3";
import { Result as SafeParseResult } from "../types/fp.js";
import { SDKValidationError } from "./sdkvalidationerror.js";
import { UserEvent } from "./userevent.js";
export type ListUserEventsRequest = {
/**
* Maximum number of items which may be returned.
*/
limit?: number | undefined;
/**
* Timestamp to only include items created since then.
*/
since?: string | undefined;
/**
* Timestamp to only include items created until then.
*/
until?: string | undefined;
/**
* Comma-delimited list of event "types" to filter the results by.
*/
types?: string | undefined;
/**
* Deprecated. Use `principalId` instead. If `principalId` and `userId` both exist, `principalId` will be used.
*/
userId?: string | undefined;
/**
* When retrieving events for a Team, the `principalId` parameter may be specified to filter events generated by a specific principal.
*/
principalId?: string | undefined;
/**
* Comma-delimited list of project IDs to filter the results by.
*/
projectIds?: string | undefined;
/**
* When set to `true`, the response will include the `payload` field for each event.
*/
withPayload?: string | undefined;
/**
* The Team identifier to perform the request on behalf of.
*/
teamId?: string | undefined;
/**
* The Team slug to perform the request on behalf of.
*/
slug?: string | undefined;
};
/**
* Successful response.
*/
export type ListUserEventsResponseBody = {
/**
* Array of events generated by the User.
*/
events: Array<UserEvent>;
};
/** @internal */
export type ListUserEventsRequest$Outbound = {
limit?: number | undefined;
since?: string | undefined;
until?: string | undefined;
types?: string | undefined;
userId?: string | undefined;
principalId?: string | undefined;
projectIds?: string | undefined;
withPayload?: string | undefined;
teamId?: string | undefined;
slug?: string | undefined;
};
/** @internal */
export declare const ListUserEventsRequest$outboundSchema: z.ZodType<ListUserEventsRequest$Outbound, z.ZodTypeDef, ListUserEventsRequest>;
export declare function listUserEventsRequestToJSON(listUserEventsRequest: ListUserEventsRequest): string;
/** @internal */
export declare const ListUserEventsResponseBody$inboundSchema: z.ZodType<ListUserEventsResponseBody, z.ZodTypeDef, unknown>;
export declare function listUserEventsResponseBodyFromJSON(jsonString: string): SafeParseResult<ListUserEventsResponseBody, SDKValidationError>;
//# sourceMappingURL=listusereventsop.d.ts.map