@37signals/basecamp 0.11.0 → 0.13.0

package/src/generated/services/google-documents.ts

@@ -0,0 +1,196 @@
+/**
+ * GoogleDocuments 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
+// =============================================================================
+
+/** GoogleDocument entity from the Basecamp API. */
+export type GoogleDocument = components["schemas"]["GoogleDocument"];
+
+/**
+ * Request parameters for createGoogleDocument.
+ */
+export interface CreateGoogleDocumentGoogleDocumentRequest {
+  /** Url */
+  url: string;
+  /** One of "doc", "sheet", "slide", "other". Backed by a Rails enum, so an
+unrecognized value is rejected up front with a field-keyed 422
+({"errors": {"document_type": ["is not a valid document type"]}}) rather
+than reaching validation. */
+  documentType: string;
+  /** Title */
+  title?: string;
+  /** Rich text description (HTML) */
+  description?: string;
+  /** active|drafted — defaults to drafted */
+  status?: string;
+  /** Subscriptions */
+  subscriptions?: number[];
+  /** Whether the document is visible to the project's clients. Applies only
+when creating directly in the tool's vault — an item created inside a
+folder inherits the folder's visibility and ignores this. A client caller
+always creates client-visible records regardless of what is sent. */
+  visibleToClients?: boolean;
+}
+
+/**
+ * Request parameters for updateGoogleDocument.
+ */
+export interface UpdateGoogleDocumentGoogleDocumentRequest {
+  /** Url */
+  url: string;
+  /** One of "doc", "sheet", "slide", "other". Backed by a Rails enum, so an
+unrecognized value is rejected up front with a field-keyed 422
+({"errors": {"document_type": ["is not a valid document type"]}}) rather
+than reaching validation. */
+  documentType: string;
+  /** Title */
+  title?: string;
+  /** Rich text description (HTML) */
+  description?: string;
+  /** Status */
+  status?: "active" | "drafted";
+  /** Subscriptions */
+  subscriptions?: number[];
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for GoogleDocuments operations.
+ */
+export class GoogleDocumentsService extends BaseService {
+
+  /**
+   * Create a new Google document in a vault.
+   * @param bucketId - The bucket ID
+   * @param vaultId - The vault ID
+   * @param req - Google_document creation parameters
+   * @returns The GoogleDocument
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.googleDocuments.createGoogleDocument(123, 123, { url: "example", documentType: "example" });
+   * ```
+   */
+  async createGoogleDocument(bucketId: number, vaultId: number, req: CreateGoogleDocumentGoogleDocumentRequest): Promise<GoogleDocument> {
+    if (!req.url) {
+      throw Errors.validation("Url is required");
+    }
+    if (!req.documentType) {
+      throw Errors.validation("Document type is required");
+    }
+    const response = await this.request(
+      {
+        service: "GoogleDocuments",
+        operation: "CreateGoogleDocument",
+        resourceType: "google_document",
+        isMutation: true,
+        projectId: bucketId,
+        resourceId: vaultId,
+      },
+      () =>
+        this.client.POST("/buckets/{bucketId}/vaults/{vaultId}/google_documents.json", {
+          params: {
+            path: { bucketId, vaultId },
+          },
+          body: {
+            url: req.url,
+            document_type: req.documentType,
+            title: req.title,
+            description: req.description,
+            status: req.status,
+            subscriptions: req.subscriptions,
+            visible_to_clients: req.visibleToClients,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Get a single Google document by id
+   * @param googleDocumentId - The google document ID
+   * @returns The GoogleDocument
+   *
+   * @example
+   * ```ts
+   * const result = await client.googleDocuments.googleDocument(123);
+   * ```
+   */
+  async googleDocument(googleDocumentId: number): Promise<GoogleDocument> {
+    const response = await this.request(
+      {
+        service: "GoogleDocuments",
+        operation: "GetGoogleDocument",
+        resourceType: "google_document",
+        isMutation: false,
+        resourceId: googleDocumentId,
+      },
+      () =>
+        this.client.GET("/google_documents/{googleDocumentId}", {
+          params: {
+            path: { googleDocumentId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Replace a Google document with a new complete representation.
+   * @param googleDocumentId - The google document ID
+   * @param req - Google_document update parameters
+   * @returns The GoogleDocument
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.googleDocuments.updateGoogleDocument(123, { url: "example", documentType: "example" });
+   * ```
+   */
+  async updateGoogleDocument(googleDocumentId: number, req: UpdateGoogleDocumentGoogleDocumentRequest): Promise<GoogleDocument> {
+    if (!req.url) {
+      throw Errors.validation("Url is required");
+    }
+    if (!req.documentType) {
+      throw Errors.validation("Document type is required");
+    }
+    const response = await this.request(
+      {
+        service: "GoogleDocuments",
+        operation: "UpdateGoogleDocument",
+        resourceType: "google_document",
+        isMutation: true,
+        resourceId: googleDocumentId,
+      },
+      () =>
+        this.client.PUT("/google_documents/{googleDocumentId}", {
+          params: {
+            path: { googleDocumentId },
+          },
+          body: {
+            url: req.url,
+            document_type: req.documentType,
+            title: req.title,
+            description: req.description,
+            status: req.status,
+            subscriptions: req.subscriptions,
+          },
+        })
+    );
+    return response;
+  }
+}

package/src/generated/services/index.ts

@@ -4,17 +4,21 @@ export { BoostsService } from "./boosts.js";
 export { CardColumnsService } from "./card-columns.js";
 export { WormholesService } from "./wormholes.js";
 export { MessageTypesService } from "./message-types.js";
+export { CampfiresService } from "./campfires.js";
+export { ClientApprovalsService } from "./client-approvals.js";
+export { ClientCorrespondencesService } from "./client-correspondences.js";
+export { ClientRepliesService } from "./client-replies.js";
 export { ToolsService } from "./tools.js";
+export { TodosService } from "./todos.js";
+export { CloudFilesService } from "./cloud-files.js";
+export { GoogleDocumentsService } from "./google-documents.js";
 export { WebhooksService } from "./webhooks.js";
+export { CalendarsService } from "./calendars.js";
 export { CardsService } from "./cards.js";
 export { CardStepsService } from "./card-steps.js";
 export { CardTablesService } from "./card-tables.js";
 export { EverythingService } from "./everything.js";
-export { CampfiresService } from "./campfires.js";
 export { PeopleService } from "./people.js";
-export { ClientApprovalsService } from "./client-approvals.js";
-export { ClientCorrespondencesService } from "./client-correspondences.js";
-export { ClientRepliesService } from "./client-replies.js";
 export { CommentsService } from "./comments.js";
 export { DocumentsService } from "./documents.js";
 export { GaugesService } from "./gauges.js";
@@ -24,6 +28,9 @@ export { LineupService } from "./lineup.js";
 export { MessageBoardsService } from "./message-boards.js";
 export { MessagesService } from "./messages.js";
 export { MyAssignmentsService } from "./my-assignments.js";
+export { BookmarksService } from "./bookmarks.js";
+export { DraftsService } from "./drafts.js";
+export { MyNotesService } from "./my-notes.js";
 export { CheckinsService } from "./checkins.js";
 export { MyNotificationsService } from "./my-notifications.js";
 export { ProjectsService } from "./projects.js";
@@ -36,10 +43,10 @@ export { SubscriptionsService } from "./subscriptions.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 { TodosService } from "./todos.js";
 export { TodosetsService } from "./todosets.js";
 export { HillChartsService } from "./hill-charts.js";
 export { UploadsService } from "./uploads.js";

package/src/generated/services/messages.ts

@@ -25,6 +25,8 @@ export interface ListMessageOptions extends PaginationOptions {
   sort?: "created_at" | "updated_at";
   /** Filter by direction */
   direction?: "asc" | "desc";
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
+  page?: number;
 }
 
 /**
@@ -96,7 +98,7 @@ export class MessagesService extends BaseService {
         this.client.GET("/message_boards/{boardId}/messages.json", {
           params: {
             path: { boardId },
-            query: { sort: options?.sort, direction: options?.direction },
+            query: { sort: options?.sort, direction: options?.direction, page: options?.page },
           },
         })
       , options

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

@@ -21,6 +21,24 @@ due_later_this_week, due_next_week, due_later */
   scope?: string;
 }
 
+/**
+ * Request parameters for prioritizeAssignment.
+ */
+export interface PrioritizeAssignmentMyAssignmentRequest {
+  /** The recording id to prioritize. */
+  id: number;
+}
+
+/**
+ * Request parameters for reorderUpNext.
+ */
+export interface ReorderUpNextMyAssignmentRequest {
+  /** The recording id to move, chosen the same way as when prioritizing. */
+  sourceId: number;
+  /** The 1-based position to move it to. */
+  position: number;
+}
+
 
 // =============================================================================
 // Service
@@ -106,4 +124,90 @@ export class MyAssignmentsService extends BaseService {
     );
     return response ?? [];
   }
+
+  /**
+   * Add a recording to Up Next — the current user's ordered list of prioritized
+   * @param req - Resource request parameters
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.myAssignments.prioritizeAssignment({ id: 1 });
+   * ```
+   */
+  async prioritizeAssignment(req: PrioritizeAssignmentMyAssignmentRequest): Promise<void> {
+    await this.request(
+      {
+        service: "MyAssignments",
+        operation: "PrioritizeAssignment",
+        resourceType: "resource",
+        isMutation: true,
+      },
+      () =>
+        this.client.POST("/my/priorities.json", {
+          body: {
+            id: req.id,
+          },
+        })
+    );
+  }
+
+  /**
+   * Remove a recording from Up Next. Exact-target:
+   * @param recordingId - The recording ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.myAssignments.deprioritizeAssignment(123);
+   * ```
+   */
+  async deprioritizeAssignment(recordingId: number): Promise<void> {
+    await this.request(
+      {
+        service: "MyAssignments",
+        operation: "DeprioritizeAssignment",
+        resourceType: "resource",
+        isMutation: true,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.DELETE("/my/priorities/{recordingId}", {
+          params: {
+            path: { recordingId },
+          },
+        })
+    );
+  }
+
+  /**
+   * Move an already-prioritized recording to a new 1-based position in Up Next
+   * @param req - Resource request parameters
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.myAssignments.reorderUpNext({ sourceId: 1, position: 1 });
+   * ```
+   */
+  async reorderUpNext(req: ReorderUpNextMyAssignmentRequest): Promise<void> {
+    await this.request(
+      {
+        service: "MyAssignments",
+        operation: "ReorderUpNext",
+        resourceType: "resource",
+        isMutation: true,
+      },
+      () =>
+        this.client.POST("/my/priority_moves.json", {
+          body: {
+            source_id: req.sourceId,
+            position: req.position,
+          },
+        })
+    );
+  }
 }

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

@@ -0,0 +1,92 @@
+/**
+ * MyNotes 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
+// =============================================================================
+
+/** MyNote entity from the Basecamp API. */
+export type MyNote = components["schemas"]["MyNote"];
+
+/**
+ * Request parameters for updateMyNote.
+ */
+export interface UpdateMyNoteMyNoteRequest {
+  /** Note */
+  note: components["schemas"]["MyNoteAttributes"];
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for MyNotes operations.
+ */
+export class MyNotesService extends BaseService {
+
+  /**
+   * Get the authenticated user's note — a per-person notebook singleton at
+   * @returns The MyNote
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.myNotes.getMyNote();
+   * ```
+   */
+  async getMyNote(): Promise<MyNote> {
+    const response = await this.request(
+      {
+        service: "MyNotes",
+        operation: "GetMyNote",
+        resourceType: "my_note",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/my/notes.json", {
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Replace the note's content, recording a new revision server-side.
+   * @param req - My_note update parameters
+   * @returns The MyNote
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.myNotes.updateMyNote({ note: { content: "Hello world" } });
+   * ```
+   */
+  async updateMyNote(req: UpdateMyNoteMyNoteRequest): Promise<MyNote> {
+    if (!req.note) {
+      throw Errors.validation("Note is required");
+    }
+    const response = await this.request(
+      {
+        service: "MyNotes",
+        operation: "UpdateMyNote",
+        resourceType: "my_note",
+        isMutation: true,
+      },
+      () =>
+        this.client.PUT("/my/notes.json", {
+          body: {
+            note: req.note,
+          },
+        })
+    );
+    return response;
+  }
+}

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

@@ -21,7 +21,9 @@ export type Notification = components["schemas"]["Notification"];
  * Options for myNotifications.
  */
 export interface MyNotificationsMyNotificationOptions {
-  /** Page number for paginating through read items. Defaults to 1. */
+  /** Page number for paginating through read items. Defaults to 1. This
+operation is not auto-paginated in any SDK, so a page is returned as
+asked for and later pages are not followed. */
   page?: number;
   /** Set to true to cap `bubble_ups` at 2 current bubble-ups and omit the
 `scheduled_bubble_ups` key entirely. Defaults to false. Use the dedicated
@@ -34,7 +36,7 @@ scheduled bubble-ups. */
  * Options for bubbleUps.
  */
 export interface BubbleUpsMyNotificationOptions extends PaginationOptions {
-  /** Page number. Defaults to 1. */
+  /** Page number. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
   page?: number;
 }
 

package/src/generated/services/people.ts

@@ -57,6 +57,8 @@ export interface UpdateMyProfilePeopleRequest {
  * Options for list.
  */
 export interface ListPeopleOptions extends PaginationOptions {
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
+  page?: number;
 }
 
 /**
@@ -71,6 +73,8 @@ export interface EnableOutOfOfficePeopleRequest {
  * Options for listForProject.
  */
 export interface ListForProjectPeopleOptions extends PaginationOptions {
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
+  page?: number;
 }
 
 /**
@@ -145,7 +149,7 @@ export class PeopleService extends BaseService {
   }
 
   /**
-   * Update the current user's preferences
+   * Update the current user's preferences.
    * @param req - My_preference update parameters
    * @returns The my_preference
    * @throws {BasecampError} If the resource is not found or fields are invalid
@@ -243,6 +247,9 @@ export class PeopleService extends BaseService {
    * @example
    * ```ts
    * const result = await client.people.list();
+   *
+   * // With options
+   * const filtered = await client.people.list({ page: 1 });
    * ```
    */
   async list(options?: ListPeopleOptions): Promise<ListResult<Person>> {
@@ -255,6 +262,9 @@ export class PeopleService extends BaseService {
       },
       () =>
         this.client.GET("/people.json", {
+          params: {
+            query: { page: options?.page },
+          },
         })
       , options
     );
@@ -394,6 +404,9 @@ export class PeopleService extends BaseService {
    * @example
    * ```ts
    * const result = await client.people.listForProject(123);
+   *
+   * // With options
+   * const filtered = await client.people.listForProject(123, { page: 1 });
    * ```
    */
   async listForProject(projectId: number, options?: ListForProjectPeopleOptions): Promise<ListResult<Person>> {
@@ -409,6 +422,7 @@ export class PeopleService extends BaseService {
         this.client.GET("/projects/{projectId}/people.json", {
           params: {
             path: { projectId },
+            query: { page: options?.page },
           },
         })
       , options

package/src/generated/services/projects.ts

@@ -23,6 +23,8 @@ export type Project = components["schemas"]["Project"];
 export interface ListProjectOptions extends PaginationOptions {
   /** Filter by status */
   status?: "active" | "archived" | "trashed";
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
+  page?: number;
 }
 
 /**
@@ -83,7 +85,7 @@ export class ProjectsService extends BaseService {
       () =>
         this.client.GET("/projects.json", {
           params: {
-            query: { status: options?.status },
+            query: { status: options?.status, page: options?.page },
           },
         })
       , options
@@ -221,4 +223,62 @@ export class ProjectsService extends BaseService {
         })
     );
   }
+
+  /**
+   * Restore a project to active status from trash as well as from the archive.
+   * @param projectId - The project ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.projects.unarchive(123);
+   * ```
+   */
+  async unarchive(projectId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Projects",
+        operation: "UnarchiveProject",
+        resourceType: "project",
+        isMutation: true,
+        projectId,
+      },
+      () =>
+        this.client.PUT("/projects/{projectId}/status/active.json", {
+          params: {
+            path: { projectId },
+          },
+        })
+    );
+  }
+
+  /**
+   * Archive a project, removing it from the active project list.
+   * @param projectId - The project ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.projects.archive(123);
+   * ```
+   */
+  async archive(projectId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Projects",
+        operation: "ArchiveProject",
+        resourceType: "project",
+        isMutation: true,
+        projectId,
+      },
+      () =>
+        this.client.PUT("/projects/{projectId}/status/archived.json", {
+          params: {
+            path: { projectId },
+          },
+        })
+    );
+  }
 }

package/src/generated/services/recordings.ts

@@ -28,6 +28,8 @@ export interface ListRecordingOptions extends PaginationOptions {
   sort?: "created_at" | "updated_at";
   /** Filter by direction */
   direction?: "asc" | "desc";
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
+  page?: number;
 }
 
 
@@ -65,43 +67,13 @@ export class RecordingsService extends BaseService {
       () =>
         this.client.GET("/projects/recordings.json", {
           params: {
-            query: { type: type, bucket: options?.bucket?.join(","), status: options?.status, sort: options?.sort, direction: options?.direction },
+            query: { type: type, bucket: options?.bucket?.join(","), status: options?.status, sort: options?.sort, direction: options?.direction, page: options?.page },
           },
         })
       , options
     );
   }
 
-  /**
-   * Get a single recording by id
-   * @param recordingId - The recording ID
-   * @returns The Recording
-   * @throws {BasecampError} If the resource is not found
-   *
-   * @example
-   * ```ts
-   * const result = await client.recordings.get(123);
-   * ```
-   */
-  async get(recordingId: number): Promise<Recording> {
-    const response = await this.request(
-      {
-        service: "Recordings",
-        operation: "GetRecording",
-        resourceType: "recording",
-        isMutation: false,
-        resourceId: recordingId,
-      },
-      () =>
-        this.client.GET("/recordings/{recordingId}", {
-          params: {
-            path: { recordingId },
-          },
-        })
-    );
-    return response;
-  }
-
   /**
    * Unarchive a recording (restore to active status)
    * @param recordingId - The recording ID