@37signals/basecamp 0.2.0

package/src/generated/services/projects.ts

@@ -0,0 +1,224 @@
+/**
+ * Projects 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
+// =============================================================================
+
+/** Project entity from the Basecamp API. */
+export type Project = components["schemas"]["Project"];
+
+/**
+ * Options for list.
+ */
+export interface ListProjectOptions extends PaginationOptions {
+  /** Filter by status */
+  status?: "active" | "archived" | "trashed";
+}
+
+/**
+ * Request parameters for create.
+ */
+export interface CreateProjectRequest {
+  /** Display name */
+  name: string;
+  /** Rich text description (HTML) */
+  description?: string;
+}
+
+/**
+ * Request parameters for update.
+ */
+export interface UpdateProjectRequest {
+  /** Display name */
+  name: string;
+  /** Rich text description (HTML) */
+  description?: string;
+  /** Admissions */
+  admissions?: "invite" | "employee" | "team";
+  /** Schedule date range settings */
+  scheduleAttributes?: components["schemas"]["ScheduleAttributes"];
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Projects operations.
+ */
+export class ProjectsService extends BaseService {
+
+  /**
+   * List projects (active by default; optionally archived/trashed)
+   * @param options - Optional query parameters
+   * @returns All Project across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.projects.list();
+   *
+   * // With options
+   * const filtered = await client.projects.list({ status: "active" });
+   * ```
+   */
+  async list(options?: ListProjectOptions): Promise<ListResult<Project>> {
+    return this.requestPaginated(
+      {
+        service: "Projects",
+        operation: "ListProjects",
+        resourceType: "project",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/projects.json", {
+          params: {
+            query: { status: options?.status },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * Create a new project
+   * @param req - Project creation parameters
+   * @returns The Project
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.projects.create({ name: "My example" });
+   * ```
+   */
+  async create(req: CreateProjectRequest): Promise<Project> {
+    if (!req.name) {
+      throw Errors.validation("Name is required");
+    }
+    const response = await this.request(
+      {
+        service: "Projects",
+        operation: "CreateProject",
+        resourceType: "project",
+        isMutation: true,
+      },
+      () =>
+        this.client.POST("/projects.json", {
+          body: {
+            name: req.name,
+            description: req.description,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Get a single project by id
+   * @param projectId - The project ID
+   * @returns The Project
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.projects.get(123);
+   * ```
+   */
+  async get(projectId: number): Promise<Project> {
+    const response = await this.request(
+      {
+        service: "Projects",
+        operation: "GetProject",
+        resourceType: "project",
+        isMutation: false,
+        projectId,
+      },
+      () =>
+        this.client.GET("/projects/{projectId}", {
+          params: {
+            path: { projectId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Update an existing project
+   * @param projectId - The project ID
+   * @param req - Project update parameters
+   * @returns The Project
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.projects.update(123, { name: "My example" });
+   * ```
+   */
+  async update(projectId: number, req: UpdateProjectRequest): Promise<Project> {
+    if (!req.name) {
+      throw Errors.validation("Name is required");
+    }
+    const response = await this.request(
+      {
+        service: "Projects",
+        operation: "UpdateProject",
+        resourceType: "project",
+        isMutation: true,
+        projectId,
+      },
+      () =>
+        this.client.PUT("/projects/{projectId}", {
+          params: {
+            path: { projectId },
+          },
+          body: {
+            name: req.name,
+            description: req.description,
+            admissions: req.admissions,
+            schedule_attributes: req.scheduleAttributes,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Trash a project. Trashed items can be recovered.
+   * @param projectId - The project ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.projects.trash(123);
+   * ```
+   */
+  async trash(projectId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Projects",
+        operation: "TrashProject",
+        resourceType: "project",
+        isMutation: true,
+        projectId,
+      },
+      () =>
+        this.client.DELETE("/projects/{projectId}", {
+          params: {
+            path: { projectId },
+          },
+        })
+    );
+  }
+}

package/src/generated/services/recordings.ts

@@ -0,0 +1,191 @@
+/**
+ * Recordings 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
+// =============================================================================
+
+/** Recording entity from the Basecamp API. */
+export type Recording = components["schemas"]["Recording"];
+
+/**
+ * Options for list.
+ */
+export interface ListRecordingOptions extends PaginationOptions {
+  /** Project IDs to filter by */
+  bucket?: number[];
+  /** Filter by status */
+  status?: "active" | "archived" | "trashed";
+  /** Filter by sort */
+  sort?: "created_at" | "updated_at";
+  /** Filter by direction */
+  direction?: "asc" | "desc";
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Recordings operations.
+ */
+export class RecordingsService extends BaseService {
+
+  /**
+   * List recordings of a given type across projects
+   * @param type - Comment|Document|Kanban::Card|Kanban::Step|Message|Question::Answer|Schedule::Entry|Todo|Todolist|Upload|Vault
+   * @param options - Optional query parameters
+   * @returns All Recording across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.recordings.list("type");
+   *
+   * // With options
+   * const filtered = await client.recordings.list("type", { bucket: [123] });
+   * ```
+   */
+  async list(type: "Comment" | "Document" | "Kanban::Card" | "Kanban::Step" | "Message" | "Question::Answer" | "Schedule::Entry" | "Todo" | "Todolist" | "Upload" | "Vault", options?: ListRecordingOptions): Promise<ListResult<Recording>> {
+    return this.requestPaginated(
+      {
+        service: "Recordings",
+        operation: "ListRecordings",
+        resourceType: "recording",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/projects/recordings.json", {
+          params: {
+            query: { type: type, bucket: options?.bucket?.join(","), status: options?.status, sort: options?.sort, direction: options?.direction },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * Get a single recording by id
+   * @param recordingId - The recording ID
+   * @returns The Recording
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.recordings.get(123);
+   * ```
+   */
+  async get(recordingId: number): Promise<Recording> {
+    const response = await this.request(
+      {
+        service: "Recordings",
+        operation: "GetRecording",
+        resourceType: "recording",
+        isMutation: false,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.GET("/recordings/{recordingId}", {
+          params: {
+            path: { recordingId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Unarchive a recording (restore to active status)
+   * @param recordingId - The recording ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.recordings.unarchive(123);
+   * ```
+   */
+  async unarchive(recordingId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Recordings",
+        operation: "UnarchiveRecording",
+        resourceType: "recording",
+        isMutation: true,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.PUT("/recordings/{recordingId}/status/active.json", {
+          params: {
+            path: { recordingId },
+          },
+        })
+    );
+  }
+
+  /**
+   * Archive a recording
+   * @param recordingId - The recording ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.recordings.archive(123);
+   * ```
+   */
+  async archive(recordingId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Recordings",
+        operation: "ArchiveRecording",
+        resourceType: "recording",
+        isMutation: true,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.PUT("/recordings/{recordingId}/status/archived.json", {
+          params: {
+            path: { recordingId },
+          },
+        })
+    );
+  }
+
+  /**
+   * Trash a recording. Trashed items can be recovered.
+   * @param recordingId - The recording ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.recordings.trash(123);
+   * ```
+   */
+  async trash(recordingId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Recordings",
+        operation: "TrashRecording",
+        resourceType: "recording",
+        isMutation: true,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.PUT("/recordings/{recordingId}/status/trashed.json", {
+          params: {
+            path: { recordingId },
+          },
+        })
+    );
+  }
+}

package/src/generated/services/reports.ts

@@ -0,0 +1,187 @@
+/**
+ * Reports 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
+// =============================================================================
+
+
+/**
+ * Options for progress.
+ */
+export interface ProgressReportOptions extends PaginationOptions {
+}
+
+/**
+ * Options for upcoming.
+ */
+export interface UpcomingReportOptions {
+  /** Window starts on */
+  windowStartsOn?: string;
+  /** Window ends on */
+  windowEndsOn?: string;
+}
+
+/**
+ * Options for assigned.
+ */
+export interface AssignedReportOptions {
+  /** Group by "bucket" or "date" */
+  groupBy?: string;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Reports operations.
+ */
+export class ReportsService extends BaseService {
+
+  /**
+   * Get account-wide activity feed (progress report)
+   * @param options - Optional query parameters
+   * @returns All results across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.reports.progress();
+   * ```
+   */
+  async progress(options?: ProgressReportOptions): Promise<components["schemas"]["GetProgressReportResponseContent"]> {
+    return this.requestPaginated(
+      {
+        service: "Reports",
+        operation: "GetProgressReport",
+        resourceType: "progress_report",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/reports/progress.json", {
+        })
+      , options
+    );
+  }
+
+  /**
+   * Get upcoming schedule entries within a date window
+   * @param options - Optional query parameters
+   * @returns The upcoming_schedule
+   *
+   * @example
+   * ```ts
+   * const result = await client.reports.upcoming();
+   * ```
+   */
+  async upcoming(options?: UpcomingReportOptions): Promise<components["schemas"]["GetUpcomingScheduleResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "Reports",
+        operation: "GetUpcomingSchedule",
+        resourceType: "upcoming_schedule",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/reports/schedules/upcoming.json", {
+          params: {
+            query: { "window_starts_on": options?.windowStartsOn, "window_ends_on": options?.windowEndsOn },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Get todos assigned to a specific person
+   * @param personId - The person ID
+   * @param options - Optional query parameters
+   * @returns The assigned_todo
+   *
+   * @example
+   * ```ts
+   * const result = await client.reports.assigned(123);
+   * ```
+   */
+  async assigned(personId: number, options?: AssignedReportOptions): Promise<components["schemas"]["GetAssignedTodosResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "Reports",
+        operation: "GetAssignedTodos",
+        resourceType: "assigned_todo",
+        isMutation: false,
+        resourceId: personId,
+      },
+      () =>
+        this.client.GET("/reports/todos/assigned/{personId}", {
+          params: {
+            path: { personId },
+            query: { "group_by": options?.groupBy },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Get overdue todos grouped by lateness
+   * @returns The overdue_todo
+   *
+   * @example
+   * ```ts
+   * const result = await client.reports.overdue();
+   * ```
+   */
+  async overdue(): Promise<components["schemas"]["GetOverdueTodosResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "Reports",
+        operation: "GetOverdueTodos",
+        resourceType: "overdue_todo",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/reports/todos/overdue.json", {
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Get a person's activity timeline
+   * @param personId - The person ID
+   * @returns The person_progress
+   *
+   * @example
+   * ```ts
+   * const result = await client.reports.personProgress(123);
+   * ```
+   */
+  async personProgress(personId: number): Promise<components["schemas"]["GetPersonProgressResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "Reports",
+        operation: "GetPersonProgress",
+        resourceType: "person_progress",
+        isMutation: false,
+        resourceId: personId,
+      },
+      () =>
+        this.client.GET("/reports/users/progress/{personId}", {
+          params: {
+            path: { personId },
+          },
+        })
+    );
+    return response;
+  }
+}