@37signals/basecamp 0.12.0 → 0.14.0

package/src/generated/services/todolists.ts

@@ -18,12 +18,12 @@ import { Errors } from "../../errors.js";
 export type Todolist = components["schemas"]["Todolist"];
 
 /**
- * Request parameters for update.
+ * Request parameters for replace.
  */
-export interface UpdateTodolistRequest {
-  /** Name (required for both Todolist and TodolistGroup) */
-  name?: string;
-  /** Description (Todolist only, ignored for groups) */
+export interface ReplaceTodolistRequest {
+  /** Name (required for a to-do list and for a group alike) - presence-validated server-side, so omitting it is a 422, not a preserve */
+  name: string;
+  /** Description (rich text HTML) - writable for a todolist group as well as a todolist, and omitting it clears it either way */
   description?: string;
 }
 
@@ -41,6 +41,8 @@ export interface RepositionTodolistRequest {
 export interface ListTodolistOptions 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;
 }
 
 /**
@@ -68,7 +70,7 @@ export class TodolistsService extends BaseService {
   /**
    * Get a single todolist or todolist group by id
    * @param id - The id
-   * @returns The todolist_or_group
+   * @returns The Todolist
    * @throws {BasecampError} If the resource is not found
    *
    * @example
@@ -76,7 +78,7 @@ export class TodolistsService extends BaseService {
    * const result = await client.todolists.get(123);
    * ```
    */
-  async get(id: number): Promise<components["schemas"]["GetTodolistOrGroupResponseContent"]> {
+  async get(id: number): Promise<Todolist> {
     const response = await this.request(
       {
         service: "Todolists",
@@ -96,18 +98,21 @@ export class TodolistsService extends BaseService {
   }
 
   /**
-   * Update an existing todolist or todolist group
+   * Replace a todolist (or todolist group) with a new complete representation.
    * @param id - The id
-   * @param req - Todolist_or_group update parameters
-   * @returns The todolist_or_group
-   * @throws {BasecampError} If the resource is not found or fields are invalid
+   * @param req - Todolist_or_group request parameters
+   * @returns The Todolist
+   * @throws {BasecampError} If the request fails
    *
    * @example
    * ```ts
-   * const result = await client.todolists.update(123, { });
+   * const result = await client.todolists.replace(123, { name: "My example" });
    * ```
    */
-  async update(id: number, req: UpdateTodolistRequest): Promise<components["schemas"]["UpdateTodolistOrGroupResponseContent"]> {
+  async replace(id: number, req: ReplaceTodolistRequest): Promise<Todolist> {
+    if (!req.name) {
+      throw Errors.validation("Name is required");
+    }
     const response = await this.request(
       {
         service: "Todolists",
@@ -190,7 +195,7 @@ export class TodolistsService extends BaseService {
         this.client.GET("/todosets/{todosetId}/todolists.json", {
           params: {
             path: { todosetId },
-            query: { status: options?.status },
+            query: { status: options?.status, page: options?.page },
           },
         })
       , options

package/src/generated/services/todos.ts

@@ -45,6 +45,8 @@ export interface ListTodoOptions extends PaginationOptions {
   status?: "active" | "archived" | "trashed";
   /** Completed */
   completed?: boolean;
+  /** 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;
 }
 
 /**
@@ -185,7 +187,7 @@ export class TodosService extends BaseService {
         this.client.GET("/todolists/{todolistId}/todos.json", {
           params: {
             path: { todolistId },
-            query: { status: options?.status, completed: options?.completed },
+            query: { status: options?.status, completed: options?.completed, page: options?.page },
           },
         })
       , options
@@ -320,35 +322,6 @@ export class TodosService extends BaseService {
     return response;
   }
 
-  /**
-   * Trash a todo. Trashed items can be recovered.
-   * @param todoId - The todo ID
-   * @returns void
-   * @throws {BasecampError} If the request fails
-   *
-   * @example
-   * ```ts
-   * await client.todos.trash(123);
-   * ```
-   */
-  async trash(todoId: number): Promise<void> {
-    await this.request(
-      {
-        service: "Todos",
-        operation: "TrashTodo",
-        resourceType: "todo",
-        isMutation: true,
-        resourceId: todoId,
-      },
-      () =>
-        this.client.DELETE("/todos/{todoId}", {
-          params: {
-            path: { todoId },
-          },
-        })
-    );
-  }
-
   /**
    * Mark a todo as complete
    * @param todoId - The todo ID

package/src/generated/services/uploads.ts

@@ -16,6 +16,8 @@ import { Errors } from "../../errors.js";
 
 /** Upload entity from the Basecamp API. */
 export type Upload = components["schemas"]["Upload"];
+/** UploadVersion entity from the Basecamp API. */
+export type UploadVersion = components["schemas"]["UploadVersion"];
 
 /**
  * Request parameters for update.
@@ -33,10 +35,32 @@ export interface UpdateUploadRequest {
 export interface ListVersionsUploadOptions extends PaginationOptions {
 }
 
+/**
+ * Request parameters for createVersion.
+ */
+export interface CreateVersionUploadRequest {
+  /** Attachable sgid */
+  attachableSgid: string;
+  /** Omit to keep the uploaded file's own name. Sending "" also keeps it. */
+  baseName?: string;
+  /** Presence-aware: omit to carry the previous version's description forward,
+send "" to clear it, send a value to set it. */
+  description?: string;
+  /** Who to notify: "default", "everyone", or "custom" (the people in subscriptions).
+
+Omit both this and subscriptions to notify nobody. A subscriptions array sent
+without notify is read as "custom". */
+  notify?: string;
+  /** People to notify about the replacement and subscribe to the upload. */
+  subscriptions?: number[];
+}
+
 /**
  * Options for list.
  */
 export interface ListUploadOptions 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;
 }
 
 /**
@@ -134,14 +158,14 @@ export class UploadsService extends BaseService {
    * List versions of an upload
    * @param uploadId - The upload ID
    * @param options - Optional query parameters
-   * @returns All Upload across all pages, with .meta.totalCount
+   * @returns All UploadVersion across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
    * const result = await client.uploads.listVersions(123);
    * ```
    */
-  async listVersions(uploadId: number, options?: ListVersionsUploadOptions): Promise<ListResult<Upload>> {
+  async listVersions(uploadId: number, options?: ListVersionsUploadOptions): Promise<ListResult<UploadVersion>> {
     return this.requestPaginated(
       {
         service: "Uploads",
@@ -160,6 +184,47 @@ export class UploadsService extends BaseService {
     );
   }
 
+  /**
+   * Replace an upload's file with a new version
+   * @param uploadId - The upload ID
+   * @param req - Upload_version creation parameters
+   * @returns The Upload
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.uploads.createVersion(123, { attachableSgid: "example" });
+   * ```
+   */
+  async createVersion(uploadId: number, req: CreateVersionUploadRequest): Promise<Upload> {
+    if (!req.attachableSgid) {
+      throw Errors.validation("Attachable sgid is required");
+    }
+    const response = await this.request(
+      {
+        service: "Uploads",
+        operation: "CreateUploadVersion",
+        resourceType: "upload_version",
+        isMutation: true,
+        resourceId: uploadId,
+      },
+      () =>
+        this.client.POST("/uploads/{uploadId}/versions.json", {
+          params: {
+            path: { uploadId },
+          },
+          body: {
+            attachable_sgid: req.attachableSgid,
+            base_name: req.baseName,
+            description: req.description,
+            notify: req.notify,
+            subscriptions: req.subscriptions,
+          },
+        })
+    );
+    return response;
+  }
+
   /**
    * List uploads in a vault
    * @param vaultId - The vault ID
@@ -169,6 +234,9 @@ export class UploadsService extends BaseService {
    * @example
    * ```ts
    * const result = await client.uploads.list(123);
+   *
+   * // With options
+   * const filtered = await client.uploads.list(123, { page: 1 });
    * ```
    */
   async list(vaultId: number, options?: ListUploadOptions): Promise<ListResult<Upload>> {
@@ -184,6 +252,7 @@ export class UploadsService extends BaseService {
         this.client.GET("/vaults/{vaultId}/uploads.json", {
           params: {
             path: { vaultId },
+            query: { page: options?.page },
           },
         })
       , options

package/src/generated/services/vaults.ts

@@ -29,6 +29,8 @@ export interface UpdateVaultRequest {
  * Options for list.
  */
 export interface ListVaultOptions 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;
 }
 
 /**
@@ -122,6 +124,9 @@ export class VaultsService extends BaseService {
    * @example
    * ```ts
    * const result = await client.vaults.list(123);
+   *
+   * // With options
+   * const filtered = await client.vaults.list(123, { page: 1 });
    * ```
    */
   async list(vaultId: number, options?: ListVaultOptions): Promise<ListResult<Vault>> {
@@ -137,6 +142,7 @@ export class VaultsService extends BaseService {
         this.client.GET("/vaults/{vaultId}/vaults.json", {
           params: {
             path: { vaultId },
+            query: { page: options?.page },
           },
         })
       , options