@37signals/basecamp 0.2.3 → 0.4.0

package/src/generated/path-mapping.ts

@@ -119,7 +119,7 @@ export const PATH_TO_OPERATION: Record<string, string> = {
   "GET:/{accountId}/reports/todos/assigned.json": "ListAssignablePeople",
   "GET:/{accountId}/reports/todos/assigned/{personId}": "GetAssignedTodos",
   "GET:/{accountId}/reports/todos/overdue.json": "GetOverdueTodos",
-  "GET:/{accountId}/reports/users/progress/{personId}": "GetPersonProgress",
+  "GET:/{accountId}/reports/users/progress/{personId}.json": "GetPersonProgress",
   "GET:/{accountId}/schedule_entries/{entryId}": "GetScheduleEntry",
   "PUT:/{accountId}/schedule_entries/{entryId}": "UpdateScheduleEntry",
   "GET:/{accountId}/schedule_entries/{entryId}/occurrences/{date}": "GetScheduleEntryOccurrence",

package/src/generated/schema.d.ts

@@ -1651,7 +1651,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/reports/users/progress/{personId}": {
+    "/reports/users/progress/{personId}.json": {
         parameters: {
             query?: never;
             header?: never;
@@ -12449,10 +12449,9 @@ export interface operations {
     Search: {
         parameters: {
             query: {
-                query: string;
+                q: string;
                 /** @description created_at|updated_at */
                 sort?: string;
-                page?: number;
             };
             header?: never;
             path?: never;

package/src/generated/services/reports.ts

@@ -13,6 +13,10 @@ import type { PaginationOptions } from "../../pagination.js";
 // Types
 // =============================================================================
 
+/** TimelineEvent entity from the Basecamp API. */
+export type TimelineEvent = components["schemas"]["TimelineEvent"];
+/** Person entity from the Basecamp API. */
+export type Person = components["schemas"]["Person"];
 
 /**
  * Options for progress.
@@ -38,6 +42,12 @@ export interface AssignedReportOptions {
   groupBy?: string;
 }
 
+/**
+ * Options for personProgress.
+ */
+export interface PersonProgressReportOptions extends PaginationOptions {
+}
+
 
 // =============================================================================
 // Service
@@ -51,14 +61,14 @@ 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
+   * @returns All TimelineEvent across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
    * const result = await client.reports.progress();
    * ```
    */
-  async progress(options?: ProgressReportOptions): Promise<components["schemas"]["GetProgressReportResponseContent"]> {
+  async progress(options?: ProgressReportOptions): Promise<ListResult<TimelineEvent>> {
     return this.requestPaginated(
       {
         service: "Reports",
@@ -159,15 +169,16 @@ export class ReportsService extends BaseService {
   /**
    * Get a person's activity timeline
    * @param personId - The person ID
-   * @returns The person_progress
+   * @param options - Optional query parameters
+   * @returns Wrapper with events as ListResult<TimelineEvent> across all pages
    *
    * @example
    * ```ts
    * const result = await client.reports.personProgress(123);
    * ```
    */
-  async personProgress(personId: number): Promise<components["schemas"]["GetPersonProgressResponseContent"]> {
-    const response = await this.request(
+  async personProgress(personId: number, options?: PersonProgressReportOptions): Promise<{ person: Person; events: ListResult<TimelineEvent> }> {
+    return this.requestPaginatedWrapped<"events", TimelineEvent>(
       {
         service: "Reports",
         operation: "GetPersonProgress",
@@ -176,12 +187,12 @@ export class ReportsService extends BaseService {
         resourceId: personId,
       },
       () =>
-        this.client.GET("/reports/users/progress/{personId}", {
+        this.client.GET("/reports/users/progress/{personId}.json", {
           params: {
             path: { personId },
           },
         })
-    );
-    return response;
+      , "events", options
+    ) as unknown as { person: Person; events: ListResult<TimelineEvent> };
   }
 }

package/src/generated/services/search.ts

@@ -20,8 +20,6 @@ import type { PaginationOptions } from "../../pagination.js";
 export interface SearchSearchOptions extends PaginationOptions {
   /** Filter by sort */
   sort?: "created_at" | "updated_at";
-  /** Page */
-  page?: number;
 }
 
 
@@ -36,16 +34,16 @@ export class SearchService extends BaseService {
 
   /**
    * Search for content across the account
-   * @param query - query
+   * @param q - q
    * @param options - Optional query parameters
    * @returns All results across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
-   * const result = await client.search.search("query");
+   * const result = await client.search.search("q");
    * ```
    */
-  async search(query: string, options?: SearchSearchOptions): Promise<components["schemas"]["SearchResponseContent"]> {
+  async search(q: string, options?: SearchSearchOptions): Promise<components["schemas"]["SearchResponseContent"]> {
     return this.requestPaginated(
       {
         service: "Search",
@@ -56,7 +54,7 @@ export class SearchService extends BaseService {
       () =>
         this.client.GET("/search.json", {
           params: {
-            query: { query: query, sort: options?.sort, page: options?.page },
+            query: { q: q, sort: options?.sort },
           },
         })
       , options

package/src/generated/services/timeline.ts

@@ -13,6 +13,8 @@ import type { PaginationOptions } from "../../pagination.js";
 // Types
 // =============================================================================
 
+/** TimelineEvent entity from the Basecamp API. */
+export type TimelineEvent = components["schemas"]["TimelineEvent"];
 
 /**
  * Options for projectTimeline.
@@ -34,14 +36,14 @@ 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
+   * @returns All TimelineEvent 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"]> {
+  async projectTimeline(projectId: number, options?: ProjectTimelineTimelineOptions): Promise<ListResult<TimelineEvent>> {
     return this.requestPaginated(
       {
         service: "Timeline",

package/src/generated/services/timesheets.ts

@@ -6,17 +6,21 @@
 
 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
 // =============================================================================
 
+/** TimesheetEntry entity from the Basecamp API. */
+export type TimesheetEntry = components["schemas"]["TimesheetEntry"];
 
 /**
  * Options for forProject.
  */
-export interface ForProjectTimesheetOptions {
+export interface ForProjectTimesheetOptions extends PaginationOptions {
   /** From */
   from?: string;
   /** To */
@@ -28,7 +32,7 @@ export interface ForProjectTimesheetOptions {
 /**
  * Options for forRecording.
  */
-export interface ForRecordingTimesheetOptions {
+export interface ForRecordingTimesheetOptions extends PaginationOptions {
   /** From */
   from?: string;
   /** To */
@@ -91,15 +95,15 @@ 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
+   * @returns All TimesheetEntry across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
    * const result = await client.timesheets.forProject(123);
    * ```
    */
-  async forProject(projectId: number, options?: ForProjectTimesheetOptions): Promise<components["schemas"]["GetProjectTimesheetResponseContent"]> {
-    const response = await this.request(
+  async forProject(projectId: number, options?: ForProjectTimesheetOptions): Promise<ListResult<TimesheetEntry>> {
+    return this.requestPaginated(
       {
         service: "Timesheets",
         operation: "GetProjectTimesheet",
@@ -114,23 +118,23 @@ export class TimesheetsService extends BaseService {
             query: { from: options?.from, to: options?.to, "person_id": options?.personId },
           },
         })
+      , options
     );
-    return response ?? [];
   }
 
   /**
    * Get timesheet for a specific recording
    * @param recordingId - The recording ID
    * @param options - Optional query parameters
-   * @returns Array of results
+   * @returns All TimesheetEntry across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
    * const result = await client.timesheets.forRecording(123);
    * ```
    */
-  async forRecording(recordingId: number, options?: ForRecordingTimesheetOptions): Promise<components["schemas"]["GetRecordingTimesheetResponseContent"]> {
-    const response = await this.request(
+  async forRecording(recordingId: number, options?: ForRecordingTimesheetOptions): Promise<ListResult<TimesheetEntry>> {
+    return this.requestPaginated(
       {
         service: "Timesheets",
         operation: "GetRecordingTimesheet",
@@ -145,15 +149,15 @@ export class TimesheetsService extends BaseService {
             query: { from: options?.from, to: options?.to, "person_id": options?.personId },
           },
         })
+      , options
     );
-    return response ?? [];
   }
 
   /**
    * Create a timesheet entry on a recording
    * @param recordingId - The recording ID
    * @param req - Timesheet_entry creation parameters
-   * @returns The timesheet_entry
+   * @returns The TimesheetEntry
    * @throws {BasecampError} If required fields are missing or invalid
    *
    * @example
@@ -161,7 +165,7 @@ export class TimesheetsService extends BaseService {
    * const result = await client.timesheets.create(123, { date: "example", hours: "example" });
    * ```
    */
-  async create(recordingId: number, req: CreateTimesheetRequest): Promise<components["schemas"]["CreateTimesheetEntryResponseContent"]> {
+  async create(recordingId: number, req: CreateTimesheetRequest): Promise<TimesheetEntry> {
     if (!req.date) {
       throw Errors.validation("Date is required");
     }
@@ -195,14 +199,14 @@ export class TimesheetsService extends BaseService {
   /**
    * Get account-wide timesheet report
    * @param options - Optional query parameters
-   * @returns Array of results
+   * @returns Array of TimesheetEntry
    *
    * @example
    * ```ts
    * const result = await client.timesheets.report();
    * ```
    */
-  async report(options?: ReportTimesheetOptions): Promise<components["schemas"]["GetTimesheetReportResponseContent"]> {
+  async report(options?: ReportTimesheetOptions): Promise<TimesheetEntry[]> {
     const response = await this.request(
       {
         service: "Timesheets",
@@ -223,7 +227,7 @@ export class TimesheetsService extends BaseService {
   /**
    * Get a single timesheet entry
    * @param entryId - The entry ID
-   * @returns The timesheet_entry
+   * @returns The TimesheetEntry
    * @throws {BasecampError} If the resource is not found
    *
    * @example
@@ -231,7 +235,7 @@ export class TimesheetsService extends BaseService {
    * const result = await client.timesheets.get(123);
    * ```
    */
-  async get(entryId: number): Promise<components["schemas"]["GetTimesheetEntryResponseContent"]> {
+  async get(entryId: number): Promise<TimesheetEntry> {
     const response = await this.request(
       {
         service: "Timesheets",
@@ -254,7 +258,7 @@ export class TimesheetsService extends BaseService {
    * Update a timesheet entry
    * @param entryId - The entry ID
    * @param req - Timesheet_entry update parameters
-   * @returns The timesheet_entry
+   * @returns The TimesheetEntry
    * @throws {BasecampError} If the resource is not found or fields are invalid
    *
    * @example
@@ -262,7 +266,7 @@ export class TimesheetsService extends BaseService {
    * const result = await client.timesheets.update(123, { });
    * ```
    */
-  async update(entryId: number, req: UpdateTimesheetRequest): Promise<components["schemas"]["UpdateTimesheetEntryResponseContent"]> {
+  async update(entryId: number, req: UpdateTimesheetRequest): Promise<TimesheetEntry> {
     const response = await this.request(
       {
         service: "Timesheets",