@37signals/basecamp 0.12.0 → 0.13.0

package/src/generated/services/bookmarks.ts

@@ -22,7 +22,7 @@ export type BookmarkStatus = components["schemas"]["BookmarkStatus"];
  * Options for listMyBookmarks.
  */
 export interface ListMyBookmarksBookmarkOptions extends PaginationOptions {
-  /** Page number for paginating through results. Defaults to 1. */
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
   page?: number;
 }
 

package/src/generated/services/boosts.ts

@@ -21,6 +21,8 @@ export type Boost = components["schemas"]["Boost"];
  * Options for listForRecording.
  */
 export interface ListForRecordingBoostOptions extends PaginationOptions {
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
+  page?: number;
 }
 
 /**
@@ -35,6 +37,8 @@ export interface CreateForRecordingBoostRequest {
  * Options for listForEvent.
  */
 export interface ListForEventBoostOptions extends PaginationOptions {
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
+  page?: number;
 }
 
 /**
@@ -123,6 +127,9 @@ export class BoostsService extends BaseService {
    * @example
    * ```ts
    * const result = await client.boosts.listForRecording(123);
+   *
+   * // With options
+   * const filtered = await client.boosts.listForRecording(123, { page: 1 });
    * ```
    */
   async listForRecording(recordingId: number, options?: ListForRecordingBoostOptions): Promise<ListResult<Boost>> {
@@ -138,6 +145,7 @@ export class BoostsService extends BaseService {
         this.client.GET("/recordings/{recordingId}/boosts.json", {
           params: {
             path: { recordingId },
+            query: { page: options?.page },
           },
         })
       , options
@@ -191,6 +199,9 @@ export class BoostsService extends BaseService {
    * @example
    * ```ts
    * const result = await client.boosts.listForEvent(123, 123);
+   *
+   * // With options
+   * const filtered = await client.boosts.listForEvent(123, 123, { page: 1 });
    * ```
    */
   async listForEvent(recordingId: number, eventId: number, options?: ListForEventBoostOptions): Promise<ListResult<Boost>> {
@@ -206,6 +217,7 @@ export class BoostsService extends BaseService {
         this.client.GET("/recordings/{recordingId}/events/{eventId}/boosts.json", {
           params: {
             path: { recordingId, eventId },
+            query: { page: options?.page },
           },
         })
       , options

package/src/generated/services/campfires.ts

@@ -14,19 +14,13 @@ import { Errors } from "../../errors.js";
 // Types
 // =============================================================================
 
-/** Campfire entity from the Basecamp API. */
-export type Campfire = components["schemas"]["Campfire"];
 /** Chatbot entity from the Basecamp API. */
 export type Chatbot = components["schemas"]["Chatbot"];
+/** Campfire entity from the Basecamp API. */
+export type Campfire = components["schemas"]["Campfire"];
 /** CampfireLine entity from the Basecamp API. */
 export type CampfireLine = components["schemas"]["CampfireLine"];
 
-/**
- * Options for list.
- */
-export interface ListCampfireOptions extends PaginationOptions {
-}
-
 /**
  * Options for listChatbots.
  */
@@ -53,6 +47,14 @@ export interface UpdateChatbotCampfireRequest {
   commandUrl?: string;
 }
 
+/**
+ * Options for list.
+ */
+export interface ListCampfireOptions extends PaginationOptions {
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
+  page?: number;
+}
+
 /**
  * Options for listLines.
  */
@@ -61,6 +63,8 @@ export interface ListLinesCampfireOptions extends PaginationOptions {
   sort?: "created_at" | "updated_at";
   /** Filter by direction */
   direction?: "asc" | "desc";
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
+  page?: number;
 }
 
 /**
@@ -89,6 +93,8 @@ export interface ListUploadsCampfireOptions extends PaginationOptions {
   sort?: "created_at" | "updated_at";
   /** Filter by direction */
   direction?: "asc" | "desc";
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
+  page?: number;
 }
 
 
@@ -101,85 +107,32 @@ export interface ListUploadsCampfireOptions extends PaginationOptions {
  */
 export class CampfiresService extends BaseService {
 
-  /**
-   * List all campfires across the account
-   * @param options - Optional query parameters
-   * @returns All Campfire across all pages, with .meta.totalCount
-   *
-   * @example
-   * ```ts
-   * const result = await client.campfires.list();
-   * ```
-   */
-  async list(options?: ListCampfireOptions): Promise<ListResult<Campfire>> {
-    return this.requestPaginated(
-      {
-        service: "Campfires",
-        operation: "ListCampfires",
-        resourceType: "campfire",
-        isMutation: false,
-      },
-      () =>
-        this.client.GET("/chats.json", {
-        })
-      , options
-    );
-  }
-
-  /**
-   * Get a campfire by ID
-   * @param campfireId - The campfire ID
-   * @returns The Campfire
-   * @throws {BasecampError} If the resource is not found
-   *
-   * @example
-   * ```ts
-   * const result = await client.campfires.get(123);
-   * ```
-   */
-  async get(campfireId: number): Promise<Campfire> {
-    const response = await this.request(
-      {
-        service: "Campfires",
-        operation: "GetCampfire",
-        resourceType: "campfire",
-        isMutation: false,
-        resourceId: campfireId,
-      },
-      () =>
-        this.client.GET("/chats/{campfireId}", {
-          params: {
-            path: { campfireId },
-          },
-        })
-    );
-    return response;
-  }
-
   /**
    * List all chatbots for a campfire
+   * @param bucketId - The bucket ID
    * @param campfireId - The campfire ID
    * @param options - Optional query parameters
    * @returns All Chatbot across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
-   * const result = await client.campfires.listChatbots(123);
+   * const result = await client.campfires.listChatbots(123, 123);
    * ```
    */
-  async listChatbots(campfireId: number, options?: ListChatbotsCampfireOptions): Promise<ListResult<Chatbot>> {
+  async listChatbots(bucketId: number, campfireId: number, options?: ListChatbotsCampfireOptions): Promise<ListResult<Chatbot>> {
     return this.requestPaginated(
       {
         service: "Campfires",
         operation: "ListChatbots",
         resourceType: "chatbot",
         isMutation: false,
+        projectId: bucketId,
         resourceId: campfireId,
       },
       () =>
-        this.client.GET("/chats/{campfireId}/integrations.json", {
+        this.client.GET("/buckets/{bucketId}/chats/{campfireId}/integrations.json", {
           params: {
-            path: { campfireId },
+            path: { bucketId, campfireId },
           },
         })
       , options
@@ -188,6 +141,7 @@ export class CampfiresService extends BaseService {
 
   /**
    * Create a new chatbot for a campfire
+   * @param bucketId - The bucket ID
    * @param campfireId - The campfire ID
    * @param req - Chatbot creation parameters
    * @returns The Chatbot
@@ -195,10 +149,10 @@ export class CampfiresService extends BaseService {
    *
    * @example
    * ```ts
-   * const result = await client.campfires.createChatbot(123, { serviceName: "example" });
+   * const result = await client.campfires.createChatbot(123, 123, { serviceName: "example" });
    * ```
    */
-  async createChatbot(campfireId: number, req: CreateChatbotCampfireRequest): Promise<Chatbot> {
+  async createChatbot(bucketId: number, campfireId: number, req: CreateChatbotCampfireRequest): Promise<Chatbot> {
     if (!req.serviceName) {
       throw Errors.validation("Service name is required");
     }
@@ -208,12 +162,13 @@ export class CampfiresService extends BaseService {
         operation: "CreateChatbot",
         resourceType: "chatbot",
         isMutation: true,
+        projectId: bucketId,
         resourceId: campfireId,
       },
       () =>
-        this.client.POST("/chats/{campfireId}/integrations.json", {
+        this.client.POST("/buckets/{bucketId}/chats/{campfireId}/integrations.json", {
           params: {
-            path: { campfireId },
+            path: { bucketId, campfireId },
           },
           body: {
             service_name: req.serviceName,
@@ -226,6 +181,7 @@ export class CampfiresService extends BaseService {
 
   /**
    * Get a chatbot by ID
+   * @param bucketId - The bucket ID
    * @param campfireId - The campfire ID
    * @param chatbotId - The chatbot ID
    * @returns The Chatbot
@@ -233,22 +189,23 @@ export class CampfiresService extends BaseService {
    *
    * @example
    * ```ts
-   * const result = await client.campfires.getChatbot(123, 123);
+   * const result = await client.campfires.getChatbot(123, 123, 123);
    * ```
    */
-  async getChatbot(campfireId: number, chatbotId: number): Promise<Chatbot> {
+  async getChatbot(bucketId: number, campfireId: number, chatbotId: number): Promise<Chatbot> {
     const response = await this.request(
       {
         service: "Campfires",
         operation: "GetChatbot",
         resourceType: "chatbot",
         isMutation: false,
+        projectId: bucketId,
         resourceId: chatbotId,
       },
       () =>
-        this.client.GET("/chats/{campfireId}/integrations/{chatbotId}", {
+        this.client.GET("/buckets/{bucketId}/chats/{campfireId}/integrations/{chatbotId}", {
           params: {
-            path: { campfireId, chatbotId },
+            path: { bucketId, campfireId, chatbotId },
           },
         })
     );
@@ -257,6 +214,7 @@ export class CampfiresService extends BaseService {
 
   /**
    * Update an existing chatbot
+   * @param bucketId - The bucket ID
    * @param campfireId - The campfire ID
    * @param chatbotId - The chatbot ID
    * @param req - Chatbot update parameters
@@ -265,10 +223,10 @@ export class CampfiresService extends BaseService {
    *
    * @example
    * ```ts
-   * const result = await client.campfires.updateChatbot(123, 123, { serviceName: "example" });
+   * const result = await client.campfires.updateChatbot(123, 123, 123, { serviceName: "example" });
    * ```
    */
-  async updateChatbot(campfireId: number, chatbotId: number, req: UpdateChatbotCampfireRequest): Promise<Chatbot> {
+  async updateChatbot(bucketId: number, campfireId: number, chatbotId: number, req: UpdateChatbotCampfireRequest): Promise<Chatbot> {
     if (!req.serviceName) {
       throw Errors.validation("Service name is required");
     }
@@ -278,12 +236,13 @@ export class CampfiresService extends BaseService {
         operation: "UpdateChatbot",
         resourceType: "chatbot",
         isMutation: true,
+        projectId: bucketId,
         resourceId: chatbotId,
       },
       () =>
-        this.client.PUT("/chats/{campfireId}/integrations/{chatbotId}", {
+        this.client.PUT("/buckets/{bucketId}/chats/{campfireId}/integrations/{chatbotId}", {
           params: {
-            path: { campfireId, chatbotId },
+            path: { bucketId, campfireId, chatbotId },
           },
           body: {
             service_name: req.serviceName,
@@ -296,6 +255,7 @@ export class CampfiresService extends BaseService {
 
   /**
    * Delete a chatbot
+   * @param bucketId - The bucket ID
    * @param campfireId - The campfire ID
    * @param chatbotId - The chatbot ID
    * @returns void
@@ -303,27 +263,89 @@ export class CampfiresService extends BaseService {
    *
    * @example
    * ```ts
-   * await client.campfires.deleteChatbot(123, 123);
+   * await client.campfires.deleteChatbot(123, 123, 123);
    * ```
    */
-  async deleteChatbot(campfireId: number, chatbotId: number): Promise<void> {
+  async deleteChatbot(bucketId: number, campfireId: number, chatbotId: number): Promise<void> {
     await this.request(
       {
         service: "Campfires",
         operation: "DeleteChatbot",
         resourceType: "chatbot",
         isMutation: true,
+        projectId: bucketId,
         resourceId: chatbotId,
       },
       () =>
-        this.client.DELETE("/chats/{campfireId}/integrations/{chatbotId}", {
+        this.client.DELETE("/buckets/{bucketId}/chats/{campfireId}/integrations/{chatbotId}", {
+          params: {
+            path: { bucketId, campfireId, chatbotId },
+          },
+        })
+    );
+  }
+
+  /**
+   * List all campfires across the account
+   * @param options - Optional query parameters
+   * @returns All Campfire across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.campfires.list();
+   *
+   * // With options
+   * const filtered = await client.campfires.list({ page: 1 });
+   * ```
+   */
+  async list(options?: ListCampfireOptions): Promise<ListResult<Campfire>> {
+    return this.requestPaginated(
+      {
+        service: "Campfires",
+        operation: "ListCampfires",
+        resourceType: "campfire",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/chats.json", {
           params: {
-            path: { campfireId, chatbotId },
+            query: { page: options?.page },
           },
         })
+      , options
     );
   }
 
+  /**
+   * Get a campfire by ID
+   * @param campfireId - The campfire ID
+   * @returns The Campfire
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.campfires.get(123);
+   * ```
+   */
+  async get(campfireId: number): Promise<Campfire> {
+    const response = await this.request(
+      {
+        service: "Campfires",
+        operation: "GetCampfire",
+        resourceType: "campfire",
+        isMutation: false,
+        resourceId: campfireId,
+      },
+      () =>
+        this.client.GET("/chats/{campfireId}", {
+          params: {
+            path: { campfireId },
+          },
+        })
+    );
+    return response;
+  }
+
   /**
    * List all lines (messages) in a campfire
    * @param campfireId - The campfire ID
@@ -351,7 +373,7 @@ export class CampfiresService extends BaseService {
         this.client.GET("/chats/{campfireId}/lines.json", {
           params: {
             path: { campfireId },
-            query: { sort: options?.sort, direction: options?.direction },
+            query: { sort: options?.sort, direction: options?.direction, page: options?.page },
           },
         })
       , options
@@ -521,7 +543,7 @@ export class CampfiresService extends BaseService {
         this.client.GET("/chats/{campfireId}/uploads.json", {
           params: {
             path: { campfireId },
-            query: { sort: options?.sort, direction: options?.direction },
+            query: { sort: options?.sort, direction: options?.direction, page: options?.page },
           },
         })
       , options

package/src/generated/services/cards.ts

@@ -45,6 +45,8 @@ export interface MoveCardRequest {
  * Options for list.
  */
 export interface ListCardOptions extends PaginationOptions {
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
+  page?: number;
 }
 
 /**
@@ -184,6 +186,9 @@ export class CardsService extends BaseService {
    * @example
    * ```ts
    * const result = await client.cards.list(123);
+   *
+   * // With options
+   * const filtered = await client.cards.list(123, { page: 1 });
    * ```
    */
   async list(columnId: number, options?: ListCardOptions): Promise<ListResult<Card>> {
@@ -199,6 +204,7 @@ export class CardsService extends BaseService {
         this.client.GET("/card_tables/lists/{columnId}/cards.json", {
           params: {
             path: { columnId },
+            query: { page: options?.page },
           },
         })
       , options

package/src/generated/services/checkins.ts

@@ -27,6 +27,8 @@ export type Person = components["schemas"]["Person"];
  * Options for reminders.
  */
 export interface RemindersCheckinOptions extends PaginationOptions {
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
+  page?: number;
 }
 
 /**
@@ -43,6 +45,8 @@ export interface UpdateAnswerCheckinRequest {
  * Options for listQuestions.
  */
 export interface ListQuestionsCheckinOptions extends PaginationOptions {
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
+  page?: number;
 }
 
 /**
@@ -73,6 +77,8 @@ export interface UpdateQuestionCheckinRequest {
  * Options for listAnswers.
  */
 export interface ListAnswersCheckinOptions extends PaginationOptions {
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
+  page?: number;
 }
 
 /**
@@ -95,6 +101,8 @@ export interface AnswerersCheckinOptions extends PaginationOptions {
  * Options for byPerson.
  */
 export interface ByPersonCheckinOptions extends PaginationOptions {
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
+  page?: number;
 }
 
 /**
@@ -137,6 +145,9 @@ export class CheckinsService extends BaseService {
       },
       () =>
         this.client.GET("/my/question_reminders.json", {
+          params: {
+            query: { page: options?.page },
+          },
         })
       , options
     );
@@ -251,6 +262,9 @@ export class CheckinsService extends BaseService {
    * @example
    * ```ts
    * const result = await client.checkins.listQuestions(123);
+   *
+   * // With options
+   * const filtered = await client.checkins.listQuestions(123, { page: 1 });
    * ```
    */
   async listQuestions(questionnaireId: number, options?: ListQuestionsCheckinOptions): Promise<ListResult<Question>> {
@@ -266,6 +280,7 @@ export class CheckinsService extends BaseService {
         this.client.GET("/questionnaires/{questionnaireId}/questions.json", {
           params: {
             path: { questionnaireId },
+            query: { page: options?.page },
           },
         })
       , options
@@ -389,6 +404,9 @@ export class CheckinsService extends BaseService {
    * @example
    * ```ts
    * const result = await client.checkins.listAnswers(123);
+   *
+   * // With options
+   * const filtered = await client.checkins.listAnswers(123, { page: 1 });
    * ```
    */
   async listAnswers(questionId: number, options?: ListAnswersCheckinOptions): Promise<ListResult<Answer>> {
@@ -404,6 +422,7 @@ export class CheckinsService extends BaseService {
         this.client.GET("/questions/{questionId}/answers.json", {
           params: {
             path: { questionId },
+            query: { page: options?.page },
           },
         })
       , options
@@ -506,6 +525,7 @@ export class CheckinsService extends BaseService {
         this.client.GET("/questions/{questionId}/answers/by/{personId}", {
           params: {
             path: { questionId, personId },
+            query: { page: options?.page },
           },
         })
       , options

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

@@ -24,6 +24,8 @@ export interface ListClientApprovalOptions extends PaginationOptions {
   sort?: "created_at" | "updated_at";
   /** Filter by direction */
   direction?: "asc" | "desc";
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
+  page?: number;
 }
 
 
@@ -38,29 +40,32 @@ export class ClientApprovalsService extends BaseService {
 
   /**
    * List all client approvals in a project
+   * @param bucketId - The bucket ID
    * @param options - Optional query parameters
    * @returns All ClientApproval across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
-   * const result = await client.clientApprovals.list();
+   * const result = await client.clientApprovals.list(123);
    *
    * // With options
-   * const filtered = await client.clientApprovals.list({ sort: "created_at" });
+   * const filtered = await client.clientApprovals.list(123, { sort: "created_at" });
    * ```
    */
-  async list(options?: ListClientApprovalOptions): Promise<ListResult<ClientApproval>> {
+  async list(bucketId: number, options?: ListClientApprovalOptions): Promise<ListResult<ClientApproval>> {
     return this.requestPaginated(
       {
         service: "ClientApprovals",
         operation: "ListClientApprovals",
         resourceType: "client_approval",
         isMutation: false,
+        projectId: bucketId,
       },
       () =>
-        this.client.GET("/client/approvals.json", {
+        this.client.GET("/buckets/{bucketId}/client/approvals.json", {
           params: {
-            query: { sort: options?.sort, direction: options?.direction },
+            path: { bucketId },
+            query: { sort: options?.sort, direction: options?.direction, page: options?.page },
           },
         })
       , options

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

@@ -24,6 +24,8 @@ export interface ListClientCorrespondenceOptions extends PaginationOptions {
   sort?: "created_at" | "updated_at";
   /** Filter by direction */
   direction?: "asc" | "desc";
+  /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
+  page?: number;
 }
 
 
@@ -38,29 +40,32 @@ export class ClientCorrespondencesService extends BaseService {
 
   /**
    * List all client correspondences in a project
+   * @param bucketId - The bucket ID
    * @param options - Optional query parameters
    * @returns All ClientCorrespondence across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
-   * const result = await client.clientCorrespondences.list();
+   * const result = await client.clientCorrespondences.list(123);
    *
    * // With options
-   * const filtered = await client.clientCorrespondences.list({ sort: "created_at" });
+   * const filtered = await client.clientCorrespondences.list(123, { sort: "created_at" });
    * ```
    */
-  async list(options?: ListClientCorrespondenceOptions): Promise<ListResult<ClientCorrespondence>> {
+  async list(bucketId: number, options?: ListClientCorrespondenceOptions): Promise<ListResult<ClientCorrespondence>> {
     return this.requestPaginated(
       {
         service: "ClientCorrespondences",
         operation: "ListClientCorrespondences",
         resourceType: "client_correspondence",
         isMutation: false,
+        projectId: bucketId,
       },
       () =>
-        this.client.GET("/client/correspondences.json", {
+        this.client.GET("/buckets/{bucketId}/client/correspondences.json", {
           params: {
-            query: { sort: options?.sort, direction: options?.direction },
+            path: { bucketId },
+            query: { sort: options?.sort, direction: options?.direction, page: options?.page },
           },
         })
       , options