@37signals/basecamp 0.11.0 → 0.13.0

package/src/generated/services/bookmarks.ts

@@ -0,0 +1,158 @@
+/**
+ * Bookmarks 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";
+
+// =============================================================================
+// Types
+// =============================================================================
+
+/** Bookmark entity from the Basecamp API. */
+export type Bookmark = components["schemas"]["Bookmark"];
+/** BookmarkStatus entity from the Basecamp API. */
+export type BookmarkStatus = components["schemas"]["BookmarkStatus"];
+
+/**
+ * Options for listMyBookmarks.
+ */
+export interface ListMyBookmarksBookmarkOptions 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;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Bookmarks operations.
+ */
+export class BookmarksService extends BaseService {
+
+  /**
+   * List the current user's bookmarks, most recently bookmarked first (paginated).
+   * @param options - Optional query parameters
+   * @returns All Bookmark across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.bookmarks.listMyBookmarks();
+   *
+   * // With options
+   * const filtered = await client.bookmarks.listMyBookmarks({ page: 1 });
+   * ```
+   */
+  async listMyBookmarks(options?: ListMyBookmarksBookmarkOptions): Promise<ListResult<Bookmark>> {
+    return this.requestPaginated(
+      {
+        service: "Bookmarks",
+        operation: "ListMyBookmarks",
+        resourceType: "bookmark",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/my/bookmarks.json", {
+          params: {
+            query: { page: options?.page },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * Report whether the current user has bookmarked the recording.
+   * @param recordingId - The recording ID
+   * @returns The BookmarkStatus
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.bookmarks.getBookmark(123);
+   * ```
+   */
+  async getBookmark(recordingId: number): Promise<BookmarkStatus> {
+    const response = await this.request(
+      {
+        service: "Bookmarks",
+        operation: "GetBookmark",
+        resourceType: "bookmark",
+        isMutation: false,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.GET("/recordings/{recordingId}/bookmark.json", {
+          params: {
+            path: { recordingId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Bookmark a recording for the current user.
+   * @param recordingId - The recording ID
+   * @returns The Bookmark
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.bookmarks.createBookmark(123);
+   * ```
+   */
+  async createBookmark(recordingId: number): Promise<Bookmark> {
+    const response = await this.request(
+      {
+        service: "Bookmarks",
+        operation: "CreateBookmark",
+        resourceType: "bookmark",
+        isMutation: true,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.POST("/recordings/{recordingId}/bookmark.json", {
+          params: {
+            path: { recordingId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Remove the current user's bookmark from a recording.
+   * @param recordingId - The recording ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.bookmarks.deleteBookmark(123);
+   * ```
+   */
+  async deleteBookmark(recordingId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Bookmarks",
+        operation: "DeleteBookmark",
+        resourceType: "bookmark",
+        isMutation: true,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.DELETE("/recordings/{recordingId}/bookmark.json", {
+          params: {
+            path: { recordingId },
+          },
+        })
+    );
+  }
+}

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

@@ -0,0 +1,102 @@
+/**
+ * Calendars 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
+// =============================================================================
+
+/** Calendar entity from the Basecamp API. */
+export type Calendar = components["schemas"]["Calendar"];
+
+/**
+ * Request parameters for updateCalendar.
+ */
+export interface UpdateCalendarCalendarRequest {
+  /** Calendar */
+  calendar: components["schemas"]["CalendarAttributes"];
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Calendars operations.
+ */
+export class CalendarsService extends BaseService {
+
+  /**
+   * Get a calendar by its bucket id. A Calendar is a top-level BC5 bucketable
+   * @param calendarId - The calendar ID
+   * @returns The Calendar
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.calendars.getCalendar(123);
+   * ```
+   */
+  async getCalendar(calendarId: number): Promise<Calendar> {
+    const response = await this.request(
+      {
+        service: "Calendars",
+        operation: "GetCalendar",
+        resourceType: "calendar",
+        isMutation: false,
+        resourceId: calendarId,
+      },
+      () =>
+        this.client.GET("/calendars/{calendarId}", {
+          params: {
+            path: { calendarId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Update a calendar's display color. An unknown color returns 422 with a JSON
+   * @param calendarId - The calendar ID
+   * @param req - Calendar update parameters
+   * @returns The Calendar
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.calendars.updateCalendar(123, { calendar: { color: "example" } });
+   * ```
+   */
+  async updateCalendar(calendarId: number, req: UpdateCalendarCalendarRequest): Promise<Calendar> {
+    if (!req.calendar) {
+      throw Errors.validation("Calendar is required");
+    }
+    const response = await this.request(
+      {
+        service: "Calendars",
+        operation: "UpdateCalendar",
+        resourceType: "calendar",
+        isMutation: true,
+        resourceId: calendarId,
+      },
+      () =>
+        this.client.PUT("/calendars/{calendarId}", {
+          params: {
+            path: { calendarId },
+          },
+          body: {
+            calendar: req.calendar,
+          },
+        })
+    );
+    return response;
+  }
+}

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