@37signals/basecamp 0.2.0

package/src/generated/services/todolist-groups.ts

@@ -0,0 +1,151 @@
+/**
+ * TodolistGroups service for the Basecamp API.
+ *
+ * @generated from OpenAPI spec - do not edit directly
+ */
+
+import { BaseService } from "../../services/base.js";
+import type { components } from "../schema.js";
+import { ListResult } from "../../pagination.js";
+import type { PaginationOptions } from "../../pagination.js";
+import { Errors } from "../../errors.js";
+
+// =============================================================================
+// Types
+// =============================================================================
+
+/** TodolistGroup entity from the Basecamp API. */
+export type TodolistGroup = components["schemas"]["TodolistGroup"];
+
+/**
+ * Request parameters for reposition.
+ */
+export interface RepositionTodolistGroupRequest {
+  /** Position for ordering (1-based) */
+  position: number;
+}
+
+/**
+ * Options for list.
+ */
+export interface ListTodolistGroupOptions extends PaginationOptions {
+}
+
+/**
+ * Request parameters for create.
+ */
+export interface CreateTodolistGroupRequest {
+  /** Display name */
+  name: string;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for TodolistGroups operations.
+ */
+export class TodolistGroupsService extends BaseService {
+
+  /**
+   * Reposition a todolist group
+   * @param groupId - The group ID
+   * @param req - Todolist_group request parameters
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.todolistGroups.reposition(123, { position: 1 });
+   * ```
+   */
+  async reposition(groupId: number, req: RepositionTodolistGroupRequest): Promise<void> {
+    await this.request(
+      {
+        service: "TodolistGroups",
+        operation: "RepositionTodolistGroup",
+        resourceType: "todolist_group",
+        isMutation: true,
+        resourceId: groupId,
+      },
+      () =>
+        this.client.PUT("/todolists/{groupId}/position.json", {
+          params: {
+            path: { groupId },
+          },
+          body: {
+            position: req.position,
+          },
+        })
+    );
+  }
+
+  /**
+   * List groups in a todolist
+   * @param todolistId - The todolist ID
+   * @param options - Optional query parameters
+   * @returns All TodolistGroup across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.todolistGroups.list(123);
+   * ```
+   */
+  async list(todolistId: number, options?: ListTodolistGroupOptions): Promise<ListResult<TodolistGroup>> {
+    return this.requestPaginated(
+      {
+        service: "TodolistGroups",
+        operation: "ListTodolistGroups",
+        resourceType: "todolist_group",
+        isMutation: false,
+        resourceId: todolistId,
+      },
+      () =>
+        this.client.GET("/todolists/{todolistId}/groups.json", {
+          params: {
+            path: { todolistId },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * Create a new group in a todolist
+   * @param todolistId - The todolist ID
+   * @param req - Todolist_group creation parameters
+   * @returns The TodolistGroup
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.todolistGroups.create(123, { name: "My example" });
+   * ```
+   */
+  async create(todolistId: number, req: CreateTodolistGroupRequest): Promise<TodolistGroup> {
+    if (!req.name) {
+      throw Errors.validation("Name is required");
+    }
+    const response = await this.request(
+      {
+        service: "TodolistGroups",
+        operation: "CreateTodolistGroup",
+        resourceType: "todolist_group",
+        isMutation: true,
+        resourceId: todolistId,
+      },
+      () =>
+        this.client.POST("/todolists/{todolistId}/groups.json", {
+          params: {
+            path: { todolistId },
+          },
+          body: {
+            name: req.name,
+          },
+        })
+    );
+    return response;
+  }
+}

package/src/generated/services/todolists.ts

@@ -0,0 +1,192 @@
+/**
+ * Todolists service for the Basecamp API.
+ *
+ * @generated from OpenAPI spec - do not edit directly
+ */
+
+import { BaseService } from "../../services/base.js";
+import type { components } from "../schema.js";
+import { ListResult } from "../../pagination.js";
+import type { PaginationOptions } from "../../pagination.js";
+import { Errors } from "../../errors.js";
+
+// =============================================================================
+// Types
+// =============================================================================
+
+/** Todolist entity from the Basecamp API. */
+export type Todolist = components["schemas"]["Todolist"];
+
+/**
+ * Request parameters for update.
+ */
+export interface UpdateTodolistRequest {
+  /** Name (required for both Todolist and TodolistGroup) */
+  name?: string;
+  /** Description (Todolist only, ignored for groups) */
+  description?: string;
+}
+
+/**
+ * Options for list.
+ */
+export interface ListTodolistOptions extends PaginationOptions {
+  /** Filter by status */
+  status?: "active" | "archived" | "trashed";
+}
+
+/**
+ * Request parameters for create.
+ */
+export interface CreateTodolistRequest {
+  /** Display name */
+  name: string;
+  /** Rich text description (HTML) */
+  description?: string;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Todolists operations.
+ */
+export class TodolistsService extends BaseService {
+
+  /**
+   * Get a single todolist or todolist group by id
+   * @param id - The id
+   * @returns The todolist_or_group
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.todolists.get(123);
+   * ```
+   */
+  async get(id: number): Promise<components["schemas"]["GetTodolistOrGroupResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "Todolists",
+        operation: "GetTodolistOrGroup",
+        resourceType: "todolist_or_group",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/todolists/{id}", {
+          params: {
+            path: { id },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Update an existing todolist or todolist group
+   * @param id - The id
+   * @param req - Todolist_or_group update parameters
+   * @returns The todolist_or_group
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.todolists.update(123, { });
+   * ```
+   */
+  async update(id: number, req: UpdateTodolistRequest): Promise<components["schemas"]["UpdateTodolistOrGroupResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "Todolists",
+        operation: "UpdateTodolistOrGroup",
+        resourceType: "todolist_or_group",
+        isMutation: true,
+      },
+      () =>
+        this.client.PUT("/todolists/{id}", {
+          params: {
+            path: { id },
+          },
+          body: {
+            name: req.name,
+            description: req.description,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * List todolists in a todoset
+   * @param todosetId - The todoset ID
+   * @param options - Optional query parameters
+   * @returns All Todolist across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.todolists.list(123);
+   *
+   * // With options
+   * const filtered = await client.todolists.list(123, { status: "active" });
+   * ```
+   */
+  async list(todosetId: number, options?: ListTodolistOptions): Promise<ListResult<Todolist>> {
+    return this.requestPaginated(
+      {
+        service: "Todolists",
+        operation: "ListTodolists",
+        resourceType: "todolist",
+        isMutation: false,
+        resourceId: todosetId,
+      },
+      () =>
+        this.client.GET("/todosets/{todosetId}/todolists.json", {
+          params: {
+            path: { todosetId },
+            query: { status: options?.status },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * Create a new todolist in a todoset
+   * @param todosetId - The todoset ID
+   * @param req - Todolist creation parameters
+   * @returns The Todolist
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.todolists.create(123, { name: "My example" });
+   * ```
+   */
+  async create(todosetId: number, req: CreateTodolistRequest): Promise<Todolist> {
+    if (!req.name) {
+      throw Errors.validation("Name is required");
+    }
+    const response = await this.request(
+      {
+        service: "Todolists",
+        operation: "CreateTodolist",
+        resourceType: "todolist",
+        isMutation: true,
+        resourceId: todosetId,
+      },
+      () =>
+        this.client.POST("/todosets/{todosetId}/todolists.json", {
+          params: {
+            path: { todosetId },
+          },
+          body: {
+            name: req.name,
+            description: req.description,
+          },
+        })
+    );
+    return response;
+  }
+}

package/src/generated/services/todos.ts

@@ -0,0 +1,369 @@
+/**
+ * Todos service for the Basecamp API.
+ *
+ * @generated from OpenAPI spec - do not edit directly
+ */
+
+import { BaseService } from "../../services/base.js";
+import type { components } from "../schema.js";
+import { ListResult } from "../../pagination.js";
+import type { PaginationOptions } from "../../pagination.js";
+import { Errors } from "../../errors.js";
+
+// =============================================================================
+// Types
+// =============================================================================
+
+/** Todo entity from the Basecamp API. */
+export type Todo = components["schemas"]["Todo"];
+
+/**
+ * Options for list.
+ */
+export interface ListTodoOptions extends PaginationOptions {
+  /** Filter by status */
+  status?: "active" | "archived" | "trashed";
+  /** Completed */
+  completed?: boolean;
+}
+
+/**
+ * Request parameters for create.
+ */
+export interface CreateTodoRequest {
+  /** Text content */
+  content: string;
+  /** Rich text description (HTML) */
+  description?: string;
+  /** Person IDs to assign to */
+  assigneeIds?: number[];
+  /** Person IDs to notify on completion */
+  completionSubscriberIds?: number[];
+  /** Whether to send notifications to relevant people */
+  notify?: boolean;
+  /** Due date (YYYY-MM-DD) */
+  dueOn?: string;
+  /** Start date (YYYY-MM-DD) */
+  startsOn?: string;
+}
+
+/**
+ * Request parameters for update.
+ */
+export interface UpdateTodoRequest {
+  /** Text content */
+  content?: string;
+  /** Rich text description (HTML) */
+  description?: string;
+  /** Person IDs to assign to */
+  assigneeIds?: number[];
+  /** Person IDs to notify on completion */
+  completionSubscriberIds?: number[];
+  /** Whether to send notifications to relevant people */
+  notify?: boolean;
+  /** Due date (YYYY-MM-DD) */
+  dueOn?: string;
+  /** Start date (YYYY-MM-DD) */
+  startsOn?: string;
+}
+
+/**
+ * Request parameters for reposition.
+ */
+export interface RepositionTodoRequest {
+  /** Position for ordering (1-based) */
+  position: number;
+  /** Optional todolist ID to move the todo to a different parent */
+  parentId?: number;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Todos operations.
+ */
+export class TodosService extends BaseService {
+
+  /**
+   * List todos in a todolist
+   * @param todolistId - The todolist ID
+   * @param options - Optional query parameters
+   * @returns All Todo across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.todos.list(123);
+   *
+   * // With options
+   * const filtered = await client.todos.list(123, { status: "active" });
+   * ```
+   */
+  async list(todolistId: number, options?: ListTodoOptions): Promise<ListResult<Todo>> {
+    return this.requestPaginated(
+      {
+        service: "Todos",
+        operation: "ListTodos",
+        resourceType: "todo",
+        isMutation: false,
+        resourceId: todolistId,
+      },
+      () =>
+        this.client.GET("/todolists/{todolistId}/todos.json", {
+          params: {
+            path: { todolistId },
+            query: { status: options?.status, completed: options?.completed },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * Create a new todo in a todolist
+   * @param todolistId - The todolist ID
+   * @param req - Todo creation parameters
+   * @returns The Todo
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.todos.create(123, { content: "Hello world" });
+   * ```
+   */
+  async create(todolistId: number, req: CreateTodoRequest): Promise<Todo> {
+    if (!req.content) {
+      throw Errors.validation("Content is required");
+    }
+    if (req.dueOn && !/^\d{4}-\d{2}-\d{2}$/.test(req.dueOn)) {
+      throw Errors.validation("Due on must be in YYYY-MM-DD format");
+    }
+    if (req.startsOn && !/^\d{4}-\d{2}-\d{2}$/.test(req.startsOn)) {
+      throw Errors.validation("Starts on must be in YYYY-MM-DD format");
+    }
+    const response = await this.request(
+      {
+        service: "Todos",
+        operation: "CreateTodo",
+        resourceType: "todo",
+        isMutation: true,
+        resourceId: todolistId,
+      },
+      () =>
+        this.client.POST("/todolists/{todolistId}/todos.json", {
+          params: {
+            path: { todolistId },
+          },
+          body: {
+            content: req.content,
+            description: req.description,
+            assignee_ids: req.assigneeIds,
+            completion_subscriber_ids: req.completionSubscriberIds,
+            notify: req.notify,
+            due_on: req.dueOn,
+            starts_on: req.startsOn,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Get a single todo by id
+   * @param todoId - The todo ID
+   * @returns The Todo
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.todos.get(123);
+   * ```
+   */
+  async get(todoId: number): Promise<Todo> {
+    const response = await this.request(
+      {
+        service: "Todos",
+        operation: "GetTodo",
+        resourceType: "todo",
+        isMutation: false,
+        resourceId: todoId,
+      },
+      () =>
+        this.client.GET("/todos/{todoId}", {
+          params: {
+            path: { todoId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Update an existing todo
+   * @param todoId - The todo ID
+   * @param req - Todo update parameters
+   * @returns The Todo
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.todos.update(123, { });
+   * ```
+   */
+  async update(todoId: number, req: UpdateTodoRequest): Promise<Todo> {
+    if (req.dueOn && !/^\d{4}-\d{2}-\d{2}$/.test(req.dueOn)) {
+      throw Errors.validation("Due on must be in YYYY-MM-DD format");
+    }
+    if (req.startsOn && !/^\d{4}-\d{2}-\d{2}$/.test(req.startsOn)) {
+      throw Errors.validation("Starts on must be in YYYY-MM-DD format");
+    }
+    const response = await this.request(
+      {
+        service: "Todos",
+        operation: "UpdateTodo",
+        resourceType: "todo",
+        isMutation: true,
+        resourceId: todoId,
+      },
+      () =>
+        this.client.PUT("/todos/{todoId}", {
+          params: {
+            path: { todoId },
+          },
+          body: {
+            content: req.content,
+            description: req.description,
+            assignee_ids: req.assigneeIds,
+            completion_subscriber_ids: req.completionSubscriberIds,
+            notify: req.notify,
+            due_on: req.dueOn,
+            starts_on: req.startsOn,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Trash a todo. Trashed items can be recovered.
+   * @param todoId - The todo ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.todos.trash(123);
+   * ```
+   */
+  async trash(todoId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Todos",
+        operation: "TrashTodo",
+        resourceType: "todo",
+        isMutation: true,
+        resourceId: todoId,
+      },
+      () =>
+        this.client.DELETE("/todos/{todoId}", {
+          params: {
+            path: { todoId },
+          },
+        })
+    );
+  }
+
+  /**
+   * Mark a todo as complete
+   * @param todoId - The todo ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.todos.complete(123);
+   * ```
+   */
+  async complete(todoId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Todos",
+        operation: "CompleteTodo",
+        resourceType: "todo",
+        isMutation: true,
+        resourceId: todoId,
+      },
+      () =>
+        this.client.POST("/todos/{todoId}/completion.json", {
+          params: {
+            path: { todoId },
+          },
+        })
+    );
+  }
+
+  /**
+   * Mark a todo as incomplete
+   * @param todoId - The todo ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.todos.uncomplete(123);
+   * ```
+   */
+  async uncomplete(todoId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Todos",
+        operation: "UncompleteTodo",
+        resourceType: "todo",
+        isMutation: true,
+        resourceId: todoId,
+      },
+      () =>
+        this.client.DELETE("/todos/{todoId}/completion.json", {
+          params: {
+            path: { todoId },
+          },
+        })
+    );
+  }
+
+  /**
+   * Reposition a todo within its todolist
+   * @param todoId - The todo ID
+   * @param req - Todo request parameters
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.todos.reposition(123, { position: 1 });
+   * ```
+   */
+  async reposition(todoId: number, req: RepositionTodoRequest): Promise<void> {
+    await this.request(
+      {
+        service: "Todos",
+        operation: "RepositionTodo",
+        resourceType: "todo",
+        isMutation: true,
+        resourceId: todoId,
+      },
+      () =>
+        this.client.PUT("/todos/{todoId}/position.json", {
+          params: {
+            path: { todoId },
+          },
+          body: {
+            position: req.position,
+            parent_id: req.parentId,
+          },
+        })
+    );
+  }
+}