@37signals/basecamp 0.8.0 → 0.9.0

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

@@ -88,6 +88,7 @@ export class CardColumnsService extends BaseService {
         operation: "SetCardColumnColor",
         resourceType: "card_column_color",
         isMutation: true,
+        projectId: bucketId,
         resourceId: columnId,
       },
       () =>
@@ -122,6 +123,7 @@ export class CardColumnsService extends BaseService {
         operation: "EnableCardColumnOnHold",
         resourceType: "card_column_on_hold",
         isMutation: true,
+        projectId: bucketId,
         resourceId: columnId,
       },
       () =>
@@ -153,6 +155,7 @@ export class CardColumnsService extends BaseService {
         operation: "DisableCardColumnOnHold",
         resourceType: "card_column_on_hold",
         isMutation: true,
+        projectId: bucketId,
         resourceId: columnId,
       },
       () =>

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

@@ -2,6 +2,7 @@ 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";

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

@@ -73,7 +73,7 @@ export class ToolsService extends BaseService {
         operation: "CreateTool",
         resourceType: "tool",
         isMutation: true,
-        resourceId: bucketId,
+        projectId: bucketId,
       },
       () =>
         this.client.POST("/buckets/{bucketId}/dock/tools.json", {

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", {

package/src/generated/services/wormholes.ts

@@ -0,0 +1,145 @@
+/**
+ * Wormholes 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";
+
+// =============================================================================
+// Types
+// =============================================================================
+
+/** Wormhole entity from the Basecamp API. */
+export type Wormhole = components["schemas"]["Wormhole"];
+
+/**
+ * Request parameters for update.
+ */
+export interface UpdateWormholeRequest {
+  /** Id of the new destination column (on another accessible card table). */
+  destinationRecordingId: number;
+}
+
+/**
+ * Request parameters for create.
+ */
+export interface CreateWormholeRequest {
+  /** Id of the destination column (on another accessible card table) to link to. */
+  destinationRecordingId: number;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Wormholes operations.
+ */
+export class WormholesService extends BaseService {
+
+  /**
+   * Update a wormhole's destination column
+   * @param bucketId - The bucket ID
+   * @param wormholeId - The wormhole ID
+   * @param req - Wormhole update parameters
+   * @returns The Wormhole
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.wormholes.update(123, 123, { destinationRecordingId: 1 });
+   * ```
+   */
+  async update(bucketId: number, wormholeId: number, req: UpdateWormholeRequest): Promise<Wormhole> {
+    const response = await this.request(
+      {
+        service: "Wormholes",
+        operation: "UpdateWormhole",
+        resourceType: "wormhole",
+        isMutation: true,
+        projectId: bucketId,
+        resourceId: wormholeId,
+      },
+      () =>
+        this.client.PUT("/buckets/{bucketId}/card_tables/wormholes/{wormholeId}", {
+          params: {
+            path: { bucketId, wormholeId },
+          },
+          body: {
+            destination_recording_id: req.destinationRecordingId,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Delete a wormhole
+   * @param bucketId - The bucket ID
+   * @param wormholeId - The wormhole ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.wormholes.delete(123, 123);
+   * ```
+   */
+  async delete(bucketId: number, wormholeId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Wormholes",
+        operation: "DeleteWormhole",
+        resourceType: "wormhole",
+        isMutation: true,
+        projectId: bucketId,
+        resourceId: wormholeId,
+      },
+      () =>
+        this.client.DELETE("/buckets/{bucketId}/card_tables/wormholes/{wormholeId}", {
+          params: {
+            path: { bucketId, wormholeId },
+          },
+        })
+    );
+  }
+
+  /**
+   * Create a wormhole linking this card table to a column on another card table.
+   * @param bucketId - The bucket ID
+   * @param cardTableId - The card table ID
+   * @param req - Wormhole creation parameters
+   * @returns The Wormhole
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.wormholes.create(123, 123, { destinationRecordingId: 1 });
+   * ```
+   */
+  async create(bucketId: number, cardTableId: number, req: CreateWormholeRequest): Promise<Wormhole> {
+    const response = await this.request(
+      {
+        service: "Wormholes",
+        operation: "CreateWormhole",
+        resourceType: "wormhole",
+        isMutation: true,
+        projectId: bucketId,
+        resourceId: cardTableId,
+      },
+      () =>
+        this.client.POST("/buckets/{bucketId}/card_tables/{cardTableId}/wormholes.json", {
+          params: {
+            path: { bucketId, cardTableId },
+          },
+          body: {
+            destination_recording_id: req.destinationRecordingId,
+          },
+        })
+    );
+    return response;
+  }
+}