@37signals/basecamp 0.2.0

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

@@ -0,0 +1,118 @@
+/**
+ * Cards 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";
+/** Card entity from the Basecamp API. */
+export type Card = components["schemas"]["Card"];
+/**
+ * Request parameters for update.
+ */
+export interface UpdateCardRequest {
+    /** Title */
+    title?: string;
+    /** Text content */
+    content?: string;
+    /** Due date (YYYY-MM-DD) */
+    dueOn?: string;
+    /** Person IDs to assign to */
+    assigneeIds?: number[];
+}
+/**
+ * Request parameters for move.
+ */
+export interface MoveCardRequest {
+    /** Column id */
+    columnId: number;
+}
+/**
+ * Options for list.
+ */
+export interface ListCardOptions extends PaginationOptions {
+}
+/**
+ * Request parameters for create.
+ */
+export interface CreateCardRequest {
+    /** Title */
+    title: string;
+    /** Text content */
+    content?: string;
+    /** Due date (YYYY-MM-DD) */
+    dueOn?: string;
+    /** Whether to send notifications to relevant people */
+    notify?: boolean;
+}
+/**
+ * Service for Cards operations.
+ */
+export declare class CardsService extends BaseService {
+    /**
+     * Get a card by ID
+     * @param cardId - The card ID
+     * @returns The Card
+     * @throws {BasecampError} If the resource is not found
+     *
+     * @example
+     * ```ts
+     * const result = await client.cards.get(123);
+     * ```
+     */
+    get(cardId: number): Promise<Card>;
+    /**
+     * Update an existing card
+     * @param cardId - The card ID
+     * @param req - Card update parameters
+     * @returns The Card
+     * @throws {BasecampError} If the resource is not found or fields are invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.cards.update(123, { });
+     * ```
+     */
+    update(cardId: number, req: UpdateCardRequest): Promise<Card>;
+    /**
+     * Move a card to a different column
+     * @param cardId - The card ID
+     * @param req - Card request parameters
+     * @returns void
+     * @throws {BasecampError} If the request fails
+     *
+     * @example
+     * ```ts
+     * await client.cards.move(123, { columnId: 1 });
+     * ```
+     */
+    move(cardId: number, req: MoveCardRequest): Promise<void>;
+    /**
+     * List cards in a column
+     * @param columnId - The column ID
+     * @param options - Optional query parameters
+     * @returns All Card across all pages, with .meta.totalCount
+     *
+     * @example
+     * ```ts
+     * const result = await client.cards.list(123);
+     * ```
+     */
+    list(columnId: number, options?: ListCardOptions): Promise<ListResult<Card>>;
+    /**
+     * Create a card in a column
+     * @param columnId - The column ID
+     * @param req - Card creation parameters
+     * @returns The Card
+     * @throws {BasecampError} If required fields are missing or invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.cards.create(123, { title: "example" });
+     * ```
+     */
+    create(columnId: number, req: CreateCardRequest): Promise<Card>;
+}
+//# sourceMappingURL=cards.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cards.d.ts","sourceRoot":"","sources":["../../../src/generated/services/cards.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,yCAAyC;AACzC,MAAM,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,YAAY;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mBAAmB;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8BAA8B;IAC9B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,iBAAiB;CACzD;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,YAAY;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,mBAAmB;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uDAAuD;IACvD,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAOD;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAE3C;;;;;;;;;;OAUG;IACG,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBxC;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IA4BnE;;;;;;;;;;;OAWG;IACG,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAqB/D;;;;;;;;;;OAUG;IACG,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAmBlF;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;CA8BtE"}

package/dist/generated/services/cards.js

