@37signals/basecamp 0.2.0

package/src/generated/services/card-columns.ts

@@ -0,0 +1,360 @@
+/**
+ * CardColumns 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
+// =============================================================================
+
+/** CardColumn entity from the Basecamp API. */
+export type CardColumn = components["schemas"]["CardColumn"];
+
+/**
+ * Request parameters for update.
+ */
+export interface UpdateCardColumnRequest {
+  /** Title */
+  title?: string;
+  /** Rich text description (HTML) */
+  description?: string;
+}
+
+/**
+ * Request parameters for setColor.
+ */
+export interface SetColorCardColumnRequest {
+  /** Valid colors: white, red, orange, yellow, green, blue, aqua, purple, gray, pink, brown */
+  color: string;
+}
+
+/**
+ * Request parameters for create.
+ */
+export interface CreateCardColumnRequest {
+  /** Title */
+  title: string;
+  /** Rich text description (HTML) */
+  description?: string;
+}
+
+/**
+ * Request parameters for move.
+ */
+export interface MoveCardColumnRequest {
+  /** Source id */
+  sourceId: number;
+  /** Target id */
+  targetId: number;
+  /** Position for ordering (1-based) */
+  position?: number;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for CardColumns operations.
+ */
+export class CardColumnsService extends BaseService {
+
+  /**
+   * Get a card column by ID
+   * @param columnId - The column ID
+   * @returns The CardColumn
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.cardColumns.get(123);
+   * ```
+   */
+  async get(columnId: number): Promise<CardColumn> {
+    const response = await this.request(
+      {
+        service: "CardColumns",
+        operation: "GetCardColumn",
+        resourceType: "card_column",
+        isMutation: false,
+        resourceId: columnId,
+      },
+      () =>
+        this.client.GET("/card_tables/columns/{columnId}", {
+          params: {
+            path: { columnId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Update an existing column
+   * @param columnId - The column ID
+   * @param req - Card_column update parameters
+   * @returns The CardColumn
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.cardColumns.update(123, { });
+   * ```
+   */
+  async update(columnId: number, req: UpdateCardColumnRequest): Promise<CardColumn> {
+    const response = await this.request(
+      {
+        service: "CardColumns",
+        operation: "UpdateCardColumn",
+        resourceType: "card_column",
+        isMutation: true,
+        resourceId: columnId,
+      },
+      () =>
+        this.client.PUT("/card_tables/columns/{columnId}", {
+          params: {
+            path: { columnId },
+          },
+          body: {
+            title: req.title,
+            description: req.description,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Set the color of a column
+   * @param columnId - The column ID
+   * @param req - Card_column_color request parameters
+   * @returns The CardColumn
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * const result = await client.cardColumns.setColor(123, { color: "example" });
+   * ```
+   */
+  async setColor(columnId: number, req: SetColorCardColumnRequest): Promise<CardColumn> {
+    if (!req.color) {
+      throw Errors.validation("Color is required");
+    }
+    const response = await this.request(
+      {
+        service: "CardColumns",
+        operation: "SetCardColumnColor",
+        resourceType: "card_column_color",
+        isMutation: true,
+        resourceId: columnId,
+      },
+      () =>
+        this.client.PUT("/card_tables/columns/{columnId}/color.json", {
+          params: {
+            path: { columnId },
+          },
+          body: {
+            color: req.color,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Enable on-hold section in a column
+   * @param columnId - The column ID
+   * @returns The CardColumn
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * const result = await client.cardColumns.enableOnHold(123);
+   * ```
+   */
+  async enableOnHold(columnId: number): Promise<CardColumn> {
+    const response = await this.request(
+      {
+        service: "CardColumns",
+        operation: "EnableCardColumnOnHold",
+        resourceType: "card_column_on_hold",
+        isMutation: true,
+        resourceId: columnId,
+      },
+      () =>
+        this.client.POST("/card_tables/columns/{columnId}/on_hold.json", {
+          params: {
+            path: { columnId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Disable on-hold section in a column
+   * @param columnId - The column ID
+   * @returns The CardColumn
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * const result = await client.cardColumns.disableOnHold(123);
+   * ```
+   */
+  async disableOnHold(columnId: number): Promise<CardColumn> {
+    const response = await this.request(
+      {
+        service: "CardColumns",
+        operation: "DisableCardColumnOnHold",
+        resourceType: "card_column_on_hold",
+        isMutation: true,
+        resourceId: columnId,
+      },
+      () =>
+        this.client.DELETE("/card_tables/columns/{columnId}/on_hold.json", {
+          params: {
+            path: { columnId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Subscribe to a card column (watch for changes)
+   * @param columnId - The column ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.cardColumns.subscribeToColumn(123);
+   * ```
+   */
+  async subscribeToColumn(columnId: number): Promise<void> {
+    await this.request(
+      {
+        service: "CardColumns",
+        operation: "SubscribeToCardColumn",
+        resourceType: "to_card_column",
+        isMutation: true,
+        resourceId: columnId,
+      },
+      () =>
+        this.client.POST("/card_tables/lists/{columnId}/subscription.json", {
+          params: {
+            path: { columnId },
+          },
+        })
+    );
+  }
+
+  /**
+   * Unsubscribe from a card column (stop watching for changes)
+   * @param columnId - The column ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.cardColumns.unsubscribeFromColumn(123);
+   * ```
+   */
+  async unsubscribeFromColumn(columnId: number): Promise<void> {
+    await this.request(
+      {
+        service: "CardColumns",
+        operation: "UnsubscribeFromCardColumn",
+        resourceType: "from_card_column",
+        isMutation: true,
+        resourceId: columnId,
+      },
+      () =>
+        this.client.DELETE("/card_tables/lists/{columnId}/subscription.json", {
+          params: {
+            path: { columnId },
+          },
+        })
+    );
+  }
+
+  /**
+   * Create a column in a card table
+   * @param cardTableId - The card table ID
+   * @param req - Card_column creation parameters
+   * @returns The CardColumn
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.cardColumns.create(123, { title: "example" });
+   * ```
+   */
+  async create(cardTableId: number, req: CreateCardColumnRequest): Promise<CardColumn> {
+    if (!req.title) {
+      throw Errors.validation("Title is required");
+    }
+    const response = await this.request(
+      {
+        service: "CardColumns",
+        operation: "CreateCardColumn",
+        resourceType: "card_column",
+        isMutation: true,
+        resourceId: cardTableId,
+      },
+      () =>
+        this.client.POST("/card_tables/{cardTableId}/columns.json", {
+          params: {
+            path: { cardTableId },
+          },
+          body: {
+            title: req.title,
+            description: req.description,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Move a column within a card table
+   * @param cardTableId - The card table ID
+   * @param req - Card_column request parameters
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.cardColumns.move(123, { sourceId: 1, targetId: 1 });
+   * ```
+   */
+  async move(cardTableId: number, req: MoveCardColumnRequest): Promise<void> {
+    await this.request(
+      {
+        service: "CardColumns",
+        operation: "MoveCardColumn",
+        resourceType: "card_column",
+        isMutation: true,
+        resourceId: cardTableId,
+      },
+      () =>
+        this.client.POST("/card_tables/{cardTableId}/moves.json", {
+          params: {
+            path: { cardTableId },
+          },
+          body: {
+            source_id: req.sourceId,
+            target_id: req.targetId,
+            position: req.position,
+          },
+        })
+    );
+  }
+}

package/src/generated/services/card-steps.ts

@@ -0,0 +1,221 @@
+/**
+ * CardSteps 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
+// =============================================================================
+
+/** CardStep entity from the Basecamp API. */
+export type CardStep = components["schemas"]["CardStep"];
+
+/**
+ * Request parameters for reposition.
+ */
+export interface RepositionCardStepRequest {
+  /** Source id */
+  sourceId: number;
+  /** 0-indexed position */
+  position: number;
+}
+
+/**
+ * Request parameters for create.
+ */
+export interface CreateCardStepRequest {
+  /** Title */
+  title: string;
+  /** Due date (YYYY-MM-DD) */
+  dueOn?: string;
+  /** Assignees */
+  assignees?: number[];
+}
+
+/**
+ * Request parameters for update.
+ */
+export interface UpdateCardStepRequest {
+  /** Title */
+  title?: string;
+  /** Due date (YYYY-MM-DD) */
+  dueOn?: string;
+  /** Assignees */
+  assignees?: number[];
+}
+
+/**
+ * Request parameters for setCompletion.
+ */
+export interface SetCompletionCardStepRequest {
+  /** Set to "on" to complete the step, "" (empty) to uncomplete */
+  completion: string;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for CardSteps operations.
+ */
+export class CardStepsService extends BaseService {
+
+  /**
+   * Reposition a step within a card
+   * @param cardId - The card ID
+   * @param req - Card_step request parameters
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.cardSteps.reposition(123, { sourceId: 1, position: 1 });
+   * ```
+   */
+  async reposition(cardId: number, req: RepositionCardStepRequest): Promise<void> {
+    await this.request(
+      {
+        service: "CardSteps",
+        operation: "RepositionCardStep",
+        resourceType: "card_step",
+        isMutation: true,
+        resourceId: cardId,
+      },
+      () =>
+        this.client.POST("/card_tables/cards/{cardId}/positions.json", {
+          params: {
+            path: { cardId },
+          },
+          body: {
+            source_id: req.sourceId,
+            position: req.position,
+          },
+        })
+    );
+  }
+
+  /**
+   * Create a step on a card
+   * @param cardId - The card ID
+   * @param req - Card_step creation parameters
+   * @returns The CardStep
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.cardSteps.create(123, { title: "example" });
+   * ```
+   */
+  async create(cardId: number, req: CreateCardStepRequest): Promise<CardStep> {
+    if (!req.title) {
+      throw Errors.validation("Title is required");
+    }
+    if (req.dueOn && !/^\d{4}-\d{2}-\d{2}$/.test(req.dueOn)) {
+      throw Errors.validation("Due on must be in YYYY-MM-DD format");
+    }
+    const response = await this.request(
+      {
+        service: "CardSteps",
+        operation: "CreateCardStep",
+        resourceType: "card_step",
+        isMutation: true,
+        resourceId: cardId,
+      },
+      () =>
+        this.client.POST("/card_tables/cards/{cardId}/steps.json", {
+          params: {
+            path: { cardId },
+          },
+          body: {
+            title: req.title,
+            due_on: req.dueOn,
+            assignees: req.assignees,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Update an existing step
+   * @param stepId - The step ID
+   * @param req - Card_step update parameters
+   * @returns The CardStep
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.cardSteps.update(123, { });
+   * ```
+   */
+  async update(stepId: number, req: UpdateCardStepRequest): Promise<CardStep> {
+    if (req.dueOn && !/^\d{4}-\d{2}-\d{2}$/.test(req.dueOn)) {
+      throw Errors.validation("Due on must be in YYYY-MM-DD format");
+    }
+    const response = await this.request(
+      {
+        service: "CardSteps",
+        operation: "UpdateCardStep",
+        resourceType: "card_step",
+        isMutation: true,
+        resourceId: stepId,
+      },
+      () =>
+        this.client.PUT("/card_tables/steps/{stepId}", {
+          params: {
+            path: { stepId },
+          },
+          body: {
+            title: req.title,
+            due_on: req.dueOn,
+            assignees: req.assignees,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Set card step completion status (PUT with completion: "on" to complete, "" to uncomplete)
+   * @param stepId - The step ID
+   * @param req - Card_step_completion request parameters
+   * @returns The CardStep
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * const result = await client.cardSteps.setCompletion(123, { completion: "example" });
+   * ```
+   */
+  async setCompletion(stepId: number, req: SetCompletionCardStepRequest): Promise<CardStep> {
+    if (!req.completion) {
+      throw Errors.validation("Completion is required");
+    }
+    const response = await this.request(
+      {
+        service: "CardSteps",
+        operation: "SetCardStepCompletion",
+        resourceType: "card_step_completion",
+        isMutation: true,
+        resourceId: stepId,
+      },
+      () =>
+        this.client.PUT("/card_tables/steps/{stepId}/completions.json", {
+          params: {
+            path: { stepId },
+          },
+          body: {
+            completion: req.completion,
+          },
+        })
+    );
+    return response;
+  }
+}

package/src/generated/services/card-tables.ts

@@ -0,0 +1,55 @@
+/**
+ * CardTables 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
+// =============================================================================
+
+/** CardTable entity from the Basecamp API. */
+export type CardTable = components["schemas"]["CardTable"];
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for CardTables operations.
+ */
+export class CardTablesService extends BaseService {
+
+  /**
+   * Get a card table by ID
+   * @param cardTableId - The card table ID
+   * @returns The CardTable
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.cardTables.get(123);
+   * ```
+   */
+  async get(cardTableId: number): Promise<CardTable> {
+    const response = await this.request(
+      {
+        service: "CardTables",
+        operation: "GetCardTable",
+        resourceType: "card_table",
+        isMutation: false,
+        resourceId: cardTableId,
+      },
+      () =>
+        this.client.GET("/card_tables/{cardTableId}", {
+          params: {
+            path: { cardTableId },
+          },
+        })
+    );
+    return response;
+  }
+}