@37signals/basecamp 0.8.0 → 0.10.0

package/src/generated/services/message-types.ts

@@ -55,24 +55,29 @@ export class MessageTypesService extends BaseService {
 
   /**
    * List message types in a project
+   * @param bucketId - The bucket ID
    * @param options - Optional query parameters
    * @returns All MessageType across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
-   * const result = await client.messageTypes.list();
+   * const result = await client.messageTypes.list(123);
    * ```
    */
-  async list(options?: ListMessageTypeOptions): Promise<ListResult<MessageType>> {
+  async list(bucketId: number, options?: ListMessageTypeOptions): Promise<ListResult<MessageType>> {
     return this.requestPaginated(
       {
         service: "MessageTypes",
         operation: "ListMessageTypes",
         resourceType: "message_type",
         isMutation: false,
+        projectId: bucketId,
       },
       () =>
-        this.client.GET("/categories.json", {
+        this.client.GET("/buckets/{bucketId}/categories.json", {
+          params: {
+            path: { bucketId },
+          },
         })
       , options
     );
@@ -80,16 +85,17 @@ export class MessageTypesService extends BaseService {
 
   /**
    * Create a new message type in a project
+   * @param bucketId - The bucket ID
    * @param req - Message_type creation parameters
    * @returns The MessageType
    * @throws {BasecampError} If required fields are missing or invalid
    *
    * @example
    * ```ts
-   * const result = await client.messageTypes.create({ name: "My example", icon: "example" });
+   * const result = await client.messageTypes.create(123, { name: "My example", icon: "example" });
    * ```
    */
-  async create(req: CreateMessageTypeRequest): Promise<MessageType> {
+  async create(bucketId: number, req: CreateMessageTypeRequest): Promise<MessageType> {
     if (!req.name) {
       throw Errors.validation("Name is required");
     }
@@ -102,9 +108,13 @@ export class MessageTypesService extends BaseService {
         operation: "CreateMessageType",
         resourceType: "message_type",
         isMutation: true,
+        projectId: bucketId,
       },
       () =>
-        this.client.POST("/categories.json", {
+        this.client.POST("/buckets/{bucketId}/categories.json", {
+          params: {
+            path: { bucketId },
+          },
           body: {
             name: req.name,
             icon: req.icon,
@@ -116,28 +126,30 @@ export class MessageTypesService extends BaseService {
 
   /**
    * Get a single message type by id
+   * @param bucketId - The bucket ID
    * @param typeId - The type ID
    * @returns The MessageType
    * @throws {BasecampError} If the resource is not found
    *
    * @example
    * ```ts
-   * const result = await client.messageTypes.get(123);
+   * const result = await client.messageTypes.get(123, 123);
    * ```
    */
-  async get(typeId: number): Promise<MessageType> {
+  async get(bucketId: number, typeId: number): Promise<MessageType> {
     const response = await this.request(
       {
         service: "MessageTypes",
         operation: "GetMessageType",
         resourceType: "message_type",
         isMutation: false,
+        projectId: bucketId,
         resourceId: typeId,
       },
       () =>
-        this.client.GET("/categories/{typeId}", {
+        this.client.GET("/buckets/{bucketId}/categories/{typeId}", {
           params: {
-            path: { typeId },
+            path: { bucketId, typeId },
           },
         })
     );
@@ -146,6 +158,7 @@ export class MessageTypesService extends BaseService {
 
   /**
    * Update an existing message type
+   * @param bucketId - The bucket ID
    * @param typeId - The type ID
    * @param req - Message_type update parameters
    * @returns The MessageType
@@ -153,22 +166,23 @@ export class MessageTypesService extends BaseService {
    *
    * @example
    * ```ts
-   * const result = await client.messageTypes.update(123, { });
+   * const result = await client.messageTypes.update(123, 123, { });
    * ```
    */
-  async update(typeId: number, req: UpdateMessageTypeRequest): Promise<MessageType> {
+  async update(bucketId: number, typeId: number, req: UpdateMessageTypeRequest): Promise<MessageType> {
     const response = await this.request(
       {
         service: "MessageTypes",
         operation: "UpdateMessageType",
         resourceType: "message_type",
         isMutation: true,
+        projectId: bucketId,
         resourceId: typeId,
       },
       () =>
-        this.client.PUT("/categories/{typeId}", {
+        this.client.PUT("/buckets/{bucketId}/categories/{typeId}", {
           params: {
-            path: { typeId },
+            path: { bucketId, typeId },
           },
           body: {
             name: req.name,
@@ -181,28 +195,30 @@ export class MessageTypesService extends BaseService {
 
   /**
    * Delete a message type
+   * @param bucketId - The bucket ID
    * @param typeId - The type ID
    * @returns void
    * @throws {BasecampError} If the request fails
    *
    * @example
    * ```ts
-   * await client.messageTypes.delete(123);
+   * await client.messageTypes.delete(123, 123);
    * ```
    */
-  async delete(typeId: number): Promise<void> {
+  async delete(bucketId: number, typeId: number): Promise<void> {
     await this.request(
       {
         service: "MessageTypes",
         operation: "DeleteMessageType",
         resourceType: "message_type",
         isMutation: true,
+        projectId: bucketId,
         resourceId: typeId,
       },
       () =>
-        this.client.DELETE("/categories/{typeId}", {
+        this.client.DELETE("/buckets/{bucketId}/categories/{typeId}", {
           params: {
-            path: { typeId },
+            path: { bucketId, typeId },
           },
         })
     );

package/src/generated/services/messages.ts

@@ -41,6 +41,8 @@ export interface CreateMessageRequest {
   categoryId?: number;
   /** Subscriptions */
   subscriptions?: number[];
+  /** Visible to clients */
+  visibleToClients?: boolean;
 }
 
 /**
@@ -136,6 +138,7 @@ export class MessagesService extends BaseService {
             status: req.status,
             category_id: req.categoryId,
             subscriptions: req.subscriptions,
+            visible_to_clients: req.visibleToClients,
           },
         })
     );

package/src/generated/services/my-notifications.ts

@@ -6,12 +6,16 @@
 
 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
 // =============================================================================
 
+/** Notification entity from the Basecamp API. */
+export type Notification = components["schemas"]["Notification"];
 
 /**
  * Options for myNotifications.
@@ -19,6 +23,19 @@ import { Errors } from "../../errors.js";
 export interface MyNotificationsMyNotificationOptions {
   /** Page number for paginating through read items. Defaults to 1. */
   page?: number;
+  /** Set to true to cap `bubble_ups` at 2 current bubble-ups and omit the
+`scheduled_bubble_ups` key entirely. Defaults to false. Use the dedicated
+bubble-ups endpoint (GetBubbleUps) to page through all current and
+scheduled bubble-ups. */
+  limitBubbleUps?: boolean;
+}
+
+/**
+ * Options for bubbleUps.
+ */
+export interface BubbleUpsMyNotificationOptions extends PaginationOptions {
+  /** Page number. Defaults to 1. */
+  page?: number;
 }
 
 /**
@@ -60,13 +77,41 @@ export class MyNotificationsService extends BaseService {
       () =>
         this.client.GET("/my/readings.json", {
           params: {
-            query: { page: options?.page },
+            query: { page: options?.page, "limit_bubble_ups": options?.limitBubbleUps },
           },
         })
     );
     return response;
   }
 
+  /**
+   * Get the current user's current and scheduled bubble-ups (paginated, 50 per page).
+   * @param options - Optional query parameters
+   * @returns All Notification across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.myNotifications.bubbleUps();
+   * ```
+   */
+  async bubbleUps(options?: BubbleUpsMyNotificationOptions): Promise<ListResult<Notification>> {
+    return this.requestPaginated(
+      {
+        service: "MyNotifications",
+        operation: "GetBubbleUps",
+        resourceType: "bubble_up",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/my/readings/bubble_ups.json", {
+          params: {
+            query: { page: options?.page },
+          },
+        })
+      , options
+    );
+  }
+
   /**
    * Mark specified items as read
    * @param req - Resource request parameters

package/src/generated/services/people.ts

@@ -152,7 +152,7 @@ export class PeopleService extends BaseService {
    *
    * @example
    * ```ts
-   * const result = await client.people.updateMyPreferences({ person: "example" });
+   * const result = await client.people.updateMyPreferences({ person: {  } });
    * ```
    */
   async updateMyPreferences(req: UpdateMyPreferencesPeopleRequest): Promise<components["schemas"]["UpdateMyPreferencesResponseContent"]> {
@@ -328,7 +328,7 @@ export class PeopleService extends BaseService {
    *
    * @example
    * ```ts
-   * const result = await client.people.enableOutOfOffice(123, { outOfOffice: "example" });
+   * const result = await client.people.enableOutOfOffice(123, { outOfOffice: { start_date: "example", end_date: "example" } });
    * ```
    */
   async enableOutOfOffice(personId: number, req: EnableOutOfOfficePeopleRequest): Promise<components["schemas"]["EnableOutOfOfficeResponseContent"]> {

package/src/generated/services/recordings.ts

@@ -42,7 +42,7 @@ export class RecordingsService extends BaseService {
 
   /**
    * List recordings of a given type across projects
-   * @param type - Comment|Document|Kanban::Card|Kanban::Step|Message|Question::Answer|Schedule::Entry|Todo|Todolist|Upload|Vault
+   * @param type - Comment|Document|Door|Kanban::Card|Kanban::Step|Message|Question::Answer|Schedule::Entry|Todo|Todolist|Upload|Vault
    * @param options - Optional query parameters
    * @returns All Recording across all pages, with .meta.totalCount
    *
@@ -54,7 +54,7 @@ export class RecordingsService extends BaseService {
    * const filtered = await client.recordings.list("type", { bucket: [123] });
    * ```
    */
-  async list(type: "Comment" | "Document" | "Kanban::Card" | "Kanban::Step" | "Message" | "Question::Answer" | "Schedule::Entry" | "Todo" | "Todolist" | "Upload" | "Vault", options?: ListRecordingOptions): Promise<ListResult<Recording>> {
+  async list(type: "Comment" | "Document" | "Door" | "Kanban::Card" | "Kanban::Step" | "Message" | "Question::Answer" | "Schedule::Entry" | "Todo" | "Todolist" | "Upload" | "Vault", options?: ListRecordingOptions): Promise<ListResult<Recording>> {
     return this.requestPaginated(
       {
         service: "Recordings",

package/src/generated/services/schedules.ts

@@ -31,7 +31,15 @@ export interface UpdateEntryScheduleRequest {
   endsAt?: string;
   /** Rich text description (HTML) */
   description?: string;
-  /** Participant ids */
+  /** Replaces the entry's participants.
+
+Omitting this member preserves the current participants; sending an empty
+array clears them. That guarantee is BC3-side and recent: until
+basecamp/bc3#12425, `Schedules::EntriesController#update` called
+`replace_participants` unconditionally, so any update omitting the key —
+including the shape in BC3's own "Update a schedule entry" doc example —
+silently removed every participant and notified each one. The controller
+now guards on the request actually addressing participants. */
   participantIds?: number[];
   /** All day */
   allDay?: boolean;
@@ -75,6 +83,8 @@ export interface CreateEntryScheduleRequest {
   notify?: boolean;
   /** Subscriptions */
   subscriptions?: number[];
+  /** Visible to clients */
+  visibleToClients?: boolean;
 }
 
 
@@ -330,6 +340,7 @@ export class SchedulesService extends BaseService {
             all_day: req.allDay,
             notify: req.notify,
             subscriptions: req.subscriptions,
+            visible_to_clients: req.visibleToClients,
           },
         })
     );

package/src/generated/services/search.ts

@@ -18,8 +18,37 @@ import type { PaginationOptions } from "../../pagination.js";
  * Options for search.
  */
 export interface SearchSearchOptions extends PaginationOptions {
+  /** Recording types to include. Use `key` values from the metadata
+endpoint's `recording_search_types`. Available since Basecamp 5. */
+  typeNames?: string[];
+  /** Project IDs to filter by. Available since Basecamp 5. */
+  bucketIds?: number[];
+  /** Creator person IDs to filter by. Available since Basecamp 5. */
+  creatorIds?: number[];
+  /** Filter attachments by type. Use `key` values from the metadata
+endpoint's `file_search_types`. */
+  fileType?: string;
+  /** Set to true to exclude chat results. */
+  excludeChat?: boolean;
+  /** Filter by since */
+  since?: "last_7_days" | "last_30_days" | "last_90_days" | "last_12_months" | "forever";
   /** Filter by sort */
-  sort?: "best_match" | "created_at";
+  sort?: "best_match" | "recency";
+  /**
+   * Deprecated: prefer type_names[].
+   * @deprecated prefer type_names[].
+   */
+  type?: string;
+  /**
+   * Deprecated: prefer bucket_ids[].
+   * @deprecated prefer bucket_ids[].
+   */
+  bucketId?: number;
+  /**
+   * Deprecated: prefer creator_ids[].
+   * @deprecated prefer creator_ids[].
+   */
+  creatorId?: number;
 }
 
 
@@ -54,7 +83,7 @@ export class SearchService extends BaseService {
       () =>
         this.client.GET("/search.json", {
           params: {
-            query: { q: q, sort: options?.sort },
+            query: { q: q, "type_names[]": options?.typeNames, "bucket_ids[]": options?.bucketIds, "creator_ids[]": options?.creatorIds, "file_type": options?.fileType, "exclude_chat": options?.excludeChat, since: options?.since, sort: options?.sort, type: options?.type, "bucket_id": options?.bucketId, "creator_id": options?.creatorId },
           },
         })
       , options

package/src/generated/services/templates.ts

@@ -49,10 +49,8 @@ export interface UpdateTemplateRequest {
  * Request parameters for createProject.
  */
 export interface CreateProjectTemplateRequest {
-  /** Display name */
-  name: string;
-  /** Rich text description (HTML) */
-  description?: string;
+  /** Project */
+  project: components["schemas"]["ProjectConstructionAttributes"];
 }
 
 
@@ -232,12 +230,12 @@ export class TemplatesService extends BaseService {
    *
    * @example
    * ```ts
-   * const result = await client.templates.createProject(123, { name: "My example" });
+   * const result = await client.templates.createProject(123, { project: { name: "My example" } });
    * ```
    */
   async createProject(templateId: number, req: CreateProjectTemplateRequest): Promise<components["schemas"]["CreateProjectFromTemplateResponseContent"]> {
-    if (!req.name) {
-      throw Errors.validation("Name is required");
+    if (!req.project) {
+      throw Errors.validation("Project is required");
     }
     const response = await this.request(
       {
@@ -253,8 +251,7 @@ export class TemplatesService extends BaseService {
             path: { templateId },
           },
           body: {
-            name: req.name,
-            description: req.description,
+            project: req.project,
           },
         })
     );

package/src/generated/services/todolists.ts

@@ -27,6 +27,14 @@ export interface UpdateTodolistRequest {
   description?: string;
 }
 
+/**
+ * Request parameters for reposition.
+ */
+export interface RepositionTodolistRequest {
+  /** Position for ordering (1-based) */
+  position: number;
+}
+
 /**
  * Options for list.
  */
@@ -43,6 +51,8 @@ export interface CreateTodolistRequest {
   name: string;
   /** Rich text description (HTML) */
   description?: string;
+  /** Visible to clients */
+  visibleToClients?: boolean;
 }
 
 
@@ -73,6 +83,7 @@ export class TodolistsService extends BaseService {
         operation: "GetTodolistOrGroup",
         resourceType: "todolist_or_group",
         isMutation: false,
+        resourceId: id,
       },
       () =>
         this.client.GET("/todolists/{id}", {
@@ -103,6 +114,7 @@ export class TodolistsService extends BaseService {
         operation: "UpdateTodolistOrGroup",
         resourceType: "todolist_or_group",
         isMutation: true,
+        resourceId: id,
       },
       () =>
         this.client.PUT("/todolists/{id}", {
@@ -118,6 +130,39 @@ export class TodolistsService extends BaseService {
     return response;
   }
 
+  /**
+   * Reposition a to-do list within its to-do set.
+   * @param todolistId - The todolist ID
+   * @param req - Todolist request parameters
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.todolists.reposition(123, { position: 1 });
+   * ```
+   */
+  async reposition(todolistId: number, req: RepositionTodolistRequest): Promise<void> {
+    await this.request(
+      {
+        service: "Todolists",
+        operation: "RepositionTodolist",
+        resourceType: "todolist",
+        isMutation: true,
+        resourceId: todolistId,
+      },
+      () =>
+        this.client.PUT("/todosets/todolists/{todolistId}/position.json", {
+          params: {
+            path: { todolistId },
+          },
+          body: {
+            position: req.position,
+          },
+        })
+    );
+  }
+
   /**
    * List todolists in a todoset
    * @param todosetId - The todoset ID
@@ -184,6 +229,7 @@ export class TodolistsService extends BaseService {
           body: {
             name: req.name,
             description: req.description,
+            visible_to_clients: req.visibleToClients,
           },
         })
     );

package/src/generated/services/tools.ts

@@ -23,6 +23,8 @@ export interface CreateToolRequest {
   toolType: string;
   /** Title for the new tool. When omitted, Basecamp assigns the next available default title for the tool type. */
   title?: string;
+  /** Create the tool already visible to clients. Honored only for tool types that manage their own client visibility (Chat::Transcript, Kanban::Board), which otherwise start hidden; every other tool type ignores it and inherits the project default. */
+  visibleToClients?: boolean;
 }
 
 /**
@@ -73,7 +75,7 @@ export class ToolsService extends BaseService {
         operation: "CreateTool",
         resourceType: "tool",
         isMutation: true,
-        resourceId: bucketId,
+        projectId: bucketId,
       },
       () =>
         this.client.POST("/buckets/{bucketId}/dock/tools.json", {
@@ -83,6 +85,7 @@ export class ToolsService extends BaseService {
           body: {
             tool_type: req.toolType,
             title: req.title,
+            visible_to_clients: req.visibleToClients,
           },
         })
     );

package/src/generated/services/uploads.ts

@@ -51,6 +51,8 @@ export interface CreateUploadRequest {
   baseName?: string;
   /** Subscriptions */
   subscriptions?: number[];
+  /** Visible to clients */
+  visibleToClients?: boolean;
 }
 
 
@@ -222,6 +224,7 @@ export class UploadsService extends BaseService {
             description: req.description,
             base_name: req.baseName,
             subscriptions: req.subscriptions,
+            visible_to_clients: req.visibleToClients,
           },
         })
     );

package/src/generated/services/webhooks.ts

@@ -75,7 +75,7 @@ export class WebhooksService extends BaseService {
         operation: "ListWebhooks",
         resourceType: "webhook",
         isMutation: false,
-        resourceId: bucketId,
+        projectId: bucketId,
       },
       () =>
         this.client.GET("/buckets/{bucketId}/webhooks.json", {
@@ -112,7 +112,7 @@ export class WebhooksService extends BaseService {
         operation: "CreateWebhook",
         resourceType: "webhook",
         isMutation: true,
-        resourceId: bucketId,
+        projectId: bucketId,
       },
       () =>
         this.client.POST("/buckets/{bucketId}/webhooks.json", {