@37signals/basecamp 0.24.0 → 0.26.0

package/src/generated/services/boosts.ts

@@ -17,6 +17,14 @@ import { Errors } from "../../errors.js";
 /** Boost entity from the Basecamp API. */
 export type Boost = components["schemas"]["Boost"];
 
+/**
+ * Request parameters for update.
+ */
+export interface UpdateBoostRequest {
+  /** Text content */
+  content: string;
+}
+
 /**
  * Options for listForRecording.
  */
@@ -89,6 +97,43 @@ export class BoostsService extends BaseService {
     return response;
   }
 
+  /**
+   * Replace the content of a boost. Only the boost's creator may update it: an
+   * @param boostId - The boost ID
+   * @param req - Boost update parameters
+   * @returns The Boost
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.boosts.update(123, { content: "Hello world" });
+   * ```
+   */
+  async update(boostId: number, req: UpdateBoostRequest): Promise<Boost> {
+    if (!req.content) {
+      throw Errors.validation("Content is required");
+    }
+    const response = await this.request(
+      {
+        service: "Boosts",
+        operation: "UpdateBoost",
+        resourceType: "boost",
+        isMutation: true,
+        resourceId: boostId,
+      },
+      () =>
+        this.client.PUT("/boosts/{boostId}", {
+          params: {
+            path: { boostId },
+          },
+          body: {
+            content: req.content,
+          },
+        })
+    );
+    return response;
+  }
+
   /**
    * Delete a boost
    * @param boostId - The boost ID
@@ -190,7 +235,7 @@ export class BoostsService extends BaseService {
   }
 
   /**
-   * List boosts on a specific event within a recording
+   * List boosts on a specific event within a recording. Only boostable events carry boosts: those whose action is completed, adopted, column_changed or moved_in (their JSON includes boosts_count and boosts_url). Any other event answers 403 Forbidden; an event on a recording the person cannot see answers 404.
    * @param recordingId - The recording ID
    * @param eventId - The event ID
    * @param options - Optional query parameters
@@ -225,7 +270,7 @@ export class BoostsService extends BaseService {
   }
 
   /**
-   * Create a boost on a specific event within a recording
+   * Create a boost on a specific event within a recording. Only boostable events accept one: those whose action is completed, adopted, column_changed or moved_in (their JSON includes boosts_count and boosts_url). Any other event answers 403 Forbidden, as does an event on a recording whose comments are closed; an event on a recording the person cannot see answers 404.
    * @param recordingId - The recording ID
    * @param eventId - The event ID
    * @param req - Event_boost creation parameters

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

@@ -47,11 +47,14 @@ export interface CreateCardColumnRequest {
  * Request parameters for move.
  */
 export interface MoveCardColumnRequest {
-  /** Source id */
+  /** The column to move. */
   sourceId: number;
-  /** Target id */
+  /** The card table the column moves within: the same id as `cardTableId`.
+Basecamp refuses any other destination, a column included, with 422. */
   targetId: number;
-  /** Position for ordering (1-based) */
+  /** 1-based slot among the card table's columns, not counting Triage,
+Not Now or Done. 1 puts the column first; a slot past the last puts it
+last. Default: 1. */
   position?: number;
 }
 
