@37signals/basecamp 0.5.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/automation.ts

@@ -0,0 +1,49 @@
+/**
+ * Automation 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
+// =============================================================================
+
+/** LineupMarker entity from the Basecamp API. */
+export type LineupMarker = components["schemas"]["LineupMarker"];
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Automation operations.
+ */
+export class AutomationService extends BaseService {
+
+  /**
+   * List all lineup markers for the account
+   * @returns Array of LineupMarker
+   *
+   * @example
+   * ```ts
+   * const result = await client.automation.listLineupMarkers();
+   * ```
+   */
+  async listLineupMarkers(): Promise<LineupMarker[]> {
+    const response = await this.request(
+      {
+        service: "Automation",
+        operation: "ListLineupMarkers",
+        resourceType: "lineup_marker",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/lineup/markers.json", {
+        })
+    );
+    return response ?? [];
+  }
+}

package/src/generated/services/boosts.ts

@@ -198,7 +198,7 @@ export class BoostsService extends BaseService {
         operation: "ListEventBoosts",
         resourceType: "event_boost",
         isMutation: false,
-        resourceId: recordingId,
+        resourceId: eventId,
       },
       () =>
         this.client.GET("/recordings/{recordingId}/events/{eventId}/boosts.json", {
@@ -233,7 +233,7 @@ export class BoostsService extends BaseService {
         operation: "CreateEventBoost",
         resourceType: "event_boost",
         isMutation: true,
-        resourceId: recordingId,
+        resourceId: eventId,
       },
       () =>
         this.client.POST("/recordings/{recordingId}/events/{eventId}/boosts.json", {

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";
 }
 
 
@@ -227,7 +235,7 @@ export class CampfiresService extends BaseService {
         operation: "GetChatbot",
         resourceType: "chatbot",
         isMutation: false,
-        resourceId: campfireId,
+        resourceId: chatbotId,
       },
       () =>
         this.client.GET("/chats/{campfireId}/integrations/{chatbotId}", {
@@ -262,7 +270,7 @@ export class CampfiresService extends BaseService {
         operation: "UpdateChatbot",
         resourceType: "chatbot",
         isMutation: true,
-        resourceId: campfireId,
+        resourceId: chatbotId,
       },
       () =>
         this.client.PUT("/chats/{campfireId}/integrations/{chatbotId}", {
@@ -297,7 +305,7 @@ export class CampfiresService extends BaseService {
         operation: "DeleteChatbot",
         resourceType: "chatbot",
         isMutation: true,
-        resourceId: campfireId,
+        resourceId: chatbotId,
       },
       () =>
         this.client.DELETE("/chats/{campfireId}/integrations/{chatbotId}", {
@@ -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
@@ -395,7 +407,7 @@ export class CampfiresService extends BaseService {
         operation: "GetCampfireLine",
         resourceType: "campfire_line",
         isMutation: false,
-        resourceId: campfireId,
+        resourceId: lineId,
       },
       () =>
         this.client.GET("/chats/{campfireId}/lines/{lineId}", {
@@ -426,7 +438,7 @@ export class CampfiresService extends BaseService {
         operation: "DeleteCampfireLine",
         resourceType: "campfire_line",
         isMutation: true,
-        resourceId: campfireId,
+        resourceId: lineId,
       },
       () =>
         this.client.DELETE("/chats/{campfireId}/lines/{lineId}", {
@@ -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/card-steps.ts

@@ -143,6 +143,36 @@ export class CardStepsService extends BaseService {
     return response;
   }
 
+  /**
+   * Get a step by ID
+   * @param stepId - The step ID
+   * @returns The CardStep
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.cardSteps.get(123);
+   * ```
+   */
+  async get(stepId: number): Promise<CardStep> {
+    const response = await this.request(
+      {
+        service: "CardSteps",
+        operation: "GetCardStep",
+        resourceType: "card_step",
+        isMutation: false,
+        resourceId: stepId,
+      },
+      () =>
+        this.client.GET("/card_tables/steps/{stepId}", {
+          params: {
+            path: { stepId },
+          },
+        })
+    );
+    return response;
+  }
+
   /**
    * Update an existing step
    * @param stepId - The step ID

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/checkins.ts

@@ -491,7 +491,7 @@ export class CheckinsService extends BaseService {
         operation: "GetAnswersByPerson",
         resourceType: "answers_by_person",
         isMutation: false,
-        resourceId: questionId,
+        resourceId: personId,
       },
       () =>
         this.client.GET("/questions/{questionId}/answers/by/{personId}", {

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/client-replies.ts

@@ -81,7 +81,7 @@ export class ClientRepliesService extends BaseService {
         operation: "GetClientReply",
         resourceType: "client_reply",
         isMutation: false,
-        resourceId: recordingId,
+        resourceId: replyId,
       },
       () =>
         this.client.GET("/client/recordings/{recordingId}/replies/{replyId}", {

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";
 }
 
 
@@ -167,7 +171,7 @@ export class ForwardsService extends BaseService {
         operation: "GetForwardReply",
         resourceType: "forward_reply",
         isMutation: false,
-        resourceId: forwardId,
+        resourceId: replyId,
       },
       () =>
         this.client.GET("/inbox_forwards/{forwardId}/replies/{replyId}", {
@@ -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