@@ -0,0 +1,166 @@
+/**
+ * Cards 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 Cards operations.
+ */
+export class CardsService extends BaseService {
+    /**
+     * Get a card by ID
+     * @param cardId - The card ID
+     * @returns The Card
+     * @throws {BasecampError} If the resource is not found
+     *
+     * @example
+     * ```ts
+     * const result = await client.cards.get(123);
+     * ```
+     */
+    async get(cardId) {
+        const response = await this.request({
+            service: "Cards",
+            operation: "GetCard",
+            resourceType: "card",
+            isMutation: false,
+            resourceId: cardId,
+        }, () => this.client.GET("/card_tables/cards/{cardId}", {
+            params: {
+                path: { cardId },
+            },
+        }));
+        return response;
+    }
+    /**
+     * Update an existing card
+     * @param cardId - The card ID
+     * @param req - Card update parameters
+     * @returns The Card
+     * @throws {BasecampError} If the resource is not found or fields are invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.cards.update(123, { });
+     * ```
+     */
+    async update(cardId, req) {
+        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: "Cards",
+            operation: "UpdateCard",
+            resourceType: "card",
+            isMutation: true,
+            resourceId: cardId,
+        }, () => this.client.PUT("/card_tables/cards/{cardId}", {
+            params: {
+                path: { cardId },
+            },
+            body: {
+                title: req.title,
+                content: req.content,
+                due_on: req.dueOn,
+                assignee_ids: req.assigneeIds,
+            },
+        }));
+        return response;
+    }
+    /**
+     * Move a card to a different column
+     * @param cardId - The card ID
+     * @param req - Card request parameters
+     * @returns void
+     * @throws {BasecampError} If the request fails
+     *
+     * @example
+     * ```ts
+     * await client.cards.move(123, { columnId: 1 });
+     * ```
+     */
+    async move(cardId, req) {
+        await this.request({
+            service: "Cards",
+            operation: "MoveCard",
+            resourceType: "card",
+            isMutation: true,
+            resourceId: cardId,
+        }, () => this.client.POST("/card_tables/cards/{cardId}/moves.json", {
+            params: {
+                path: { cardId },
+            },
+            body: {
+                column_id: req.columnId,
+            },
+        }));
+    }
+    /**
+     * List cards in a column
+     * @param columnId - The column ID
+     * @param options - Optional query parameters
+     * @returns All Card across all pages, with .meta.totalCount
+     *
+     * @example
+     * ```ts
+     * const result = await client.cards.list(123);
+     * ```
+     */
+    async list(columnId, options) {
+        return this.requestPaginated({
+            service: "Cards",
+            operation: "ListCards",
+            resourceType: "card",
+            isMutation: false,
+            resourceId: columnId,
+        }, () => this.client.GET("/card_tables/lists/{columnId}/cards.json", {
+            params: {
+                path: { columnId },
+            },
+        }), options);
+    }
+    /**
+     * Create a card in a column
+     * @param columnId - The column ID
+     * @param req - Card creation parameters
+     * @returns The Card
+     * @throws {BasecampError} If required fields are missing or invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.cards.create(123, { title: "example" });
+     * ```
+     */
+    async create(columnId, req) {
+        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: "Cards",
+            operation: "CreateCard",
+            resourceType: "card",
+            isMutation: true,
+            resourceId: columnId,
+        }, () => this.client.POST("/card_tables/lists/{columnId}/cards.json", {
+            params: {
+                path: { columnId },
+            },
+            body: {
+                title: req.title,
+                content: req.content,
+                due_on: req.dueOn,
+                notify: req.notify,
+            },
+        }));
+        return response;
+    }
+}
+//# sourceMappingURL=cards.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cards.js","sourceRoot":"","sources":["../../../src/generated/services/cards.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAIrD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAoDzC,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAE3C;;;;;;;;;;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,6BAA6B,EAAE;YAC7C,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,GAAG,CAAC,KAAK,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,MAAM,MAAM,CAAC,UAAU,CAAC,qCAAqC,CAAC,CAAC;QACjE,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,6BAA6B,EAAE;YAC7C,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,MAAM,EAAE;aACjB;YACD,IAAI,EAAE;gBACJ,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,OAAO,EAAE,GAAG,CAAC,OAAO;gBACpB,MAAM,EAAE,GAAG,CAAC,KAAK;gBACjB,YAAY,EAAE,GAAG,CAAC,WAAW;aAC9B;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,IAAI,CAAC,MAAc,EAAE,GAAoB;QAC7C,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,UAAU;YACrB,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,MAAM;SACnB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,wCAAwC,EAAE;YACzD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,MAAM,EAAE;aACjB;YACD,IAAI,EAAE;gBACJ,SAAS,EAAE,GAAG,CAAC,QAAQ;aACxB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,IAAI,CAAC,QAAgB,EAAE,OAAyB;QACpD,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,WAAW;YACtB,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,QAAQ;SACrB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,0CAA0C,EAAE;YAC1D,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,QAAQ,EAAE;aACnB;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,CAAC,QAAgB,EAAE,GAAsB;QACnD,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;QAC/C,CAAC;QACD,IAAI,GAAG,CAAC,KAAK,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,MAAM,MAAM,CAAC,UAAU,CAAC,qCAAqC,CAAC,CAAC;QACjE,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,QAAQ;SACrB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,0CAA0C,EAAE;YAC3D,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,QAAQ,EAAE;aACnB;YACD,IAAI,EAAE;gBACJ,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,OAAO,EAAE,GAAG,CAAC,OAAO;gBACpB,MAAM,EAAE,GAAG,CAAC,KAAK;gBACjB,MAAM,EAAE,GAAG,CAAC,MAAM;aACnB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}

