@37signals/basecamp 0.2.0

package/dist/generated/services/tools.js

@@ -0,0 +1,197 @@
+/**
+ * Tools service for the Basecamp API.
+ *
+ * @generated from OpenAPI spec - do not edit directly
+ */
+import { BaseService } from "../../services/base.js";
+import { Errors } from "../../errors.js";
+// =============================================================================
+// 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) {
+        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) {
+        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, req) {
+        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) {
+        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) {
+        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, req) {
+        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) {
+        await this.request({
+            service: "Tools",
+            operation: "DisableTool",
+            resourceType: "tool",
+            isMutation: true,
+            resourceId: toolId,
+        }, () => this.client.DELETE("/recordings/{toolId}/position.json", {
+            params: {
+                path: { toolId },
+            },
+        }));
+    }
+}
+//# sourceMappingURL=tools.js.map

package/dist/generated/services/tools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools.js","sourceRoot":"","sources":["../../../src/generated/services/tools.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAkCzC,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAE3C;;;;;;;;;;OAUG;IACH,KAAK,CAAC,KAAK,CAAC,GAAqB;QAC/B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,WAAW;YACtB,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,IAAI;SACjB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,EAAE;YACnC,IAAI,EAAE;gBACJ,mBAAmB,EAAE,GAAG,CAAC,iBAAiB;aAC3C;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,CAAC,MAAc;QACtB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,SAAS;YACpB,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,MAAM;SACnB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,sBAAsB,EAAE;YACtC,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,MAAM,EAAE;aACjB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,CAAC,MAAc,EAAE,GAAsB;QACjD,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;QAC/C,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,YAAY;YACvB,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,MAAM;SACnB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,sBAAsB,EAAE;YACtC,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,MAAM,EAAE;aACjB;YACD,IAAI,EAAE;gBACJ,KAAK,EAAE,GAAG,CAAC,KAAK;aACjB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM,CAAC,MAAc;QACzB,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,YAAY;YACvB,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,MAAM;SACnB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,sBAAsB,EAAE;YACzC,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,MAAM,EAAE;aACjB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM,CAAC,MAAc;QACzB,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,YAAY;YACvB,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,MAAM;SACnB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,oCAAoC,EAAE;YACrD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,MAAM,EAAE;aACjB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,UAAU,CAAC,MAAc,EAAE,GAA0B;QACzD,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,gBAAgB;YAC3B,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,MAAM;SACnB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,oCAAoC,EAAE;YACpD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,MAAM,EAAE;aACjB;YACD,IAAI,EAAE;gBACJ,QAAQ,EAAE,GAAG,CAAC,QAAQ;aACvB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,OAAO,CAAC,MAAc;QAC1B,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,aAAa;YACxB,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,MAAM;SACnB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,oCAAoC,EAAE;YACvD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,MAAM,EAAE;aACjB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;CACF"}

package/dist/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/dist/generated/services/uploads.d.ts

@@ -0,0 +1,109 @@
+/**
+ * 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";
+/** 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 for Uploads operations.
+ */
+export declare 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);
+     * ```
+     */
+    get(uploadId: number): Promise<Upload>;
+    /**
+     * 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, { });
+     * ```
+     */
+    update(uploadId: number, req: UpdateUploadRequest): Promise<Upload>;
+    /**
+     * 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);
+     * ```
+     */
+    listVersions(uploadId: number, options?: ListVersionsUploadOptions): Promise<ListResult<Upload>>;
+    /**
+     * 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);
+     * ```
+     */
+    list(vaultId: number, options?: ListUploadOptions): Promise<ListResult<Upload>>;
+    /**
+     * 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" });
+     * ```
+     */
+    create(vaultId: number, req: CreateUploadRequest): Promise<Upload>;
+}
+//# sourceMappingURL=uploads.d.ts.map

package/dist/generated/services/uploads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["../../../src/generated/services/uploads.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAO7D,2CAA2C;AAC3C,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;CACnE;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;CAC3D;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,sBAAsB;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAOD;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAE7C;;;;;;;;;;OAUG;IACG,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAmB5C;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;IAuBzE;;;;;;;;;;OAUG;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAmBtG;;;;;;;;;;OAUG;IACG,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAmBrF;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;CA0BzE"}