@37signals/basecamp 0.2.0

package/src/generated/services/forwards.ts

@@ -0,0 +1,241 @@
+/**
+ * Forwards 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
+// =============================================================================
+
+/** Forward entity from the Basecamp API. */
+export type Forward = components["schemas"]["Forward"];
+/** ForwardReply entity from the Basecamp API. */
+export type ForwardReply = components["schemas"]["ForwardReply"];
+/** Inbox entity from the Basecamp API. */
+export type Inbox = components["schemas"]["Inbox"];
+
+/**
+ * Options for listReplies.
+ */
+export interface ListRepliesForwardOptions extends PaginationOptions {
+}
+
+/**
+ * Request parameters for createReply.
+ */
+export interface CreateReplyForwardRequest {
+  /** Text content */
+  content: string;
+}
+
+/**
+ * Options for list.
+ */
+export interface ListForwardOptions extends PaginationOptions {
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Forwards operations.
+ */
+export class ForwardsService extends BaseService {
+
+  /**
+   * Get a forward by ID
+   * @param forwardId - The forward ID
+   * @returns The Forward
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.forwards.get(123);
+   * ```
+   */
+  async get(forwardId: number): Promise<Forward> {
+    const response = await this.request(
+      {
+        service: "Forwards",
+        operation: "GetForward",
+        resourceType: "forward",
+        isMutation: false,
+        resourceId: forwardId,
+      },
+      () =>
+        this.client.GET("/inbox_forwards/{forwardId}", {
+          params: {
+            path: { forwardId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * List all replies to a forward
+   * @param forwardId - The forward ID
+   * @param options - Optional query parameters
+   * @returns All ForwardReply across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.forwards.listReplies(123);
+   * ```
+   */
+  async listReplies(forwardId: number, options?: ListRepliesForwardOptions): Promise<ListResult<ForwardReply>> {
+    return this.requestPaginated(
+      {
+        service: "Forwards",
+        operation: "ListForwardReplies",
+        resourceType: "forward_replie",
+        isMutation: false,
+        resourceId: forwardId,
+      },
+      () =>
+        this.client.GET("/inbox_forwards/{forwardId}/replies.json", {
+          params: {
+            path: { forwardId },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * Create a reply to a forward
+   * @param forwardId - The forward ID
+   * @param req - Forward_reply creation parameters
+   * @returns The ForwardReply
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.forwards.createReply(123, { content: "Hello world" });
+   * ```
+   */
+  async createReply(forwardId: number, req: CreateReplyForwardRequest): Promise<ForwardReply> {
+    if (!req.content) {
+      throw Errors.validation("Content is required");
+    }
+    const response = await this.request(
+      {
+        service: "Forwards",
+        operation: "CreateForwardReply",
+        resourceType: "forward_reply",
+        isMutation: true,
+        resourceId: forwardId,
+      },
+      () =>
+        this.client.POST("/inbox_forwards/{forwardId}/replies.json", {
+          params: {
+            path: { forwardId },
+          },
+          body: {
+            content: req.content,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Get a forward reply by ID
+   * @param forwardId - The forward ID
+   * @param replyId - The reply ID
+   * @returns The ForwardReply
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.forwards.getReply(123, 123);
+   * ```
+   */
+  async getReply(forwardId: number, replyId: number): Promise<ForwardReply> {
+    const response = await this.request(
+      {
+        service: "Forwards",
+        operation: "GetForwardReply",
+        resourceType: "forward_reply",
+        isMutation: false,
+        resourceId: forwardId,
+      },
+      () =>
+        this.client.GET("/inbox_forwards/{forwardId}/replies/{replyId}", {
+          params: {
+            path: { forwardId, replyId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Get an inbox by ID
+   * @param inboxId - The inbox ID
+   * @returns The Inbox
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.forwards.getInbox(123);
+   * ```
+   */
+  async getInbox(inboxId: number): Promise<Inbox> {
+    const response = await this.request(
+      {
+        service: "Forwards",
+        operation: "GetInbox",
+        resourceType: "inbox",
+        isMutation: false,
+        resourceId: inboxId,
+      },
+      () =>
+        this.client.GET("/inboxes/{inboxId}", {
+          params: {
+            path: { inboxId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * List all forwards in an inbox
+   * @param inboxId - The inbox ID
+   * @param options - Optional query parameters
+   * @returns All Forward across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.forwards.list(123);
+   * ```
+   */
+  async list(inboxId: number, options?: ListForwardOptions): Promise<ListResult<Forward>> {
+    return this.requestPaginated(
+      {
+        service: "Forwards",
+        operation: "ListForwards",
+        resourceType: "forward",
+        isMutation: false,
+        resourceId: inboxId,
+      },
+      () =>
+        this.client.GET("/inboxes/{inboxId}/forwards.json", {
+          params: {
+            path: { inboxId },
+          },
+        })
+      , options
+    );
+  }
+}

package/src/generated/services/index.ts

@@ -0,0 +1,38 @@
+export { AttachmentsService } from "./attachments.js";
+export { BoostsService } from "./boosts.js";
+export { WebhooksService } from "./webhooks.js";
+export { CardsService } from "./cards.js";
+export { CardStepsService } from "./card-steps.js";
+export { CardColumnsService } from "./card-columns.js";
+export { CardTablesService } from "./card-tables.js";
+export { MessageTypesService } from "./message-types.js";
+export { CampfiresService } from "./campfires.js";
+export { PeopleService } from "./people.js";
+export { ClientApprovalsService } from "./client-approvals.js";
+export { ClientCorrespondencesService } from "./client-correspondences.js";
+export { ClientRepliesService } from "./client-replies.js";
+export { CommentsService } from "./comments.js";
+export { ToolsService } from "./tools.js";
+export { DocumentsService } from "./documents.js";
+export { ForwardsService } from "./forwards.js";
+export { LineupService } from "./lineup.js";
+export { MessageBoardsService } from "./message-boards.js";
+export { MessagesService } from "./messages.js";
+export { CheckinsService } from "./checkins.js";
+export { ProjectsService } from "./projects.js";
+export { RecordingsService } from "./recordings.js";
+export { TimelineService } from "./timeline.js";
+export { TimesheetsService } from "./timesheets.js";
+export { ClientVisibilityService } from "./client-visibility.js";
+export { EventsService } from "./events.js";
+export { SubscriptionsService } from "./subscriptions.js";
+export { ReportsService } from "./reports.js";
+export { SchedulesService } from "./schedules.js";
+export { SearchService } from "./search.js";
+export { TemplatesService } from "./templates.js";
+export { TodolistGroupsService } from "./todolist-groups.js";
+export { TodolistsService } from "./todolists.js";
+export { TodosService } from "./todos.js";
+export { TodosetsService } from "./todosets.js";
+export { UploadsService } from "./uploads.js";
+export { VaultsService } from "./vaults.js";

package/src/generated/services/lineup.ts

@@ -0,0 +1,143 @@
+/**
+ * Lineup 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
+// =============================================================================
+
+
+/**
+ * Request parameters for create.
+ */
+export interface CreateLineupRequest {
+  /** Display name */
+  name: string;
+  /** Date */
+  date: string;
+}
+
+/**
+ * Request parameters for update.
+ */
+export interface UpdateLineupRequest {
+  /** Display name */
+  name?: string;
+  /** Date */
+  date?: string;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Lineup operations.
+ */
+export class LineupService extends BaseService {
+
+  /**
+   * Create a new lineup marker
+   * @param req - Lineup_marker creation parameters
+   * @returns void
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * await client.lineup.create({ name: "My example", date: "example" });
+   * ```
+   */
+  async create(req: CreateLineupRequest): Promise<void> {
+    if (!req.name) {
+      throw Errors.validation("Name is required");
+    }
+    if (!req.date) {
+      throw Errors.validation("Date is required");
+    }
+    await this.request(
+      {
+        service: "Lineup",
+        operation: "CreateLineupMarker",
+        resourceType: "lineup_marker",
+        isMutation: true,
+      },
+      () =>
+        this.client.POST("/lineup/markers.json", {
+          body: {
+            name: req.name,
+            date: req.date,
+          },
+        })
+    );
+  }
+
+  /**
+   * Update an existing lineup marker
+   * @param markerId - The marker ID
+   * @param req - Lineup_marker update parameters
+   * @returns void
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * await client.lineup.update(123, { });
+   * ```
+   */
+  async update(markerId: number, req: UpdateLineupRequest): Promise<void> {
+    await this.request(
+      {
+        service: "Lineup",
+        operation: "UpdateLineupMarker",
+        resourceType: "lineup_marker",
+        isMutation: true,
+        resourceId: markerId,
+      },
+      () =>
+        this.client.PUT("/lineup/markers/{markerId}", {
+          params: {
+            path: { markerId },
+          },
+          body: {
+            name: req.name,
+            date: req.date,
+          },
+        })
+    );
+  }
+
+  /**
+   * Delete a lineup marker
+   * @param markerId - The marker ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.lineup.delete(123);
+   * ```
+   */
+  async delete(markerId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Lineup",
+        operation: "DeleteLineupMarker",
+        resourceType: "lineup_marker",
+        isMutation: true,
+        resourceId: markerId,
+      },
+      () =>
+        this.client.DELETE("/lineup/markers/{markerId}", {
+          params: {
+            path: { markerId },
+          },
+        })
+    );
+  }
+}

package/src/generated/services/message-boards.ts

@@ -0,0 +1,55 @@
+/**
+ * MessageBoards 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
+// =============================================================================
+
+/** MessageBoard entity from the Basecamp API. */
+export type MessageBoard = components["schemas"]["MessageBoard"];
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for MessageBoards operations.
+ */
+export class MessageBoardsService extends BaseService {
+
+  /**
+   * Get a message board
+   * @param boardId - The board ID
+   * @returns The MessageBoard
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.messageBoards.get(123);
+   * ```
+   */
+  async get(boardId: number): Promise<MessageBoard> {
+    const response = await this.request(
+      {
+        service: "MessageBoards",
+        operation: "GetMessageBoard",
+        resourceType: "message_board",
+        isMutation: false,
+        resourceId: boardId,
+      },
+      () =>
+        this.client.GET("/message_boards/{boardId}", {
+          params: {
+            path: { boardId },
+          },
+        })
+    );
+    return response;
+  }
+}

package/src/generated/services/message-types.ts

@@ -0,0 +1,210 @@
+/**
+ * MessageTypes 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
+// =============================================================================
+
+/** MessageType entity from the Basecamp API. */
+export type MessageType = components["schemas"]["MessageType"];
+
+/**
+ * Options for list.
+ */
+export interface ListMessageTypeOptions extends PaginationOptions {
+}
+
+/**
+ * Request parameters for create.
+ */
+export interface CreateMessageTypeRequest {
+  /** Display name */
+  name: string;
+  /** Icon identifier */
+  icon: string;
+}
+
+/**
+ * Request parameters for update.
+ */
+export interface UpdateMessageTypeRequest {
+  /** Display name */
+  name?: string;
+  /** Icon identifier */
+  icon?: string;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for MessageTypes operations.
+ */
+export class MessageTypesService extends BaseService {
+
+  /**
+   * List message types in a project
+   * @param options - Optional query parameters
+   * @returns All MessageType across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.messageTypes.list();
+   * ```
+   */
+  async list(options?: ListMessageTypeOptions): Promise<ListResult<MessageType>> {
+    return this.requestPaginated(
+      {
+        service: "MessageTypes",
+        operation: "ListMessageTypes",
+        resourceType: "message_type",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/categories.json", {
+        })
+      , options
+    );
+  }
+
+  /**
+   * Create a new message type in a project
+   * @param req - Message_type creation parameters
+   * @returns The MessageType
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.messageTypes.create({ name: "My example", icon: "example" });
+   * ```
+   */
+  async create(req: CreateMessageTypeRequest): Promise<MessageType> {
+    if (!req.name) {
+      throw Errors.validation("Name is required");
+    }
+    if (!req.icon) {
+      throw Errors.validation("Icon is required");
+    }
+    const response = await this.request(
+      {
+        service: "MessageTypes",
+        operation: "CreateMessageType",
+        resourceType: "message_type",
+        isMutation: true,
+      },
+      () =>
+        this.client.POST("/categories.json", {
+          body: {
+            name: req.name,
+            icon: req.icon,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Get a single message type by id
+   * @param typeId - The type ID
+   * @returns The MessageType
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.messageTypes.get(123);
+   * ```
+   */
+  async get(typeId: number): Promise<MessageType> {
+    const response = await this.request(
+      {
+        service: "MessageTypes",
+        operation: "GetMessageType",
+        resourceType: "message_type",
+        isMutation: false,
+        resourceId: typeId,
+      },
+      () =>
+        this.client.GET("/categories/{typeId}", {
+          params: {
+            path: { typeId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Update an existing message type
+   * @param typeId - The type ID
+   * @param req - Message_type update parameters
+   * @returns The MessageType
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.messageTypes.update(123, { });
+   * ```
+   */
+  async update(typeId: number, req: UpdateMessageTypeRequest): Promise<MessageType> {
+    const response = await this.request(
+      {
+        service: "MessageTypes",
+        operation: "UpdateMessageType",
+        resourceType: "message_type",
+        isMutation: true,
+        resourceId: typeId,
+      },
+      () =>
+        this.client.PUT("/categories/{typeId}", {
+          params: {
+            path: { typeId },
+          },
+          body: {
+            name: req.name,
+            icon: req.icon,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Delete a message type
+   * @param typeId - The type ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.messageTypes.delete(123);
+   * ```
+   */
+  async delete(typeId: number): Promise<void> {
+    await this.request(
+      {
+        service: "MessageTypes",
+        operation: "DeleteMessageType",
+        resourceType: "message_type",
+        isMutation: true,
+        resourceId: typeId,
+      },
+      () =>
+        this.client.DELETE("/categories/{typeId}", {
+          params: {
+            path: { typeId },
+          },
+        })
+    );
+  }
+}