@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>
132 lines • 4.95 kB
TypeScript
import * as z from "zod/v3";
import { ClosedEnum } from "../types/enums.js";
import { Result as SafeParseResult } from "../types/fp.js";
import { SDKValidationError } from "./sdkvalidationerror.js";
/**
* The project role that will be added to this Access Group. "null" will remove this project level role.
*/
export declare const UpdateAccessGroupRole: {
readonly Admin: "ADMIN";
readonly ProjectViewer: "PROJECT_VIEWER";
readonly ProjectDeveloper: "PROJECT_DEVELOPER";
};
/**
* The project role that will be added to this Access Group. "null" will remove this project level role.
*/
export type UpdateAccessGroupRole = ClosedEnum<typeof UpdateAccessGroupRole>;
export type UpdateAccessGroupProjects = {
/**
* The ID of the project.
*/
projectId: string;
/**
* The project role that will be added to this Access Group. "null" will remove this project level role.
*/
role: UpdateAccessGroupRole | null;
};
export type UpdateAccessGroupRequestBody = {
/**
* The name of the access group
*/
name?: string | undefined;
projects?: Array<UpdateAccessGroupProjects> | undefined;
/**
* List of members to add to the access group.
*/
membersToAdd?: Array<string> | undefined;
/**
* List of members to remove from the access group.
*/
membersToRemove?: Array<string> | undefined;
};
export type UpdateAccessGroupRequest = {
idOrName: string;
/**
* 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;
requestBody: UpdateAccessGroupRequestBody;
};
export declare const UpdateAccessGroupEntitlements: {
readonly V0: "v0";
};
export type UpdateAccessGroupEntitlements = ClosedEnum<typeof UpdateAccessGroupEntitlements>;
export type UpdateAccessGroupResponseBody = {
entitlements: Array<UpdateAccessGroupEntitlements>;
/**
* The name of this access group.
*/
name: string;
/**
* Timestamp in milliseconds when the access group was created.
*/
createdAt: string;
/**
* ID of the team that this access group belongs to.
*/
teamId: string;
/**
* Timestamp in milliseconds when the access group was last updated.
*/
updatedAt: string;
/**
* ID of the access group.
*/
accessGroupId: string;
/**
* Number of members in the access group.
*/
membersCount: number;
/**
* Number of projects in the access group.
*/
projectsCount: number;
/**
* Roles that the team has in the access group.
*/
teamRoles?: Array<string> | undefined;
/**
* Permissions that the team has in the access group.
*/
teamPermissions?: Array<string> | undefined;
};
/** @internal */
export declare const UpdateAccessGroupRole$outboundSchema: z.ZodNativeEnum<typeof UpdateAccessGroupRole>;
/** @internal */
export type UpdateAccessGroupProjects$Outbound = {
projectId: string;
role: string | null;
};
/** @internal */
export declare const UpdateAccessGroupProjects$outboundSchema: z.ZodType<UpdateAccessGroupProjects$Outbound, z.ZodTypeDef, UpdateAccessGroupProjects>;
export declare function updateAccessGroupProjectsToJSON(updateAccessGroupProjects: UpdateAccessGroupProjects): string;
/** @internal */
export type UpdateAccessGroupRequestBody$Outbound = {
name?: string | undefined;
projects?: Array<UpdateAccessGroupProjects$Outbound> | undefined;
membersToAdd?: Array<string> | undefined;
membersToRemove?: Array<string> | undefined;
};
/** @internal */
export declare const UpdateAccessGroupRequestBody$outboundSchema: z.ZodType<UpdateAccessGroupRequestBody$Outbound, z.ZodTypeDef, UpdateAccessGroupRequestBody>;
export declare function updateAccessGroupRequestBodyToJSON(updateAccessGroupRequestBody: UpdateAccessGroupRequestBody): string;
/** @internal */
export type UpdateAccessGroupRequest$Outbound = {
idOrName: string;
teamId?: string | undefined;
slug?: string | undefined;
RequestBody: UpdateAccessGroupRequestBody$Outbound;
};
/** @internal */
export declare const UpdateAccessGroupRequest$outboundSchema: z.ZodType<UpdateAccessGroupRequest$Outbound, z.ZodTypeDef, UpdateAccessGroupRequest>;
export declare function updateAccessGroupRequestToJSON(updateAccessGroupRequest: UpdateAccessGroupRequest): string;
/** @internal */
export declare const UpdateAccessGroupEntitlements$inboundSchema: z.ZodNativeEnum<typeof UpdateAccessGroupEntitlements>;
/** @internal */
export declare const UpdateAccessGroupResponseBody$inboundSchema: z.ZodType<UpdateAccessGroupResponseBody, z.ZodTypeDef, unknown>;
export declare function updateAccessGroupResponseBodyFromJSON(jsonString: string): SafeParseResult<UpdateAccessGroupResponseBody, SDKValidationError>;
//# sourceMappingURL=updateaccessgroupop.d.ts.map