@37signals/basecamp 0.14.0 → 0.16.0

package/src/generated/services/bubble-ups.ts

@@ -0,0 +1,98 @@
+/**
+ * BubbleUps 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
+// =============================================================================
+
+
+/**
+ * Request parameters for createBubbleUp.
+ */
+export interface CreateBubbleUpBubbleUpRequest {
+  /** Timing for the bubble-up. `"now"` bubbles up immediately; a scheduling
+keyword (`"today"`, `"tomorrow"`, `"weekend"`, `"next_week"`) or an ISO8601
+date (e.g. `"2026-09-10"`) schedules it to resurface later. bc3 requires a
+value — omitting `at` errors server-side (`Date.iso8601(nil)`) — so send
+`"now"` for the immediate case. */
+  at?: string;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for BubbleUps operations.
+ */
+export class BubbleUpsService extends BaseService {
+
+  /**
+   * Bubble up a recording for the current user, resurfacing it in the current
+   * @param recordingId - The recording ID
+   * @param req - Bubble_up creation parameters
+   * @returns void
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * await client.bubbleUps.createBubbleUp(123, { });
+   * ```
+   */
+  async createBubbleUp(recordingId: number, req: CreateBubbleUpBubbleUpRequest): Promise<void> {
+    await this.request(
+      {
+        service: "BubbleUps",
+        operation: "CreateBubbleUp",
+        resourceType: "bubble_up",
+        isMutation: true,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.POST("/recordings/{recordingId}/bubble_up.json", {
+          params: {
+            path: { recordingId },
+          },
+          body: {
+            at: req.at,
+          },
+        })
+    );
+  }
+
+  /**
+   * Remove the current user's bubble-up from a recording.
+   * @param recordingId - The recording ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.bubbleUps.deleteBubbleUp(123);
+   * ```
+   */
+  async deleteBubbleUp(recordingId: number): Promise<void> {
+    await this.request(
+      {
+        service: "BubbleUps",
+        operation: "DeleteBubbleUp",
+        resourceType: "bubble_up",
+        isMutation: true,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.DELETE("/recordings/{recordingId}/bubble_up.json", {
+          params: {
+            path: { recordingId },
+          },
+        })
+    );
+  }
+}

package/src/generated/services/checkins.ts

@@ -135,7 +135,7 @@ export class CheckinsService extends BaseService {
    * const result = await client.checkins.reminders();
    * ```
    */
-  async reminders(options?: RemindersCheckinOptions): Promise<components["schemas"]["GetQuestionRemindersResponseContent"]> {
+  async reminders(options?: RemindersCheckinOptions): Promise<ListResult<components["schemas"]["QuestionReminder"]>> {
     return this.requestPaginated(
       {
         service: "Checkins",

package/src/generated/services/gauges.ts

@@ -214,7 +214,7 @@ export class GaugesService extends BaseService {
    * const filtered = await client.gauges.listGaugeNeedles(123, { page: 1 });
    * ```
    */
-  async listGaugeNeedles(projectId: number, options?: ListGaugeNeedlesGaugeOptions): Promise<components["schemas"]["ListGaugeNeedlesResponseContent"]> {
+  async listGaugeNeedles(projectId: number, options?: ListGaugeNeedlesGaugeOptions): Promise<ListResult<components["schemas"]["GaugeNeedle"]>> {
     return this.requestPaginated(
       {
         service: "Gauges",
@@ -286,7 +286,7 @@ export class GaugesService extends BaseService {
    * const filtered = await client.gauges.listGauges({ bucketIds: "example" });
    * ```
    */
-  async listGauges(options?: ListGaugesGaugeOptions): Promise<components["schemas"]["ListGaugesResponseContent"]> {
+  async listGauges(options?: ListGaugesGaugeOptions): Promise<ListResult<components["schemas"]["Gauge"]>> {
     return this.requestPaginated(
       {
         service: "Gauges",

package/src/generated/services/index.ts

@@ -37,6 +37,7 @@ export { ProjectsService } from "./projects.js";
 export { RecordingsService } from "./recordings.js";
 export { TimelineService } from "./timeline.js";
 export { TimesheetsService } from "./timesheets.js";
+export { BubbleUpsService } from "./bubble-ups.js";
 export { ClientVisibilityService } from "./client-visibility.js";
 export { EventsService } from "./events.js";
 export { SubscriptionsService } from "./subscriptions.js";

package/src/generated/services/projects.ts

@@ -61,6 +61,30 @@ export interface UpdateProjectRequest {
  */
 export class ProjectsService extends BaseService {
 
+  /**
+   * List the projects the current user has most recently visited, most recent visit first.
+   * @returns Array of Project
+   *
+   * @example
+   * ```ts
+   * const result = await client.projects.listRecentProjects();
+   * ```
+   */
+  async listRecentProjects(): Promise<Project[]> {
+    const response = await this.request(
+      {
+        service: "Projects",
+        operation: "ListRecentProjects",
+        resourceType: "project",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/my/recent_projects.json", {
+        })
+    );
+    return response ?? [];
+  }
+
   /**
    * List projects (active by default; optionally archived/trashed)
    * @param options - Optional query parameters
@@ -224,6 +248,35 @@ export class ProjectsService extends BaseService {
     );
   }
 
+  /**
+   * Record that the current user visited a project, moving it to the front of ListRecentProjects.
+   * @param projectId - The project ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.projects.recordProjectVisit(123);
+   * ```
+   */
+  async recordProjectVisit(projectId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Projects",
+        operation: "RecordProjectVisit",
+        resourceType: "project",
+        isMutation: true,
+        projectId,
+      },
+      () =>
+        this.client.POST("/projects/{projectId}/recent_visit.json", {
+          params: {
+            path: { projectId },
+          },
+        })
+    );
+  }
+
   /**
    * Restore a project to active status from trash as well as from the archive.
    * @param projectId - The project ID

package/src/generated/services/recordings.ts

@@ -74,6 +74,65 @@ export class RecordingsService extends BaseService {
     );
   }
 
+  /**
+   * Put a recording's card in the spotlight area on its project or template home page.
+   * @param recordingId - The recording ID
+   * @returns The Recording
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * const result = await client.recordings.spotlight(123);
+   * ```
+   */
+  async spotlight(recordingId: number): Promise<Recording> {
+    const response = await this.request(
+      {
+        service: "Recordings",
+        operation: "SpotlightRecording",
+        resourceType: "recording",
+        isMutation: true,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.POST("/recordings/{recordingId}/spotlight.json", {
+          params: {
+            path: { recordingId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Remove a recording from the spotlight area.
+   * @param recordingId - The recording ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.recordings.unspotlight(123);
+   * ```
+   */
+  async unspotlight(recordingId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Recordings",
+        operation: "UnspotlightRecording",
+        resourceType: "recording",
+        isMutation: true,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.DELETE("/recordings/{recordingId}/spotlight.json", {
+          params: {
+            path: { recordingId },
+          },
+        })
+    );
+  }
+
   /**
    * Unarchive a recording (restore to active status)
    * @param recordingId - The recording ID

package/src/generated/services/search.ts

@@ -74,7 +74,7 @@ export class SearchService extends BaseService {
    * const result = await client.search.search("q");
    * ```
    */
-  async search(q: string, options?: SearchSearchOptions): Promise<components["schemas"]["SearchResponseContent"]> {
+  async search(q: string, options?: SearchSearchOptions): Promise<ListResult<components["schemas"]["SearchResult"]>> {
     return this.requestPaginated(
       {
         service: "Search",

package/src/generated/services/templates.ts

@@ -17,6 +17,18 @@ import { Errors } from "../../errors.js";
 /** Template entity from the Basecamp API. */
 export type Template = components["schemas"]["Template"];
 
+/**
+ * Request parameters for createLibraryCopy.
+ */
+export interface CreateLibraryCopyTemplateRequest {
+  /** Template recording id */
+  templateRecordingId: number;
+  /** Destination parent id */
+  destinationParentId: number;
+  /** Confirm granting destination-project access to people referenced by the template. */
+  addingPeopleConfirmed?: boolean;
+}
+
 /**
  * Options for list.
  */
@@ -65,6 +77,92 @@ export interface CreateProjectTemplateRequest {
  */
 export class TemplatesService extends BaseService {
 
+  /**
+   * Get the account's to-do list template library
+   * @returns The template_library
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.templates.getLibrary();
+   * ```
+   */
+  async getLibrary(): Promise<components["schemas"]["GetTemplateLibraryResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "Templates",
+        operation: "GetTemplateLibrary",
+        resourceType: "template_library",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/template_library.json", {
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Start copying a to-do list template into a project
+   * @param req - Template_library_copy creation parameters
+   * @returns The template_library_copy
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.templates.createLibraryCopy({ templateRecordingId: 1, destinationParentId: 1 });
+   * ```
+   */
+  async createLibraryCopy(req: CreateLibraryCopyTemplateRequest): Promise<components["schemas"]["CreateTemplateLibraryCopyResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "Templates",
+        operation: "CreateTemplateLibraryCopy",
+        resourceType: "template_library_copy",
+        isMutation: true,
+      },
+      () =>
+        this.client.POST("/template_library/copies.json", {
+          body: {
+            template_recording_id: req.templateRecordingId,
+            destination_parent_id: req.destinationParentId,
+            adding_people_confirmed: req.addingPeopleConfirmed,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Get the current status of a to-do list template copy
+   * @param copyId - The copy ID
+   * @returns The template_library_copy
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.templates.getLibraryCopy(123);
+   * ```
+   */
+  async getLibraryCopy(copyId: number): Promise<components["schemas"]["GetTemplateLibraryCopyResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "Templates",
+        operation: "GetTemplateLibraryCopy",
+        resourceType: "template_library_copy",
+        isMutation: false,
+        resourceId: copyId,
+      },
+      () =>
+        this.client.GET("/template_library/copies/{copyId}", {
+          params: {
+            path: { copyId },
+          },
+        })
+    );
+    return response;
+  }
+
   /**
    * List all templates visible to the current user
    * @param options - Optional query parameters