@37signals/basecamp 0.11.0 → 0.13.0

package/src/generated/services/todos.ts

@@ -17,6 +17,26 @@ import { Errors } from "../../errors.js";
 /** Todo entity from the Basecamp API. */
 export type Todo = components["schemas"]["Todo"];
 
+/**
+ * Request parameters for createTodosetTodo.
+ */
+export interface CreateTodosetTodoTodoRequest {
+  /** 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;
+}
+
 /**
  * Options for list.
  */
@@ -25,6 +45,8 @@ export interface ListTodoOptions extends PaginationOptions {
   status?: "active" | "archived" | "trashed";
   /** Completed */
   completed?: boolean;
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
+  page?: number;
 }
 
 /**
@@ -87,6 +109,57 @@ export interface RepositionTodoRequest {
  */
 export class TodosService extends BaseService {
 
+  /**
+   * Create a to-do directly under a project's to-do set, outside any to-do list.
+   * @param bucketId - The bucket ID
+   * @param todosetId - The todoset 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.createTodosetTodo(123, 123, { content: "Hello world" });
+   * ```
+   */
+  async createTodosetTodo(bucketId: number, todosetId: number, req: CreateTodosetTodoTodoRequest): 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: "CreateTodosetTodo",
+        resourceType: "todo",
+        isMutation: true,
+        projectId: bucketId,
+        resourceId: todosetId,
+      },
+      () =>
+        this.client.POST("/buckets/{bucketId}/todosets/{todosetId}/todos.json", {
+          params: {
+            path: { bucketId, todosetId },
+          },
+          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;
+  }
+
   /**
    * List todos in a todolist
    * @param todolistId - The todolist ID
@@ -114,7 +187,7 @@ export class TodosService extends BaseService {
         this.client.GET("/todolists/{todolistId}/todos.json", {
           params: {
             path: { todolistId },
-            query: { status: options?.status, completed: options?.completed },
+            query: { status: options?.status, completed: options?.completed, page: options?.page },
           },
         })
       , options
@@ -249,35 +322,6 @@ export class TodosService extends BaseService {
     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

package/src/generated/services/uploads.ts

@@ -37,6 +37,8 @@ export interface ListVersionsUploadOptions extends PaginationOptions {
  * Options for list.
  */
 export interface ListUploadOptions extends PaginationOptions {
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
+  page?: number;
 }
 
 /**
@@ -169,6 +171,9 @@ export class UploadsService extends BaseService {
    * @example
    * ```ts
    * const result = await client.uploads.list(123);
+   *
+   * // With options
+   * const filtered = await client.uploads.list(123, { page: 1 });
    * ```
    */
   async list(vaultId: number, options?: ListUploadOptions): Promise<ListResult<Upload>> {
@@ -184,6 +189,7 @@ export class UploadsService extends BaseService {
         this.client.GET("/vaults/{vaultId}/uploads.json", {
           params: {
             path: { vaultId },
+            query: { page: options?.page },
           },
         })
       , options

package/src/generated/services/vaults.ts

@@ -29,6 +29,8 @@ export interface UpdateVaultRequest {
  * Options for list.
  */
 export interface ListVaultOptions extends PaginationOptions {
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
+  page?: number;
 }
 
 /**
@@ -122,6 +124,9 @@ export class VaultsService extends BaseService {
    * @example
    * ```ts
    * const result = await client.vaults.list(123);
+   *
+   * // With options
+   * const filtered = await client.vaults.list(123, { page: 1 });
    * ```
    */
   async list(vaultId: number, options?: ListVaultOptions): Promise<ListResult<Vault>> {
@@ -137,6 +142,7 @@ export class VaultsService extends BaseService {
         this.client.GET("/vaults/{vaultId}/vaults.json", {
           params: {
             path: { vaultId },
+            query: { page: options?.page },
           },
         })
       , options