feat: Add complete workspace endpoints support (#372)

Co-authored-by: Claude <[email protected]>

Author: scottlovegrove

src/TodoistApi.ts

@@ -51,3 +51,30 @@ export const ENDPOINT_AUTHORIZATION = 'authorize'
 export const ENDPOINT_GET_TOKEN = 'access_token'
 export const ENDPOINT_REVOKE_TOKEN = 'access_tokens/revoke'
 export const ENDPOINT_REVOKE = 'revoke'
+
+// Workspace endpoints
+export const ENDPOINT_WORKSPACE_INVITATIONS = 'workspaces/invitations'
+export const ENDPOINT_WORKSPACE_INVITATIONS_ALL = 'workspaces/invitations/all'
+export const ENDPOINT_WORKSPACE_INVITATIONS_DELETE = 'workspaces/invitations/delete'
+export const ENDPOINT_WORKSPACE_JOIN = 'workspaces/join'
+export const ENDPOINT_WORKSPACE_LOGO = 'workspaces/logo'
+export const ENDPOINT_WORKSPACE_PLAN_DETAILS = 'workspaces/plan_details'
+export const ENDPOINT_WORKSPACE_USERS = 'workspaces/users'
+
+// Workspace invitation actions (require invite_code parameter)
+export function getWorkspaceInvitationAcceptEndpoint(inviteCode: string): string {
+    return `workspaces/invitations/${inviteCode}/accept`
+}
+
+export function getWorkspaceInvitationRejectEndpoint(inviteCode: string): string {
+    return `workspaces/invitations/${inviteCode}/reject`
+}
+
+// Workspace projects (require workspace_id parameter)
+export function getWorkspaceActiveProjectsEndpoint(workspaceId: number): string {
+    return `workspaces/${workspaceId}/projects/active`
+}
+
+export function getWorkspaceArchivedProjectsEndpoint(workspaceId: number): string {
+    return `workspaces/${workspaceId}/projects/archived`
+}

src/TodoistApi.workspaces.test.ts

@@ -136,6 +136,11 @@ export async function request<T>(
                     relativePath,
                     hasSyncCommands ? JSON.stringify(payload) : payload,
                 )
+            case 'PUT':
+                return await axiosClient.put<T>(
+                    relativePath,
+                    hasSyncCommands ? JSON.stringify(payload) : payload,
+                )
             case 'DELETE':
                 return await axiosClient.delete<T>(relativePath)
         }

src/consts/endpoints.ts

@@ -472,3 +472,104 @@ export const ActivityEventSchema = z
  * Represents an activity log event in Todoist.
  */
 export type ActivityEvent = z.infer<typeof ActivityEventSchema>
+
+/**
+ * Available workspace roles.
+ */
+export const WORKSPACE_ROLES = ['ADMIN', 'MEMBER', 'GUEST'] as const
+
+/**
+ * Role of a user within a workspace.
+ */
+export type WorkspaceRole = (typeof WORKSPACE_ROLES)[number]
+
+export const WorkspaceRoleSchema = z.enum(WORKSPACE_ROLES)
+
+export const WorkspaceUserSchema = z.object({
+    userId: z.string(),
+    workspaceId: z.string(),
+    userEmail: z.string(),
+    fullName: z.string(),
+    timezone: z.string(),
+    role: WorkspaceRoleSchema,
+    imageId: z.string().nullable(),
+    isDeleted: z.boolean().default(false),
+})
+
+/**
+ * Represents a user within a workspace (MemberView from API).
+ */
+export type WorkspaceUser = z.infer<typeof WorkspaceUserSchema>
+
+export const WorkspaceInvitationSchema = z.object({
+    id: z.string().default('0'),
+    inviterId: z.string(),
+    userEmail: z.string(),
+    workspaceId: z.string(),
+    role: WorkspaceRoleSchema,
+    isExistingUser: z.boolean(),
+})
+
+/**
+ * Represents a workspace invitation.
+ */
+export type WorkspaceInvitation = z.infer<typeof WorkspaceInvitationSchema>
+
+export const PlanPriceSchema = z.object({
+    currency: z.string(),
+    amount: z.union([z.number(), z.string()]),
+    interval: z.string().optional(),
+})
+
+/**
+ * Plan pricing information.
+ */
+export type PlanPrice = z.infer<typeof PlanPriceSchema>
+
+export const FormattedPriceListingSchema = z.object({
+    currency: z.string().optional(),
+    amount: z.number().optional(),
+    interval: z.string().optional(),
+    formatted: z.string().optional(),
+})
+
+/**
+ * Formatted price listing for workspace plans.
+ */
+export type FormattedPriceListing = z.infer<typeof FormattedPriceListingSchema>
+
+export const WorkspacePlanDetailsSchema = z.object({
+    currentMemberCount: z.number(),
+    currentPlan: z.enum(['Business', 'Starter']),
+    currentPlanStatus: z.enum(['Active', 'Downgraded', 'Cancelled', 'NeverSubscribed']),
+    downgradeAt: z.string().nullable(),
+    currentActiveProjects: z.number(),
+    maximumActiveProjects: z.number(),
+    priceList: z.array(FormattedPriceListingSchema),
+    workspaceId: z.number(),
+    isTrialing: z.boolean(),
+    trialEndsAt: z.string().nullable(),
+    cancelAtPeriodEnd: z.boolean(),
+    hasTrialed: z.boolean(),
+    planPrice: PlanPriceSchema.nullable(),
+    hasBillingPortal: z.boolean(),
+    hasBillingPortalSwitchToAnnual: z.boolean(),
+})
+
+/**
+ * Represents workspace plan and billing details.
+ */
+export type WorkspacePlanDetails = z.infer<typeof WorkspacePlanDetailsSchema>
+
+export const JoinWorkspaceResultSchema = z.object({
+    custom_sorting_applied: z.boolean(),
+    project_sort_preference: z.string(),
+    role: WorkspaceRoleSchema,
+    user_id: z.string(),
+    workspace_id: z.string(),
+})
+
+/**
+ * Result returned when successfully joining a workspace.
+ */
+export type JoinWorkspaceResult = z.infer<typeof JoinWorkspaceResultSchema>

