@37signals/basecamp 0.6.0 → 0.7.0

package/src/generated/services/index.ts

@@ -1,3 +1,4 @@
+export { AccountService } from "./account.js";
 export { AttachmentsService } from "./attachments.js";
 export { BoostsService } from "./boosts.js";
 export { WebhooksService } from "./webhooks.js";
@@ -14,12 +15,15 @@ export { ClientRepliesService } from "./client-replies.js";
 export { CommentsService } from "./comments.js";
 export { ToolsService } from "./tools.js";
 export { DocumentsService } from "./documents.js";
+export { GaugesService } from "./gauges.js";
 export { ForwardsService } from "./forwards.js";
 export { AutomationService } from "./automation.js";
 export { LineupService } from "./lineup.js";
 export { MessageBoardsService } from "./message-boards.js";
 export { MessagesService } from "./messages.js";
+export { MyAssignmentsService } from "./my-assignments.js";
 export { CheckinsService } from "./checkins.js";
+export { MyNotificationsService } from "./my-notifications.js";
 export { ProjectsService } from "./projects.js";
 export { RecordingsService } from "./recordings.js";
 export { TimelineService } from "./timeline.js";
@@ -35,5 +39,6 @@ export { TodolistGroupsService } from "./todolist-groups.js";
 export { TodolistsService } from "./todolists.js";
 export { TodosService } from "./todos.js";
 export { TodosetsService } from "./todosets.js";
+export { HillChartsService } from "./hill-charts.js";
 export { UploadsService } from "./uploads.js";
 export { VaultsService } from "./vaults.js";

package/src/generated/services/my-assignments.ts

@@ -0,0 +1,109 @@
+/**
+ * MyAssignments 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";
+
+// =============================================================================
+// Types
+// =============================================================================
+
+
+/**
+ * Options for myDueAssignments.
+ */
+export interface MyDueAssignmentsMyAssignmentOptions {
+  /** Filter by due date range: overdue, due_today, due_tomorrow,
+due_later_this_week, due_next_week, due_later */
+  scope?: string;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for MyAssignments operations.
+ */
+export class MyAssignmentsService extends BaseService {
+
+  /**
+   * Get the current user's active assignments grouped into priorities and non_priorities.
+   * @returns The my_assignment
+   *
+   * @example
+   * ```ts
+   * const result = await client.myAssignments.myAssignments();
+   * ```
+   */
+  async myAssignments(): Promise<components["schemas"]["GetMyAssignmentsResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "MyAssignments",
+        operation: "GetMyAssignments",
+        resourceType: "my_assignment",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/my/assignments.json", {
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Get the current user's completed assignments.
+   * @returns Array of results
+   *
+   * @example
+   * ```ts
+   * const result = await client.myAssignments.myCompletedAssignments();
+   * ```
+   */
+  async myCompletedAssignments(): Promise<components["schemas"]["GetMyCompletedAssignmentsResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "MyAssignments",
+        operation: "GetMyCompletedAssignments",
+        resourceType: "my_completed_assignment",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/my/assignments/completed.json", {
+        })
+    );
+    return response ?? [];
+  }
+
+  /**
+   * Get the current user's assignments filtered by due date scope.
+   * @param options - Optional query parameters
+   * @returns Array of results
+   *
+   * @example
+   * ```ts
+   * const result = await client.myAssignments.myDueAssignments();
+   * ```
+   */
+  async myDueAssignments(options?: MyDueAssignmentsMyAssignmentOptions): Promise<components["schemas"]["GetMyDueAssignmentsResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "MyAssignments",
+        operation: "GetMyDueAssignments",
+        resourceType: "my_due_assignment",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/my/assignments/due.json", {
+          params: {
+            query: { scope: options?.scope },
+          },
+        })
+    );
+    return response ?? [];
+  }
+}

package/src/generated/services/my-notifications.ts

