@37signals/basecamp 0.2.0

package/dist/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,
+          },
+        })
+    );
+  }
+}

package/dist/generated/services/todosets.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Todosets 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";
+/** Todoset entity from the Basecamp API. */
+export type Todoset = components["schemas"]["Todoset"];
+/**
+ * Service for Todosets operations.
+ */
+export declare class TodosetsService extends BaseService {
+    /**
+     * Get a todoset (container for todolists in a project)
+     * @param todosetId - The todoset ID
+     * @returns The Todoset
+     * @throws {BasecampError} If the resource is not found
+     *
+     * @example
+     * ```ts
+     * const result = await client.todosets.get(123);
+     * ```
+     */
+    get(todosetId: number): Promise<Todoset>;
+}
+//# sourceMappingURL=todosets.d.ts.map

package/dist/generated/services/todosets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"todosets.d.ts","sourceRoot":"","sources":["../../../src/generated/services/todosets.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAM/C,4CAA4C;AAC5C,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC;AAMvD;;GAEG;AACH,qBAAa,eAAgB,SAAQ,WAAW;IAE9C;;;;;;;;;;OAUG;IACG,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CAkB/C"}

package/dist/generated/services/todosets.js

@@ -0,0 +1,40 @@
+/**
+ * Todosets service for the Basecamp API.
+ *
+ * @generated from OpenAPI spec - do not edit directly
+ */
+import { BaseService } from "../../services/base.js";
+// =============================================================================
+// Service
+// =============================================================================
+/**
+ * Service for Todosets operations.
+ */
+export class TodosetsService extends BaseService {
+    /**
+     * Get a todoset (container for todolists in a project)
+     * @param todosetId - The todoset ID
+     * @returns The Todoset
+     * @throws {BasecampError} If the resource is not found
+     *
+     * @example
+     * ```ts
+     * const result = await client.todosets.get(123);
+     * ```
+     */
+    async get(todosetId) {
+        const response = await this.request({
+            service: "Todosets",
+            operation: "GetTodoset",
+            resourceType: "todoset",
+            isMutation: false,
+            resourceId: todosetId,
+        }, () => this.client.GET("/todosets/{todosetId}", {
+            params: {
+                path: { todosetId },
+            },
+        }));
+        return response;
+    }
+}
+//# sourceMappingURL=todosets.js.map

package/dist/generated/services/todosets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"todosets.js","sourceRoot":"","sources":["../../../src/generated/services/todosets.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAUrD,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,WAAW;IAE9C;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,CAAC,SAAiB;QACzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,UAAU;YACnB,SAAS,EAAE,YAAY;YACvB,YAAY,EAAE,SAAS;YACvB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,SAAS;SACtB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,uBAAuB,EAAE;YACvC,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,SAAS,EAAE;aACpB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}

package/dist/generated/services/todosets.ts

@@ -0,0 +1,55 @@
+/**
+ * Todosets 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";
+
+// =============================================================================
+// Types
+// =============================================================================
+
+/** Todoset entity from the Basecamp API. */
+export type Todoset = components["schemas"]["Todoset"];
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Todosets operations.
+ */
+export class TodosetsService extends BaseService {
+
+  /**
+   * Get a todoset (container for todolists in a project)
+   * @param todosetId - The todoset ID
+   * @returns The Todoset
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.todosets.get(123);
+   * ```
+   */
+  async get(todosetId: number): Promise<Todoset> {
+    const response = await this.request(
+      {
+        service: "Todosets",
+        operation: "GetTodoset",
+        resourceType: "todoset",
+        isMutation: false,
+        resourceId: todosetId,
+      },
+      () =>
+        this.client.GET("/todosets/{todosetId}", {
+          params: {
+            path: { todosetId },
+          },
+        })
+    );
+    return response;
+  }
+}

package/dist/generated/services/tools.d.ts

@@ -0,0 +1,122 @@
+/**
+ * Tools 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";
+/** Tool entity from the Basecamp API. */
+export type Tool = components["schemas"]["Tool"];
+/**
+ * Request parameters for clone.
+ */
+export interface CloneToolRequest {
+    /** Source recording id */
+    sourceRecordingId: number;
+}
+/**
+ * Request parameters for update.
+ */
+export interface UpdateToolRequest {
+    /** Title */
+    title: string;
+}
+/**
+ * Request parameters for reposition.
+ */
+export interface RepositionToolRequest {
+    /** Position for ordering (1-based) */
+    position: number;
+}
+/**
+ * Service for Tools operations.
+ */
+export declare class ToolsService extends BaseService {
+    /**
+     * Clone an existing tool to create a new one
+     * @param req - Tool request parameters
+     * @returns The Tool
+     * @throws {BasecampError} If the request fails
+     *
+     * @example
+     * ```ts
+     * const result = await client.tools.clone({ sourceRecordingId: 1 });
+     * ```
+     */
+    clone(req: CloneToolRequest): Promise<Tool>;
+    /**
+     * Get a dock tool by id
+     * @param toolId - The tool ID
+     * @returns The Tool
+     * @throws {BasecampError} If the resource is not found
+     *
+     * @example
+     * ```ts
+     * const result = await client.tools.get(123);
+     * ```
+     */
+    get(toolId: number): Promise<Tool>;
+    /**
+     * Update (rename) an existing tool
+     * @param toolId - The tool ID
+     * @param req - Tool update parameters
+     * @returns The Tool
+     * @throws {BasecampError} If the resource is not found or fields are invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.tools.update(123, { title: "example" });
+     * ```
+     */
+    update(toolId: number, req: UpdateToolRequest): Promise<Tool>;
+    /**
+     * Delete a tool (trash it)
+     * @param toolId - The tool ID
+     * @returns void
+     * @throws {BasecampError} If the request fails
+     *
+     * @example
+     * ```ts
+     * await client.tools.delete(123);
+     * ```
+     */
+    delete(toolId: number): Promise<void>;
+    /**
+     * Enable a tool (show it on the project dock)
+     * @param toolId - The tool ID
+     * @returns void
+     * @throws {BasecampError} If the request fails
+     *
+     * @example
+     * ```ts
+     * await client.tools.enable(123);
+     * ```
+     */
+    enable(toolId: number): Promise<void>;
+    /**
+     * Reposition a tool on the project dock
+     * @param toolId - The tool ID
+     * @param req - Tool request parameters
+     * @returns void
+     * @throws {BasecampError} If the request fails
+     *
+     * @example
+     * ```ts
+     * await client.tools.reposition(123, { position: 1 });
+     * ```
+     */
+    reposition(toolId: number, req: RepositionToolRequest): Promise<void>;
+    /**
+     * Disable a tool (hide it from the project dock)
+     * @param toolId - The tool ID
+     * @returns void
+     * @throws {BasecampError} If the request fails
+     *
+     * @example
+     * ```ts
+     * await client.tools.disable(123);
+     * ```
+     */
+    disable(toolId: number): Promise<void>;
+}
+//# sourceMappingURL=tools.d.ts.map

package/dist/generated/services/tools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools.d.ts","sourceRoot":"","sources":["../../../src/generated/services/tools.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAO/C,yCAAyC;AACzC,MAAM,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,0BAA0B;IAC1B,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,YAAY;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAOD;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAE3C;;;;;;;;;;OAUG;IACG,KAAK,CAAC,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBjD;;;;;;;;;;OAUG;IACG,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBxC;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAyBnE;;;;;;;;;;OAUG;IACG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB3C;;;;;;;;;;OAUG;IACG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB3C;;;;;;;;;;;OAWG;IACG,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqB3E;;;;;;;;;;OAUG;IACG,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAiB7C"}