@37signals/basecamp 0.2.0

package/dist/generated/services/boosts.ts

@@ -0,0 +1,250 @@
+/**
+ * Boosts 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
+// =============================================================================
+
+
+/**
+ * Options for listForRecording.
+ */
+export interface ListForRecordingBoostOptions extends PaginationOptions {
+}
+
+/**
+ * Request parameters for createForRecording.
+ */
+export interface CreateForRecordingBoostRequest {
+  /** Text content */
+  content: string;
+}
+
+/**
+ * Options for listForEvent.
+ */
+export interface ListForEventBoostOptions extends PaginationOptions {
+}
+
+/**
+ * Request parameters for createForEvent.
+ */
+export interface CreateForEventBoostRequest {
+  /** Text content */
+  content: string;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for Boosts operations.
+ */
+export class BoostsService extends BaseService {
+
+  /**
+   * Get a single boost
+   * @param boostId - The boost ID
+   * @returns The boost
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.boosts.get(123);
+   * ```
+   */
+  async get(boostId: number): Promise<components["schemas"]["GetBoostResponseContent"]> {
+    const response = await this.request(
+      {
+        service: "Boosts",
+        operation: "GetBoost",
+        resourceType: "boost",
+        isMutation: false,
+        resourceId: boostId,
+      },
+      () =>
+        this.client.GET("/boosts/{boostId}", {
+          params: {
+            path: { boostId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Delete a boost
+   * @param boostId - The boost ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.boosts.delete(123);
+   * ```
+   */
+  async delete(boostId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Boosts",
+        operation: "DeleteBoost",
+        resourceType: "boost",
+        isMutation: true,
+        resourceId: boostId,
+      },
+      () =>
+        this.client.DELETE("/boosts/{boostId}", {
+          params: {
+            path: { boostId },
+          },
+        })
+    );
+  }
+
+  /**
+   * List boosts on a recording
+   * @param recordingId - The recording ID
+   * @param options - Optional query parameters
+   * @returns All results across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.boosts.listForRecording(123);
+   * ```
+   */
+  async listForRecording(recordingId: number, options?: ListForRecordingBoostOptions): Promise<components["schemas"]["ListRecordingBoostsResponseContent"]> {
+    return this.requestPaginated(
+      {
+        service: "Boosts",
+        operation: "ListRecordingBoosts",
+        resourceType: "recording_boost",
+        isMutation: false,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.GET("/recordings/{recordingId}/boosts.json", {
+          params: {
+            path: { recordingId },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * Create a boost on a recording
+   * @param recordingId - The recording ID
+   * @param req - Recording_boost creation parameters
+   * @returns The recording_boost
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.boosts.createForRecording(123, { content: "Hello world" });
+   * ```
+   */
+  async createForRecording(recordingId: number, req: CreateForRecordingBoostRequest): Promise<components["schemas"]["CreateRecordingBoostResponseContent"]> {
+    if (!req.content) {
+      throw Errors.validation("Content is required");
+    }
+    const response = await this.request(
+      {
+        service: "Boosts",
+        operation: "CreateRecordingBoost",
+        resourceType: "recording_boost",
+        isMutation: true,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.POST("/recordings/{recordingId}/boosts.json", {
+          params: {
+            path: { recordingId },
+          },
+          body: {
+            content: req.content,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * List boosts on a specific event within a recording
+   * @param recordingId - The recording ID
+   * @param eventId - The event ID
+   * @param options - Optional query parameters
+   * @returns All results across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.boosts.listForEvent(123, 123);
+   * ```
+   */
+  async listForEvent(recordingId: number, eventId: number, options?: ListForEventBoostOptions): Promise<components["schemas"]["ListEventBoostsResponseContent"]> {
+    return this.requestPaginated(
+      {
+        service: "Boosts",
+        operation: "ListEventBoosts",
+        resourceType: "event_boost",
+        isMutation: false,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.GET("/recordings/{recordingId}/events/{eventId}/boosts.json", {
+          params: {
+            path: { recordingId, eventId },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * Create a boost on a specific event within a recording
+   * @param recordingId - The recording ID
+   * @param eventId - The event ID
+   * @param req - Event_boost creation parameters
+   * @returns The event_boost
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.boosts.createForEvent(123, 123, { content: "Hello world" });
+   * ```
+   */
+  async createForEvent(recordingId: number, eventId: number, req: CreateForEventBoostRequest): Promise<components["schemas"]["CreateEventBoostResponseContent"]> {
+    if (!req.content) {
+      throw Errors.validation("Content is required");
+    }
+    const response = await this.request(
+      {
+        service: "Boosts",
+        operation: "CreateEventBoost",
+        resourceType: "event_boost",
+        isMutation: true,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.POST("/recordings/{recordingId}/events/{eventId}/boosts.json", {
+          params: {
+            path: { recordingId, eventId },
+          },
+          body: {
+            content: req.content,
+          },
+        })
+    );
+    return response;
+  }
+}

package/dist/generated/services/campfires.d.ts

@@ -0,0 +1,202 @@
+/**
+ * Campfires 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";
+/** Campfire entity from the Basecamp API. */
+export type Campfire = components["schemas"]["Campfire"];
+/** Chatbot entity from the Basecamp API. */
+export type Chatbot = components["schemas"]["Chatbot"];
+/** CampfireLine entity from the Basecamp API. */
+export type CampfireLine = components["schemas"]["CampfireLine"];
+/**
+ * Options for list.
+ */
+export interface ListCampfireOptions extends PaginationOptions {
+}
+/**
+ * Options for listChatbots.
+ */
+export interface ListChatbotsCampfireOptions extends PaginationOptions {
+}
+/**
+ * Request parameters for createChatbot.
+ */
+export interface CreateChatbotCampfireRequest {
+    /** Service name */
+    serviceName: string;
+    /** Command url */
+    commandUrl?: string;
+}
+/**
+ * Request parameters for updateChatbot.
+ */
+export interface UpdateChatbotCampfireRequest {
+    /** Service name */
+    serviceName: string;
+    /** Command url */
+    commandUrl?: string;
+}
+/**
+ * Options for listLines.
+ */
+export interface ListLinesCampfireOptions extends PaginationOptions {
+}
+/**
+ * Request parameters for createLine.
+ */
+export interface CreateLineCampfireRequest {
+    /** Text content */
+    content: string;
+    /** Content type */
+    contentType?: string;
+}
+/**
+ * Service for Campfires operations.
+ */
+export declare 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();
+     * ```
+     */
+    list(options?: ListCampfireOptions): Promise<ListResult<Campfire>>;
+    /**
+     * 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);
+     * ```
+     */
+    get(campfireId: number): Promise<Campfire>;
+    /**
+     * List all chatbots for a campfire
+     * @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);
+     * ```
+     */
+    listChatbots(campfireId: number, options?: ListChatbotsCampfireOptions): Promise<ListResult<Chatbot>>;
+    /**
+     * Create a new chatbot for a campfire
+     * @param campfireId - The campfire ID
+     * @param req - Chatbot creation parameters
+     * @returns The Chatbot
+     * @throws {BasecampError} If required fields are missing or invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.campfires.createChatbot(123, { serviceName: "example" });
+     * ```
+     */
+    createChatbot(campfireId: number, req: CreateChatbotCampfireRequest): Promise<Chatbot>;
+    /**
+     * Get a chatbot by ID
+     * @param campfireId - The campfire ID
+     * @param chatbotId - The chatbot ID
+     * @returns The Chatbot
+     * @throws {BasecampError} If the resource is not found
+     *
+     * @example
+     * ```ts
+     * const result = await client.campfires.getChatbot(123, 123);
+     * ```
+     */
+    getChatbot(campfireId: number, chatbotId: number): Promise<Chatbot>;
+    /**
+     * Update an existing chatbot
+     * @param campfireId - The campfire ID
+     * @param chatbotId - The chatbot ID
+     * @param req - Chatbot update parameters
+     * @returns The Chatbot
+     * @throws {BasecampError} If the resource is not found or fields are invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.campfires.updateChatbot(123, 123, { serviceName: "example" });
+     * ```
+     */
+    updateChatbot(campfireId: number, chatbotId: number, req: UpdateChatbotCampfireRequest): Promise<Chatbot>;
+    /**
+     * Delete a chatbot
+     * @param campfireId - The campfire ID
+     * @param chatbotId - The chatbot ID
+     * @returns void
+     * @throws {BasecampError} If the request fails
+     *
+     * @example
+     * ```ts
+     * await client.campfires.deleteChatbot(123, 123);
+     * ```
+     */
+    deleteChatbot(campfireId: number, chatbotId: number): Promise<void>;
+    /**
+     * List all lines (messages) in a campfire
+     * @param campfireId - The campfire ID
+     * @param options - Optional query parameters
+     * @returns All CampfireLine across all pages, with .meta.totalCount
+     *
+     * @example
+     * ```ts
+     * const result = await client.campfires.listLines(123);
+     * ```
+     */
+    listLines(campfireId: number, options?: ListLinesCampfireOptions): Promise<ListResult<CampfireLine>>;
+    /**
+     * Create a new line (message) in a campfire
+     * @param campfireId - The campfire ID
+     * @param req - Campfire_line creation parameters
+     * @returns The CampfireLine
+     * @throws {BasecampError} If required fields are missing or invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.campfires.createLine(123, { content: "Hello world" });
+     * ```
+     */
+    createLine(campfireId: number, req: CreateLineCampfireRequest): Promise<CampfireLine>;
+    /**
+     * Get a campfire line by ID
+     * @param campfireId - The campfire ID
+     * @param lineId - The line ID
+     * @returns The CampfireLine
+     * @throws {BasecampError} If the resource is not found
+     *
+     * @example
+     * ```ts
+     * const result = await client.campfires.getLine(123, 123);
+     * ```
+     */
+    getLine(campfireId: number, lineId: number): Promise<CampfireLine>;
+    /**
+     * Delete a campfire line
+     * @param campfireId - The campfire ID
+     * @param lineId - The line ID
+     * @returns void
+     * @throws {BasecampError} If the request fails
+     *
+     * @example
+     * ```ts
+     * await client.campfires.deleteLine(123, 123);
+     * ```
+     */
+    deleteLine(campfireId: number, lineId: number): Promise<void>;
+}
+//# sourceMappingURL=campfires.d.ts.map

package/dist/generated/services/campfires.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"campfires.d.ts","sourceRoot":"","sources":["../../../src/generated/services/campfires.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAO7D,6CAA6C;AAC7C,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAC;AACzD,4CAA4C;AAC5C,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC;AACvD,iDAAiD;AACjD,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;CAC7D;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,iBAAiB;CACrE;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,mBAAmB;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,mBAAmB;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,iBAAiB;CAClE;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,mBAAmB;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAOD;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAE/C;;;;;;;;;OASG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAexE;;;;;;;;;;OAUG;IACG,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAmBhD;;;;;;;;;;OAUG;IACG,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAmB3G;;;;;;;;;;;OAWG;IACG,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,4BAA4B,GAAG,OAAO,CAAC,OAAO,CAAC;IA0B5F;;;;;;;;;;;OAWG;IACG,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAmBzE;;;;;;;;;;;;OAYG;IACG,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,4BAA4B,GAAG,OAAO,CAAC,OAAO,CAAC;IA0B/G;;;;;;;;;;;OAWG;IACG,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBzE;;;;;;;;;;OAUG;IACG,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,wBAAwB,GAAG,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;IAmB1G;;;;;;;;;;;OAWG;IACG,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,yBAAyB,GAAG,OAAO,CAAC,YAAY,CAAC;IA0B3F;;;;;;;;;;;OAWG;IACG,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAmBxE;;;;;;;;;;;OAWG;IACG,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAiBpE"}