@37signals/basecamp 0.23.0 → 0.25.0

package/src/generated/schema.d.ts

@@ -712,7 +712,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** @description Move a column within a card table */
+        /** @description 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. */
         post: operations["MoveCardColumn"];
         delete?: never;
         options?: never;
@@ -1464,7 +1464,7 @@ export interface paths {
         /** @description List all lineup markers for the account */
         get: operations["ListLineupMarkers"];
         put?: never;
-        /** @description Create a new lineup marker */
+        /** @description Create a new lineup marker. Returns the created marker. */
         post: operations["CreateLineupMarker"];
         delete?: never;
         options?: never;
@@ -1480,7 +1480,7 @@ export interface paths {
             cookie?: never;
         };
         get?: never;
-        /** @description Update an existing lineup marker */
+        /** @description Update an existing lineup marker. Returns the updated marker. */
         put: operations["UpdateLineupMarker"];
         post?: never;
         /** @description Delete a lineup marker */
@@ -1846,7 +1846,7 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * @description Get the current user's notification inbox (the "Hey!" menu).
+         * @description Get the current user's notifications (the "Hey!" menu in Basecamp 4).
          *     Notifications are grouped into unreads, reads, bubble-ups, and
          *     scheduled bubble-ups (`memories` remains as an always-empty
          *     placeholder on BC5). Reads are paginated (50 per page). Unreads are
@@ -2372,7 +2372,7 @@ export interface paths {
         };
         /** @description Get a single question by id */
         get: operations["GetQuestion"];
-        /** @description Update an existing question */
+        /** @description 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. */
         put: operations["UpdateQuestion"];
         post?: never;
         delete?: never;
@@ -2649,10 +2649,10 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description List boosts on a specific event within a recording */
+        /** @description 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. */
         get: operations["ListEventBoosts"];
         put?: never;
-        /** @description Create a boost on a specific event within a recording */
+        /** @description 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. */
         post: operations["CreateEventBoost"];
         delete?: never;
         options?: never;
@@ -4633,6 +4633,7 @@ export interface components {
             name: string;
             date: string;
         };
+        CreateLineupMarkerResponseContent: components["schemas"]["LineupMarker"];
         CreateMessageRequestContent: {
             subject: string;
             content?: string;
@@ -5038,8 +5039,14 @@ export interface components {
             created_at: string;
             creator: components["schemas"]["Person"];
             performed_by?: components["schemas"]["Person"];
-            /** Format: int32 */
+            /**
+             * Format: int32
+             * @description Present only on boostable events (action completed, adopted,
+             *     column_changed or moved_in); the event boost operations refuse any
+             *     other event with 403.
+             */
             boosts_count?: number;
+            /** @description Present only on boostable events; see boosts_count. */
             boosts_url?: string;
         };
         EventDetails: {
@@ -5855,11 +5862,23 @@ export interface components {
             updated_at: string;
         };
         MoveCardColumnRequestContent: {
-            /** Format: int64 */
+            /**
+             * Format: int64
+             * @description The column to move.
+             */
             source_id: number;
-            /** Format: int64 */
+            /**
+             * Format: int64
+             * @description The card table the column moves within: the same id as `cardTableId`.
+             *     Basecamp refuses any other destination, a column included, with 422.
+             */
             target_id: number;
-            /** Format: int32 */
+            /**
+             * Format: int32
+             * @description 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;
         };
         MoveCardRequestContent: {
@@ -6194,6 +6213,11 @@ export interface components {
             start_date?: string;
             end_date?: string;
             clients_enabled?: boolean;
+            /**
+             * @description True when the project's timesheet is turned on. The project timesheet
+             *     report (GET /projects/{projectId}/timesheet.json) answers 404 until it is.
+             */
+            timesheet_enabled?: boolean;
             bookmark_url?: string;
             /** @description Bucket stars collection for this project (`/buckets/{id}/stars.json`). */
             star_url?: string;
@@ -7947,6 +7971,7 @@ export interface components {
             name?: string;
             date?: string;
         };
+        UpdateLineupMarkerResponseContent: components["schemas"]["LineupMarker"];
         UpdateMessageRequestContent: {
             subject?: string;
             content?: string;
@@ -8021,9 +8046,9 @@ export interface components {
             subscribed?: boolean;
         };
         UpdateQuestionRequestContent: {
+            /** @description The question text. An update carries a title, a schedule or both. */
             title?: string;
             schedule?: components["schemas"]["QuestionScheduleInput"];
-            paused?: boolean;
         };
         UpdateQuestionResponseContent: components["schemas"]["Question"];
         UpdateScheduleSettingsRequestContent: {
@@ -14884,7 +14909,9 @@ export interface operations {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": components["schemas"]["CreateLineupMarkerResponseContent"];
+                };
             };
             /** @description UnauthorizedError 401 response */
             401: {
@@ -14953,7 +14980,9 @@ export interface operations {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": components["schemas"]["UpdateLineupMarkerResponseContent"];
+                };
             };
             /** @description UnauthorizedError 401 response */
             401: {

package/src/generated/services/boosts.ts

@@ -190,7 +190,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 +225,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/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/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
    *