@37signals/basecamp 0.20.0 → 0.21.0

package/dist/generated/services/subtasks.js

@@ -0,0 +1,240 @@
+/**
+ * Subtasks 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 Subtasks operations.
+ */
+export class SubtasksService extends BaseService {
+    /**
+     * List a recording's subtasks, in position order
+     * @param recordingId - The recording ID
+     * @param options - Optional query parameters
+     * @returns Every Subtask across all pages, with .meta.totalCount
+     *
+     * @example
+     * ```ts
+     * const result = await client.subtasks.list(123);
+     *
+     * // With options
+     * const filtered = await client.subtasks.list(123, { page: 1 });
+     * ```
+     */
+    async list(recordingId, options) {
+        return this.requestPaginated({
+            service: "Subtasks",
+            operation: "ListSubtasks",
+            resourceType: "subtask",
+            isMutation: false,
+            resourceId: recordingId,
+        }, () => this.client.GET("/recordings/{recordingId}/subtasks.json", {
+            params: {
+                path: { recordingId },
+                query: { page: options?.page },
+            },
+        }), options);
+    }
+    /**
+     * Create a subtask under a to-do or a card
+     * @param recordingId - The recording ID
+     * @param req - Subtask creation parameters
+     * @returns The Subtask
+     * @throws {BasecampError} If required fields are missing or invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.subtasks.create(123, { title: "example" });
+     * ```
+     */
+    async create(recordingId, 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: "Subtasks",
+            operation: "CreateSubtask",
+            resourceType: "subtask",
+            isMutation: true,
+            resourceId: recordingId,
+        }, () => this.client.POST("/recordings/{recordingId}/subtasks.json", {
+            params: {
+                path: { recordingId },
+            },
+            body: {
+                title: req.title,
+                due_on: req.dueOn,
+                assignee_ids: req.assigneeIds,
+            },
+        }));
+        return response;
+    }
+    /**
+     * Get a subtask by ID
+     * @param subtaskId - The subtask ID
+     * @returns The Subtask
+     * @throws {BasecampError} If the resource is not found
+     *
+     * @example
+     * ```ts
+     * const result = await client.subtasks.get(123);
+     * ```
+     */
+    async get(subtaskId) {
+        const response = await this.request({
+            service: "Subtasks",
+            operation: "GetSubtask",
+            resourceType: "subtask",
+            isMutation: false,
+            resourceId: subtaskId,
+        }, () => this.client.GET("/subtasks/{subtaskId}", {
+            params: {
+                path: { subtaskId },
+            },
+        }));
+        return response;
+    }
+    /**
+     * Update a subtask
+     * @param subtaskId - The subtask ID
+     * @param req - Subtask update parameters
+     * @returns The Subtask
+     * @throws {BasecampError} If the resource is not found or fields are invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.subtasks.update(123, { });
+     * ```
+     */
+    async update(subtaskId, 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: "Subtasks",
+            operation: "UpdateSubtask",
+            resourceType: "subtask",
+            isMutation: true,
+            resourceId: subtaskId,
+        }, () => this.client.PUT("/subtasks/{subtaskId}", {
+            params: {
+                path: { subtaskId },
+            },
+            body: {
+                title: req.title,
+                due_on: req.dueOn,
+                assignee_ids: req.assigneeIds,
+            },
+        }));
+        return response;
+    }
+    /**
+     * Delete a subtask
+     * @param subtaskId - The subtask ID
+     * @returns void
+     * @throws {BasecampError} If the request fails
+     *
+     * @example
+     * ```ts
+     * await client.subtasks.delete(123);
+     * ```
+     */
+    async delete(subtaskId) {
+        await this.request({
+            service: "Subtasks",
+            operation: "DeleteSubtask",
+            resourceType: "subtask",
+            isMutation: true,
+            resourceId: subtaskId,
+        }, () => this.client.DELETE("/subtasks/{subtaskId}", {
+            params: {
+                path: { subtaskId },
+            },
+        }));
+    }
+    /**
+     * Mark a subtask as completed
+     * @param subtaskId - The subtask ID
+     * @returns void
+     * @throws {BasecampError} If the request fails
+     *
+     * @example
+     * ```ts
+     * await client.subtasks.complete(123);
+     * ```
+     */
+    async complete(subtaskId) {
+        await this.request({
+            service: "Subtasks",
+            operation: "CompleteSubtask",
+            resourceType: "subtask",
+            isMutation: true,
+            resourceId: subtaskId,
+        }, () => this.client.POST("/subtasks/{subtaskId}/completion.json", {
+            params: {
+                path: { subtaskId },
+            },
+        }));
+    }
+    /**
+     * Mark a subtask as not completed
+     * @param subtaskId - The subtask ID
+     * @returns void
+     * @throws {BasecampError} If the request fails
+     *
+     * @example
+     * ```ts
+     * await client.subtasks.uncomplete(123);
+     * ```
+     */
+    async uncomplete(subtaskId) {
+        await this.request({
+            service: "Subtasks",
+            operation: "UncompleteSubtask",
+            resourceType: "subtask",
+            isMutation: true,
+            resourceId: subtaskId,
+        }, () => this.client.DELETE("/subtasks/{subtaskId}/completion.json", {
+            params: {
+                path: { subtaskId },
+            },
+        }));
+    }
+    /**
+     * Move a subtask to a new position among its siblings
+     * @param subtaskId - The subtask ID
+     * @param req - Subtask request parameters
+     * @returns void
+     * @throws {BasecampError} If the request fails
+     *
+     * @example
+     * ```ts
+     * await client.subtasks.reposition(123, { position: 1 });
+     * ```
+     */
+    async reposition(subtaskId, req) {
+        await this.request({
+            service: "Subtasks",
+            operation: "RepositionSubtask",
+            resourceType: "subtask",
+            isMutation: true,
+            resourceId: subtaskId,
+        }, () => this.client.PUT("/subtasks/{subtaskId}/position.json", {
+            params: {
+                path: { subtaskId },
+            },
+            body: {
+                position: req.position,
+            },
+        }));
+    }
+}
+//# sourceMappingURL=subtasks.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"subtasks.js","sourceRoot":"","sources":["../../../src/generated/services/subtasks.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,eAAgB,SAAQ,WAAW;IAE9C;;;;;;;;;;;;;OAaG;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;gBACrB,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE;aAC/B;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,CAAC,WAAmB,EAAE,GAAyB;QACzD,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,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,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,MAAM,EAAE,GAAG,CAAC,KAAK;gBACjB,YAAY,EAAE,GAAG,CAAC,WAAW;aAC9B;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;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,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,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,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,MAAM,EAAE,GAAG,CAAC,KAAK;gBACjB,YAAY,EAAE,GAAG,CAAC,WAAW;aAC9B;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM,CAAC,SAAiB;QAC5B,MAAM,IAAI,CAAC,OAAO,CAChB;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,MAAM,CAAC,uBAAuB,EAAE;YAC1C,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,SAAS,EAAE;aACpB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,QAAQ,CAAC,SAAiB;QAC9B,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,UAAU;YACnB,SAAS,EAAE,iBAAiB;YAC5B,YAAY,EAAE,SAAS;YACvB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,SAAS;SACtB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,uCAAuC,EAAE;YACxD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,SAAS,EAAE;aACpB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,UAAU,CAAC,SAAiB;QAChC,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,UAAU;YACnB,SAAS,EAAE,mBAAmB;YAC9B,YAAY,EAAE,SAAS;YACvB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,SAAS;SACtB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,uCAAuC,EAAE;YAC1D,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,SAAS,EAAE;aACpB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,UAAU,CAAC,SAAiB,EAAE,GAA6B;QAC/D,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,UAAU;YACnB,SAAS,EAAE,mBAAmB;YAC9B,YAAY,EAAE,SAAS;YACvB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,SAAS;SACtB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,qCAAqC,EAAE;YACrD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,SAAS,EAAE;aACpB;YACD,IAAI,EAAE;gBACJ,QAAQ,EAAE,GAAG,CAAC,QAAQ;aACvB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;CACF"}