@@ -330,7 +333,7 @@ export class CardColumnsService extends BaseService {
   }
 
   /**
-   * Move a column within a card table
+   * Move a column to a slot within its card table. target_id is the card table's own id (the same as cardTableId), not a column; position is the 1-based slot among the columns, not counting Triage, Not Now or Done.
    * @param cardTableId - The card table ID
    * @param req - Card_column request parameters
    * @returns void

package/src/generated/services/cards.ts

@@ -35,7 +35,8 @@ export interface UpdateVerbatimCardRequest {
  * Request parameters for move.
  */
 export interface MoveCardRequest {
-  /** Column id */
+  /** Any column in the card's project, on this or another card table, or a
+wormhole id to send the card to another project. */
   columnId: number;
   /** 1-indexed position within the destination column. Defaults to 1 (top). */
   position?: number;
@@ -144,7 +145,7 @@ export class CardsService extends BaseService {
   }
 
   /**
-   * Move a card to a different column
+   * Move a card to any column in its project, including on another card table there, or through a linked wormhole to another project (queued: the card gets a new id, and position, if sent, must still be positive but doesn't set placement).
    * @param cardId - The card ID
    * @param req - Card request parameters
    * @returns void

package/src/generated/services/checkins.ts

@@ -65,12 +65,10 @@ export interface CreateQuestionCheckinRequest {
  * Request parameters for updateQuestion.
  */
 export interface UpdateQuestionCheckinRequest {
-  /** Title */
+  /** The question text. An update carries a title, a schedule or both. */
   title?: string;
   /** Schedule */
   schedule?: components["schemas"]["QuestionScheduleInput"];
-  /** Paused */
-  paused?: boolean;
 }
 
 /**
@@ -361,7 +359,7 @@ export class CheckinsService extends BaseService {
   }
 
   /**
-   * Update an existing question
+   * Update an existing question's title, schedule or both. A schedule replaces the whole schedule, so send every part of it: one without frequency or time_of_day is refused, and one without start_date re-anchors the recurrence on today. Pausing and resuming are PauseQuestion and ResumeQuestion.
    * @param questionId - The question ID
    * @param req - Question update parameters
    * @returns The Question
@@ -389,7 +387,6 @@ export class CheckinsService extends BaseService {
           body: {
             title: req.title,
             schedule: req.schedule,
-            paused: req.paused,
           },
         })
     );

package/src/generated/services/index.ts

@@ -19,6 +19,7 @@ export { CardsService } from "./cards.js";
 export { CardStepsService } from "./card-steps.js";
 export { CardTablesService } from "./card-tables.js";
 export { EverythingService } from "./everything.js";
+export { PingsService } from "./pings.js";
 export { PeopleService } from "./people.js";
 export { CommentsService } from "./comments.js";
 export { DocumentsService } from "./documents.js";

package/src/generated/services/lineup.ts

@@ -70,24 +70,24 @@ export class LineupService extends BaseService {
   }
 
   /**
-   * Create a new lineup marker
+   * Create a new lineup marker. Returns the created marker.
    * @param req - Lineup_marker creation parameters
-   * @returns void
+   * @returns The LineupMarker
    * @throws {BasecampError} If required fields are missing or invalid
    *
    * @example
    * ```ts
-   * await client.lineup.create({ name: "My example", date: "example" });
+   * const result = await client.lineup.create({ name: "My example", date: "example" });
    * ```
    */
-  async create(req: CreateLineupRequest): Promise<void> {
+  async create(req: CreateLineupRequest): Promise<LineupMarker> {
     if (!req.name) {
       throw Errors.validation("Name is required");
     }
     if (!req.date) {
       throw Errors.validation("Date is required");
     }
-    await this.request(
+    const response = await this.request(
       {
         service: "Lineup",
         operation: "CreateLineupMarker",
@@ -102,22 +102,23 @@ export class LineupService extends BaseService {
           },
         })
     );
+    return response;
   }
 
   /**
-   * Update an existing lineup marker
+   * Update an existing lineup marker. Returns the updated marker.
    * @param markerId - The marker ID
    * @param req - Lineup_marker update parameters
-   * @returns void
+   * @returns The LineupMarker
    * @throws {BasecampError} If the resource is not found or fields are invalid
    *
    * @example
    * ```ts
-   * await client.lineup.update(123, { });
+   * const result = await client.lineup.update(123, { });
    * ```
    */
-  async update(markerId: number, req: UpdateLineupRequest): Promise<void> {
-    await this.request(
+  async update(markerId: number, req: UpdateLineupRequest): Promise<LineupMarker> {
+    const response = await this.request(
       {
         service: "Lineup",
         operation: "UpdateLineupMarker",
@@ -136,6 +137,7 @@ export class LineupService extends BaseService {
           },
         })
     );
+    return response;
   }
 
   /**

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

@@ -60,7 +60,7 @@ At most 500 per request. */
 export class MyNotificationsService extends BaseService {
 
   /**
-   * Get the current user's notification inbox (the "Hey!" menu).
+   * Get the current user's notifications (the "Hey!" menu in Basecamp 4).
    * @param options - Optional query parameters
    * @returns The my_notification
    *

package/src/generated/services/pings.ts

@@ -0,0 +1,125 @@
+/**
+ * Pings 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
+// =============================================================================
+
+
+/**
+ * Request parameters for create.
+ */
+export interface CreatePingRequest {
+  /** Person ids of the people to ping. People the caller cannot reach are
+dropped. */
+  userIds: number[];
+  /** Create a new group even when a Ping with exactly these people exists. */
+  newGroup?: boolean;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Pings operations.
+ */
+export class PingsService extends BaseService {
+
+  /**
+   * Get Pings: the caller's active Pings that have a line in them, most
+   * @returns Array of results
+   *
+   * @example
+   * ```ts
+   * const result = await client.pings.list();
+   * ```
+   */
+  async list(): Promise<components["schemas"]["ListPingsResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "Pings",
+        operation: "ListPings",
+        resourceType: "ping",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/circles.json", {
+        })
+    );
+    return response ?? [];
+  }
+
+  /**
+   * Create a Ping with people, or return the one that already holds exactly
+   * @param req - Ping creation parameters
+   * @returns The ping
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.pings.create({ userIds: [1234] });
+   * ```
+   */
+  async create(req: CreatePingRequest): Promise<components["schemas"]["CreatePingResponseContent"]> {
+    if (!req.userIds) {
+      throw Errors.validation("User ids is required");
+    }
+    const response = await this.request(
+      {
+        service: "Pings",
+        operation: "CreatePing",
+        resourceType: "ping",
+        isMutation: true,
+      },
+      () =>
+        this.client.POST("/circles.json", {
+          body: {
+            user_ids: req.userIds,
+            new_group: req.newGroup,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Get a Ping by its id, which is its bucket's id.
+   * @param pingId - A Ping's id is the id of the bucket that holds it (the bucket type is
+"Circle", which is also the wire path), so the `bucket.id` a Ping's
+recordings carry is the id GetPing takes.
+   * @returns The ping
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.pings.get(123);
+   * ```
+   */
+  async get(pingId: number): Promise<components["schemas"]["GetPingResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "Pings",
+        operation: "GetPing",
+        resourceType: "ping",
+        isMutation: false,
+        resourceId: pingId,
+      },
+      () =>
+        this.client.GET("/circles/{pingId}", {
+          params: {
+            path: { pingId },
+          },
+        })
+    );
+    return response;
+  }
+}

package/src/generated/services/wormholes.ts

@@ -41,7 +41,7 @@ export interface CreateWormholeRequest {
 export class WormholesService extends BaseService {
 
   /**
-   * Update a wormhole's destination column
+   * Point a card table's wormhole, its shortcut for sending cards to another card table, at a different destination column
    * @param bucketId - The bucket ID
    * @param wormholeId - The wormhole ID
    * @param req - Wormhole update parameters
@@ -77,7 +77,7 @@ export class WormholesService extends BaseService {
   }
 
   /**
-   * Delete a wormhole
+   * Permanently delete a card table's wormhole, the shortcut that sends cards to another card table.
    * @param bucketId - The bucket ID
    * @param wormholeId - The wormhole ID
    * @returns void
@@ -108,7 +108,7 @@ export class WormholesService extends BaseService {
   }
 
   /**
-   * Create a wormhole linking this card table to a column on another card table.
+   * Add a wormhole to a card table: a standing shortcut that sends cards to a column on another card table, usually in another project.
    * @param bucketId - The bucket ID
    * @param cardTableId - The card table ID
    * @param req - Wormhole creation parameters