@37signals/basecamp 0.2.0

package/src/generated/services/templates.ts

@@ -0,0 +1,294 @@
+/**
+ * Templates 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
+// =============================================================================
+
+/** Template entity from the Basecamp API. */
+export type Template = components["schemas"]["Template"];
+
+/**
+ * Options for list.
+ */
+export interface ListTemplateOptions extends PaginationOptions {
+  /** Filter by status */
+  status?: "active" | "archived" | "trashed";
+}
+
+/**
+ * Request parameters for create.
+ */
+export interface CreateTemplateRequest {
+  /** Display name */
+  name: string;
+  /** Rich text description (HTML) */
+  description?: string;
+}
+
+/**
+ * Request parameters for update.
+ */
+export interface UpdateTemplateRequest {
+  /** Display name */
+  name?: string;
+  /** Rich text description (HTML) */
+  description?: string;
+}
+
+/**
+ * Request parameters for createProject.
+ */
+export interface CreateProjectTemplateRequest {
+  /** Display name */
+  name: string;
+  /** Rich text description (HTML) */
+  description?: string;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Templates operations.
+ */
+export class TemplatesService extends BaseService {
+
+  /**
+   * List all templates visible to the current user
+   * @param options - Optional query parameters
+   * @returns All Template across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.templates.list();
+   *
+   * // With options
+   * const filtered = await client.templates.list({ status: "active" });
+   * ```
+   */
+  async list(options?: ListTemplateOptions): Promise<ListResult<Template>> {
+    return this.requestPaginated(
+      {
+        service: "Templates",
+        operation: "ListTemplates",
+        resourceType: "template",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/templates.json", {
+          params: {
+            query: { status: options?.status },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * Create a new template
+   * @param req - Template creation parameters
+   * @returns The Template
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.templates.create({ name: "My example" });
+   * ```
+   */
+  async create(req: CreateTemplateRequest): Promise<Template> {
+    if (!req.name) {
+      throw Errors.validation("Name is required");
+    }
+    const response = await this.request(
+      {
+        service: "Templates",
+        operation: "CreateTemplate",
+        resourceType: "template",
+        isMutation: true,
+      },
+      () =>
+        this.client.POST("/templates.json", {
+          body: {
+            name: req.name,
+            description: req.description,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Get a single template by id
+   * @param templateId - The template ID
+   * @returns The Template
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.templates.get(123);
+   * ```
+   */
+  async get(templateId: number): Promise<Template> {
+    const response = await this.request(
+      {
+        service: "Templates",
+        operation: "GetTemplate",
+        resourceType: "template",
+        isMutation: false,
+        resourceId: templateId,
+      },
+      () =>
+        this.client.GET("/templates/{templateId}", {
+          params: {
+            path: { templateId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Update an existing template
+   * @param templateId - The template ID
+   * @param req - Template update parameters
+   * @returns The Template
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.templates.update(123, { });
+   * ```
+   */
+  async update(templateId: number, req: UpdateTemplateRequest): Promise<Template> {
+    const response = await this.request(
+      {
+        service: "Templates",
+        operation: "UpdateTemplate",
+        resourceType: "template",
+        isMutation: true,
+        resourceId: templateId,
+      },
+      () =>
+        this.client.PUT("/templates/{templateId}", {
+          params: {
+            path: { templateId },
+          },
+          body: {
+            name: req.name,
+            description: req.description,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Delete a template (trash it)
+   * @param templateId - The template ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.templates.delete(123);
+   * ```
+   */
+  async delete(templateId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Templates",
+        operation: "DeleteTemplate",
+        resourceType: "template",
+        isMutation: true,
+        resourceId: templateId,
+      },
+      () =>
+        this.client.DELETE("/templates/{templateId}", {
+          params: {
+            path: { templateId },
+          },
+        })
+    );
+  }
+
+  /**
+   * Create a project from a template (asynchronous)
+   * @param templateId - The template ID
+   * @param req - Project_from_template creation parameters
+   * @returns The project_from_template
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.templates.createProject(123, { name: "My example" });
+   * ```
+   */
+  async createProject(templateId: number, req: CreateProjectTemplateRequest): Promise<components["schemas"]["CreateProjectFromTemplateResponseContent"]> {
+    if (!req.name) {
+      throw Errors.validation("Name is required");
+    }
+    const response = await this.request(
+      {
+        service: "Templates",
+        operation: "CreateProjectFromTemplate",
+        resourceType: "project_from_template",
+        isMutation: true,
+        resourceId: templateId,
+      },
+      () =>
+        this.client.POST("/templates/{templateId}/project_constructions.json", {
+          params: {
+            path: { templateId },
+          },
+          body: {
+            name: req.name,
+            description: req.description,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Get the status of a project construction
+   * @param templateId - The template ID
+   * @param constructionId - The construction ID
+   * @returns The project_construction
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.templates.getConstruction(123, 123);
+   * ```
+   */
+  async getConstruction(templateId: number, constructionId: number): Promise<components["schemas"]["GetProjectConstructionResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "Templates",
+        operation: "GetProjectConstruction",
+        resourceType: "project_construction",
+        isMutation: false,
+        resourceId: templateId,
+      },
+      () =>
+        this.client.GET("/templates/{templateId}/project_constructions/{constructionId}", {
+          params: {
+            path: { templateId, constructionId },
+          },
+        })
+    );
+    return response;
+  }
+}

package/src/generated/services/timeline.ts

@@ -0,0 +1,62 @@
+/**
+ * Timeline 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 projectTimeline.
+ */
+export interface ProjectTimelineTimelineOptions extends PaginationOptions {
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Timeline operations.
+ */
+export class TimelineService extends BaseService {
+
+  /**
+   * Get project timeline
+   * @param projectId - The project ID
+   * @param options - Optional query parameters
+   * @returns All results across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.timeline.projectTimeline(123);
+   * ```
+   */
+  async projectTimeline(projectId: number, options?: ProjectTimelineTimelineOptions): Promise<components["schemas"]["GetProjectTimelineResponseContent"]> {
+    return this.requestPaginated(
+      {
+        service: "Timeline",
+        operation: "GetProjectTimeline",
+        resourceType: "project_timeline",
+        isMutation: false,
+        projectId,
+      },
+      () =>
+        this.client.GET("/projects/{projectId}/timeline.json", {
+          params: {
+            path: { projectId },
+          },
+        })
+      , options
+    );
+  }
+}

package/src/generated/services/timesheets.ts

@@ -0,0 +1,289 @@
+/**
+ * Timesheets 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
+// =============================================================================
+
+
+/**
+ * Options for forProject.
+ */
+export interface ForProjectTimesheetOptions {
+  /** From */
+  from?: string;
+  /** To */
+  to?: string;
+  /** Person id */
+  personId?: number;
+}
+
+/**
+ * Options for forRecording.
+ */
+export interface ForRecordingTimesheetOptions {
+  /** From */
+  from?: string;
+  /** To */
+  to?: string;
+  /** Person id */
+  personId?: number;
+}
+
+/**
+ * Request parameters for create.
+ */
+export interface CreateTimesheetRequest {
+  /** Date */
+  date: string;
+  /** Hours */
+  hours: string;
+  /** Rich text description (HTML) */
+  description?: string;
+  /** Person id */
+  personId?: number;
+}
+
+/**
+ * Options for report.
+ */
+export interface ReportTimesheetOptions {
+  /** From */
+  from?: string;
+  /** To */
+  to?: string;
+  /** Person id */
+  personId?: number;
+}
+
+/**
+ * Request parameters for update.
+ */
+export interface UpdateTimesheetRequest {
+  /** Date */
+  date?: string;
+  /** Hours */
+  hours?: string;
+  /** Rich text description (HTML) */
+  description?: string;
+  /** Person id */
+  personId?: number;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Timesheets operations.
+ */
+export class TimesheetsService extends BaseService {
+
+  /**
+   * Get timesheet for a specific project
+   * @param projectId - The project ID
+   * @param options - Optional query parameters
+   * @returns Array of results
+   *
+   * @example
+   * ```ts
+   * const result = await client.timesheets.forProject(123);
+   * ```
+   */
+  async forProject(projectId: number, options?: ForProjectTimesheetOptions): Promise<components["schemas"]["GetProjectTimesheetResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "Timesheets",
+        operation: "GetProjectTimesheet",
+        resourceType: "project_timesheet",
+        isMutation: false,
+        projectId,
+      },
+      () =>
+        this.client.GET("/projects/{projectId}/timesheet.json", {
+          params: {
+            path: { projectId },
+            query: { from: options?.from, to: options?.to, "person_id": options?.personId },
+          },
+        })
+    );
+    return response ?? [];
+  }
+
+  /**
+   * Get timesheet for a specific recording
+   * @param recordingId - The recording ID
+   * @param options - Optional query parameters
+   * @returns Array of results
+   *
+   * @example
+   * ```ts
+   * const result = await client.timesheets.forRecording(123);
+   * ```
+   */
+  async forRecording(recordingId: number, options?: ForRecordingTimesheetOptions): Promise<components["schemas"]["GetRecordingTimesheetResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "Timesheets",
+        operation: "GetRecordingTimesheet",
+        resourceType: "recording_timesheet",
+        isMutation: false,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.GET("/recordings/{recordingId}/timesheet.json", {
+          params: {
+            path: { recordingId },
+            query: { from: options?.from, to: options?.to, "person_id": options?.personId },
+          },
+        })
+    );
+    return response ?? [];
+  }
+
+  /**
+   * Create a timesheet entry on a recording
+   * @param recordingId - The recording ID
+   * @param req - Timesheet_entry creation parameters
+   * @returns The timesheet_entry
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.timesheets.create(123, { date: "example", hours: "example" });
+   * ```
+   */
+  async create(recordingId: number, req: CreateTimesheetRequest): Promise<components["schemas"]["CreateTimesheetEntryResponseContent"]> {
+    if (!req.date) {
+      throw Errors.validation("Date is required");
+    }
+    if (!req.hours) {
+      throw Errors.validation("Hours is required");
+    }
+    const response = await this.request(
+      {
+        service: "Timesheets",
+        operation: "CreateTimesheetEntry",
+        resourceType: "timesheet_entry",
+        isMutation: true,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.POST("/recordings/{recordingId}/timesheet/entries.json", {
+          params: {
+            path: { recordingId },
+          },
+          body: {
+            date: req.date,
+            hours: req.hours,
+            description: req.description,
+            person_id: req.personId,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Get account-wide timesheet report
+   * @param options - Optional query parameters
+   * @returns Array of results
+   *
+   * @example
+   * ```ts
+   * const result = await client.timesheets.report();
+   * ```
+   */
+  async report(options?: ReportTimesheetOptions): Promise<components["schemas"]["GetTimesheetReportResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "Timesheets",
+        operation: "GetTimesheetReport",
+        resourceType: "timesheet_report",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/reports/timesheet.json", {
+          params: {
+            query: { from: options?.from, to: options?.to, "person_id": options?.personId },
+          },
+        })
+    );
+    return response ?? [];
+  }
+
+  /**
+   * Get a single timesheet entry
+   * @param entryId - The entry ID
+   * @returns The timesheet_entry
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.timesheets.get(123);
+   * ```
+   */
+  async get(entryId: number): Promise<components["schemas"]["GetTimesheetEntryResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "Timesheets",
+        operation: "GetTimesheetEntry",
+        resourceType: "timesheet_entry",
+        isMutation: false,
+        resourceId: entryId,
+      },
+      () =>
+        this.client.GET("/timesheet_entries/{entryId}", {
+          params: {
+            path: { entryId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Update a timesheet entry
+   * @param entryId - The entry ID
+   * @param req - Timesheet_entry update parameters
+   * @returns The timesheet_entry
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.timesheets.update(123, { });
+   * ```
+   */
+  async update(entryId: number, req: UpdateTimesheetRequest): Promise<components["schemas"]["UpdateTimesheetEntryResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "Timesheets",
+        operation: "UpdateTimesheetEntry",
+        resourceType: "timesheet_entry",
+        isMutation: true,
+        resourceId: entryId,
+      },
+      () =>
+        this.client.PUT("/timesheet_entries/{entryId}", {
+          params: {
+            path: { entryId },
+          },
+          body: {
+            date: req.date,
+            hours: req.hours,
+            description: req.description,
+            person_id: req.personId,
+          },
+        })
+    );
+    return response;
+  }
+}