Workspace Members Data Structures

interface InviteMemberRequest {
  /** Email address of the user to invite */
  email: string;
  /** Role to assign to the member */
  role: Role;
}

interface InviteMemberResponse {
  /** Whether the invitation was successful */
  ok: boolean;
  /** Optional message describing the result */
  message?: string;
  /** Optional error code (e.g., 'plan/limit-reached') */
  code?: string;
}

interface Member {
  /** Unique member identifier */
  id: string;
  role: Role;
  status: Status;
  /** ISO 8601 timestamp of when the member joined (empty string for pending invites) */
  createdAt: string;
  /** ISO 8601 timestamp of when the member was last updated (optional) */
  updatedAt?: string;
  user: User;
}

interface PaginatedMembers {
  /** Array of workspace members */
  items: Member[];
  /** Current page number (1-indexed) */
  page: number;
  /** Number of items per page */
  limit: number;
  /** Total number of items across all pages */
  total: number;
  /** Total number of pages */
  totalPages: number;
  /** Whether there is a next page */
  hasNext: boolean;
  /** Whether there is a previous page */
  hasPrev: boolean;
}

interface RemoveMemberResponse {
  /** Whether the removal was successful */
  ok: boolean;
  /** Optional message describing the result */
  message?: string;
}

type Role = "owner" | "admin" | "member" | "viewer";

type Status = "active" | "inactive" | "invited";

interface UpdateMemberRoleRequest {
  /** New role to assign to the member (cannot be 'owner') */
  role: Role;
}

interface UpdateMemberRoleResponse {
  /** Whether the role update was successful */
  ok: boolean;
  /** Optional message describing the result */
  message?: string;
}

interface User {
  /** Unique user identifier (empty string for pending invites) */
  id: string;
  /** User email address */
  email: string;
  /** User's full name */
  fullName: string;
  /** URL to user's avatar image */
  avatarUrl?: string;
  /** ISO 8601 timestamp of when the user account was created (empty string for pending invites) */
  createdAt: string;
  /** ISO 8601 timestamp of when the user account was last updated (empty string for pending invites) */
  updatedAt: string;
}