@@ -0,0 +1,100 @@
+/**
+ * MyNotifications 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 myNotifications.
+ */
+export interface MyNotificationsMyNotificationOptions {
+  /** Page number for paginating through read items. Defaults to 1. */
+  page?: number;
+}
+
+/**
+ * Request parameters for markAsRead.
+ */
+export interface MarkAsReadMyNotificationRequest {
+  /** Array of readable_sgid values identifying the items to mark as read */
+  readables: string[];
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for MyNotifications operations.
+ */
+export class MyNotificationsService extends BaseService {
+
+  /**
+   * Get the current user's notification inbox (the "Hey!" menu).
+   * @param options - Optional query parameters
+   * @returns The my_notification
+   *
+   * @example
+   * ```ts
+   * const result = await client.myNotifications.myNotifications();
+   * ```
+   */
+  async myNotifications(options?: MyNotificationsMyNotificationOptions): Promise<components["schemas"]["GetMyNotificationsResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "MyNotifications",
+        operation: "GetMyNotifications",
+        resourceType: "my_notification",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/my/readings.json", {
+          params: {
+            query: { page: options?.page },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Mark specified items as read
+   * @param req - Resource request parameters
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.myNotifications.markAsRead({ readables: [1234] });
+   * ```
+   */
+  async markAsRead(req: MarkAsReadMyNotificationRequest): Promise<void> {
+    if (!req.readables) {
+      throw Errors.validation("Readables is required");
+    }
+    await this.request(
+      {
+        service: "MyNotifications",
+        operation: "MarkAsRead",
+        resourceType: "resource",
+        isMutation: true,
+      },
+      () =>
+        this.client.PUT("/my/unreads.json", {
+          body: {
+            readables: req.readables,
+          },
+        })
+    );
+  }
+}

package/src/generated/services/people.ts

@@ -8,6 +8,7 @@ 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
@@ -22,12 +23,50 @@ export type Person = components["schemas"]["Person"];
 export interface ListPingablePeopleOptions extends PaginationOptions {
 }
 
+/**
+ * Request parameters for updateMyPreferences.
+ */
+export interface UpdateMyPreferencesPeopleRequest {
+  /** Person */
+  person: components["schemas"]["PreferencesPayload"];
+}
+
+/**
+ * Request parameters for updateMyProfile.
+ */
+export interface UpdateMyProfilePeopleRequest {
+  /** Display name */
+  name?: string;
+  /** Email address */
+  emailAddress?: string;
+  /** Title */
+  title?: string;
+  /** Bio */
+  bio?: string;
+  /** Location */
+  location?: string;
+  /** Time zone name */
+  timeZoneName?: string;
+  /** First week day */
+  firstWeekDay?: components["schemas"]["FirstWeekDay"];
+  /** Time format */
+  timeFormat?: string;
+}
+
 /**
  * Options for list.
  */
 export interface ListPeopleOptions extends PaginationOptions {
 }
 
+/**
+ * Request parameters for enableOutOfOffice.
+ */
+export interface EnableOutOfOfficePeopleRequest {
+  /** Out of office */
+  outOfOffice: components["schemas"]["OutOfOfficePayload"];
+}
+
 /**
  * Options for listForProject.
  */
@@ -81,6 +120,62 @@ export class PeopleService extends BaseService {
     );
   }
 
+  /**
+   * Get the current user's preferences
+   * @returns The my_preference
+   *
+   * @example
+   * ```ts
+   * const result = await client.people.myPreferences();
+   * ```
+   */
+  async myPreferences(): Promise<components["schemas"]["GetMyPreferencesResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "People",
+        operation: "GetMyPreferences",
+        resourceType: "my_preference",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/my/preferences.json", {
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Update the current user's preferences
+   * @param req - My_preference update parameters
+   * @returns The my_preference
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.people.updateMyPreferences({ person: "example" });
+   * ```
+   */
+  async updateMyPreferences(req: UpdateMyPreferencesPeopleRequest): Promise<components["schemas"]["UpdateMyPreferencesResponseContent"]> {
+    if (!req.person) {
+      throw Errors.validation("Person is required");
+    }
+    const response = await this.request(
+      {
+        service: "People",
+        operation: "UpdateMyPreferences",
+        resourceType: "my_preference",
+        isMutation: true,
+      },
+      () =>
+        this.client.PUT("/my/preferences.json", {
+          body: {
+            person: req.person,
+          },
+        })
+    );
+    return response;
+  }
+
   /**
    * Get the current authenticated user's profile
    * @returns The Person
@@ -105,6 +200,41 @@ export class PeopleService extends BaseService {
     return response;
   }
 
+  /**
+   * Update the current authenticated user's profile
+   * @param req - My_profile update parameters
+   * @returns void
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * await client.people.updateMyProfile({ });
+   * ```
+   */
+  async updateMyProfile(req: UpdateMyProfilePeopleRequest): Promise<void> {
+    await this.request(
+      {
+        service: "People",
+        operation: "UpdateMyProfile",
+        resourceType: "my_profile",
+        isMutation: true,
+      },
+      () =>
+        this.client.PUT("/my/profile.json", {
+          body: {
+            name: req.name,
+            email_address: req.emailAddress,
+            title: req.title,
+            bio: req.bio,
+            location: req.location,
+            time_zone_name: req.timeZoneName,
+            first_week_day: req.firstWeekDay,
+            time_format: req.timeFormat,
+          },
+        })
+    );
+  }
+
   /**
    * List all people visible to the current user
    * @param options - Optional query parameters
@@ -160,6 +290,101 @@ export class PeopleService extends BaseService {
     return response;
   }
 
+  /**
+   * Get the out of office status for a person
+   * @param personId - The person ID
+   * @returns The out_of_office
+   *
+   * @example
+   * ```ts
+   * const result = await client.people.outOfOffice(123);
+   * ```
+   */
+  async outOfOffice(personId: number): Promise<components["schemas"]["GetOutOfOfficeResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "People",
+        operation: "GetOutOfOffice",
+        resourceType: "out_of_office",
+        isMutation: false,
+        resourceId: personId,
+      },
+      () =>
+        this.client.GET("/people/{personId}/out_of_office.json", {
+          params: {
+            path: { personId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Enable or replace out of office for a person.
+   * @param personId - The person ID
+   * @param req - Out_of_office request parameters
+   * @returns The out_of_office
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * const result = await client.people.enableOutOfOffice(123, { outOfOffice: "example" });
+   * ```
+   */
+  async enableOutOfOffice(personId: number, req: EnableOutOfOfficePeopleRequest): Promise<components["schemas"]["EnableOutOfOfficeResponseContent"]> {
+    if (!req.outOfOffice) {
+      throw Errors.validation("Out of office is required");
+    }
+    const response = await this.request(
+      {
+        service: "People",
+        operation: "EnableOutOfOffice",
+        resourceType: "out_of_office",
+        isMutation: true,
+        resourceId: personId,
+      },
+      () =>
+        this.client.POST("/people/{personId}/out_of_office.json", {
+          params: {
+            path: { personId },
+          },
+          body: {
+            out_of_office: req.outOfOffice,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Disable out of office for a person.
+   * @param personId - The person ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.people.disableOutOfOffice(123);
+   * ```
+   */
+  async disableOutOfOffice(personId: number): Promise<void> {
+    await this.request(
+      {
+        service: "People",
+        operation: "DisableOutOfOffice",
+        resourceType: "out_of_office",
+        isMutation: true,
+        resourceId: personId,
+      },
+      () =>
+        this.client.DELETE("/people/{personId}/out_of_office.json", {
+          params: {
+            path: { personId },
+          },
+        })
+    );
+  }
+
   /**
    * List all active people on a project
    * @param projectId - The project ID