@37signals/basecamp 0.11.0 → 0.13.0

package/src/generated/services/everything.ts

@@ -30,7 +30,12 @@ export type Todo = components["schemas"]["Todo"];
  * Options for everythingCompletedCards.
  */
 export interface EverythingCompletedCardsEverythingOptions extends PaginationOptions {
-  /** Page number for paginating through results. Defaults to 1. */
+  /** Restrict to tasks assigned to at least one of the given people (repeatable).
+Assignees on nested steps are not considered. */
+  assigneeIds?: number[];
+  /** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
+  due?: string;
+  /** 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;
 }
 
@@ -38,7 +43,12 @@ export interface EverythingCompletedCardsEverythingOptions extends PaginationOpt
  * Options for everythingNoDueDateCards.
  */
 export interface EverythingNoDueDateCardsEverythingOptions extends PaginationOptions {
-  /** Page number for paginating through results. Defaults to 1. */
+  /** Restrict to tasks assigned to at least one of the given people (repeatable).
+Assignees on nested steps are not considered. */
+  assigneeIds?: number[];
+  /** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
+  due?: string;
+  /** 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;
 }
 
@@ -46,7 +56,12 @@ export interface EverythingNoDueDateCardsEverythingOptions extends PaginationOpt
  * Options for everythingNotNowCards.
  */
 export interface EverythingNotNowCardsEverythingOptions extends PaginationOptions {
-  /** Page number for paginating through results. Defaults to 1. */
+  /** Restrict to tasks assigned to at least one of the given people (repeatable).
+Assignees on nested steps are not considered. */
+  assigneeIds?: number[];
+  /** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
+  due?: string;
+  /** 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;
 }
 
@@ -54,15 +69,36 @@ export interface EverythingNotNowCardsEverythingOptions extends PaginationOption
  * Options for everythingOpenCards.
  */
 export interface EverythingOpenCardsEverythingOptions extends PaginationOptions {
-  /** Page number for paginating through results. Defaults to 1. */
+  /** Restrict to tasks assigned to at least one of the given people (repeatable).
+Assignees on nested steps are not considered. */
+  assigneeIds?: number[];
+  /** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
+  due?: string;
+  /** 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;
 }
 
+/**
+ * Options for everythingOverdueCards.
+ */
+export interface EverythingOverdueCardsEverythingOptions {
+  /** Restrict to tasks assigned to at least one of the given people (repeatable).
+Assignees on nested steps are not considered. */
+  assigneeIds?: number[];
+  /** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
+  due?: string;
+}
+
 /**
  * Options for everythingUnassignedCards.
  */
 export interface EverythingUnassignedCardsEverythingOptions extends PaginationOptions {
-  /** Page number for paginating through results. Defaults to 1. */
+  /** Restrict to tasks assigned to at least one of the given people (repeatable).
+Assignees on nested steps are not considered. */
+  assigneeIds?: number[];
+  /** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
+  due?: string;
+  /** 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;
 }
 
@@ -70,7 +106,7 @@ export interface EverythingUnassignedCardsEverythingOptions extends PaginationOp
  * Options for everythingCheckins.
  */
 export interface EverythingCheckinsEverythingOptions extends PaginationOptions {
-  /** Page number for paginating through results. Defaults to 1. */
+  /** 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;
 }
 
@@ -78,7 +114,7 @@ export interface EverythingCheckinsEverythingOptions extends PaginationOptions {
  * Options for everythingComments.
  */
 export interface EverythingCommentsEverythingOptions extends PaginationOptions {
-  /** Page number for paginating through results. Defaults to 1. */
+  /** 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;
 }
 
@@ -90,7 +126,7 @@ export interface EverythingFilesEverythingOptions extends PaginationOptions {
   kind?: string;
   /** Restrict to files created by the given people (repeatable). */
   peopleIds?: number[];
-  /** Page number for paginating through results. Defaults to 1. */
+  /** 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;
 }
 
@@ -98,7 +134,7 @@ export interface EverythingFilesEverythingOptions extends PaginationOptions {
  * Options for everythingForwards.
  */
 export interface EverythingForwardsEverythingOptions extends PaginationOptions {
-  /** Page number for paginating through results. Defaults to 1. */
+  /** 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;
 }
 
@@ -106,7 +142,7 @@ export interface EverythingForwardsEverythingOptions extends PaginationOptions {
  * Options for everythingMessages.
  */
 export interface EverythingMessagesEverythingOptions extends PaginationOptions {
-  /** Page number for paginating through results. Defaults to 1. */
+  /** 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;
 }
 
@@ -114,7 +150,12 @@ export interface EverythingMessagesEverythingOptions extends PaginationOptions {
  * Options for everythingCompletedTodos.
  */
 export interface EverythingCompletedTodosEverythingOptions extends PaginationOptions {
-  /** Page number for paginating through results. Defaults to 1. */
+  /** Restrict to tasks assigned to at least one of the given people (repeatable).
+Assignees on nested steps are not considered. */
+  assigneeIds?: number[];
+  /** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
+  due?: string;
+  /** 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,7 +163,12 @@ export interface EverythingCompletedTodosEverythingOptions extends PaginationOpt
  * Options for everythingNoDueDateTodos.
  */
 export interface EverythingNoDueDateTodosEverythingOptions extends PaginationOptions {
-  /** Page number for paginating through results. Defaults to 1. */
+  /** Restrict to tasks assigned to at least one of the given people (repeatable).
+Assignees on nested steps are not considered. */
+  assigneeIds?: number[];
+  /** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
+  due?: string;
+  /** 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;
 }
 
@@ -130,15 +176,36 @@ export interface EverythingNoDueDateTodosEverythingOptions extends PaginationOpt
  * Options for everythingOpenTodos.
  */
 export interface EverythingOpenTodosEverythingOptions extends PaginationOptions {
-  /** Page number for paginating through results. Defaults to 1. */
+  /** Restrict to tasks assigned to at least one of the given people (repeatable).
+Assignees on nested steps are not considered. */
+  assigneeIds?: number[];
+  /** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
+  due?: string;
+  /** 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;
 }
 
+/**
+ * Options for everythingOverdueTodos.
+ */
+export interface EverythingOverdueTodosEverythingOptions {
+  /** Restrict to tasks assigned to at least one of the given people (repeatable).
+Assignees on nested steps are not considered. */
+  assigneeIds?: number[];
+  /** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
+  due?: string;
+}
+
 /**
  * Options for everythingUnassignedTodos.
  */
 export interface EverythingUnassignedTodosEverythingOptions extends PaginationOptions {
-  /** Page number for paginating through results. Defaults to 1. */
+  /** Restrict to tasks assigned to at least one of the given people (repeatable).
+Assignees on nested steps are not considered. */
+  assigneeIds?: number[];
+  /** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
+  due?: string;
+  /** 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;
 }
 
@@ -173,7 +240,7 @@ export class EverythingService extends BaseService {
       () =>
         this.client.GET("/cards/completed.json", {
           params: {
-            query: { page: options?.page },
+            query: { "assignee_ids[]": options?.assigneeIds, due: options?.due, page: options?.page },
           },
         })
       , options
@@ -201,7 +268,7 @@ export class EverythingService extends BaseService {
       () =>
         this.client.GET("/cards/no_due_date.json", {
           params: {
-            query: { page: options?.page },
+            query: { "assignee_ids[]": options?.assigneeIds, due: options?.due, page: options?.page },
           },
         })
       , options
@@ -229,7 +296,7 @@ export class EverythingService extends BaseService {
       () =>
         this.client.GET("/cards/not_now.json", {
           params: {
-            query: { page: options?.page },
+            query: { "assignee_ids[]": options?.assigneeIds, due: options?.due, page: options?.page },
           },
         })
       , options
@@ -257,7 +324,7 @@ export class EverythingService extends BaseService {
       () =>
         this.client.GET("/cards/open.json", {
           params: {
-            query: { page: options?.page },
+            query: { "assignee_ids[]": options?.assigneeIds, due: options?.due, page: options?.page },
           },
         })
       , options
@@ -266,6 +333,7 @@ export class EverythingService extends BaseService {
 
   /**
    * Get every overdue card across all accessible projects, oldest-due-date-first.
+   * @param options - Optional query parameters
    * @returns Array of Card
    *
    * @example
@@ -273,7 +341,7 @@ export class EverythingService extends BaseService {
    * const result = await client.everything.everythingOverdueCards();
    * ```
    */
-  async everythingOverdueCards(): Promise<Card[]> {
+  async everythingOverdueCards(options?: EverythingOverdueCardsEverythingOptions): Promise<Card[]> {
     const response = await this.request(
       {
         service: "Everything",
@@ -283,6 +351,9 @@ export class EverythingService extends BaseService {
       },
       () =>
         this.client.GET("/cards/overdue.json", {
+          params: {
+            query: { "assignee_ids[]": options?.assigneeIds, due: options?.due },
+          },
         })
     );
     return response ?? [];
@@ -309,7 +380,7 @@ export class EverythingService extends BaseService {
       () =>
         this.client.GET("/cards/unassigned.json", {
           params: {
-            query: { page: options?.page },
+            query: { "assignee_ids[]": options?.assigneeIds, due: options?.due, page: options?.page },
           },
         })
       , options
@@ -477,7 +548,7 @@ export class EverythingService extends BaseService {
       () =>
         this.client.GET("/todos/completed.json", {
           params: {
-            query: { page: options?.page },
+            query: { "assignee_ids[]": options?.assigneeIds, due: options?.due, page: options?.page },
           },
         })
       , options
@@ -505,7 +576,7 @@ export class EverythingService extends BaseService {
       () =>
         this.client.GET("/todos/no_due_date.json", {
           params: {
-            query: { page: options?.page },
+            query: { "assignee_ids[]": options?.assigneeIds, due: options?.due, page: options?.page },
           },
         })
       , options
@@ -533,7 +604,7 @@ export class EverythingService extends BaseService {
       () =>
         this.client.GET("/todos/open.json", {
           params: {
-            query: { page: options?.page },
+            query: { "assignee_ids[]": options?.assigneeIds, due: options?.due, page: options?.page },
           },
         })
       , options
@@ -542,6 +613,7 @@ export class EverythingService extends BaseService {
 
   /**
    * Get every overdue to-do across all accessible projects, oldest-due-date-first.
+   * @param options - Optional query parameters
    * @returns Array of Todo
    *
    * @example
@@ -549,7 +621,7 @@ export class EverythingService extends BaseService {
    * const result = await client.everything.everythingOverdueTodos();
    * ```
    */
-  async everythingOverdueTodos(): Promise<Todo[]> {
+  async everythingOverdueTodos(options?: EverythingOverdueTodosEverythingOptions): Promise<Todo[]> {
     const response = await this.request(
       {
         service: "Everything",
@@ -559,6 +631,9 @@ export class EverythingService extends BaseService {
       },
       () =>
         this.client.GET("/todos/overdue.json", {
+          params: {
+            query: { "assignee_ids[]": options?.assigneeIds, due: options?.due },
+          },
         })
     );
     return response ?? [];
@@ -585,7 +660,7 @@ export class EverythingService extends BaseService {
       () =>
         this.client.GET("/todos/unassigned.json", {
           params: {
-            query: { page: options?.page },
+            query: { "assignee_ids[]": options?.assigneeIds, due: options?.due, page: options?.page },
           },
         })
       , options

package/src/generated/services/folders.ts

@@ -0,0 +1,201 @@
+/**
+ * Folders 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 { Errors } from "../../errors.js";
+
+// =============================================================================
+// Types
+// =============================================================================
+
+/** Folder entity from the Basecamp API. */
+export type Folder = components["schemas"]["Folder"];
+/** FolderWithProjects entity from the Basecamp API. */
+export type FolderWithProjects = components["schemas"]["FolderWithProjects"];
+
+/**
+ * Request parameters for createFolder.
+ */
+export interface CreateFolderFolderRequest {
+  /** The folder's name. Defaults to `New folder` when blank, null, or omitted. */
+  name?: string;
+  /** IDs of the projects to file into the folder — the same ids the folder
+reports back as `bucket_ids` and expands as `projects`. This does not
+round-trip under its own name. Omit it, or send null or an empty array,
+for an empty folder. */
+  projectIds?: number[];
+}
+
+/**
+ * Request parameters for updateFolder.
+ */
+export interface UpdateFolderFolderRequest {
+  /** The folder's new name. Blank is rejected with 422 — unlike create, update
+does not fall back to a default name. */
+  name: string;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Folders operations.
+ */
+export class FoldersService extends BaseService {
+
+  /**
+   * List the authenticated user's folders in home-screen order.
+   * @returns Array of Folder
+   *
+   * @example
+   * ```ts
+   * const result = await client.folders.listFolders();
+   * ```
+   */
+  async listFolders(): Promise<Folder[]> {
+    const response = await this.request(
+      {
+        service: "Folders",
+        operation: "ListFolders",
+        resourceType: "folder",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/stacks.json", {
+        })
+    );
+    return response ?? [];
+  }
+
+  /**
+   * Create a folder for the authenticated user and file the given projects into it.
+   * @param req - Folder creation parameters
+   * @returns The FolderWithProjects
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.folders.createFolder({ });
+   * ```
+   */
+  async createFolder(req: CreateFolderFolderRequest): Promise<FolderWithProjects> {
+    const response = await this.request(
+      {
+        service: "Folders",
+        operation: "CreateFolder",
+        resourceType: "folder",
+        isMutation: true,
+      },
+      () =>
+        this.client.POST("/stacks.json", {
+          body: {
+            name: req.name,
+            project_ids: req.projectIds,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Get one folder, with the projects grouped inside it expanded under `projects`.
+   * @param folderId - The folder ID
+   * @returns The FolderWithProjects
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.folders.getFolder(123);
+   * ```
+   */
+  async getFolder(folderId: number): Promise<FolderWithProjects> {
+    const response = await this.request(
+      {
+        service: "Folders",
+        operation: "GetFolder",
+        resourceType: "folder",
+        isMutation: false,
+        resourceId: folderId,
+      },
+      () =>
+        this.client.GET("/stacks/{folderId}", {
+          params: {
+            path: { folderId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Rename a folder.
+   * @param folderId - The folder ID
+   * @param req - Folder update parameters
+   * @returns The FolderWithProjects
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.folders.updateFolder(123, { name: "My example" });
+   * ```
+   */
+  async updateFolder(folderId: number, req: UpdateFolderFolderRequest): Promise<FolderWithProjects> {
+    if (!req.name) {
+      throw Errors.validation("Name is required");
+    }
+    const response = await this.request(
+      {
+        service: "Folders",
+        operation: "UpdateFolder",
+        resourceType: "folder",
+        isMutation: true,
+        resourceId: folderId,
+      },
+      () =>
+        this.client.PUT("/stacks/{folderId}", {
+          params: {
+            path: { folderId },
+          },
+          body: {
+            name: req.name,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Delete a folder and unpin its projects from the home screen.
+   * @param folderId - The folder ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.folders.deleteFolder(123);
+   * ```
+   */
+  async deleteFolder(folderId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Folders",
+        operation: "DeleteFolder",
+        resourceType: "folder",
+        isMutation: true,
+        resourceId: folderId,
+      },
+      () =>
+        this.client.DELETE("/stacks/{folderId}", {
+          params: {
+            path: { folderId },
+          },
+        })
+    );
+  }
+}

package/src/generated/services/forwards.ts

@@ -8,7 +8,6 @@ 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
@@ -25,14 +24,8 @@ export type Inbox = components["schemas"]["Inbox"];
  * Options for listReplies.
  */
 export interface ListRepliesForwardOptions extends PaginationOptions {
-}
-
-/**
- * Request parameters for createReply.
- */
-export interface CreateReplyForwardRequest {
-  /** Text content */
-  content: string;
+  /** 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;
 }
 
 /**
@@ -43,6 +36,8 @@ export interface ListForwardOptions extends PaginationOptions {
   sort?: "created_at" | "updated_at";
   /** Filter by direction */
   direction?: "asc" | "desc";
+  /** 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;
 }
 
 
@@ -94,6 +89,9 @@ export class ForwardsService extends BaseService {
    * @example
    * ```ts
    * const result = await client.forwards.listReplies(123);
+   *
+   * // With options
+   * const filtered = await client.forwards.listReplies(123, { page: 1 });
    * ```
    */
   async listReplies(forwardId: number, options?: ListRepliesForwardOptions): Promise<ListResult<ForwardReply>> {
@@ -109,49 +107,13 @@ export class ForwardsService extends BaseService {
         this.client.GET("/inbox_forwards/{forwardId}/replies.json", {
           params: {
             path: { forwardId },
+            query: { page: options?.page },
           },
         })
       , options
     );
   }
 
-  /**
-   * Create a reply to a forward
-   * @param forwardId - The forward ID
-   * @param req - Forward_reply creation parameters
-   * @returns The ForwardReply
-   * @throws {BasecampError} If required fields are missing or invalid
-   *
-   * @example
-   * ```ts
-   * const result = await client.forwards.createReply(123, { content: "Hello world" });
-   * ```
-   */
-  async createReply(forwardId: number, req: CreateReplyForwardRequest): Promise<ForwardReply> {
-    if (!req.content) {
-      throw Errors.validation("Content is required");
-    }
-    const response = await this.request(
-      {
-        service: "Forwards",
-        operation: "CreateForwardReply",
-        resourceType: "forward_reply",
-        isMutation: true,
-        resourceId: forwardId,
-      },
-      () =>
-        this.client.POST("/inbox_forwards/{forwardId}/replies.json", {
-          params: {
-            path: { forwardId },
-          },
-          body: {
-            content: req.content,
-          },
-        })
-    );
-    return response;
-  }
-
   /**
    * Get a forward reply by ID
    * @param forwardId - The forward ID
@@ -237,10 +199,10 @@ export class ForwardsService extends BaseService {
         resourceId: inboxId,
       },
       () =>
-        this.client.GET("/inboxes/{inboxId}/forwards.json", {
+        this.client.GET("/inboxes/{inboxId}/inbox_forwards.json", {
           params: {
             path: { inboxId },
-            query: { sort: options?.sort, direction: options?.direction },
+            query: { sort: options?.sort, direction: options?.direction, page: options?.page },
           },
         })
       , options

package/src/generated/services/gauges.ts

@@ -35,6 +35,8 @@ export interface ToggleGaugeGaugeRequest {
  * Options for listGaugeNeedles.
  */
 export interface ListGaugeNeedlesGaugeOptions 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;
 }
 
 /**
@@ -56,6 +58,8 @@ export interface ListGaugesGaugeOptions extends PaginationOptions {
   /** Comma-separated list of project IDs. When provided, results are returned
 in the order specified instead of by risk level. */
   bucketIds?: string;
+  /** 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;
 }
 
 
@@ -205,6 +209,9 @@ export class GaugesService extends BaseService {
    * @example
    * ```ts
    * const result = await client.gauges.listGaugeNeedles(123);
+   *
+   * // With options
+   * const filtered = await client.gauges.listGaugeNeedles(123, { page: 1 });
    * ```
    */
   async listGaugeNeedles(projectId: number, options?: ListGaugeNeedlesGaugeOptions): Promise<components["schemas"]["ListGaugeNeedlesResponseContent"]> {
@@ -220,6 +227,7 @@ export class GaugesService extends BaseService {
         this.client.GET("/projects/{projectId}/gauge/needles.json", {
           params: {
             path: { projectId },
+            query: { page: options?.page },
           },
         })
       , options
@@ -289,7 +297,7 @@ export class GaugesService extends BaseService {
       () =>
         this.client.GET("/reports/gauges.json", {
           params: {
-            query: { "bucket_ids": options?.bucketIds },
+            query: { "bucket_ids": options?.bucketIds, page: options?.page },
           },
         })
       , options