@37signals/basecamp 0.5.0 → 0.7.0

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;
+  }
+}

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,11 +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";
@@ -34,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,
+          },
+        })
+    );
+  }
+}