@37signals/basecamp 0.6.0 → 0.7.0

package/src/generated/services/account.ts

@@ -0,0 +1,144 @@
+/**
+ * Account 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
+// =============================================================================
+
+
+/**
+ * Request parameters for updateAccountName.
+ */
+export interface UpdateAccountNameAccountRequest {
+  /** Display name */
+  name: string;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Account operations.
+ */
+export class AccountService extends BaseService {
+
+  /**
+   * Get the account for the current access token
+   * @returns The account
+   *
+   * @example
+   * ```ts
+   * const result = await client.account.account();
+   * ```
+   */
+  async account(): Promise<components["schemas"]["GetAccountResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "Account",
+        operation: "GetAccount",
+        resourceType: "account",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/account.json", {
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Upload or replace the account logo.
+   * @param file - File or Blob to upload
+   * @param filename - Display name for the uploaded file
+   * @returns void
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * await client.account.updateAccountLogo();
+   * ```
+   */
+  async updateAccountLogo(file: Blob | File, filename?: string): Promise<void> {
+    const url = `${this.baseUrl}` +
+      `/account/logo.json`;
+    return this.requestMultipartUpload(
+      {
+        service: "Account",
+        operation: "UpdateAccountLogo",
+        resourceType: "account_logo",
+        isMutation: true,
+      },
+      url,
+      "PUT",
+      file,
+      "logo",
+      filename,
+    );
+  }
+
+
+  /**
+   * Remove the account logo. Only administrators and account owners can use this endpoint.
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.account.removeAccountLogo();
+   * ```
+   */
+  async removeAccountLogo(): Promise<void> {
+    await this.request(
+      {
+        service: "Account",
+        operation: "RemoveAccountLogo",
+        resourceType: "resource",
+        isMutation: true,
+      },
+      () =>
+        this.client.DELETE("/account/logo.json", {
+        })
+    );
+  }
+
+  /**
+   * Rename the current account. Only account owners can use this endpoint.
+   * @param req - Account_name update parameters
+   * @returns The account_name
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.account.updateAccountName({ name: "My example" });
+   * ```
+   */
+  async updateAccountName(req: UpdateAccountNameAccountRequest): Promise<components["schemas"]["UpdateAccountNameResponseContent"]> {
+    if (!req.name) {
+      throw Errors.validation("Name is required");
+    }
+    const response = await this.request(
+      {
+        service: "Account",
+        operation: "UpdateAccountName",
+        resourceType: "account_name",
+        isMutation: true,
+      },
+      () =>
+        this.client.PUT("/account/name.json", {
+          body: {
+            name: req.name,
+          },
+        })
+    );
+    return response;
+  }
+}

package/src/generated/services/campfires.ts

@@ -57,6 +57,10 @@ export interface UpdateChatbotCampfireRequest {
  * Options for listLines.
  */
 export interface ListLinesCampfireOptions extends PaginationOptions {
+  /** Filter by sort */
+  sort?: "created_at" | "updated_at";
+  /** Filter by direction */
+  direction?: "asc" | "desc";
 }
 
 /**
@@ -73,6 +77,10 @@ export interface CreateLineCampfireRequest {
  * Options for listUploads.
  */
 export interface ListUploadsCampfireOptions extends PaginationOptions {
+  /** Filter by sort */
+  sort?: "created_at" | "updated_at";
+  /** Filter by direction */
+  direction?: "asc" | "desc";
 }
 
 
@@ -317,6 +325,9 @@ export class CampfiresService extends BaseService {
    * @example
    * ```ts
    * const result = await client.campfires.listLines(123);
+   *
+   * // With options
+   * const filtered = await client.campfires.listLines(123, { sort: "created_at" });
    * ```
    */
   async listLines(campfireId: number, options?: ListLinesCampfireOptions): Promise<ListResult<CampfireLine>> {
@@ -332,6 +343,7 @@ export class CampfiresService extends BaseService {
         this.client.GET("/chats/{campfireId}/lines.json", {
           params: {
             path: { campfireId },
+            query: { sort: options?.sort, direction: options?.direction },
           },
         })
       , options
@@ -446,6 +458,9 @@ export class CampfiresService extends BaseService {
    * @example
    * ```ts
    * const result = await client.campfires.listUploads(123);
+   *
+   * // With options
+   * const filtered = await client.campfires.listUploads(123, { sort: "created_at" });
    * ```
    */
   async listUploads(campfireId: number, options?: ListUploadsCampfireOptions): Promise<ListResult<CampfireLine>> {
@@ -461,6 +476,7 @@ export class CampfiresService extends BaseService {
         this.client.GET("/chats/{campfireId}/uploads.json", {
           params: {
             path: { campfireId },
+            query: { sort: options?.sort, direction: options?.direction },
           },
         })
       , options

package/src/generated/services/cards.ts

@@ -37,6 +37,8 @@ export interface UpdateCardRequest {
 export interface MoveCardRequest {
   /** Column id */
   columnId: number;
+  /** 1-indexed position within the destination column. Defaults to 1 (top). */
+  position?: number;
 }
 
 /**
@@ -167,6 +169,7 @@ export class CardsService extends BaseService {
           },
           body: {
             column_id: req.columnId,
+            position: req.position,
           },
         })
     );

package/src/generated/services/client-approvals.ts

@@ -20,6 +20,10 @@ export type ClientApproval = components["schemas"]["ClientApproval"];
  * Options for list.
  */
 export interface ListClientApprovalOptions extends PaginationOptions {
+  /** Filter by sort */
+  sort?: "created_at" | "updated_at";
+  /** Filter by direction */
+  direction?: "asc" | "desc";
 }
 
 
@@ -40,6 +44,9 @@ export class ClientApprovalsService extends BaseService {
    * @example
    * ```ts
    * const result = await client.clientApprovals.list();
+   *
+   * // With options
+   * const filtered = await client.clientApprovals.list({ sort: "created_at" });
    * ```
    */
   async list(options?: ListClientApprovalOptions): Promise<ListResult<ClientApproval>> {
@@ -52,6 +59,9 @@ export class ClientApprovalsService extends BaseService {
       },
       () =>
         this.client.GET("/client/approvals.json", {
+          params: {
+            query: { sort: options?.sort, direction: options?.direction },
+          },
         })
       , options
     );

package/src/generated/services/client-correspondences.ts

@@ -20,6 +20,10 @@ export type ClientCorrespondence = components["schemas"]["ClientCorrespondence"]
  * Options for list.
  */
 export interface ListClientCorrespondenceOptions extends PaginationOptions {
+  /** Filter by sort */
+  sort?: "created_at" | "updated_at";
+  /** Filter by direction */
+  direction?: "asc" | "desc";
 }
 
 
@@ -40,6 +44,9 @@ export class ClientCorrespondencesService extends BaseService {
    * @example
    * ```ts
    * const result = await client.clientCorrespondences.list();
+   *
+   * // With options
+   * const filtered = await client.clientCorrespondences.list({ sort: "created_at" });
    * ```
    */
   async list(options?: ListClientCorrespondenceOptions): Promise<ListResult<ClientCorrespondence>> {
@@ -52,6 +59,9 @@ export class ClientCorrespondencesService extends BaseService {
       },
       () =>
         this.client.GET("/client/correspondences.json", {
+          params: {
+            query: { sort: options?.sort, direction: options?.direction },
+          },
         })
       , options
     );

package/src/generated/services/forwards.ts

@@ -39,6 +39,10 @@ export interface CreateReplyForwardRequest {
  * Options for list.
  */
 export interface ListForwardOptions extends PaginationOptions {
+  /** Filter by sort */
+  sort?: "created_at" | "updated_at";
+  /** Filter by direction */
+  direction?: "asc" | "desc";
 }
 
 
@@ -218,6 +222,9 @@ export class ForwardsService extends BaseService {
    * @example
    * ```ts
    * const result = await client.forwards.list(123);
+   *
+   * // With options
+   * const filtered = await client.forwards.list(123, { sort: "created_at" });
    * ```
    */
   async list(inboxId: number, options?: ListForwardOptions): Promise<ListResult<Forward>> {
@@ -233,6 +240,7 @@ export class ForwardsService extends BaseService {
         this.client.GET("/inboxes/{inboxId}/forwards.json", {
           params: {
             path: { inboxId },
+            query: { sort: options?.sort, direction: options?.direction },
           },
         })
       , options

package/src/generated/services/gauges.ts

@@ -0,0 +1,298 @@
+/**
+ * Gauges 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
+// =============================================================================
+
+
+/**
+ * Request parameters for updateGaugeNeedle.
+ */
+export interface UpdateGaugeNeedleGaugeRequest {
+  /** Gauge needle */
+  gaugeNeedle?: components["schemas"]["GaugeNeedleUpdatePayload"];
+}
+
+/**
+ * Request parameters for toggleGauge.
+ */
+export interface ToggleGaugeGaugeRequest {
+  /** Gauge */
+  gauge: components["schemas"]["GaugeTogglePayload"];
+}
+
+/**
+ * Options for listGaugeNeedles.
+ */
+export interface ListGaugeNeedlesGaugeOptions extends PaginationOptions {
+}
+
+/**
+ * Request parameters for createGaugeNeedle.
+ */
+export interface CreateGaugeNeedleGaugeRequest {
+  /** Gauge needle */
+  gaugeNeedle: components["schemas"]["GaugeNeedlePayload"];
+  /** Who to notify: "everyone", "working_on", "custom", or omit for nobody */
+  notify?: string;
+  /** Array of people IDs to notify (only used when notify is "custom") */
+  subscriptions?: number[];
+}
+
+/**
+ * Options for listGauges.
+ */
+export interface ListGaugesGaugeOptions extends PaginationOptions {
+  /** Comma-separated list of project IDs. When provided, results are returned
+in the order specified instead of by risk level. */
+  bucketIds?: string;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Gauges operations.
+ */
+export class GaugesService extends BaseService {
+
+  /**
+   * Get a gauge needle by ID
+   * @param needleId - The needle ID
+   * @returns The gauge_needle
+   *
+   * @example
+   * ```ts
+   * const result = await client.gauges.gaugeNeedle(123);
+   * ```
+   */
+  async gaugeNeedle(needleId: number): Promise<components["schemas"]["GetGaugeNeedleResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "Gauges",
+        operation: "GetGaugeNeedle",
+        resourceType: "gauge_needle",
+        isMutation: false,
+        resourceId: needleId,
+      },
+      () =>
+        this.client.GET("/gauge_needles/{needleId}", {
+          params: {
+            path: { needleId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Update a gauge needle's description. Position and color are immutable.
+   * @param needleId - The needle ID
+   * @param req - Gauge_needle update parameters
+   * @returns The gauge_needle
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.gauges.updateGaugeNeedle(123, { });
+   * ```
+   */
+  async updateGaugeNeedle(needleId: number, req: UpdateGaugeNeedleGaugeRequest): Promise<components["schemas"]["UpdateGaugeNeedleResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "Gauges",
+        operation: "UpdateGaugeNeedle",
+        resourceType: "gauge_needle",
+        isMutation: true,
+        resourceId: needleId,
+      },
+      () =>
+        this.client.PUT("/gauge_needles/{needleId}", {
+          params: {
+            path: { needleId },
+          },
+          body: {
+            gauge_needle: req.gaugeNeedle,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Destroy a gauge needle
+   * @param needleId - The needle ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.gauges.destroyGaugeNeedle(123);
+   * ```
+   */
+  async destroyGaugeNeedle(needleId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Gauges",
+        operation: "DestroyGaugeNeedle",
+        resourceType: "resource",
+        isMutation: true,
+        resourceId: needleId,
+      },
+      () =>
+        this.client.DELETE("/gauge_needles/{needleId}", {
+          params: {
+            path: { needleId },
+          },
+        })
+    );
+  }
+
+  /**
+   * Enable or disable the gauge for a project. Only project admins can toggle gauges.
+   * @param projectId - The project ID
+   * @param req - Resource request parameters
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.gauges.toggleGauge(123, { gauge: "example" });
+   * ```
+   */
+  async toggleGauge(projectId: number, req: ToggleGaugeGaugeRequest): Promise<void> {
+    if (!req.gauge) {
+      throw Errors.validation("Gauge is required");
+    }
+    await this.request(
+      {
+        service: "Gauges",
+        operation: "ToggleGauge",
+        resourceType: "resource",
+        isMutation: true,
+        projectId,
+      },
+      () =>
+        this.client.PUT("/projects/{projectId}/gauge.json", {
+          params: {
+            path: { projectId },
+          },
+          body: {
+            gauge: req.gauge,
+          },
+        })
+    );
+  }
+
+  /**
+   * List gauge needles for a project, ordered newest first.
+   * @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.gauges.listGaugeNeedles(123);
+   * ```
+   */
+  async listGaugeNeedles(projectId: number, options?: ListGaugeNeedlesGaugeOptions): Promise<components["schemas"]["ListGaugeNeedlesResponseContent"]> {
+    return this.requestPaginated(
+      {
+        service: "Gauges",
+        operation: "ListGaugeNeedles",
+        resourceType: "gauge_needle",
+        isMutation: false,
+        projectId,
+      },
+      () =>
+        this.client.GET("/projects/{projectId}/gauge/needles.json", {
+          params: {
+            path: { projectId },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * Create a gauge needle (progress update) for a project
+   * @param projectId - The project ID
+   * @param req - Gauge_needle creation parameters
+   * @returns The gauge_needle
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.gauges.createGaugeNeedle(123, { gaugeNeedle: "example" });
+   * ```
+   */
+  async createGaugeNeedle(projectId: number, req: CreateGaugeNeedleGaugeRequest): Promise<components["schemas"]["CreateGaugeNeedleResponseContent"]> {
+    if (!req.gaugeNeedle) {
+      throw Errors.validation("Gauge needle is required");
+    }
+    const response = await this.request(
+      {
+        service: "Gauges",
+        operation: "CreateGaugeNeedle",
+        resourceType: "gauge_needle",
+        isMutation: true,
+        projectId,
+      },
+      () =>
+        this.client.POST("/projects/{projectId}/gauge/needles.json", {
+          params: {
+            path: { projectId },
+          },
+          body: {
+            gauge_needle: req.gaugeNeedle,
+            notify: req.notify,
+            subscriptions: req.subscriptions,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * List gauges across all projects the authenticated user has access to.
+   * @param options - Optional query parameters
+   * @returns All results across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.gauges.listGauges();
+   *
+   * // With options
+   * const filtered = await client.gauges.listGauges({ bucketIds: "example" });
+   * ```
+   */
+  async listGauges(options?: ListGaugesGaugeOptions): Promise<components["schemas"]["ListGaugesResponseContent"]> {
+    return this.requestPaginated(
+      {
+        service: "Gauges",
+        operation: "ListGauges",
+        resourceType: "gauge",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/reports/gauges.json", {
+          params: {
+            query: { "bucket_ids": options?.bucketIds },
+          },
+        })
+      , options
+    );
+  }
+}

package/src/generated/services/hill-charts.ts

@@ -0,0 +1,99 @@
+/**
+ * HillCharts 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
+// =============================================================================
+
+
+/**
+ * Request parameters for updateSettings.
+ */
+export interface UpdateSettingsHillChartRequest {
+  /** Tracked */
+  tracked?: number[];
+  /** Untracked */
+  untracked?: number[];
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for HillCharts operations.
+ */
+export class HillChartsService extends BaseService {
+
+  /**
+   * Get the hill chart for a todoset
+   * @param todosetId - The todoset ID
+   * @returns The hill_chart
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.hillCharts.get(123);
+   * ```
+   */
+  async get(todosetId: number): Promise<components["schemas"]["GetHillChartResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "HillCharts",
+        operation: "GetHillChart",
+        resourceType: "hill_chart",
+        isMutation: false,
+        resourceId: todosetId,
+      },
+      () =>
+        this.client.GET("/todosets/{todosetId}/hill.json", {
+          params: {
+            path: { todosetId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Track or untrack todolists on a hill chart
+   * @param todosetId - The todoset ID
+   * @param req - Hill_chart update parameters
+   * @returns The hill_chart
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.hillCharts.updateSettings(123, { });
+   * ```
+   */
+  async updateSettings(todosetId: number, req: UpdateSettingsHillChartRequest): Promise<components["schemas"]["UpdateHillChartSettingsResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "HillCharts",
+        operation: "UpdateHillChartSettings",
+        resourceType: "hill_chart",
+        isMutation: true,
+        resourceId: todosetId,
+      },
+      () =>
+        this.client.PUT("/todosets/{todosetId}/hills/settings.json", {
+          params: {
+            path: { todosetId },
+          },
+          body: {
+            tracked: req.tracked,
+            untracked: req.untracked,
+          },
+        })
+    );
+    return response;
+  }
+}