@37signals/basecamp 0.7.3 → 0.9.0

package/src/generated/services/campfires.ts

@@ -73,6 +73,14 @@ export interface CreateLineCampfireRequest {
   contentType?: string;
 }
 
+/**
+ * Request parameters for updateLine.
+ */
+export interface UpdateLineCampfireRequest {
+  /** The new line content, interpreted as rich text (HTML) */
+  content: string;
+}
+
 /**
  * Options for listUploads.
  */
@@ -420,7 +428,44 @@ export class CampfiresService extends BaseService {
   }
 
   /**
-   * Delete a campfire line
+   * Update an existing campfire line; the content is always treated as rich text (HTML).
+   * @param campfireId - The campfire ID
+   * @param lineId - The line ID
+   * @param req - Campfire_line update parameters
+   * @returns void
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * await client.campfires.updateLine(123, 123, { content: "Hello world" });
+   * ```
+   */
+  async updateLine(campfireId: number, lineId: number, req: UpdateLineCampfireRequest): Promise<void> {
+    if (!req.content) {
+      throw Errors.validation("Content is required");
+    }
+    await this.request(
+      {
+        service: "Campfires",
+        operation: "UpdateCampfireLine",
+        resourceType: "campfire_line",
+        isMutation: true,
+        resourceId: lineId,
+      },
+      () =>
+        this.client.PUT("/chats/{campfireId}/lines/{lineId}", {
+          params: {
+            path: { campfireId, lineId },
+          },
+          body: {
+            content: req.content,
+          },
+        })
+    );
+  }
+
+  /**
+   * Delete a campfire line; allowed for the line's creator or an admin.
    * @param campfireId - The campfire ID
    * @param lineId - The line ID
    * @returns void

package/src/generated/services/card-columns.ts

@@ -15,6 +15,14 @@ import { Errors } from "../../errors.js";
 /** CardColumn entity from the Basecamp API. */
 export type CardColumn = components["schemas"]["CardColumn"];
 
+/**
+ * Request parameters for setColor.
+ */
+export interface SetColorCardColumnRequest {
+  /** Valid colors: white, red, orange, yellow, green, blue, aqua, purple, gray, pink, brown */
+  color: string;
+}
+
 /**
  * Request parameters for update.
  */
@@ -25,14 +33,6 @@ export interface UpdateCardColumnRequest {
   description?: string;
 }
 
-/**
- * Request parameters for setColor.
- */
-export interface SetColorCardColumnRequest {
-  /** Valid colors: white, red, orange, yellow, green, blue, aqua, purple, gray, pink, brown */
-  color: string;
-}
-
 /**
  * Request parameters for create.
  */
