@37signals/basecamp 0.2.0

package/dist/generated/services/client-visibility.ts

@@ -0,0 +1,68 @@
+/**
+ * ClientVisibility 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
+// =============================================================================
+
+/** Recording entity from the Basecamp API. */
+export type Recording = components["schemas"]["Recording"];
+
+/**
+ * Request parameters for setVisibility.
+ */
+export interface SetVisibilityClientVisibilityRequest {
+  /** Visible to clients */
+  visibleToClients: boolean;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for ClientVisibility operations.
+ */
+export class ClientVisibilityService extends BaseService {
+
+  /**
+   * Set client visibility for a recording
+   * @param recordingId - The recording ID
+   * @param req - Client_visibility request parameters
+   * @returns The Recording
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * const result = await client.clientVisibility.setVisibility(123, { visibleToClients: true });
+   * ```
+   */
+  async setVisibility(recordingId: number, req: SetVisibilityClientVisibilityRequest): Promise<Recording> {
+    const response = await this.request(
+      {
+        service: "ClientVisibility",
+        operation: "SetClientVisibility",
+        resourceType: "client_visibility",
+        isMutation: true,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.PUT("/recordings/{recordingId}/client_visibility.json", {
+          params: {
+            path: { recordingId },
+          },
+          body: {
+            visible_to_clients: req.visibleToClients,
+          },
+        })
+    );
+    return response;
+  }
+}

package/dist/generated/services/comments.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Comments 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";
+/** Comment entity from the Basecamp API. */
+export type Comment = components["schemas"]["Comment"];
+/**
+ * Request parameters for update.
+ */
+export interface UpdateCommentRequest {
+    /** Text content */
+    content: string;
+}
+/**
+ * Options for list.
+ */
+export interface ListCommentOptions extends PaginationOptions {
+}
+/**
+ * Request parameters for create.
+ */
+export interface CreateCommentRequest {
+    /** Text content */
+    content: string;
+}
+/**
+ * Service for Comments operations.
+ */
+export declare class CommentsService extends BaseService {
+    /**
+     * Get a single comment by id
+     * @param commentId - The comment ID
+     * @returns The Comment
+     * @throws {BasecampError} If the resource is not found
+     *
+     * @example
+     * ```ts
+     * const result = await client.comments.get(123);
+     * ```
+     */
+    get(commentId: number): Promise<Comment>;
+    /**
+     * Update an existing comment
+     * @param commentId - The comment ID
+     * @param req - Comment update parameters
+     * @returns The Comment
+     * @throws {BasecampError} If the resource is not found or fields are invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.comments.update(123, { content: "Hello world" });
+     * ```
+     */
+    update(commentId: number, req: UpdateCommentRequest): Promise<Comment>;
+    /**
+     * List comments on a recording
+     * @param recordingId - The recording ID
+     * @param options - Optional query parameters
+     * @returns All Comment across all pages, with .meta.totalCount
+     *
+     * @example
+     * ```ts
+     * const result = await client.comments.list(123);
+     * ```
+     */
+    list(recordingId: number, options?: ListCommentOptions): Promise<ListResult<Comment>>;
+    /**
+     * Create a new comment on a recording
+     * @param recordingId - The recording ID
+     * @param req - Comment creation parameters
+     * @returns The Comment
+     * @throws {BasecampError} If required fields are missing or invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.comments.create(123, { content: "Hello world" });
+     * ```
+     */
+    create(recordingId: number, req: CreateCommentRequest): Promise<Comment>;
+}
+//# sourceMappingURL=comments.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"comments.d.ts","sourceRoot":"","sources":["../../../src/generated/services/comments.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,4CAA4C;AAC5C,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,iBAAiB;CAC5D;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;CACjB;AAOD;;GAEG;AACH,qBAAa,eAAgB,SAAQ,WAAW;IAE9C;;;;;;;;;;OAUG;IACG,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAmB9C;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAyB5E;;;;;;;;;;OAUG;IACG,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAmB3F;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;CAwB/E"}

package/dist/generated/services/comments.js

@@ -0,0 +1,129 @@
+/**
+ * Comments 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 Comments operations.
+ */
+export class CommentsService extends BaseService {
+    /**
+     * Get a single comment by id
+     * @param commentId - The comment ID
+     * @returns The Comment
+     * @throws {BasecampError} If the resource is not found
+     *
+     * @example
+     * ```ts
+     * const result = await client.comments.get(123);
+     * ```
+     */
+    async get(commentId) {
+        const response = await this.request({
+            service: "Comments",
+            operation: "GetComment",
+            resourceType: "comment",
+            isMutation: false,
+            resourceId: commentId,
+        }, () => this.client.GET("/comments/{commentId}", {
+            params: {
+                path: { commentId },
+            },
+        }));
+        return response;
+    }
+    /**
+     * Update an existing comment
+     * @param commentId - The comment ID
+     * @param req - Comment update parameters
+     * @returns The Comment
+     * @throws {BasecampError} If the resource is not found or fields are invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.comments.update(123, { content: "Hello world" });
+     * ```
+     */
+    async update(commentId, req) {
+        if (!req.content) {
+            throw Errors.validation("Content is required");
+        }
+        const response = await this.request({
+            service: "Comments",
+            operation: "UpdateComment",
+            resourceType: "comment",
+            isMutation: true,
+            resourceId: commentId,
+        }, () => this.client.PUT("/comments/{commentId}", {
+            params: {
+                path: { commentId },
+            },
+            body: {
+                content: req.content,
+            },
+        }));
+        return response;
+    }
+    /**
+     * List comments on a recording
+     * @param recordingId - The recording ID
+     * @param options - Optional query parameters
+     * @returns All Comment across all pages, with .meta.totalCount
+     *
+     * @example
+     * ```ts
+     * const result = await client.comments.list(123);
+     * ```
+     */
+    async list(recordingId, options) {
+        return this.requestPaginated({
+            service: "Comments",
+            operation: "ListComments",
+            resourceType: "comment",
+            isMutation: false,
+            resourceId: recordingId,
+        }, () => this.client.GET("/recordings/{recordingId}/comments.json", {
+            params: {
+                path: { recordingId },
+            },
+        }), options);
+    }
+    /**
+     * Create a new comment on a recording
+     * @param recordingId - The recording ID
+     * @param req - Comment creation parameters
+     * @returns The Comment
+     * @throws {BasecampError} If required fields are missing or invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.comments.create(123, { content: "Hello world" });
+     * ```
+     */
+    async create(recordingId, req) {
+        if (!req.content) {
+            throw Errors.validation("Content is required");
+        }
+        const response = await this.request({
+            service: "Comments",
+            operation: "CreateComment",
+            resourceType: "comment",
+            isMutation: true,
+            resourceId: recordingId,
+        }, () => this.client.POST("/recordings/{recordingId}/comments.json", {
+            params: {
+                path: { recordingId },
+            },
+            body: {
+                content: req.content,
+            },
+        }));
+        return response;
+    }
+}
+//# sourceMappingURL=comments.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"comments.js","sourceRoot":"","sources":["../../../src/generated/services/comments.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAIrD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAgCzC,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,WAAW;IAE9C;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,CAAC,SAAiB;QACzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,UAAU;YACnB,SAAS,EAAE,YAAY;YACvB,YAAY,EAAE,SAAS;YACvB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,SAAS;SACtB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,uBAAuB,EAAE;YACvC,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,SAAS,EAAE;aACpB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,CAAC,SAAiB,EAAE,GAAyB;QACvD,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,MAAM,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;QACjD,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,UAAU;YACnB,SAAS,EAAE,eAAe;YAC1B,YAAY,EAAE,SAAS;YACvB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,SAAS;SACtB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,uBAAuB,EAAE;YACvC,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,SAAS,EAAE;aACpB;YACD,IAAI,EAAE;gBACJ,OAAO,EAAE,GAAG,CAAC,OAAO;aACrB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,IAAI,CAAC,WAAmB,EAAE,OAA4B;QAC1D,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,UAAU;YACnB,SAAS,EAAE,cAAc;YACzB,YAAY,EAAE,SAAS;YACvB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,WAAW;SACxB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,yCAAyC,EAAE;YACzD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,WAAW,EAAE;aACtB;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,CAAC,WAAmB,EAAE,GAAyB;QACzD,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,MAAM,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;QACjD,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,UAAU;YACnB,SAAS,EAAE,eAAe;YAC1B,YAAY,EAAE,SAAS;YACvB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,WAAW;SACxB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,yCAAyC,EAAE;YAC1D,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,WAAW,EAAE;aACtB;YACD,IAAI,EAAE;gBACJ,OAAO,EAAE,GAAG,CAAC,OAAO;aACrB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}

package/dist/generated/services/comments.ts

@@ -0,0 +1,185 @@
+/**
+ * Comments 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
+// =============================================================================
+
+/** Comment entity from the Basecamp API. */
+export type Comment = components["schemas"]["Comment"];
+
+/**
+ * Request parameters for update.
+ */
+export interface UpdateCommentRequest {
+  /** Text content */
+  content: string;
+}
+
+/**
+ * Options for list.
+ */
+export interface ListCommentOptions extends PaginationOptions {
+}
+
+/**
+ * Request parameters for create.
+ */
+export interface CreateCommentRequest {
+  /** Text content */
+  content: string;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Comments operations.
+ */
+export class CommentsService extends BaseService {
+
+  /**
+   * Get a single comment by id
+   * @param commentId - The comment ID
+   * @returns The Comment
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.comments.get(123);
+   * ```
+   */
+  async get(commentId: number): Promise<Comment> {
+    const response = await this.request(
+      {
+        service: "Comments",
+        operation: "GetComment",
+        resourceType: "comment",
+        isMutation: false,
+        resourceId: commentId,
+      },
+      () =>
+        this.client.GET("/comments/{commentId}", {
+          params: {
+            path: { commentId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Update an existing comment
+   * @param commentId - The comment ID
+   * @param req - Comment update parameters
+   * @returns The Comment
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.comments.update(123, { content: "Hello world" });
+   * ```
+   */
+  async update(commentId: number, req: UpdateCommentRequest): Promise<Comment> {
+    if (!req.content) {
+      throw Errors.validation("Content is required");
+    }
+    const response = await this.request(
+      {
+        service: "Comments",
+        operation: "UpdateComment",
+        resourceType: "comment",
+        isMutation: true,
+        resourceId: commentId,
+      },
+      () =>
+        this.client.PUT("/comments/{commentId}", {
+          params: {
+            path: { commentId },
+          },
+          body: {
+            content: req.content,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * List comments on a recording
+   * @param recordingId - The recording ID
+   * @param options - Optional query parameters
+   * @returns All Comment across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.comments.list(123);
+   * ```
+   */
+  async list(recordingId: number, options?: ListCommentOptions): Promise<ListResult<Comment>> {
+    return this.requestPaginated(
+      {
+        service: "Comments",
+        operation: "ListComments",
+        resourceType: "comment",
+        isMutation: false,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.GET("/recordings/{recordingId}/comments.json", {
+          params: {
+            path: { recordingId },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * Create a new comment on a recording
+   * @param recordingId - The recording ID
+   * @param req - Comment creation parameters
+   * @returns The Comment
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.comments.create(123, { content: "Hello world" });
+   * ```
+   */
+  async create(recordingId: number, req: CreateCommentRequest): Promise<Comment> {
+    if (!req.content) {
+      throw Errors.validation("Content is required");
+    }
+    const response = await this.request(
+      {
+        service: "Comments",
+        operation: "CreateComment",
+        resourceType: "comment",
+        isMutation: true,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.POST("/recordings/{recordingId}/comments.json", {
+          params: {
+            path: { recordingId },
+          },
+          body: {
+            content: req.content,
+          },
+        })
+    );
+    return response;
+  }
+}

package/dist/generated/services/documents.d.ts

@@ -0,0 +1,92 @@
+/**
+ * Documents 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";
+/** Document entity from the Basecamp API. */
+export type Document = components["schemas"]["Document"];
+/**
+ * Request parameters for update.
+ */
+export interface UpdateDocumentRequest {
+    /** Title */
+    title?: string;
+    /** Text content */
+    content?: string;
+}
+/**
+ * Options for list.
+ */
+export interface ListDocumentOptions extends PaginationOptions {
+}
+/**
+ * Request parameters for create.
+ */
+export interface CreateDocumentRequest {
+    /** Title */
+    title: string;
+    /** Text content */
+    content?: string;
+    /** Status */
+    status?: "active" | "drafted";
+}
+/**
+ * Service for Documents operations.
+ */
+export declare class DocumentsService extends BaseService {
+    /**
+     * Get a single document by id
+     * @param documentId - The document ID
+     * @returns The Document
+     * @throws {BasecampError} If the resource is not found
+     *
+     * @example
+     * ```ts
+     * const result = await client.documents.get(123);
+     * ```
+     */
+    get(documentId: number): Promise<Document>;
+    /**
+     * Update an existing document
+     * @param documentId - The document ID
+     * @param req - Document update parameters
+     * @returns The Document
+     * @throws {BasecampError} If the resource is not found or fields are invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.documents.update(123, { });
+     * ```
+     */
+    update(documentId: number, req: UpdateDocumentRequest): Promise<Document>;
+    /**
+     * List documents in a vault
+     * @param vaultId - The vault ID
+     * @param options - Optional query parameters
+     * @returns All Document across all pages, with .meta.totalCount
+     *
+     * @example
+     * ```ts
+     * const result = await client.documents.list(123);
+     * ```
+     */
+    list(vaultId: number, options?: ListDocumentOptions): Promise<ListResult<Document>>;
+    /**
+     * Create a new document in a vault
+     * @param vaultId - The vault ID
+     * @param req - Document creation parameters
+     * @returns The Document
+     * @throws {BasecampError} If required fields are missing or invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.documents.create(123, { title: "example" });
+     * ```
+     */
+    create(vaultId: number, req: CreateDocumentRequest): Promise<Document>;
+}
+//# sourceMappingURL=documents.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"documents.d.ts","sourceRoot":"","sources":["../../../src/generated/services/documents.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,6CAA6C;AAC7C,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,YAAY;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mBAAmB;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;CAC7D;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,YAAY;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,mBAAmB;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa;IACb,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;CAC/B;AAOD;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAE/C;;;;;;;;;;OAUG;IACG,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAmBhD;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAuB/E;;;;;;;;;;OAUG;IACG,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAmBzF;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC;CA0B7E"}