package/dist/generated/services/cards.ts

@@ -0,0 +1,247 @@
+/**
+ * Cards 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
+// =============================================================================
+
+/** Card entity from the Basecamp API. */
+export type Card = components["schemas"]["Card"];
+
+/**
+ * Request parameters for update.
+ */
+export interface UpdateCardRequest {
+  /** Title */
+  title?: string;
+  /** Text content */
+  content?: string;
+  /** Due date (YYYY-MM-DD) */
+  dueOn?: string;
+  /** Person IDs to assign to */
+  assigneeIds?: number[];
+}
+
+/**
+ * Request parameters for move.
+ */
+export interface MoveCardRequest {
+  /** Column id */
+  columnId: number;
+}
+
+/**
+ * Options for list.
+ */
+export interface ListCardOptions extends PaginationOptions {
+}
+
+/**
+ * Request parameters for create.
+ */
+export interface CreateCardRequest {
+  /** Title */
+  title: string;
+  /** Text content */
+  content?: string;
+  /** Due date (YYYY-MM-DD) */
+  dueOn?: string;
+  /** Whether to send notifications to relevant people */
+  notify?: boolean;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Cards operations.
+ */
+export class CardsService extends BaseService {
+
+  /**
+   * Get a card by ID
+   * @param cardId - The card ID
+   * @returns The Card
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.cards.get(123);
+   * ```
+   */
+  async get(cardId: number): Promise<Card> {
+    const response = await this.request(
+      {
+        service: "Cards",
+        operation: "GetCard",
+        resourceType: "card",
+        isMutation: false,
+        resourceId: cardId,
+      },
+      () =>
+        this.client.GET("/card_tables/cards/{cardId}", {
+          params: {
+            path: { cardId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Update an existing card
+   * @param cardId - The card ID
+   * @param req - Card update parameters
+   * @returns The Card
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.cards.update(123, { });
+   * ```
+   */
+  async update(cardId: number, req: UpdateCardRequest): Promise<Card> {
+    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: "Cards",
+        operation: "UpdateCard",
+        resourceType: "card",
+        isMutation: true,
+        resourceId: cardId,
+      },
+      () =>
+        this.client.PUT("/card_tables/cards/{cardId}", {
+          params: {
+            path: { cardId },
+          },
+          body: {
+            title: req.title,
+            content: req.content,
+            due_on: req.dueOn,
+            assignee_ids: req.assigneeIds,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Move a card to a different column
+   * @param cardId - The card ID
+   * @param req - Card request parameters
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.cards.move(123, { columnId: 1 });
+   * ```
+   */
+  async move(cardId: number, req: MoveCardRequest): Promise<void> {
+    await this.request(
+      {
+        service: "Cards",
+        operation: "MoveCard",
+        resourceType: "card",
+        isMutation: true,
+        resourceId: cardId,
+      },
+      () =>
+        this.client.POST("/card_tables/cards/{cardId}/moves.json", {
+          params: {
+            path: { cardId },
+          },
+          body: {
+            column_id: req.columnId,
+          },
+        })
+    );
+  }
+
+  /**
+   * List cards in a column
+   * @param columnId - The column ID
+   * @param options - Optional query parameters
+   * @returns All Card across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.cards.list(123);
+   * ```
+   */
+  async list(columnId: number, options?: ListCardOptions): Promise<ListResult<Card>> {
+    return this.requestPaginated(
+      {
+        service: "Cards",
+        operation: "ListCards",
+        resourceType: "card",
+        isMutation: false,
+        resourceId: columnId,
+      },
+      () =>
+        this.client.GET("/card_tables/lists/{columnId}/cards.json", {
+          params: {
+            path: { columnId },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * Create a card in a column
+   * @param columnId - The column ID
+   * @param req - Card creation parameters
+   * @returns The Card
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.cards.create(123, { title: "example" });
+   * ```
+   */
+  async create(columnId: number, req: CreateCardRequest): Promise<Card> {
+    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: "Cards",
+        operation: "CreateCard",
+        resourceType: "card",
+        isMutation: true,
+        resourceId: columnId,
+      },
+      () =>
+        this.client.POST("/card_tables/lists/{columnId}/cards.json", {
+          params: {
+            path: { columnId },
+          },
+          body: {
+            title: req.title,
+            content: req.content,
+            due_on: req.dueOn,
+            notify: req.notify,
+          },
+        })
+    );
+    return response;
+  }
+}