package/dist/generated/services/subtasks.ts

@@ -0,0 +1,336 @@
+/**
+ * Subtasks 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
+// =============================================================================
+
+/** Subtask entity from the Basecamp API. */
+export type Subtask = components["schemas"]["Subtask"];
+/** @deprecated renamed to Subtask, the same Kanban::Step record. */
+export type CardStep = Subtask;
+
+/**
+ * Options for list.
+ */
+export interface ListSubtaskOptions extends PaginationOptions {
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
+  page?: number;
+}
+
+/**
+ * Request parameters for create.
+ */
+export interface CreateSubtaskRequest {
+  /** Title */
+  title: string;
+  /** Due date (YYYY-MM-DD) */
+  dueOn?: string;
+  /** Person IDs to assign to */
+  assigneeIds?: number[];
+}
+
+/**
+ * Request parameters for update.
+ */
+export interface UpdateSubtaskRequest {
+  /** Title */
+  title?: string;
+  /** Due date (YYYY-MM-DD) */
+  dueOn?: string;
+  /** Person IDs to assign to */
+  assigneeIds?: number[];
+}
+
+/**
+ * Request parameters for reposition.
+ */
+export interface RepositionSubtaskRequest {
+  /** The 1-based position to move it to */
+  position: number;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Subtasks operations.
+ */
+export class SubtasksService extends BaseService {
+
+  /**
+   * List a recording's subtasks, in position order
+   * @param recordingId - The recording ID
+   * @param options - Optional query parameters
+   * @returns Every Subtask across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.subtasks.list(123);
+   *
+   * // With options
+   * const filtered = await client.subtasks.list(123, { page: 1 });
+   * ```
+   */
+  async list(recordingId: number, options?: ListSubtaskOptions): Promise<ListResult<Subtask>> {
+    return this.requestPaginated(
+      {
+        service: "Subtasks",
+        operation: "ListSubtasks",
+        resourceType: "subtask",
+        isMutation: false,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.GET("/recordings/{recordingId}/subtasks.json", {
+          params: {
+            path: { recordingId },
+            query: { page: options?.page },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * Create a subtask under a to-do or a card
+   * @param recordingId - The recording ID
+   * @param req - Subtask creation parameters
+   * @returns The Subtask
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.subtasks.create(123, { title: "example" });
+   * ```
+   */
+  async create(recordingId: number, req: CreateSubtaskRequest): Promise<Subtask> {
+    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: "Subtasks",
+        operation: "CreateSubtask",
+        resourceType: "subtask",
+        isMutation: true,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.POST("/recordings/{recordingId}/subtasks.json", {
+          params: {
+            path: { recordingId },
+          },
+          body: {
+            title: req.title,
+            due_on: req.dueOn,
+            assignee_ids: req.assigneeIds,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Get a subtask by ID
+   * @param subtaskId - The subtask ID
+   * @returns The Subtask
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.subtasks.get(123);
+   * ```
+   */
+  async get(subtaskId: number): Promise<Subtask> {
+    const response = await this.request(
+      {
+        service: "Subtasks",
+        operation: "GetSubtask",
+        resourceType: "subtask",
+        isMutation: false,
+        resourceId: subtaskId,
+      },
+      () =>
+        this.client.GET("/subtasks/{subtaskId}", {
+          params: {
+            path: { subtaskId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Update a subtask
+   * @param subtaskId - The subtask ID
+   * @param req - Subtask update parameters
+   * @returns The Subtask
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.subtasks.update(123, { });
+   * ```
+   */
+  async update(subtaskId: number, req: UpdateSubtaskRequest): Promise<Subtask> {
+    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: "Subtasks",
+        operation: "UpdateSubtask",
+        resourceType: "subtask",
+        isMutation: true,
+        resourceId: subtaskId,
+      },
+      () =>
+        this.client.PUT("/subtasks/{subtaskId}", {
+          params: {
+            path: { subtaskId },
+          },
+          body: {
+            title: req.title,
+            due_on: req.dueOn,
+            assignee_ids: req.assigneeIds,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Delete a subtask
+   * @param subtaskId - The subtask ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.subtasks.delete(123);
+   * ```
+   */
+  async delete(subtaskId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Subtasks",
+        operation: "DeleteSubtask",
+        resourceType: "subtask",
+        isMutation: true,
+        resourceId: subtaskId,
+      },
+      () =>
+        this.client.DELETE("/subtasks/{subtaskId}", {
+          params: {
+            path: { subtaskId },
+          },
+        })
+    );
+  }
+
+  /**
+   * Mark a subtask as completed
+   * @param subtaskId - The subtask ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.subtasks.complete(123);
+   * ```
+   */
+  async complete(subtaskId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Subtasks",
+        operation: "CompleteSubtask",
+        resourceType: "subtask",
+        isMutation: true,
+        resourceId: subtaskId,
+      },
+      () =>
+        this.client.POST("/subtasks/{subtaskId}/completion.json", {
+          params: {
+            path: { subtaskId },
+          },
+        })
+    );
+  }
+
+  /**
+   * Mark a subtask as not completed
+   * @param subtaskId - The subtask ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.subtasks.uncomplete(123);
+   * ```
+   */
+  async uncomplete(subtaskId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Subtasks",
+        operation: "UncompleteSubtask",
+        resourceType: "subtask",
+        isMutation: true,
+        resourceId: subtaskId,
+      },
+      () =>
+        this.client.DELETE("/subtasks/{subtaskId}/completion.json", {
+          params: {
+            path: { subtaskId },
+          },
+        })
+    );
+  }
+
+  /**
+   * Move a subtask to a new position among its siblings
+   * @param subtaskId - The subtask ID
+   * @param req - Subtask request parameters
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.subtasks.reposition(123, { position: 1 });
+   * ```
+   */
+  async reposition(subtaskId: number, req: RepositionSubtaskRequest): Promise<void> {
+    await this.request(
+      {
+        service: "Subtasks",
+        operation: "RepositionSubtask",
+        resourceType: "subtask",
+        isMutation: true,
+        resourceId: subtaskId,
+      },
+      () =>
+        this.client.PUT("/subtasks/{subtaskId}/position.json", {
+          params: {
+            path: { subtaskId },
+          },
+          body: {
+            position: req.position,
+          },
+        })
+    );
+  }
+}