src/restClient.ts

@@ -1 +1 @@
-export type HttpMethod = 'POST' | 'GET' | 'DELETE'
+export type HttpMethod = 'POST' | 'GET' | 'DELETE' | 'PUT'

src/types/entities.ts

@@ -570,3 +570,154 @@ export type DeleteUploadArgs = {
      */
     fileUrl: string
 }
+
+// Workspace-related types
+
+/**
+ * Arguments for getting workspace invitations.
+ */
+export type GetWorkspaceInvitationsArgs = {
+    /**
+     * The workspace ID to get invitations for.
+     */
+    workspaceId: number
+}
+
+/**
+ * Arguments for deleting a workspace invitation.
+ */
+export type DeleteWorkspaceInvitationArgs = {
+    /**
+     * The workspace ID.
+     */
+    workspaceId: number
+    /**
+     * The email address of the invitation to delete.
+     */
+    userEmail: string
+}
+
+/**
+ * Arguments for accepting/rejecting a workspace invitation.
+ */
+export type WorkspaceInvitationActionArgs = {
+    /**
+     * The invitation code from the email.
+     */
+    inviteCode: string
+}
+
+/**
+ * Arguments for joining a workspace.
+ */
+export type JoinWorkspaceArgs = {
+    /**
+     * Optional invitation code/link to join via.
+     */
+    inviteCode?: string | null
+    /**
+     * Optional workspace ID to join via domain auto-join.
+     */
+    workspaceId?: number | null
+}
+
+/**
+ * Arguments for uploading/updating workspace logo.
+ */
+export type WorkspaceLogoArgs = {
+    /**
+     * The workspace ID.
+     */
+    workspaceId: number
+    /**
+     * The image file to upload (Buffer, Stream, or file path).
+     */
+    file?: Buffer | NodeJS.ReadableStream | string
+    /**
+     * The file name (required for Buffer/Stream uploads).
+     */
+    fileName?: string
+    /**
+     * Whether to delete the logo instead of updating it.
+     */
+    delete?: boolean
+}
+
+/**
+ * Arguments for getting workspace plan details.
+ */
+export type GetWorkspacePlanDetailsArgs = {
+    /**
+     * The workspace ID.
+     */
+    workspaceId: number
+}
+
+/**
+ * Arguments for getting workspace users (paginated).
+ */
+export type GetWorkspaceUsersArgs = {
+    /**
+     * Optional workspace ID. If not provided, returns users for all workspaces.
+     */
+    workspaceId?: number | null
+    /**
+     * Cursor for pagination.
+     */
+    cursor?: string | null
+    /**
+     * Maximum number of users to return (default: 100).
+     */
+    limit?: number
+}
+
+/**
+ * Arguments for getting workspace projects (paginated).
+ */
+export type GetWorkspaceProjectsArgs = {
+    /**
+     * The workspace ID.
+     */
+    workspaceId: number
+    /**
+     * Cursor for pagination.
+     */
+    cursor?: string | null
+    /**
+     * Maximum number of projects to return (default: 100).
+     */
+    limit?: number
+}
+
+/**
+ * Paginated response for workspace users.
+ */
+export type GetWorkspaceUsersResponse = {
+    /**
+     * Whether there are more users available.
+     */
+    hasMore: boolean
+    /**
+     * Cursor for the next page of results.
+     */
+    nextCursor?: string
+    /**
+     * Array of workspace users.
+     */
+    workspaceUsers: import('./entities').WorkspaceUser[]
+}
+
+/**
+ * Response type for workspace invitations endpoint (simple email list).
+ */
+export type WorkspaceInvitationsResponse = string[]
+
+/**
+ * Response type for all workspace invitations endpoint (detailed objects).
+ */
+export type AllWorkspaceInvitationsResponse = import('./entities').WorkspaceInvitation[]
+
+/**
+ * Response type for workspace logo upload.
+ */
+export type WorkspaceLogoResponse = Record<string, unknown> | null