@37signals/basecamp 0.2.0

package/src/generated/services/campfires.ts

@@ -0,0 +1,433 @@
+/**
+ * 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";
+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"];
+/** 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
+// =============================================================================
+
+/**
+ * Service for Campfires operations.
+ */
+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 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);
+   * ```
+   */
+  async listChatbots(campfireId: number, options?: ListChatbotsCampfireOptions): Promise<ListResult<Chatbot>> {
+    return this.requestPaginated(
+      {
+        service: "Campfires",
+        operation: "ListChatbots",
+        resourceType: "chatbot",
+        isMutation: false,
+        resourceId: campfireId,
+      },
+      () =>
+        this.client.GET("/chats/{campfireId}/integrations.json", {
+          params: {
+            path: { campfireId },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * 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" });
+   * ```
+   */
+  async createChatbot(campfireId: number, req: CreateChatbotCampfireRequest): Promise<Chatbot> {
+    if (!req.serviceName) {
+      throw Errors.validation("Service name is required");
+    }
+    const response = await this.request(
+      {
+        service: "Campfires",
+        operation: "CreateChatbot",
+        resourceType: "chatbot",
+        isMutation: true,
+        resourceId: campfireId,
+      },
+      () =>
+        this.client.POST("/chats/{campfireId}/integrations.json", {
+          params: {
+            path: { campfireId },
+          },
+          body: {
+            service_name: req.serviceName,
+            command_url: req.commandUrl,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * 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);
+   * ```
+   */
+  async getChatbot(campfireId: number, chatbotId: number): Promise<Chatbot> {
+    const response = await this.request(
+      {
+        service: "Campfires",
+        operation: "GetChatbot",
+        resourceType: "chatbot",
+        isMutation: false,
+        resourceId: campfireId,
+      },
+      () =>
+        this.client.GET("/chats/{campfireId}/integrations/{chatbotId}", {
+          params: {
+            path: { campfireId, chatbotId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * 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" });
+   * ```
+   */
+  async updateChatbot(campfireId: number, chatbotId: number, req: UpdateChatbotCampfireRequest): Promise<Chatbot> {
+    if (!req.serviceName) {
+      throw Errors.validation("Service name is required");
+    }
+    const response = await this.request(
+      {
+        service: "Campfires",
+        operation: "UpdateChatbot",
+        resourceType: "chatbot",
+        isMutation: true,
+        resourceId: campfireId,
+      },
+      () =>
+        this.client.PUT("/chats/{campfireId}/integrations/{chatbotId}", {
+          params: {
+            path: { campfireId, chatbotId },
+          },
+          body: {
+            service_name: req.serviceName,
+            command_url: req.commandUrl,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * 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);
+   * ```
+   */
+  async deleteChatbot(campfireId: number, chatbotId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Campfires",
+        operation: "DeleteChatbot",
+        resourceType: "chatbot",
+        isMutation: true,
+        resourceId: campfireId,
+      },
+      () =>
+        this.client.DELETE("/chats/{campfireId}/integrations/{chatbotId}", {
+          params: {
+            path: { campfireId, chatbotId },
+          },
+        })
+    );
+  }
+
+  /**
+   * 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);
+   * ```
+   */
+  async listLines(campfireId: number, options?: ListLinesCampfireOptions): Promise<ListResult<CampfireLine>> {
+    return this.requestPaginated(
+      {
+        service: "Campfires",
+        operation: "ListCampfireLines",
+        resourceType: "campfire_line",
+        isMutation: false,
+        resourceId: campfireId,
+      },
+      () =>
+        this.client.GET("/chats/{campfireId}/lines.json", {
+          params: {
+            path: { campfireId },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * 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" });
+   * ```
+   */
+  async createLine(campfireId: number, req: CreateLineCampfireRequest): Promise<CampfireLine> {
+    if (!req.content) {
+      throw Errors.validation("Content is required");
+    }
+    const response = await this.request(
+      {
+        service: "Campfires",
+        operation: "CreateCampfireLine",
+        resourceType: "campfire_line",
+        isMutation: true,
+        resourceId: campfireId,
+      },
+      () =>
+        this.client.POST("/chats/{campfireId}/lines.json", {
+          params: {
+            path: { campfireId },
+          },
+          body: {
+            content: req.content,
+            content_type: req.contentType,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * 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);
+   * ```
+   */
+  async getLine(campfireId: number, lineId: number): Promise<CampfireLine> {
+    const response = await this.request(
+      {
+        service: "Campfires",
+        operation: "GetCampfireLine",
+        resourceType: "campfire_line",
+        isMutation: false,
+        resourceId: campfireId,
+      },
+      () =>
+        this.client.GET("/chats/{campfireId}/lines/{lineId}", {
+          params: {
+            path: { campfireId, lineId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * 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);
+   * ```
+   */
+  async deleteLine(campfireId: number, lineId: number): Promise<void> {
+    await this.request(
+      {
+        service: "Campfires",
+        operation: "DeleteCampfireLine",
+        resourceType: "campfire_line",
+        isMutation: true,
+        resourceId: campfireId,
+      },
+      () =>
+        this.client.DELETE("/chats/{campfireId}/lines/{lineId}", {
+          params: {
+            path: { campfireId, lineId },
+          },
+        })
+    );
+  }
+}