@37signals/basecamp 0.19.0 → 0.21.0

package/src/generated/services/bookmarks.ts

@@ -39,7 +39,7 @@ export class BookmarksService extends BaseService {
   /**
    * List the current user's bookmarks, most recently bookmarked first (paginated).
    * @param options - Optional query parameters
-   * @returns All Bookmark across all pages, with .meta.totalCount
+   * @returns Every Bookmark across all pages, with .meta.totalCount
    *
    * @example
    * ```ts

package/src/generated/services/boosts.ts

@@ -122,7 +122,7 @@ export class BoostsService extends BaseService {
    * List boosts on a recording
    * @param recordingId - The recording ID
    * @param options - Optional query parameters
-   * @returns All Boost across all pages, with .meta.totalCount
+   * @returns Every Boost across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -194,7 +194,7 @@ export class BoostsService extends BaseService {
    * @param recordingId - The recording ID
    * @param eventId - The event ID
    * @param options - Optional query parameters
-   * @returns All Boost across all pages, with .meta.totalCount
+   * @returns Every Boost across all pages, with .meta.totalCount
    *
    * @example
    * ```ts

package/src/generated/services/campfires.ts

@@ -112,7 +112,7 @@ export class CampfiresService extends BaseService {
    * @param bucketId - The bucket ID
    * @param campfireId - The campfire ID
    * @param options - Optional query parameters
-   * @returns All Chatbot across all pages, with .meta.totalCount
+   * @returns Every Chatbot across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -288,7 +288,7 @@ export class CampfiresService extends BaseService {
   /**
    * List all campfires across the account
    * @param options - Optional query parameters
-   * @returns All Campfire across all pages, with .meta.totalCount
+   * @returns Every Campfire across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -350,7 +350,7 @@ export class CampfiresService extends BaseService {
    * List all lines (messages) in a campfire
    * @param campfireId - The campfire ID
    * @param options - Optional query parameters
-   * @returns All CampfireLine across all pages, with .meta.totalCount
+   * @returns Every CampfireLine across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -520,7 +520,7 @@ export class CampfiresService extends BaseService {
    * List uploaded files in a campfire
    * @param campfireId - The campfire ID
    * @param options - Optional query parameters
-   * @returns All CampfireLine across all pages, with .meta.totalCount
+   * @returns Every CampfireLine across all pages, with .meta.totalCount
    *
    * @example
    * ```ts

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

@@ -12,8 +12,10 @@ import { Errors } from "../../errors.js";
 // Types
 // =============================================================================
 
-/** CardStep entity from the Basecamp API. */
-export type CardStep = components["schemas"]["CardStep"];
+/** Subtask entity from the Basecamp API. */
+export type Subtask = components["schemas"]["Subtask"];
+/** @deprecated renamed to Subtask, the same Kanban::Step record. */
+export type CardStep = Subtask;
 
 /**
  * Request parameters for reposition.
@@ -21,7 +23,9 @@ export type CardStep = components["schemas"]["CardStep"];
 export interface RepositionCardStepRequest {
   /** Source id */
   sourceId: number;
-  /** 0-indexed position */
+  /** The 1-based position to move it to (1 = top), the same `reposition_to`
+a to-do uses. bc3's doc said "Zero indexed" until BC3 #12659 corrected
+it; the server never was. */
   position: number;
 }
 
