@theventures/caret
Version:
Unofficial Node.js API client for the Caret HTTP API
41 lines • 1.44 kB
TypeScript
import { APIResource } from "../core/resource.js";
import type { CreatedGroup, Group, GroupCreateParams, Invite, InviteCreateParams, InviteDeleteResponse, InvitesListParams, InvitesListResponse, Member, MembersListParams, MembersListResponse, MemberUpdateParams, Workspace as WorkspaceType } from "../types/workspace.js";
export declare class Workspace extends APIResource {
/**
* Get the workspace details
*/
get(): Promise<WorkspaceType>;
/**
* List all members in the workspace
*/
listMembers(params?: MembersListParams): Promise<MembersListResponse>;
/**
* Get a specific member by ID
*/
getMember(id: string): Promise<Member>;
/**
* Update a member's group assignments
*/
updateMember(id: string, params: MemberUpdateParams): Promise<Member>;
/**
* List all groups in the workspace
*/
listGroups(): Promise<Group[]>;
/**
* Create a new group in the workspace
*/
createGroup(params: GroupCreateParams): Promise<CreatedGroup>;
/**
* List all invites in the workspace
*/
listInvites(params?: InvitesListParams): Promise<InvitesListResponse>;
/**
* Create a new invite to the workspace
*/
createInvite(params: InviteCreateParams): Promise<Invite>;
/**
* Delete an existing invite
*/
deleteInvite(id: string): Promise<InviteDeleteResponse>;
}
//# sourceMappingURL=workspace.d.ts.map