@37signals/basecamp 0.5.0 → 0.7.0

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

package/src/generated/services/search.ts

@@ -19,7 +19,7 @@ import type { PaginationOptions } from "../../pagination.js";
  */
 export interface SearchSearchOptions extends PaginationOptions {
   /** Filter by sort */
-  sort?: "created_at" | "updated_at";
+  sort?: "best_match" | "created_at";
 }
 
 

package/src/generated/services/templates.ts

@@ -280,7 +280,7 @@ export class TemplatesService extends BaseService {
         operation: "GetProjectConstruction",
         resourceType: "project_construction",
         isMutation: false,
-        resourceId: templateId,
+        resourceId: constructionId,
       },
       () =>
         this.client.GET("/templates/{templateId}/project_constructions/{constructionId}", {

package/src/generated/services/tools.ts

@@ -21,6 +21,8 @@ export type Tool = components["schemas"]["Tool"];
 export interface CloneToolRequest {
   /** Source recording id */
   sourceRecordingId: number;
+  /** Title */
+  title?: string;
 }
 
 /**
@@ -72,6 +74,7 @@ export class ToolsService extends BaseService {
         this.client.POST("/dock/tools.json", {
           body: {
             source_recording_id: req.sourceRecordingId,
+            title: req.title,
           },
         })
     );