@37signals/basecamp 0.11.0 → 0.12.0

package/src/generated/services/bookmarks.ts

@@ -0,0 +1,158 @@
+/**
+ * Bookmarks 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";
+
+// =============================================================================
+// Types
+// =============================================================================
+
+/** Bookmark entity from the Basecamp API. */
+export type Bookmark = components["schemas"]["Bookmark"];
+/** BookmarkStatus entity from the Basecamp API. */
+export type BookmarkStatus = components["schemas"]["BookmarkStatus"];
+
+/**
+ * Options for listMyBookmarks.
+ */
+export interface ListMyBookmarksBookmarkOptions extends PaginationOptions {
+  /** Page number for paginating through results. Defaults to 1. */
+  page?: number;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Bookmarks operations.
+ */
+export class BookmarksService extends BaseService {
+
+  /**
+   * List the current user's bookmarks, most recently bookmarked first (paginated).
+   * @param options - Optional query parameters
+   * @returns All Bookmark across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.bookmarks.listMyBookmarks();
+   *
+   * // With options
+   * const filtered = await client.bookmarks.listMyBookmarks({ page: 1 });
+   * ```
+   */
+  async listMyBookmarks(options?: ListMyBookmarksBookmarkOptions): Promise<ListResult<Bookmark>> {
+    return this.requestPaginated(
+      {
+        service: "Bookmarks",
+        operation: "ListMyBookmarks",
+        resourceType: "bookmark",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/my/bookmarks.json", {
+          params: {
+            query: { page: options?.page },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * Report whether the current user has bookmarked the recording.
+   * @param recordingId - The recording ID
+   * @returns The BookmarkStatus
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.bookmarks.getBookmark(123);
+   * ```
+   */
+  async getBookmark(recordingId: number): Promise<BookmarkStatus> {
+    const response = await this.request(
+      {
+        service: "Bookmarks",
+        operation: "GetBookmark",
+        resourceType: "bookmark",
+        isMutation: false,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.GET("/recordings/{recordingId}/bookmark.json", {
+          params: {
+            path: { recordingId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Bookmark a recording for the current user.
+   * @param recordingId - The recording ID
+   * @returns The Bookmark
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.bookmarks.createBookmark(123);
+   * ```
+   */
+  async createBookmark(recordingId: number): Promise<Bookmark> {
+    const response = await this.request(
+      {
+        service: "Bookmarks",
+        operation: "CreateBookmark",
+        resourceType: "bookmark",
+        isMutation: true,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.POST("/recordings/{recordingId}/bookmark.json", {
+          params: {
+            path: { recordingId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Remove the current user's bookmark from a recording.
+   * @param recordingId - The recording ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.bookmarks.deleteBookmark(123);
+   * ```
+   */
+  async deleteBookmark(recordingId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Bookmarks",
+        operation: "DeleteBookmark",
+        resourceType: "bookmark",
+        isMutation: true,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.DELETE("/recordings/{recordingId}/bookmark.json", {
+          params: {
+            path: { recordingId },
+          },
+        })
+    );
+  }
+}

package/src/generated/services/calendars.ts

@@ -0,0 +1,102 @@
+/**
+ * Calendars 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
+// =============================================================================
+
+/** Calendar entity from the Basecamp API. */
+export type Calendar = components["schemas"]["Calendar"];
+
+/**
+ * Request parameters for updateCalendar.
+ */
+export interface UpdateCalendarCalendarRequest {
+  /** Calendar */
+  calendar: components["schemas"]["CalendarAttributes"];
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Calendars operations.
+ */
+export class CalendarsService extends BaseService {
+
+  /**
+   * Get a calendar by its bucket id. A Calendar is a top-level BC5 bucketable
+   * @param calendarId - The calendar ID
+   * @returns The Calendar
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.calendars.getCalendar(123);
+   * ```
+   */
+  async getCalendar(calendarId: number): Promise<Calendar> {
+    const response = await this.request(
+      {
+        service: "Calendars",
+        operation: "GetCalendar",
+        resourceType: "calendar",
+        isMutation: false,
+        resourceId: calendarId,
+      },
+      () =>
+        this.client.GET("/calendars/{calendarId}", {
+          params: {
+            path: { calendarId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Update a calendar's display color. An unknown color returns 422 with a JSON
+   * @param calendarId - The calendar ID
+   * @param req - Calendar update parameters
+   * @returns The Calendar
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.calendars.updateCalendar(123, { calendar: { color: "example" } });
+   * ```
+   */
+  async updateCalendar(calendarId: number, req: UpdateCalendarCalendarRequest): Promise<Calendar> {
+    if (!req.calendar) {
+      throw Errors.validation("Calendar is required");
+    }
+    const response = await this.request(
+      {
+        service: "Calendars",
+        operation: "UpdateCalendar",
+        resourceType: "calendar",
+        isMutation: true,
+        resourceId: calendarId,
+      },
+      () =>
+        this.client.PUT("/calendars/{calendarId}", {
+          params: {
+            path: { calendarId },
+          },
+          body: {
+            calendar: req.calendar,
+          },
+        })
+    );
+    return response;
+  }
+}

package/src/generated/services/drafts.ts

@@ -0,0 +1,67 @@
+/**
+ * Drafts 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";
+
+// =============================================================================
+// Types
+// =============================================================================
+
+/** Draft entity from the Basecamp API. */
+export type Draft = components["schemas"]["Draft"];
+
+/**
+ * Options for listMyDrafts.
+ */
+export interface ListMyDraftsDraftOptions extends PaginationOptions {
+  /** Page number for paginating through results. Defaults to 1. */
+  page?: number;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Drafts operations.
+ */
+export class DraftsService extends BaseService {
+
+  /**
+   * List the current user's drafts across their active projects, most recently
+   * @param options - Optional query parameters
+   * @returns All Draft across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.drafts.listMyDrafts();
+   *
+   * // With options
+   * const filtered = await client.drafts.listMyDrafts({ page: 1 });
+   * ```
+   */
+  async listMyDrafts(options?: ListMyDraftsDraftOptions): Promise<ListResult<Draft>> {
+    return this.requestPaginated(
+      {
+        service: "Drafts",
+        operation: "ListMyDrafts",
+        resourceType: "my_draft",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/my/drafts.json", {
+          params: {
+            query: { page: options?.page },
+          },
+        })
+      , options
+    );
+  }
+}

package/src/generated/services/everything.ts

@@ -30,6 +30,11 @@ export type Todo = components["schemas"]["Todo"];
  * Options for everythingCompletedCards.
  */
 export interface EverythingCompletedCardsEverythingOptions extends PaginationOptions {
+  /** 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. */
   page?: number;
 }
@@ -38,6 +43,11 @@ export interface EverythingCompletedCardsEverythingOptions extends PaginationOpt
  * Options for everythingNoDueDateCards.
  */
 export interface EverythingNoDueDateCardsEverythingOptions extends PaginationOptions {
+  /** 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. */
   page?: number;
 }
@@ -46,6 +56,11 @@ export interface EverythingNoDueDateCardsEverythingOptions extends PaginationOpt
  * Options for everythingNotNowCards.
  */
 export interface EverythingNotNowCardsEverythingOptions extends PaginationOptions {
+  /** 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. */
   page?: number;
 }
@@ -54,14 +69,35 @@ export interface EverythingNotNowCardsEverythingOptions extends PaginationOption
  * Options for everythingOpenCards.
  */
 export interface EverythingOpenCardsEverythingOptions extends PaginationOptions {
+  /** 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. */
   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 {
+  /** 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. */
   page?: number;
 }
@@ -114,6 +150,11 @@ export interface EverythingMessagesEverythingOptions extends PaginationOptions {
  * Options for everythingCompletedTodos.
  */
 export interface EverythingCompletedTodosEverythingOptions extends PaginationOptions {
+  /** 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. */
   page?: number;
 }
@@ -122,6 +163,11 @@ export interface EverythingCompletedTodosEverythingOptions extends PaginationOpt
  * Options for everythingNoDueDateTodos.
  */
 export interface EverythingNoDueDateTodosEverythingOptions extends PaginationOptions {
+  /** 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. */
   page?: number;
 }
@@ -130,14 +176,35 @@ export interface EverythingNoDueDateTodosEverythingOptions extends PaginationOpt
  * Options for everythingOpenTodos.
  */
 export interface EverythingOpenTodosEverythingOptions extends PaginationOptions {
+  /** 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. */
   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 {
+  /** 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. */
   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/index.ts

@@ -5,7 +5,9 @@ export { CardColumnsService } from "./card-columns.js";
 export { WormholesService } from "./wormholes.js";
 export { MessageTypesService } from "./message-types.js";
 export { ToolsService } from "./tools.js";
+export { TodosService } from "./todos.js";
 export { WebhooksService } from "./webhooks.js";
+export { CalendarsService } from "./calendars.js";
 export { CardsService } from "./cards.js";
 export { CardStepsService } from "./card-steps.js";
 export { CardTablesService } from "./card-tables.js";
@@ -24,6 +26,9 @@ export { LineupService } from "./lineup.js";
 export { MessageBoardsService } from "./message-boards.js";
 export { MessagesService } from "./messages.js";
 export { MyAssignmentsService } from "./my-assignments.js";
+export { BookmarksService } from "./bookmarks.js";
+export { DraftsService } from "./drafts.js";
+export { MyNotesService } from "./my-notes.js";
 export { CheckinsService } from "./checkins.js";
 export { MyNotificationsService } from "./my-notifications.js";
 export { ProjectsService } from "./projects.js";
@@ -39,7 +44,6 @@ export { SearchService } from "./search.js";
 export { TemplatesService } from "./templates.js";
 export { TodolistGroupsService } from "./todolist-groups.js";
 export { TodolistsService } from "./todolists.js";
-export { TodosService } from "./todos.js";
 export { TodosetsService } from "./todosets.js";
 export { HillChartsService } from "./hill-charts.js";
 export { UploadsService } from "./uploads.js";