@37signals/basecamp 0.2.0

package/src/generated/services/todosets.ts

@@ -0,0 +1,55 @@
+/**
+ * Todosets 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";
+
+// =============================================================================
+// Types
+// =============================================================================
+
+/** Todoset entity from the Basecamp API. */
+export type Todoset = components["schemas"]["Todoset"];
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Todosets operations.
+ */
+export class TodosetsService extends BaseService {
+
+  /**
+   * Get a todoset (container for todolists in a project)
+   * @param todosetId - The todoset ID
+   * @returns The Todoset
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.todosets.get(123);
+   * ```
+   */
+  async get(todosetId: number): Promise<Todoset> {
+    const response = await this.request(
+      {
+        service: "Todosets",
+        operation: "GetTodoset",
+        resourceType: "todoset",
+        isMutation: false,
+        resourceId: todosetId,
+      },
+      () =>
+        this.client.GET("/todosets/{todosetId}", {
+          params: {
+            path: { todosetId },
+          },
+        })
+    );
+    return response;
+  }
+}

package/src/generated/services/tools.ts

@@ -0,0 +1,267 @@
+/**
+ * Tools 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
+// =============================================================================
+
+/** Tool entity from the Basecamp API. */
+export type Tool = components["schemas"]["Tool"];
+
+/**
+ * Request parameters for clone.
+ */
+export interface CloneToolRequest {
+  /** Source recording id */
+  sourceRecordingId: number;
+}
+
+/**
+ * Request parameters for update.
+ */
+export interface UpdateToolRequest {
+  /** Title */
+  title: string;
+}
+
+/**
+ * Request parameters for reposition.
+ */
+export interface RepositionToolRequest {
+  /** Position for ordering (1-based) */
+  position: number;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Tools operations.
+ */
+export class ToolsService extends BaseService {
+
+  /**
+   * Clone an existing tool to create a new one
+   * @param req - Tool request parameters
+   * @returns The Tool
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * const result = await client.tools.clone({ sourceRecordingId: 1 });
+   * ```
+   */
+  async clone(req: CloneToolRequest): Promise<Tool> {
+    const response = await this.request(
+      {
+        service: "Tools",
+        operation: "CloneTool",
+        resourceType: "tool",
+        isMutation: true,
+      },
+      () =>
+        this.client.POST("/dock/tools.json", {
+          body: {
+            source_recording_id: req.sourceRecordingId,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Get a dock tool by id
+   * @param toolId - The tool ID
+   * @returns The Tool
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.tools.get(123);
+   * ```
+   */
+  async get(toolId: number): Promise<Tool> {
+    const response = await this.request(
+      {
+        service: "Tools",
+        operation: "GetTool",
+        resourceType: "tool",
+        isMutation: false,
+        resourceId: toolId,
+      },
+      () =>
+        this.client.GET("/dock/tools/{toolId}", {
+          params: {
+            path: { toolId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Update (rename) an existing tool
+   * @param toolId - The tool ID
+   * @param req - Tool update parameters
+   * @returns The Tool
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.tools.update(123, { title: "example" });
+   * ```
+   */
+  async update(toolId: number, req: UpdateToolRequest): Promise<Tool> {
+    if (!req.title) {
+      throw Errors.validation("Title is required");
+    }
+    const response = await this.request(
+      {
+        service: "Tools",
+        operation: "UpdateTool",
+        resourceType: "tool",
+        isMutation: true,
+        resourceId: toolId,
+      },
+      () =>
+        this.client.PUT("/dock/tools/{toolId}", {
+          params: {
+            path: { toolId },
+          },
+          body: {
+            title: req.title,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Delete a tool (trash it)
+   * @param toolId - The tool ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.tools.delete(123);
+   * ```
+   */
+  async delete(toolId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Tools",
+        operation: "DeleteTool",
+        resourceType: "tool",
+        isMutation: true,
+        resourceId: toolId,
+      },
+      () =>
+        this.client.DELETE("/dock/tools/{toolId}", {
+          params: {
+            path: { toolId },
+          },
+        })
+    );
+  }
+
+  /**
+   * Enable a tool (show it on the project dock)
+   * @param toolId - The tool ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.tools.enable(123);
+   * ```
+   */
+  async enable(toolId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Tools",
+        operation: "EnableTool",
+        resourceType: "tool",
+        isMutation: true,
+        resourceId: toolId,
+      },
+      () =>
+        this.client.POST("/recordings/{toolId}/position.json", {
+          params: {
+            path: { toolId },
+          },
+        })
+    );
+  }
+
+  /**
+   * Reposition a tool on the project dock
+   * @param toolId - The tool ID
+   * @param req - Tool request parameters
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.tools.reposition(123, { position: 1 });
+   * ```
+   */
+  async reposition(toolId: number, req: RepositionToolRequest): Promise<void> {
+    await this.request(
+      {
+        service: "Tools",
+        operation: "RepositionTool",
+        resourceType: "tool",
+        isMutation: true,
+        resourceId: toolId,
+      },
+      () =>
+        this.client.PUT("/recordings/{toolId}/position.json", {
+          params: {
+            path: { toolId },
+          },
+          body: {
+            position: req.position,
+          },
+        })
+    );
+  }
+
+  /**
+   * Disable a tool (hide it from the project dock)
+   * @param toolId - The tool ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.tools.disable(123);
+   * ```
+   */
+  async disable(toolId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Tools",
+        operation: "DisableTool",
+        resourceType: "tool",
+        isMutation: true,
+        resourceId: toolId,
+      },
+      () =>
+        this.client.DELETE("/recordings/{toolId}/position.json", {
+          params: {
+            path: { toolId },
+          },
+        })
+    );
+  }
+}

package/src/generated/services/uploads.ts

@@ -0,0 +1,227 @@
+/**
+ * Uploads 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 { ListResult } from "../../pagination.js";
+import type { PaginationOptions } from "../../pagination.js";
+import { Errors } from "../../errors.js";
+
+// =============================================================================
+// Types
+// =============================================================================
+
+/** Upload entity from the Basecamp API. */
+export type Upload = components["schemas"]["Upload"];
+
+/**
+ * Request parameters for update.
+ */
+export interface UpdateUploadRequest {
+  /** Rich text description (HTML) */
+  description?: string;
+  /** Base name */
+  baseName?: string;
+}
+
+/**
+ * Options for listVersions.
+ */
+export interface ListVersionsUploadOptions extends PaginationOptions {
+}
+
+/**
+ * Options for list.
+ */
+export interface ListUploadOptions extends PaginationOptions {
+}
+
+/**
+ * Request parameters for create.
+ */
+export interface CreateUploadRequest {
+  /** Attachable sgid */
+  attachableSgid: string;
+  /** Rich text description (HTML) */
+  description?: string;
+  /** Base name */
+  baseName?: string;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Uploads operations.
+ */
+export class UploadsService extends BaseService {
+
+  /**
+   * Get a single upload by id
+   * @param uploadId - The upload ID
+   * @returns The Upload
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.uploads.get(123);
+   * ```
+   */
+  async get(uploadId: number): Promise<Upload> {
+    const response = await this.request(
+      {
+        service: "Uploads",
+        operation: "GetUpload",
+        resourceType: "upload",
+        isMutation: false,
+        resourceId: uploadId,
+      },
+      () =>
+        this.client.GET("/uploads/{uploadId}", {
+          params: {
+            path: { uploadId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Update an existing upload
+   * @param uploadId - The upload ID
+   * @param req - Upload update parameters
+   * @returns The Upload
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.uploads.update(123, { });
+   * ```
+   */
+  async update(uploadId: number, req: UpdateUploadRequest): Promise<Upload> {
+    const response = await this.request(
+      {
+        service: "Uploads",
+        operation: "UpdateUpload",
+        resourceType: "upload",
+        isMutation: true,
+        resourceId: uploadId,
+      },
+      () =>
+        this.client.PUT("/uploads/{uploadId}", {
+          params: {
+            path: { uploadId },
+          },
+          body: {
+            description: req.description,
+            base_name: req.baseName,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * List versions of an upload
+   * @param uploadId - The upload ID
+   * @param options - Optional query parameters
+   * @returns All Upload across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.uploads.listVersions(123);
+   * ```
+   */
+  async listVersions(uploadId: number, options?: ListVersionsUploadOptions): Promise<ListResult<Upload>> {
+    return this.requestPaginated(
+      {
+        service: "Uploads",
+        operation: "ListUploadVersions",
+        resourceType: "upload_version",
+        isMutation: false,
+        resourceId: uploadId,
+      },
+      () =>
+        this.client.GET("/uploads/{uploadId}/versions.json", {
+          params: {
+            path: { uploadId },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * List uploads in a vault
+   * @param vaultId - The vault ID
+   * @param options - Optional query parameters
+   * @returns All Upload across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.uploads.list(123);
+   * ```
+   */
+  async list(vaultId: number, options?: ListUploadOptions): Promise<ListResult<Upload>> {
+    return this.requestPaginated(
+      {
+        service: "Uploads",
+        operation: "ListUploads",
+        resourceType: "upload",
+        isMutation: false,
+        resourceId: vaultId,
+      },
+      () =>
+        this.client.GET("/vaults/{vaultId}/uploads.json", {
+          params: {
+            path: { vaultId },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * Create a new upload in a vault
+   * @param vaultId - The vault ID
+   * @param req - Upload creation parameters
+   * @returns The Upload
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.uploads.create(123, { attachableSgid: "example" });
+   * ```
+   */
+  async create(vaultId: number, req: CreateUploadRequest): Promise<Upload> {
+    if (!req.attachableSgid) {
+      throw Errors.validation("Attachable sgid is required");
+    }
+    const response = await this.request(
+      {
+        service: "Uploads",
+        operation: "CreateUpload",
+        resourceType: "upload",
+        isMutation: true,
+        resourceId: vaultId,
+      },
+      () =>
+        this.client.POST("/vaults/{vaultId}/uploads.json", {
+          params: {
+            path: { vaultId },
+          },
+          body: {
+            attachable_sgid: req.attachableSgid,
+            description: req.description,
+            base_name: req.baseName,
+          },
+        })
+    );
+    return response;
+  }
+}