@37signals/basecamp 0.2.0

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

@@ -0,0 +1,89 @@
+/**
+ * ClientCorrespondences 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";
+
+// =============================================================================
+// Types
+// =============================================================================
+
+/** ClientCorrespondence entity from the Basecamp API. */
+export type ClientCorrespondence = components["schemas"]["ClientCorrespondence"];
+
+/**
+ * Options for list.
+ */
+export interface ListClientCorrespondenceOptions extends PaginationOptions {
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for ClientCorrespondences operations.
+ */
+export class ClientCorrespondencesService extends BaseService {
+
+  /**
+   * List all client correspondences in a project
+   * @param options - Optional query parameters
+   * @returns All ClientCorrespondence across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.clientCorrespondences.list();
+   * ```
+   */
+  async list(options?: ListClientCorrespondenceOptions): Promise<ListResult<ClientCorrespondence>> {
+    return this.requestPaginated(
+      {
+        service: "ClientCorrespondences",
+        operation: "ListClientCorrespondences",
+        resourceType: "client_correspondence",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/client/correspondences.json", {
+        })
+      , options
+    );
+  }
+
+  /**
+   * Get a single client correspondence by id
+   * @param correspondenceId - The correspondence ID
+   * @returns The ClientCorrespondence
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.clientCorrespondences.get(123);
+   * ```
+   */
+  async get(correspondenceId: number): Promise<ClientCorrespondence> {
+    const response = await this.request(
+      {
+        service: "ClientCorrespondences",
+        operation: "GetClientCorrespondence",
+        resourceType: "client_correspondence",
+        isMutation: false,
+        resourceId: correspondenceId,
+      },
+      () =>
+        this.client.GET("/client/correspondences/{correspondenceId}", {
+          params: {
+            path: { correspondenceId },
+          },
+        })
+    );
+    return response;
+  }
+}

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

@@ -0,0 +1,95 @@
+/**
+ * ClientReplies 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";
+
+// =============================================================================
+// Types
+// =============================================================================
+
+/** ClientReply entity from the Basecamp API. */
+export type ClientReply = components["schemas"]["ClientReply"];
+
+/**
+ * Options for list.
+ */
+export interface ListClientReplyOptions extends PaginationOptions {
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for ClientReplies operations.
+ */
+export class ClientRepliesService extends BaseService {
+
+  /**
+   * List all client replies for a recording (correspondence or approval)
+   * @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);
+   * ```
+   */
+  async list(recordingId: number, options?: ListClientReplyOptions): Promise<ListResult<ClientReply>> {
+    return this.requestPaginated(
+      {
+        service: "ClientReplies",
+        operation: "ListClientReplies",
+        resourceType: "client_replie",
+        isMutation: false,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.GET("/client/recordings/{recordingId}/replies.json", {
+          params: {
+            path: { recordingId },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * Get a single client reply by id
+   * @param recordingId - The recording ID
+   * @param replyId - The reply ID
+   * @returns The ClientReply
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.clientReplies.get(123, 123);
+   * ```
+   */
+  async get(recordingId: number, replyId: number): Promise<ClientReply> {
+    const response = await this.request(
+      {
+        service: "ClientReplies",
+        operation: "GetClientReply",
+        resourceType: "client_reply",
+        isMutation: false,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.GET("/client/recordings/{recordingId}/replies/{replyId}", {
+          params: {
+            path: { recordingId, replyId },
+          },
+        })
+    );
+    return response;
+  }
+}

package/src/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/src/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/src/generated/services/documents.ts

@@ -0,0 +1,191 @@
+/**
+ * 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";
+import { Errors } from "../../errors.js";
+
+// =============================================================================
+// Types
+// =============================================================================
+
+/** 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
+// =============================================================================
+
+/**
+ * Service for Documents operations.
+ */
+export 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);
+   * ```
+   */
+  async get(documentId: number): Promise<Document> {
+    const response = await this.request(
+      {
+        service: "Documents",
+        operation: "GetDocument",
+        resourceType: "document",
+        isMutation: false,
+        resourceId: documentId,
+      },
+      () =>
+        this.client.GET("/documents/{documentId}", {
+          params: {
+            path: { documentId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * 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, { });
+   * ```
+   */
+  async update(documentId: number, req: UpdateDocumentRequest): Promise<Document> {
+    const response = await this.request(
+      {
+        service: "Documents",
+        operation: "UpdateDocument",
+        resourceType: "document",
+        isMutation: true,
+        resourceId: documentId,
+      },
+      () =>
+        this.client.PUT("/documents/{documentId}", {
+          params: {
+            path: { documentId },
+          },
+          body: {
+            title: req.title,
+            content: req.content,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * 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);
+   * ```
+   */
+  async list(vaultId: number, options?: ListDocumentOptions): Promise<ListResult<Document>> {
+    return this.requestPaginated(
+      {
+        service: "Documents",
+        operation: "ListDocuments",
+        resourceType: "document",
+        isMutation: false,
+        resourceId: vaultId,
+      },
+      () =>
+        this.client.GET("/vaults/{vaultId}/documents.json", {
+          params: {
+            path: { vaultId },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * 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" });
+   * ```
+   */
+  async create(vaultId: number, req: CreateDocumentRequest): Promise<Document> {
+    if (!req.title) {
+      throw Errors.validation("Title is required");
+    }
+    const response = await this.request(
+      {
+        service: "Documents",
+        operation: "CreateDocument",
+        resourceType: "document",
+        isMutation: true,
+        resourceId: vaultId,
+      },
+      () =>
+        this.client.POST("/vaults/{vaultId}/documents.json", {
+          params: {
+            path: { vaultId },
+          },
+          body: {
+            title: req.title,
+            content: req.content,
+            status: req.status,
+          },
+        })
+    );
+    return response;
+  }
+}

package/src/generated/services/events.ts

@@ -0,0 +1,64 @@
+/**
+ * Events 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";
+
+// =============================================================================
+// Types
+// =============================================================================
+
+/** Event entity from the Basecamp API. */
+export type Event = components["schemas"]["Event"];
+
+/**
+ * Options for list.
+ */
+export interface ListEventOptions extends PaginationOptions {
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Events operations.
+ */
+export class EventsService extends BaseService {
+
+  /**
+   * List all events for a recording
+   * @param recordingId - The recording ID
+   * @param options - Optional query parameters
+   * @returns All Event across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.events.list(123);
+   * ```
+   */
+  async list(recordingId: number, options?: ListEventOptions): Promise<ListResult<Event>> {
+    return this.requestPaginated(
+      {
+        service: "Events",
+        operation: "ListEvents",
+        resourceType: "event",
+        isMutation: false,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.GET("/recordings/{recordingId}/events.json", {
+          params: {
+            path: { recordingId },
+          },
+        })
+      , options
+    );
+  }
+}