@@ -105,7 +109,7 @@ export class CardStepsService extends BaseService {
    * Create a step on a card
    * @param cardId - The card ID
    * @param req - Card_step creation parameters
-   * @returns The CardStep
+   * @returns The Subtask
    * @throws {BasecampError} If required fields are missing or invalid
    *
    * @example
@@ -113,7 +117,7 @@ export class CardStepsService extends BaseService {
    * const result = await client.cardSteps.create(123, { title: "example" });
    * ```
    */
-  async create(cardId: number, req: CreateCardStepRequest): Promise<CardStep> {
+  async create(cardId: number, req: CreateCardStepRequest): Promise<Subtask> {
     if (!req.title) {
       throw Errors.validation("Title is required");
     }
@@ -146,7 +150,7 @@ export class CardStepsService extends BaseService {
   /**
    * Get a step by ID
    * @param stepId - The step ID
-   * @returns The CardStep
+   * @returns The Subtask
    * @throws {BasecampError} If the resource is not found
    *
    * @example
@@ -154,7 +158,7 @@ export class CardStepsService extends BaseService {
    * const result = await client.cardSteps.get(123);
    * ```
    */
-  async get(stepId: number): Promise<CardStep> {
+  async get(stepId: number): Promise<Subtask> {
     const response = await this.request(
       {
         service: "CardSteps",
@@ -177,7 +181,7 @@ export class CardStepsService extends BaseService {
    * Update an existing step
    * @param stepId - The step ID
    * @param req - Card_step update parameters
-   * @returns The CardStep
+   * @returns The Subtask
    * @throws {BasecampError} If the resource is not found or fields are invalid
    *
    * @example
@@ -185,7 +189,7 @@ export class CardStepsService extends BaseService {
    * const result = await client.cardSteps.update(123, { });
    * ```
    */
-  async update(stepId: number, req: UpdateCardStepRequest): Promise<CardStep> {
+  async update(stepId: number, req: UpdateCardStepRequest): Promise<Subtask> {
     if (req.dueOn && !/^\d{4}-\d{2}-\d{2}$/.test(req.dueOn)) {
       throw Errors.validation("Due on must be in YYYY-MM-DD format");
     }
@@ -216,7 +220,7 @@ export class CardStepsService extends BaseService {
    * Set card step completion status (PUT with completion: "on" to complete, "" to uncomplete)
    * @param stepId - The step ID
    * @param req - Card_step_completion request parameters
-   * @returns The CardStep
+   * @returns The Subtask
    * @throws {BasecampError} If the request fails
    *
    * @example
@@ -224,7 +228,7 @@ export class CardStepsService extends BaseService {
    * const result = await client.cardSteps.setCompletion(123, { completion: "example" });
    * ```
    */
-  async setCompletion(stepId: number, req: SetCompletionCardStepRequest): Promise<CardStep> {
+  async setCompletion(stepId: number, req: SetCompletionCardStepRequest): Promise<Subtask> {
     if (!req.completion) {
       throw Errors.validation("Completion is required");
     }

package/src/generated/services/cards.ts

@@ -181,7 +181,7 @@ export class CardsService extends BaseService {
    * List cards in a column
    * @param columnId - The column ID
    * @param options - Optional query parameters
-   * @returns All Card across all pages, with .meta.totalCount
+   * @returns Every Card across all pages, with .meta.totalCount
    *
    * @example
    * ```ts

package/src/generated/services/checkins.ts

@@ -257,7 +257,7 @@ export class CheckinsService extends BaseService {
    * List all questions in a questionnaire
    * @param questionnaireId - The questionnaire ID
    * @param options - Optional query parameters
-   * @returns All Question across all pages, with .meta.totalCount
+   * @returns Every Question across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -399,7 +399,7 @@ export class CheckinsService extends BaseService {
    * List all answers for a question
    * @param questionId - The question ID
    * @param options - Optional query parameters
-   * @returns All Answer across all pages, with .meta.totalCount
+   * @returns Every Answer across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -474,7 +474,7 @@ export class CheckinsService extends BaseService {
    * List all people who have answered a question (answerers)
    * @param questionId - The question ID
    * @param options - Optional query parameters
-   * @returns All Person across all pages, with .meta.totalCount
+   * @returns Every Person across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -505,7 +505,7 @@ export class CheckinsService extends BaseService {
    * @param questionId - The question ID
    * @param personId - The person ID
    * @param options - Optional query parameters
-   * @returns All Answer across all pages, with .meta.totalCount
+   * @returns Every Answer across all pages, with .meta.totalCount
    *
    * @example
    * ```ts

package/src/generated/services/client-approvals.ts

@@ -42,7 +42,7 @@ export class ClientApprovalsService extends BaseService {
    * List all client approvals in a project
    * @param bucketId - The bucket ID
    * @param options - Optional query parameters
-   * @returns All ClientApproval across all pages, with .meta.totalCount
+   * @returns Every ClientApproval across all pages, with .meta.totalCount
    *
    * @example
    * ```ts

package/src/generated/services/client-correspondences.ts

@@ -42,7 +42,7 @@ export class ClientCorrespondencesService extends BaseService {
    * List all client correspondences in a project
    * @param bucketId - The bucket ID
    * @param options - Optional query parameters
-   * @returns All ClientCorrespondence across all pages, with .meta.totalCount
+   * @returns Every ClientCorrespondence across all pages, with .meta.totalCount
    *
    * @example
    * ```ts

package/src/generated/services/client-replies.ts

@@ -39,7 +39,7 @@ export class ClientRepliesService extends BaseService {
    * @param bucketId - The bucket ID
    * @param recordingId - The recording ID
    * @param options - Optional query parameters
-   * @returns All ClientReply across all pages, with .meta.totalCount
+   * @returns Every ClientReply across all pages, with .meta.totalCount
    *
    * @example
    * ```ts

package/src/generated/services/comments.ts

@@ -122,7 +122,7 @@ export class CommentsService extends BaseService {
    * List comments on a recording
    * @param recordingId - The recording ID
    * @param options - Optional query parameters
-   * @returns All Comment across all pages, with .meta.totalCount
+   * @returns Every Comment across all pages, with .meta.totalCount
    *
    * @example
    * ```ts

package/src/generated/services/documents.ts

@@ -130,7 +130,7 @@ export class DocumentsService extends BaseService {
    * List documents in a vault
    * @param vaultId - The vault ID
    * @param options - Optional query parameters
-   * @returns All Document across all pages, with .meta.totalCount
+   * @returns Every Document across all pages, with .meta.totalCount
    *
    * @example
    * ```ts

package/src/generated/services/drafts.ts

@@ -37,7 +37,7 @@ export class DraftsService extends BaseService {
   /**
    * List the current user's drafts across their active projects, most recently
    * @param options - Optional query parameters
-   * @returns All Draft across all pages, with .meta.totalCount
+   * @returns Every Draft across all pages, with .meta.totalCount
    *
    * @example
    * ```ts

package/src/generated/services/events.ts

@@ -38,7 +38,7 @@ export class EventsService extends BaseService {
    * List all events for a recording
    * @param recordingId - The recording ID
    * @param options - Optional query parameters
-   * @returns All Event across all pages, with .meta.totalCount
+   * @returns Every Event across all pages, with .meta.totalCount
    *
    * @example
    * ```ts

package/src/generated/services/everything.ts

@@ -222,7 +222,7 @@ export class EverythingService extends BaseService {
   /**
    * Completed cards across all accessible projects, grouped by project (paginated).
    * @param options - Optional query parameters
-   * @returns All BucketCardsGroup across all pages, with .meta.totalCount
+   * @returns Every BucketCardsGroup across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -250,7 +250,7 @@ export class EverythingService extends BaseService {
   /**
    * Open cards with no due date across all accessible projects, grouped by project (paginated).
    * @param options - Optional query parameters
-   * @returns All BucketCardsGroup across all pages, with .meta.totalCount
+   * @returns Every BucketCardsGroup across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -278,7 +278,7 @@ export class EverythingService extends BaseService {
   /**
    * Cards parked in a project's "Not now" column across all accessible projects, grouped by project (paginated).
    * @param options - Optional query parameters
-   * @returns All BucketCardsGroup across all pages, with .meta.totalCount
+   * @returns Every BucketCardsGroup across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -306,7 +306,7 @@ export class EverythingService extends BaseService {
   /**
    * Incomplete cards in active columns across all accessible projects, grouped by project (paginated).
    * @param options - Optional query parameters
-   * @returns All BucketCardsGroup across all pages, with .meta.totalCount
+   * @returns Every BucketCardsGroup across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -362,7 +362,7 @@ export class EverythingService extends BaseService {
   /**
    * Open, unassigned cards across all accessible projects, grouped by project (paginated).
    * @param options - Optional query parameters
-   * @returns All BucketCardsGroup across all pages, with .meta.totalCount
+   * @returns Every BucketCardsGroup across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -390,7 +390,7 @@ export class EverythingService extends BaseService {
   /**
    * Get every automatic check-in answer across all accessible projects, newest-first.
    * @param options - Optional query parameters
-   * @returns All Recording across all pages, with .meta.totalCount
+   * @returns Every Recording across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -418,7 +418,7 @@ export class EverythingService extends BaseService {
   /**
    * Get every comment across all accessible projects, newest-first (paginated).
    * @param options - Optional query parameters
-   * @returns All Recording across all pages, with .meta.totalCount
+   * @returns Every Recording across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -446,7 +446,7 @@ export class EverythingService extends BaseService {
   /**
    * Get every file recording across all accessible projects, newest-first (paginated).
    * @param options - Optional query parameters
-   * @returns All EverythingFile across all pages, with .meta.totalCount
+   * @returns Every EverythingFile across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -474,7 +474,7 @@ export class EverythingService extends BaseService {
   /**
    * Get every inbox forward across all accessible projects, newest-first (paginated).
    * @param options - Optional query parameters
-   * @returns All Recording across all pages, with .meta.totalCount
+   * @returns Every Recording across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -502,7 +502,7 @@ export class EverythingService extends BaseService {
   /**
    * Get every message across all accessible projects, newest-first (paginated).
    * @param options - Optional query parameters
-   * @returns All Recording across all pages, with .meta.totalCount
+   * @returns Every Recording across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -530,7 +530,7 @@ export class EverythingService extends BaseService {
   /**
    * Completed to-dos across all accessible projects, grouped by project (paginated).
    * @param options - Optional query parameters
-   * @returns All BucketTodosGroup across all pages, with .meta.totalCount
+   * @returns Every BucketTodosGroup across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -558,7 +558,7 @@ export class EverythingService extends BaseService {
   /**
    * Open to-dos with no due date across all accessible projects, grouped by project (paginated).
    * @param options - Optional query parameters
-   * @returns All BucketTodosGroup across all pages, with .meta.totalCount
+   * @returns Every BucketTodosGroup across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -586,7 +586,7 @@ export class EverythingService extends BaseService {
   /**
    * Active, incomplete to-dos across all accessible projects, grouped by project (paginated).
    * @param options - Optional query parameters
-   * @returns All BucketTodosGroup across all pages, with .meta.totalCount
+   * @returns Every BucketTodosGroup across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -642,7 +642,7 @@ export class EverythingService extends BaseService {
   /**
    * Open, unassigned to-dos across all accessible projects, grouped by project (paginated).
    * @param options - Optional query parameters
-   * @returns All BucketTodosGroup across all pages, with .meta.totalCount
+   * @returns Every BucketTodosGroup across all pages, with .meta.totalCount
    *
    * @example
    * ```ts

package/src/generated/services/forwards.ts

@@ -84,7 +84,7 @@ export class ForwardsService extends BaseService {
    * List all replies to a forward
    * @param forwardId - The forward ID
    * @param options - Optional query parameters
-   * @returns All ForwardReply across all pages, with .meta.totalCount
+   * @returns Every ForwardReply across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -179,7 +179,7 @@ export class ForwardsService extends BaseService {
    * List all forwards in an inbox
    * @param inboxId - The inbox ID
    * @param options - Optional query parameters
-   * @returns All Forward across all pages, with .meta.totalCount
+   * @returns Every Forward across all pages, with .meta.totalCount
    *
    * @example
    * ```ts

package/src/generated/services/index.ts

@@ -9,6 +9,7 @@ export { ClientApprovalsService } from "./client-approvals.js";
 export { ClientCorrespondencesService } from "./client-correspondences.js";
 export { ClientRepliesService } from "./client-replies.js";
 export { ToolsService } from "./tools.js";
+export { TemplatesService } from "./templates.js";
 export { TodosService } from "./todos.js";
 export { CloudFilesService } from "./cloud-files.js";
 export { GoogleDocumentsService } from "./google-documents.js";
@@ -24,7 +25,6 @@ export { DocumentsService } from "./documents.js";
 export { EventFeedService } from "./event-feed.js";
 export { GaugesService } from "./gauges.js";
 export { ForwardsService } from "./forwards.js";
-export { AutomationService } from "./automation.js";
 export { LineupService } from "./lineup.js";
 export { MessageBoardsService } from "./message-boards.js";
 export { MessagesService } from "./messages.js";
@@ -42,11 +42,11 @@ export { BubbleUpsService } from "./bubble-ups.js";
 export { ClientVisibilityService } from "./client-visibility.js";
 export { EventsService } from "./events.js";
 export { SubscriptionsService } from "./subscriptions.js";
+export { SubtasksService } from "./subtasks.js";
 export { ReportsService } from "./reports.js";
 export { SchedulesService } from "./schedules.js";
 export { SearchService } from "./search.js";
 export { FoldersService } from "./folders.js";
-export { TemplatesService } from "./templates.js";
 export { TodolistGroupsService } from "./todolist-groups.js";
 export { TodolistsService } from "./todolists.js";
 export { TodosetsService } from "./todosets.js";

package/src/generated/services/lineup.ts

@@ -12,6 +12,8 @@ import { Errors } from "../../errors.js";
 // Types
 // =============================================================================
 
+/** LineupMarker entity from the Basecamp API. */
+export type LineupMarker = components["schemas"]["LineupMarker"];
 
 /**
  * Request parameters for create.
@@ -43,6 +45,30 @@ export interface UpdateLineupRequest {
  */
 export class LineupService extends BaseService {
 
+  /**
+   * List all lineup markers for the account
+   * @returns Array of LineupMarker
+   *
+   * @example
+   * ```ts
+   * const result = await client.lineup.listLineupMarkers();
+   * ```
+   */
+  async listLineupMarkers(): Promise<LineupMarker[]> {
+    const response = await this.request(
+      {
+        service: "Lineup",
+        operation: "ListLineupMarkers",
+        resourceType: "lineup_marker",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/lineup/markers.json", {
+        })
+    );
+    return response ?? [];
+  }
+
   /**
    * Create a new lineup marker
    * @param req - Lineup_marker creation parameters

package/src/generated/services/message-types.ts

@@ -57,7 +57,7 @@ export class MessageTypesService extends BaseService {
    * List message types in a project
    * @param bucketId - The bucket ID
    * @param options - Optional query parameters
-   * @returns All MessageType across all pages, with .meta.totalCount
+   * @returns Every MessageType across all pages, with .meta.totalCount
    *
    * @example
    * ```ts

package/src/generated/services/messages.ts

@@ -75,7 +75,7 @@ export class MessagesService extends BaseService {
    * List messages on a message board
    * @param boardId - The board ID
    * @param options - Optional query parameters
-   * @returns All Message across all pages, with .meta.totalCount
+   * @returns Every Message across all pages, with .meta.totalCount
    *
    * @example
    * ```ts

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

@@ -44,7 +44,8 @@ export interface BubbleUpsMyNotificationOptions extends PaginationOptions {
  * Request parameters for markAsRead.
  */
 export interface MarkAsReadMyNotificationRequest {
-  /** Array of readable_sgid values identifying the items to mark as read */
+  /** Array of readable_sgid values identifying the items to mark as read.
+At most 500 per request. */
   readables: string[];
 }
 
@@ -89,7 +90,7 @@ export class MyNotificationsService extends BaseService {
   /**
    * Get the current user's current and scheduled bubble-ups (paginated, 50 per page).
    * @param options - Optional query parameters
-   * @returns All Notification across all pages, with .meta.totalCount
+   * @returns Every Notification across all pages, with .meta.totalCount
    *
    * @example
    * ```ts

package/src/generated/services/people.ts

@@ -114,7 +114,7 @@ export class PeopleService extends BaseService {
   /**
    * List all account users who can be pinged
    * @param options - Optional query parameters
-   * @returns All Person across all pages, with .meta.totalCount
+   * @returns Every Person across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -254,7 +254,7 @@ export class PeopleService extends BaseService {
   /**
    * List all people visible to the current user
    * @param options - Optional query parameters
-   * @returns All Person across all pages, with .meta.totalCount
+   * @returns Every Person across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -471,7 +471,7 @@ export class PeopleService extends BaseService {
    * List all active people on a project
    * @param projectId - The project ID
    * @param options - Optional query parameters
-   * @returns All Person across all pages, with .meta.totalCount
+   * @returns Every Person across all pages, with .meta.totalCount
    *
    * @example
    * ```ts

package/src/generated/services/projects.ts

@@ -88,7 +88,7 @@ export class ProjectsService extends BaseService {
   /**
    * List projects (active by default; optionally archived/trashed)
    * @param options - Optional query parameters
-   * @returns All Project across all pages, with .meta.totalCount
+   * @returns Every Project across all pages, with .meta.totalCount
    *
    * @example
    * ```ts

package/src/generated/services/recordings.ts

@@ -46,7 +46,7 @@ export class RecordingsService extends BaseService {
    * List recordings of a given type across projects
    * @param type - Comment|Document|Door|Kanban::Card|Kanban::Step|Message|Question::Answer|Schedule::Entry|Todo|Todolist|Upload|Vault
    * @param options - Optional query parameters
-   * @returns All Recording across all pages, with .meta.totalCount
+   * @returns Every Recording across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
@@ -163,7 +163,7 @@ export class RecordingsService extends BaseService {
   }
 
   /**
-   * Archive a recording
+   * Archive a recording; bc3 answers 403 for types it never lets be archived, timesheet entries among them
    * @param recordingId - The recording ID
    * @returns void
    * @throws {BasecampError} If the request fails
@@ -192,7 +192,7 @@ export class RecordingsService extends BaseService {
   }
 
   /**
-   * Trash a recording. Trashed items can be recovered.
+   * Trash a recording; bc3 answers 403 for types it never lets be trashed, timesheet entries among them (DestroyTimesheetEntry removes those, permanently). Trashed items can be recovered.
    * @param recordingId - The recording ID
    * @returns void
    * @throws {BasecampError} If the request fails

package/src/generated/services/reports.ts

@@ -55,7 +55,7 @@ export class ReportsService extends BaseService {
   /**
    * Get account-wide activity feed (progress report)
    * @param options - Optional query parameters
-   * @returns All TimelineEvent across all pages, with .meta.totalCount
+   * @returns Every TimelineEvent across all pages, with .meta.totalCount
    *
    * @example
    * ```ts

package/src/generated/services/schedules.ts

@@ -353,7 +353,7 @@ export class SchedulesService extends BaseService {
    * List entries on a schedule
    * @param scheduleId - The schedule ID
    * @param options - Optional query parameters
-   * @returns All ScheduleEntry across all pages, with .meta.totalCount
+   * @returns Every ScheduleEntry across all pages, with .meta.totalCount
    *
    * @example
    * ```ts