@37signals/basecamp 0.12.0 → 0.14.0

package/src/generated/services/folders.ts

@@ -0,0 +1,201 @@
+/**
+ * Folders 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
+// =============================================================================
+
+/** Folder entity from the Basecamp API. */
+export type Folder = components["schemas"]["Folder"];
+/** FolderWithProjects entity from the Basecamp API. */
+export type FolderWithProjects = components["schemas"]["FolderWithProjects"];
+
+/**
+ * Request parameters for createFolder.
+ */
+export interface CreateFolderFolderRequest {
+  /** The folder's name. Defaults to `New folder` when blank, null, or omitted. */
+  name?: string;
+  /** IDs of the projects to file into the folder — the same ids the folder
+reports back as `bucket_ids` and expands as `projects`. This does not
+round-trip under its own name. Omit it, or send null or an empty array,
+for an empty folder. */
+  projectIds?: number[];
+}
+
+/**
+ * Request parameters for updateFolder.
+ */
+export interface UpdateFolderFolderRequest {
+  /** The folder's new name. Blank is rejected with 422 — unlike create, update
+does not fall back to a default name. */
+  name: string;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Folders operations.
+ */
+export class FoldersService extends BaseService {
+
+  /**
+   * List the authenticated user's folders in home-screen order.
+   * @returns Array of Folder
+   *
+   * @example
+   * ```ts
+   * const result = await client.folders.listFolders();
+   * ```
+   */
+  async listFolders(): Promise<Folder[]> {
+    const response = await this.request(
+      {
+        service: "Folders",
+        operation: "ListFolders",
+        resourceType: "folder",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/stacks.json", {
+        })
+    );
+    return response ?? [];
+  }
+
+  /**
+   * Create a folder for the authenticated user and file the given projects into it.
+   * @param req - Folder creation parameters
+   * @returns The FolderWithProjects
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.folders.createFolder({ });
+   * ```
+   */
+  async createFolder(req: CreateFolderFolderRequest): Promise<FolderWithProjects> {
+    const response = await this.request(
+      {
+        service: "Folders",
+        operation: "CreateFolder",
+        resourceType: "folder",
+        isMutation: true,
+      },
+      () =>
+        this.client.POST("/stacks.json", {
+          body: {
+            name: req.name,
+            project_ids: req.projectIds,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Get one folder, with the projects grouped inside it expanded under `projects`.
+   * @param folderId - The folder ID
+   * @returns The FolderWithProjects
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.folders.getFolder(123);
+   * ```
+   */
+  async getFolder(folderId: number): Promise<FolderWithProjects> {
+    const response = await this.request(
+      {
+        service: "Folders",
+        operation: "GetFolder",
+        resourceType: "folder",
+        isMutation: false,
+        resourceId: folderId,
+      },
+      () =>
+        this.client.GET("/stacks/{folderId}", {
+          params: {
+            path: { folderId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Rename a folder.
+   * @param folderId - The folder ID
+   * @param req - Folder update parameters
+   * @returns The FolderWithProjects
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.folders.updateFolder(123, { name: "My example" });
+   * ```
+   */
+  async updateFolder(folderId: number, req: UpdateFolderFolderRequest): Promise<FolderWithProjects> {
+    if (!req.name) {
+      throw Errors.validation("Name is required");
+    }
+    const response = await this.request(
+      {
+        service: "Folders",
+        operation: "UpdateFolder",
+        resourceType: "folder",
+        isMutation: true,
+        resourceId: folderId,
+      },
+      () =>
+        this.client.PUT("/stacks/{folderId}", {
+          params: {
+            path: { folderId },
+          },
+          body: {
+            name: req.name,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Delete a folder and unpin its projects from the home screen.
+   * @param folderId - The folder ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.folders.deleteFolder(123);
+   * ```
+   */
+  async deleteFolder(folderId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Folders",
+        operation: "DeleteFolder",
+        resourceType: "folder",
+        isMutation: true,
+        resourceId: folderId,
+      },
+      () =>
+        this.client.DELETE("/stacks/{folderId}", {
+          params: {
+            path: { folderId },
+          },
+        })
+    );
+  }
+}

package/src/generated/services/forwards.ts

@@ -8,7 +8,6 @@ import { BaseService } from "../../services/base.js";
 import type { components } from "../schema.js";
 import { ListResult } from "../../pagination.js";
 import type { PaginationOptions } from "../../pagination.js";
-import { Errors } from "../../errors.js";
 
 // =============================================================================
 // Types
@@ -25,14 +24,8 @@ export type Inbox = components["schemas"]["Inbox"];
  * Options for listReplies.
  */
 export interface ListRepliesForwardOptions extends PaginationOptions {
-}
-
-/**
- * Request parameters for createReply.
- */
-export interface CreateReplyForwardRequest {
-  /** Text content */
-  content: string;
+  /** 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;
 }
 
 /**
@@ -43,6 +36,8 @@ export interface ListForwardOptions 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;
 }
 
 
@@ -94,6 +89,9 @@ export class ForwardsService extends BaseService {
    * @example
    * ```ts
    * const result = await client.forwards.listReplies(123);
+   *
+   * // With options
+   * const filtered = await client.forwards.listReplies(123, { page: 1 });
    * ```
    */
   async listReplies(forwardId: number, options?: ListRepliesForwardOptions): Promise<ListResult<ForwardReply>> {
@@ -109,49 +107,13 @@ export class ForwardsService extends BaseService {
         this.client.GET("/inbox_forwards/{forwardId}/replies.json", {
           params: {
             path: { forwardId },
+            query: { page: options?.page },
           },
         })
       , options
     );
   }
 
-  /**
-   * Create a reply to a forward
-   * @param forwardId - The forward ID
-   * @param req - Forward_reply creation parameters
-   * @returns The ForwardReply
-   * @throws {BasecampError} If required fields are missing or invalid
-   *
-   * @example
-   * ```ts
-   * const result = await client.forwards.createReply(123, { content: "Hello world" });
-   * ```
-   */
-  async createReply(forwardId: number, req: CreateReplyForwardRequest): Promise<ForwardReply> {
-    if (!req.content) {
-      throw Errors.validation("Content is required");
-    }
-    const response = await this.request(
-      {
-        service: "Forwards",
-        operation: "CreateForwardReply",
-        resourceType: "forward_reply",
-        isMutation: true,
-        resourceId: forwardId,
-      },
-      () =>
-        this.client.POST("/inbox_forwards/{forwardId}/replies.json", {
-          params: {
-            path: { forwardId },
-          },
-          body: {
-            content: req.content,
-          },
-        })
-    );
-    return response;
-  }
-
   /**
    * Get a forward reply by ID
    * @param forwardId - The forward ID
@@ -237,10 +199,10 @@ export class ForwardsService extends BaseService {
         resourceId: inboxId,
       },
       () =>
-        this.client.GET("/inboxes/{inboxId}/forwards.json", {
+        this.client.GET("/inboxes/{inboxId}/inbox_forwards.json", {
           params: {
             path: { inboxId },
-            query: { sort: options?.sort, direction: options?.direction },
+            query: { sort: options?.sort, direction: options?.direction, page: options?.page },
           },
         })
       , options

package/src/generated/services/gauges.ts

@@ -35,6 +35,8 @@ export interface ToggleGaugeGaugeRequest {
  * Options for listGaugeNeedles.
  */
 export interface ListGaugeNeedlesGaugeOptions 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;
 }
 
 /**
@@ -56,6 +58,8 @@ export interface ListGaugesGaugeOptions extends PaginationOptions {
   /** Comma-separated list of project IDs. When provided, results are returned
 in the order specified instead of by risk level. */
   bucketIds?: string;
+  /** 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;
 }
 
 
@@ -205,6 +209,9 @@ export class GaugesService extends BaseService {
    * @example
    * ```ts
    * const result = await client.gauges.listGaugeNeedles(123);
+   *
+   * // With options
+   * const filtered = await client.gauges.listGaugeNeedles(123, { page: 1 });
    * ```
    */
   async listGaugeNeedles(projectId: number, options?: ListGaugeNeedlesGaugeOptions): Promise<components["schemas"]["ListGaugeNeedlesResponseContent"]> {
@@ -220,6 +227,7 @@ export class GaugesService extends BaseService {
         this.client.GET("/projects/{projectId}/gauge/needles.json", {
           params: {
             path: { projectId },
+            query: { page: options?.page },
           },
         })
       , options
@@ -289,7 +297,7 @@ export class GaugesService extends BaseService {
       () =>
         this.client.GET("/reports/gauges.json", {
           params: {
-            query: { "bucket_ids": options?.bucketIds },
+            query: { "bucket_ids": options?.bucketIds, page: options?.page },
           },
         })
       , options

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,19 +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";
@@ -41,6 +43,7 @@ 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";

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-notes.ts

@@ -59,7 +59,7 @@ export class MyNotesService extends BaseService {
   }
 
   /**
-   * Replace the note's content, recording a new revision server-side. The first
+   * 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

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