@37signals/basecamp 0.12.0 → 0.13.0

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

@@ -20,6 +20,8 @@ export type ClientReply = components["schemas"]["ClientReply"];
  * Options for list.
  */
 export interface ListClientReplyOptions 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;
 }
 
 
@@ -34,28 +36,34 @@ export class ClientRepliesService extends BaseService {
 
   /**
    * List all client replies for a recording (correspondence or approval)
+   * @param bucketId - The bucket ID
    * @param recordingId - The recording ID
    * @param options - Optional query parameters
    * @returns All ClientReply across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
-   * const result = await client.clientReplies.list(123);
+   * const result = await client.clientReplies.list(123, 123);
+   *
+   * // With options
+   * const filtered = await client.clientReplies.list(123, 123, { page: 1 });
    * ```
    */
-  async list(recordingId: number, options?: ListClientReplyOptions): Promise<ListResult<ClientReply>> {
+  async list(bucketId: number, recordingId: number, options?: ListClientReplyOptions): Promise<ListResult<ClientReply>> {
     return this.requestPaginated(
       {
         service: "ClientReplies",
         operation: "ListClientReplies",
         resourceType: "client_replie",
         isMutation: false,
+        projectId: bucketId,
         resourceId: recordingId,
       },
       () =>
-        this.client.GET("/client/recordings/{recordingId}/replies.json", {
+        this.client.GET("/buckets/{bucketId}/client/recordings/{recordingId}/replies.json", {
           params: {
-            path: { recordingId },
+            path: { bucketId, recordingId },
+            query: { page: options?.page },
           },
         })
       , options
@@ -64,6 +72,7 @@ export class ClientRepliesService extends BaseService {
 
   /**
    * Get a single client reply by id
+   * @param bucketId - The bucket ID
    * @param recordingId - The recording ID
    * @param replyId - The reply ID
    * @returns The ClientReply
@@ -71,22 +80,23 @@ export class ClientRepliesService extends BaseService {
    *
    * @example
    * ```ts
-   * const result = await client.clientReplies.get(123, 123);
+   * const result = await client.clientReplies.get(123, 123, 123);
    * ```
    */
-  async get(recordingId: number, replyId: number): Promise<ClientReply> {
+  async get(bucketId: number, recordingId: number, replyId: number): Promise<ClientReply> {
     const response = await this.request(
       {
         service: "ClientReplies",
         operation: "GetClientReply",
         resourceType: "client_reply",
         isMutation: false,
+        projectId: bucketId,
         resourceId: replyId,
       },
       () =>
-        this.client.GET("/client/recordings/{recordingId}/replies/{replyId}", {
+        this.client.GET("/buckets/{bucketId}/client/recordings/{recordingId}/replies/{replyId}", {
           params: {
-            path: { recordingId, replyId },
+            path: { bucketId, recordingId, replyId },
           },
         })
     );

package/src/generated/services/cloud-files.ts

@@ -0,0 +1,188 @@
+/**
+ * CloudFiles 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
+// =============================================================================
+
+/** CloudFile entity from the Basecamp API. */
+export type CloudFile = components["schemas"]["CloudFile"];
+
+/**
+ * Request parameters for createCloudFile.
+ */
+export interface CreateCloudFileCloudFileRequest {
+  /** Url */
+  url: string;
+  /** Short identifier for the external service — "dropbox", "google_doc",
+"figma", "other", … Derived from the CloudFile::Service subclass name, so it
+is always present. `other` accepts any well-formed HTTPS URL. */
+  service: string;
+  /** Title */
+  title?: string;
+  /** Rich text description (HTML) */
+  description?: string;
+  /** Subscriptions */
+  subscriptions?: number[];
+  /** Whether the cloud file 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 updateCloudFile.
+ */
+export interface UpdateCloudFileCloudFileRequest {
+  /** Url */
+  url: string;
+  /** Short identifier for the external service — "dropbox", "google_doc",
+"figma", "other", … Derived from the CloudFile::Service subclass name, so it
+is always present. `other` accepts any well-formed HTTPS URL. */
+  service: string;
+  /** Title */
+  title?: string;
+  /** Rich text description (HTML) */
+  description?: string;
+  /** Subscriptions */
+  subscriptions?: number[];
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for CloudFiles operations.
+ */
+export class CloudFilesService extends BaseService {
+
+  /**
+   * Create a new cloud file in a vault.
+   * @param bucketId - The bucket ID
+   * @param vaultId - The vault ID
+   * @param req - Cloud_file creation parameters
+   * @returns The CloudFile
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.cloudFiles.createCloudFile(123, 123, { url: "example", service: "example" });
+   * ```
+   */
+  async createCloudFile(bucketId: number, vaultId: number, req: CreateCloudFileCloudFileRequest): Promise<CloudFile> {
+    if (!req.url) {
+      throw Errors.validation("Url is required");
+    }
+    if (!req.service) {
+      throw Errors.validation("Service is required");
+    }
+    const response = await this.request(
+      {
+        service: "CloudFiles",
+        operation: "CreateCloudFile",
+        resourceType: "cloud_file",
+        isMutation: true,
+        projectId: bucketId,
+        resourceId: vaultId,
+      },
+      () =>
+        this.client.POST("/buckets/{bucketId}/vaults/{vaultId}/cloud_files.json", {
+          params: {
+            path: { bucketId, vaultId },
+          },
+          body: {
+            url: req.url,
+            service: req.service,
+            title: req.title,
+            description: req.description,
+            subscriptions: req.subscriptions,
+            visible_to_clients: req.visibleToClients,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Get a single cloud file by id
+   * @param cloudFileId - The cloud file ID
+   * @returns The CloudFile
+   *
+   * @example
+   * ```ts
+   * const result = await client.cloudFiles.cloudFile(123);
+   * ```
+   */
+  async cloudFile(cloudFileId: number): Promise<CloudFile> {
+    const response = await this.request(
+      {
+        service: "CloudFiles",
+        operation: "GetCloudFile",
+        resourceType: "cloud_file",
+        isMutation: false,
+        resourceId: cloudFileId,
+      },
+      () =>
+        this.client.GET("/cloud_files/{cloudFileId}", {
+          params: {
+            path: { cloudFileId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Replace a cloud file with a new complete representation.
+   * @param cloudFileId - The cloud file ID
+   * @param req - Cloud_file update parameters
+   * @returns The CloudFile
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.cloudFiles.updateCloudFile(123, { url: "example", service: "example" });
+   * ```
+   */
+  async updateCloudFile(cloudFileId: number, req: UpdateCloudFileCloudFileRequest): Promise<CloudFile> {
+    if (!req.url) {
+      throw Errors.validation("Url is required");
+    }
+    if (!req.service) {
+      throw Errors.validation("Service is required");
+    }
+    const response = await this.request(
+      {
+        service: "CloudFiles",
+        operation: "UpdateCloudFile",
+        resourceType: "cloud_file",
+        isMutation: true,
+        resourceId: cloudFileId,
+      },
+      () =>
+        this.client.PUT("/cloud_files/{cloudFileId}", {
+          params: {
+            path: { cloudFileId },
+          },
+          body: {
+            url: req.url,
+            service: req.service,
+            title: req.title,
+            description: req.description,
+            subscriptions: req.subscriptions,
+          },
+        })
+    );
+    return response;
+  }
+}

package/src/generated/services/comments.ts

@@ -29,6 +29,8 @@ export interface UpdateCommentRequest {
  * Options for list.
  */
 export interface ListCommentOptions 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;
 }
 
 /**
@@ -125,6 +127,9 @@ export class CommentsService extends BaseService {
    * @example
    * ```ts
    * const result = await client.comments.list(123);
+   *
+   * // With options
+   * const filtered = await client.comments.list(123, { page: 1 });
    * ```
    */
   async list(recordingId: number, options?: ListCommentOptions): Promise<ListResult<Comment>> {
@@ -140,6 +145,7 @@ export class CommentsService extends BaseService {
         this.client.GET("/recordings/{recordingId}/comments.json", {
           params: {
             path: { recordingId },
+            query: { page: options?.page },
           },
         })
       , options

package/src/generated/services/documents.ts

@@ -18,9 +18,9 @@ import { Errors } from "../../errors.js";
 export type Document = components["schemas"]["Document"];
 
 /**
- * Request parameters for update.
+ * Request parameters for replace.
  */
-export interface UpdateDocumentRequest {
+export interface ReplaceDocumentRequest {
   /** Title */
   title?: string;
   /** Text content */
@@ -31,6 +31,8 @@ export interface UpdateDocumentRequest {
  * Options for list.
  */
 export interface ListDocumentOptions 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;
 }
 
 /**
@@ -90,22 +92,22 @@ export class DocumentsService extends BaseService {
   }
 
   /**
-   * Update an existing document
+   * Replace a document with a new complete representation.
    * @param documentId - The document ID
-   * @param req - Document update parameters
+   * @param req - Document request parameters
    * @returns The Document
-   * @throws {BasecampError} If the resource is not found or fields are invalid
+   * @throws {BasecampError} If the request fails
    *
    * @example
    * ```ts
-   * const result = await client.documents.update(123, { });
+   * const result = await client.documents.replace(123, { });
    * ```
    */
-  async update(documentId: number, req: UpdateDocumentRequest): Promise<Document> {
+  async replace(documentId: number, req: ReplaceDocumentRequest): Promise<Document> {
     const response = await this.request(
       {
         service: "Documents",
-        operation: "UpdateDocument",
+        operation: "ReplaceDocument",
         resourceType: "document",
         isMutation: true,
         resourceId: documentId,
@@ -133,6 +135,9 @@ export class DocumentsService extends BaseService {
    * @example
    * ```ts
    * const result = await client.documents.list(123);
+   *
+   * // With options
+   * const filtered = await client.documents.list(123, { page: 1 });
    * ```
    */
   async list(vaultId: number, options?: ListDocumentOptions): Promise<ListResult<Document>> {
@@ -148,6 +153,7 @@ export class DocumentsService extends BaseService {
         this.client.GET("/vaults/{vaultId}/documents.json", {
           params: {
             path: { vaultId },
+            query: { page: options?.page },
           },
         })
       , options

package/src/generated/services/drafts.ts

@@ -20,7 +20,7 @@ export type Draft = components["schemas"]["Draft"];
  * Options for listMyDrafts.
  */
 export interface ListMyDraftsDraftOptions extends PaginationOptions {
-  /** Page number for paginating through results. Defaults to 1. */
+  /** 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;
 }
 

package/src/generated/services/events.ts

@@ -20,6 +20,8 @@ export type Event = components["schemas"]["Event"];
  * Options for list.
  */
 export interface ListEventOptions 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;
 }
 
 
@@ -41,6 +43,9 @@ export class EventsService extends BaseService {
    * @example
    * ```ts
    * const result = await client.events.list(123);
+   *
+   * // With options
+   * const filtered = await client.events.list(123, { page: 1 });
    * ```
    */
   async list(recordingId: number, options?: ListEventOptions): Promise<ListResult<Event>> {
@@ -56,6 +61,7 @@ export class EventsService extends BaseService {
         this.client.GET("/recordings/{recordingId}/events.json", {
           params: {
             path: { recordingId },
+            query: { page: options?.page },
           },
         })
       , options

package/src/generated/services/everything.ts

@@ -35,7 +35,7 @@ Assignees on nested steps are not considered. */
   assigneeIds?: number[];
   /** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
   due?: string;
-  /** Page number for paginating through results. Defaults to 1. */
+  /** 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;
 }
 
@@ -48,7 +48,7 @@ Assignees on nested steps are not considered. */
   assigneeIds?: number[];
   /** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
   due?: string;
-  /** Page number for paginating through results. Defaults to 1. */
+  /** 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;
 }
 
@@ -61,7 +61,7 @@ Assignees on nested steps are not considered. */
   assigneeIds?: number[];
   /** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
   due?: string;
-  /** Page number for paginating through results. Defaults to 1. */
+  /** 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;
 }
 
@@ -74,7 +74,7 @@ Assignees on nested steps are not considered. */
   assigneeIds?: number[];
   /** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
   due?: string;
-  /** Page number for paginating through results. Defaults to 1. */
+  /** 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;
 }
 
@@ -98,7 +98,7 @@ Assignees on nested steps are not considered. */
   assigneeIds?: number[];
   /** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
   due?: string;
-  /** Page number for paginating through results. Defaults to 1. */
+  /** 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;
 }
 
@@ -106,7 +106,7 @@ Assignees on nested steps are not considered. */
  * Options for everythingCheckins.
  */
 export interface EverythingCheckinsEverythingOptions extends PaginationOptions {
-  /** Page number for paginating through results. Defaults to 1. */
+  /** 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;
 }
 
@@ -114,7 +114,7 @@ export interface EverythingCheckinsEverythingOptions extends PaginationOptions {
  * Options for everythingComments.
  */
 export interface EverythingCommentsEverythingOptions extends PaginationOptions {
-  /** Page number for paginating through results. Defaults to 1. */
+  /** 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;
 }
 
@@ -126,7 +126,7 @@ export interface EverythingFilesEverythingOptions extends PaginationOptions {
   kind?: string;
   /** Restrict to files created by the given people (repeatable). */
   peopleIds?: number[];
-  /** Page number for paginating through results. Defaults to 1. */
+  /** 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;
 }
 
@@ -134,7 +134,7 @@ export interface EverythingFilesEverythingOptions extends PaginationOptions {
  * Options for everythingForwards.
  */
 export interface EverythingForwardsEverythingOptions extends PaginationOptions {
-  /** Page number for paginating through results. Defaults to 1. */
+  /** 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;
 }
 
@@ -142,7 +142,7 @@ export interface EverythingForwardsEverythingOptions extends PaginationOptions {
  * Options for everythingMessages.
  */
 export interface EverythingMessagesEverythingOptions extends PaginationOptions {
-  /** Page number for paginating through results. Defaults to 1. */
+  /** 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;
 }
 
@@ -155,7 +155,7 @@ Assignees on nested steps are not considered. */
   assigneeIds?: number[];
   /** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
   due?: string;
-  /** Page number for paginating through results. Defaults to 1. */
+  /** 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;
 }
 
@@ -168,7 +168,7 @@ Assignees on nested steps are not considered. */
   assigneeIds?: number[];
   /** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
   due?: string;
-  /** Page number for paginating through results. Defaults to 1. */
+  /** 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;
 }
 
@@ -181,7 +181,7 @@ Assignees on nested steps are not considered. */
   assigneeIds?: number[];
   /** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
   due?: string;
-  /** Page number for paginating through results. Defaults to 1. */
+  /** 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,7 +205,7 @@ Assignees on nested steps are not considered. */
   assigneeIds?: number[];
   /** Filter by due date: with, without, or overdue. Unrecognized values are ignored. */
   due?: string;
-  /** Page number for paginating through results. Defaults to 1. */
+  /** 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;
 }