@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>
95 lines • 3.42 kB
TypeScript
import * as z from "zod/v3";
import { ClosedEnum } from "../types/enums.js";
import { Result as SafeParseResult } from "../types/fp.js";
import { Drive } from "./drive.js";
import { SDKValidationError } from "./sdkvalidationerror.js";
/**
* Field to sort drives by.
*/
export declare const ListDrivesQueryParamSortBy: {
readonly CreatedAt: "createdAt";
readonly UpdatedAt: "updatedAt";
readonly Name: "name";
};
/**
* Field to sort drives by.
*/
export type ListDrivesQueryParamSortBy = ClosedEnum<typeof ListDrivesQueryParamSortBy>;
/**
* Sort direction for results.
*/
export declare const ListDrivesQueryParamSortOrder: {
readonly Asc: "asc";
readonly Desc: "desc";
};
/**
* Sort direction for results.
*/
export type ListDrivesQueryParamSortOrder = ClosedEnum<typeof ListDrivesQueryParamSortOrder>;
export type ListDrivesRequest = {
/**
* The project ID or name associated with the drives. Required unless using a Vercel OIDC token scoped to a project.
*/
projectId?: string | undefined;
/**
* Maximum number of drives to return in the response. Used for pagination.
*/
limit?: number | undefined;
/**
* Opaque pagination cursor from a previous response.
*/
cursor?: string | undefined;
/**
* Field to sort drives by.
*/
sortBy?: ListDrivesQueryParamSortBy | undefined;
/**
* Filter drives whose name starts with this prefix. Only valid when sortBy=name.
*/
namePrefix?: string | undefined;
/**
* Sort direction for results.
*/
sortOrder?: ListDrivesQueryParamSortOrder | 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;
};
export type ListDrivesPagination = {
count: number;
next: string | null;
};
export type ListDrivesResponseBody = {
drives: Array<Drive>;
pagination: ListDrivesPagination;
};
/** @internal */
export declare const ListDrivesQueryParamSortBy$outboundSchema: z.ZodNativeEnum<typeof ListDrivesQueryParamSortBy>;
/** @internal */
export declare const ListDrivesQueryParamSortOrder$outboundSchema: z.ZodNativeEnum<typeof ListDrivesQueryParamSortOrder>;
/** @internal */
export type ListDrivesRequest$Outbound = {
projectId?: string | undefined;
limit: number;
cursor?: string | undefined;
sortBy: string;
namePrefix?: string | undefined;
sortOrder: string;
teamId?: string | undefined;
slug?: string | undefined;
};
/** @internal */
export declare const ListDrivesRequest$outboundSchema: z.ZodType<ListDrivesRequest$Outbound, z.ZodTypeDef, ListDrivesRequest>;
export declare function listDrivesRequestToJSON(listDrivesRequest: ListDrivesRequest): string;
/** @internal */
export declare const ListDrivesPagination$inboundSchema: z.ZodType<ListDrivesPagination, z.ZodTypeDef, unknown>;
export declare function listDrivesPaginationFromJSON(jsonString: string): SafeParseResult<ListDrivesPagination, SDKValidationError>;
/** @internal */
export declare const ListDrivesResponseBody$inboundSchema: z.ZodType<ListDrivesResponseBody, z.ZodTypeDef, unknown>;
export declare function listDrivesResponseBodyFromJSON(jsonString: string): SafeParseResult<ListDrivesResponseBody, SDKValidationError>;
//# sourceMappingURL=listdrivesop.d.ts.map