@@ -66,29 +66,38 @@ export interface MoveCardColumnRequest {
 export class CardColumnsService extends BaseService {
 
   /**
-   * Get a card column by ID
+   * Set the color of a column
+   * @param bucketId - The bucket ID
    * @param columnId - The column ID
+   * @param req - Card_column_color request parameters
    * @returns The CardColumn
-   * @throws {BasecampError} If the resource is not found
+   * @throws {BasecampError} If the request fails
    *
    * @example
    * ```ts
-   * const result = await client.cardColumns.get(123);
+   * const result = await client.cardColumns.setColor(123, 123, { color: "example" });
    * ```
    */
-  async get(columnId: number): Promise<CardColumn> {
+  async setColor(bucketId: number, columnId: number, req: SetColorCardColumnRequest): Promise<CardColumn> {
+    if (!req.color) {
+      throw Errors.validation("Color is required");
+    }
     const response = await this.request(
       {
         service: "CardColumns",
-        operation: "GetCardColumn",
-        resourceType: "card_column",
-        isMutation: false,
+        operation: "SetCardColumnColor",
+        resourceType: "card_column_color",
+        isMutation: true,
+        projectId: bucketId,
         resourceId: columnId,
       },
       () =>
-        this.client.GET("/card_tables/columns/{columnId}", {
+        this.client.PUT("/buckets/{bucketId}/card_tables/columns/{columnId}/color.json", {
           params: {
-            path: { columnId },
+            path: { bucketId, columnId },
+          },
+          body: {
+            color: req.color,
           },
         })
     );
@@ -96,34 +105,31 @@ export class CardColumnsService extends BaseService {
   }
 
   /**
-   * Update an existing column
+   * Enable on-hold section in a column
+   * @param bucketId - The bucket ID
    * @param columnId - The column ID
-   * @param req - Card_column update parameters
    * @returns The CardColumn
-   * @throws {BasecampError} If the resource is not found or fields are invalid
+   * @throws {BasecampError} If the request fails
    *
    * @example
    * ```ts
-   * const result = await client.cardColumns.update(123, { });
+   * const result = await client.cardColumns.enableOnHold(123, 123);
    * ```
    */
-  async update(columnId: number, req: UpdateCardColumnRequest): Promise<CardColumn> {
+  async enableOnHold(bucketId: number, columnId: number): Promise<CardColumn> {
     const response = await this.request(
       {
         service: "CardColumns",
-        operation: "UpdateCardColumn",
-        resourceType: "card_column",
+        operation: "EnableCardColumnOnHold",
+        resourceType: "card_column_on_hold",
         isMutation: true,
+        projectId: bucketId,
         resourceId: columnId,
       },
       () =>
-        this.client.PUT("/card_tables/columns/{columnId}", {
+        this.client.POST("/buckets/{bucketId}/card_tables/columns/{columnId}/on_hold.json", {
           params: {
-            path: { columnId },
-          },
-          body: {
-            title: req.title,
-            description: req.description,
+            path: { bucketId, columnId },
           },
         })
     );
@@ -131,36 +137,31 @@ export class CardColumnsService extends BaseService {
   }
 
   /**
-   * Set the color of a column
+   * Disable on-hold section in a column
+   * @param bucketId - The bucket ID
    * @param columnId - The column ID
-   * @param req - Card_column_color request parameters
    * @returns The CardColumn
    * @throws {BasecampError} If the request fails
    *
    * @example
    * ```ts
-   * const result = await client.cardColumns.setColor(123, { color: "example" });
+   * const result = await client.cardColumns.disableOnHold(123, 123);
    * ```
    */
-  async setColor(columnId: number, req: SetColorCardColumnRequest): Promise<CardColumn> {
-    if (!req.color) {
-      throw Errors.validation("Color is required");
-    }
+  async disableOnHold(bucketId: number, columnId: number): Promise<CardColumn> {
     const response = await this.request(
       {
         service: "CardColumns",
-        operation: "SetCardColumnColor",
-        resourceType: "card_column_color",
+        operation: "DisableCardColumnOnHold",
+        resourceType: "card_column_on_hold",
         isMutation: true,
+        projectId: bucketId,
         resourceId: columnId,
       },
       () =>
-        this.client.PUT("/card_tables/columns/{columnId}/color.json", {
+        this.client.DELETE("/buckets/{bucketId}/card_tables/columns/{columnId}/on_hold.json", {
           params: {
-            path: { columnId },
-          },
-          body: {
-            color: req.color,
+            path: { bucketId, columnId },
           },
         })
     );
@@ -168,27 +169,27 @@ export class CardColumnsService extends BaseService {
   }
 
   /**
-   * Enable on-hold section in a column
+   * Get a card column by ID
    * @param columnId - The column ID
    * @returns The CardColumn
-   * @throws {BasecampError} If the request fails
+   * @throws {BasecampError} If the resource is not found
    *
    * @example
    * ```ts
-   * const result = await client.cardColumns.enableOnHold(123);
+   * const result = await client.cardColumns.get(123);
    * ```
    */
-  async enableOnHold(columnId: number): Promise<CardColumn> {
+  async get(columnId: number): Promise<CardColumn> {
     const response = await this.request(
       {
         service: "CardColumns",
-        operation: "EnableCardColumnOnHold",
-        resourceType: "card_column_on_hold",
-        isMutation: true,
+        operation: "GetCardColumn",
+        resourceType: "card_column",
+        isMutation: false,
         resourceId: columnId,
       },
       () =>
-        this.client.POST("/card_tables/columns/{columnId}/on_hold.json", {
+        this.client.GET("/card_tables/columns/{columnId}", {
           params: {
             path: { columnId },
           },
@@ -198,30 +199,35 @@ export class CardColumnsService extends BaseService {
   }
 
   /**
-   * Disable on-hold section in a column
+   * Update an existing column
    * @param columnId - The column ID
+   * @param req - Card_column update parameters
    * @returns The CardColumn
-   * @throws {BasecampError} If the request fails
+   * @throws {BasecampError} If the resource is not found or fields are invalid
    *
    * @example
    * ```ts
-   * const result = await client.cardColumns.disableOnHold(123);
+   * const result = await client.cardColumns.update(123, { });
    * ```
    */
-  async disableOnHold(columnId: number): Promise<CardColumn> {
+  async update(columnId: number, req: UpdateCardColumnRequest): Promise<CardColumn> {
     const response = await this.request(
       {
         service: "CardColumns",
-        operation: "DisableCardColumnOnHold",
-        resourceType: "card_column_on_hold",
+        operation: "UpdateCardColumn",
+        resourceType: "card_column",
         isMutation: true,
         resourceId: columnId,
       },
       () =>
-        this.client.DELETE("/card_tables/columns/{columnId}/on_hold.json", {
+        this.client.PUT("/card_tables/columns/{columnId}", {
           params: {
             path: { columnId },
           },
+          body: {
+            title: req.title,
+            description: req.description,
+          },
         })
     );
     return response;

package/src/generated/services/checkins.ts

@@ -53,6 +53,8 @@ export interface CreateQuestionCheckinRequest {
   title: string;
   /** Schedule */
   schedule: components["schemas"]["QuestionSchedule"];
+  /** Visible to clients */
+  visibleToClients?: boolean;
 }
 
 /**
@@ -279,7 +281,7 @@ export class CheckinsService extends BaseService {
    *
    * @example
    * ```ts
-   * const result = await client.checkins.createQuestion(123, { title: "example", schedule: "example" });
+   * const result = await client.checkins.createQuestion(123, { title: "example", schedule: {  } });
    * ```
    */
   async createQuestion(questionnaireId: number, req: CreateQuestionCheckinRequest): Promise<Question> {
@@ -305,6 +307,7 @@ export class CheckinsService extends BaseService {
           body: {
             title: req.title,
             schedule: req.schedule,
+            visible_to_clients: req.visibleToClients,
           },
         })
     );

package/src/generated/services/documents.ts

@@ -45,6 +45,8 @@ export interface CreateDocumentRequest {
   status?: "active" | "drafted";
   /** Subscriptions */
   subscriptions?: number[];
+  /** Visible to clients */
+  visibleToClients?: boolean;
 }
 
 
@@ -186,6 +188,7 @@ export class DocumentsService extends BaseService {
             content: req.content,
             status: req.status,
             subscriptions: req.subscriptions,
+            visible_to_clients: req.visibleToClients,
           },
         })
     );

package/src/generated/services/gauges.ts

@@ -169,7 +169,7 @@ export class GaugesService extends BaseService {
    *
    * @example
    * ```ts
-   * await client.gauges.toggleGauge(123, { gauge: "example" });
+   * await client.gauges.toggleGauge(123, { gauge: { enabled: true } });
    * ```
    */
   async toggleGauge(projectId: number, req: ToggleGaugeGaugeRequest): Promise<void> {
@@ -235,7 +235,7 @@ export class GaugesService extends BaseService {
    *
    * @example
    * ```ts
-   * const result = await client.gauges.createGaugeNeedle(123, { gaugeNeedle: "example" });
+   * const result = await client.gauges.createGaugeNeedle(123, { gaugeNeedle: { position: 1 } });
    * ```
    */
   async createGaugeNeedle(projectId: number, req: CreateGaugeNeedleGaugeRequest): Promise<components["schemas"]["CreateGaugeNeedleResponseContent"]> {

package/src/generated/services/index.ts

@@ -1,10 +1,12 @@
 export { AccountService } from "./account.js";
 export { AttachmentsService } from "./attachments.js";
 export { BoostsService } from "./boosts.js";
+export { CardColumnsService } from "./card-columns.js";
+export { WormholesService } from "./wormholes.js";
+export { ToolsService } from "./tools.js";
 export { WebhooksService } from "./webhooks.js";
 export { CardsService } from "./cards.js";
 export { CardStepsService } from "./card-steps.js";
-export { CardColumnsService } from "./card-columns.js";
 export { CardTablesService } from "./card-tables.js";
 export { MessageTypesService } from "./message-types.js";
 export { CampfiresService } from "./campfires.js";
@@ -13,7 +15,6 @@ export { ClientApprovalsService } from "./client-approvals.js";
 export { ClientCorrespondencesService } from "./client-correspondences.js";
 export { ClientRepliesService } from "./client-replies.js";
 export { CommentsService } from "./comments.js";
-export { ToolsService } from "./tools.js";
 export { DocumentsService } from "./documents.js";
 export { GaugesService } from "./gauges.js";
 export { ForwardsService } from "./forwards.js";

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/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/reports.ts

@@ -84,7 +84,7 @@ export class ReportsService extends BaseService {
   }
 
   /**
-   * Get upcoming schedule entries within a date window
+   * Get upcoming schedule entries and assignable items within a date window.
    * @param options - Optional query parameters
    * @returns The upcoming_schedule
    *

package/src/generated/services/schedules.ts

@@ -75,6 +75,8 @@ export interface CreateEntryScheduleRequest {
   notify?: boolean;
   /** Subscriptions */
   subscriptions?: number[];
+  /** Visible to clients */
+  visibleToClients?: boolean;
 }
 
 
@@ -330,6 +332,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/todos.ts

@@ -48,11 +48,11 @@ export interface CreateTodoRequest {
 }
 
 /**
- * Request parameters for update.
+ * Request parameters for replace.
  */
-export interface UpdateTodoRequest {
+export interface ReplaceTodoRequest {
   /** Text content */
-  content?: string;
+  content: string;
   /** Rich text description (HTML) */
   description?: string;
   /** Person IDs to assign to */
@@ -201,18 +201,21 @@ export class TodosService extends BaseService {
   }
 
   /**
-   * Update an existing todo
+   * Replace a todo with a new complete representation.
    * @param todoId - The todo ID
-   * @param req - Todo update parameters
+   * @param req - Todo request parameters
    * @returns The Todo
-   * @throws {BasecampError} If the resource is not found or fields are invalid
+   * @throws {BasecampError} If the request fails
    *
    * @example
    * ```ts
-   * const result = await client.todos.update(123, { });
+   * const result = await client.todos.replace(123, { content: "Hello world" });
    * ```
    */
-  async update(todoId: number, req: UpdateTodoRequest): Promise<Todo> {
+  async replace(todoId: number, req: ReplaceTodoRequest): 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");
     }
@@ -222,7 +225,7 @@ export class TodosService extends BaseService {
     const response = await this.request(
       {
         service: "Todos",
-        operation: "UpdateTodo",
+        operation: "ReplaceTodo",
         resourceType: "todo",
         isMutation: true,
         resourceId: todoId,