@37signals/basecamp 0.2.0

package/dist/generated/services/message-types.ts

@@ -0,0 +1,210 @@
+/**
+ * MessageTypes 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
+// =============================================================================
+
+/** MessageType entity from the Basecamp API. */
+export type MessageType = components["schemas"]["MessageType"];
+
+/**
+ * Options for list.
+ */
+export interface ListMessageTypeOptions extends PaginationOptions {
+}
+
+/**
+ * Request parameters for create.
+ */
+export interface CreateMessageTypeRequest {
+  /** Display name */
+  name: string;
+  /** Icon identifier */
+  icon: string;
+}
+
+/**
+ * Request parameters for update.
+ */
+export interface UpdateMessageTypeRequest {
+  /** Display name */
+  name?: string;
+  /** Icon identifier */
+  icon?: string;
+}
+
+
+// =============================================================================
+// Service
+// =============================================================================
+
+/**
+ * Service for MessageTypes operations.
+ */
+export class MessageTypesService extends BaseService {
+
+  /**
+   * List message types in a project
+   * @param options - Optional query parameters
+   * @returns All MessageType across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.messageTypes.list();
+   * ```
+   */
+  async list(options?: ListMessageTypeOptions): Promise<ListResult<MessageType>> {
+    return this.requestPaginated(
+      {
+        service: "MessageTypes",
+        operation: "ListMessageTypes",
+        resourceType: "message_type",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/categories.json", {
+        })
+      , options
+    );
+  }
+
+  /**
+   * Create a new message type in a project
+   * @param req - Message_type creation parameters
+   * @returns The MessageType
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.messageTypes.create({ name: "My example", icon: "example" });
+   * ```
+   */
+  async create(req: CreateMessageTypeRequest): Promise<MessageType> {
+    if (!req.name) {
+      throw Errors.validation("Name is required");
+    }
+    if (!req.icon) {
+      throw Errors.validation("Icon is required");
+    }
+    const response = await this.request(
+      {
+        service: "MessageTypes",
+        operation: "CreateMessageType",
+        resourceType: "message_type",
+        isMutation: true,
+      },
+      () =>
+        this.client.POST("/categories.json", {
+          body: {
+            name: req.name,
+            icon: req.icon,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Get a single message type by id
+   * @param typeId - The type ID
+   * @returns The MessageType
+   * @throws {BasecampError} If the resource is not found
+   *
+   * @example
+   * ```ts
+   * const result = await client.messageTypes.get(123);
+   * ```
+   */
+  async get(typeId: number): Promise<MessageType> {
+    const response = await this.request(
+      {
+        service: "MessageTypes",
+        operation: "GetMessageType",
+        resourceType: "message_type",
+        isMutation: false,
+        resourceId: typeId,
+      },
+      () =>
+        this.client.GET("/categories/{typeId}", {
+          params: {
+            path: { typeId },
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Update an existing message type
+   * @param typeId - The type ID
+   * @param req - Message_type update parameters
+   * @returns The MessageType
+   * @throws {BasecampError} If the resource is not found or fields are invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.messageTypes.update(123, { });
+   * ```
+   */
+  async update(typeId: number, req: UpdateMessageTypeRequest): Promise<MessageType> {
+    const response = await this.request(
+      {
+        service: "MessageTypes",
+        operation: "UpdateMessageType",
+        resourceType: "message_type",
+        isMutation: true,
+        resourceId: typeId,
+      },
+      () =>
+        this.client.PUT("/categories/{typeId}", {
+          params: {
+            path: { typeId },
+          },
+          body: {
+            name: req.name,
+            icon: req.icon,
+          },
+        })
+    );
+    return response;
+  }
+
+  /**
+   * Delete a message type
+   * @param typeId - The type ID
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.messageTypes.delete(123);
+   * ```
+   */
+  async delete(typeId: number): Promise<void> {
+    await this.request(
+      {
+        service: "MessageTypes",
+        operation: "DeleteMessageType",
+        resourceType: "message_type",
+        isMutation: true,
+        resourceId: typeId,
+      },
+      () =>
+        this.client.DELETE("/categories/{typeId}", {
+          params: {
+            path: { typeId },
+          },
+        })
+    );
+  }
+}

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

@@ -0,0 +1,122 @@
+/**
+ * Messages 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";
+/** Message entity from the Basecamp API. */
+export type Message = components["schemas"]["Message"];
+/**
+ * Options for list.
+ */
+export interface ListMessageOptions extends PaginationOptions {
+}
+/**
+ * Request parameters for create.
+ */
+export interface CreateMessageRequest {
+    /** Subject line */
+    subject: string;
+    /** Text content */
+    content?: string;
+    /** Status */
+    status?: "active" | "drafted";
+    /** Category id */
+    categoryId?: number;
+}
+/**
+ * Request parameters for update.
+ */
+export interface UpdateMessageRequest {
+    /** Subject line */
+    subject?: string;
+    /** Text content */
+    content?: string;
+    /** Status */
+    status?: "active" | "drafted";
+    /** Category id */
+    categoryId?: number;
+}
+/**
+ * Service for Messages operations.
+ */
+export declare class MessagesService extends BaseService {
+    /**
+     * List messages on a message board
+     * @param boardId - The board ID
+     * @param options - Optional query parameters
+     * @returns All Message across all pages, with .meta.totalCount
+     *
+     * @example
+     * ```ts
+     * const result = await client.messages.list(123);
+     * ```
+     */
+    list(boardId: number, options?: ListMessageOptions): Promise<ListResult<Message>>;
+    /**
+     * Create a new message on a message board
+     * @param boardId - The board ID
+     * @param req - Message creation parameters
+     * @returns The Message
+     * @throws {BasecampError} If required fields are missing or invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.messages.create(123, { subject: "example" });
+     * ```
+     */
+    create(boardId: number, req: CreateMessageRequest): Promise<Message>;
+    /**
+     * Get a single message by id
+     * @param messageId - The message ID
+     * @returns The Message
+     * @throws {BasecampError} If the resource is not found
+     *
+     * @example
+     * ```ts
+     * const result = await client.messages.get(123);
+     * ```
+     */
+    get(messageId: number): Promise<Message>;
+    /**
+     * Update an existing message
+     * @param messageId - The message ID
+     * @param req - Message update parameters
+     * @returns The Message
+     * @throws {BasecampError} If the resource is not found or fields are invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.messages.update(123, { });
+     * ```
+     */
+    update(messageId: number, req: UpdateMessageRequest): Promise<Message>;
+    /**
+     * Pin a message to the top of the message board
+     * @param messageId - The message ID
+     * @returns void
+     * @throws {BasecampError} If the request fails
+     *
+     * @example
+     * ```ts
+     * await client.messages.pin(123);
+     * ```
+     */
+    pin(messageId: number): Promise<void>;
+    /**
+     * Unpin a message from the message board
+     * @param messageId - The message ID
+     * @returns void
+     * @throws {BasecampError} If the request fails
+     *
+     * @example
+     * ```ts
+     * await client.messages.unpin(123);
+     * ```
+     */
+    unpin(messageId: number): Promise<void>;
+}
+//# sourceMappingURL=messages.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../../src/generated/services/messages.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,4CAA4C;AAC5C,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,iBAAiB;CAC5D;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,mBAAmB;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa;IACb,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC9B,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,mBAAmB;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mBAAmB;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa;IACb,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC9B,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAOD;;GAEG;AACH,qBAAa,eAAgB,SAAQ,WAAW;IAE9C;;;;;;;;;;OAUG;IACG,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAmBvF;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IA4B1E;;;;;;;;;;OAUG;IACG,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAmB9C;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAyB5E;;;;;;;;;;OAUG;IACG,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB3C;;;;;;;;;;OAUG;IACG,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAiB9C"}

package/dist/generated/services/messages.js

@@ -0,0 +1,180 @@
+/**
+ * Messages service for the Basecamp API.
+ *
+ * @generated from OpenAPI spec - do not edit directly
+ */
+import { BaseService } from "../../services/base.js";
+import { Errors } from "../../errors.js";
+// =============================================================================
+// Service
+// =============================================================================
+/**
+ * Service for Messages operations.
+ */
+export class MessagesService extends BaseService {
+    /**
+     * List messages on a message board
+     * @param boardId - The board ID
+     * @param options - Optional query parameters
+     * @returns All Message across all pages, with .meta.totalCount
+     *
+     * @example
+     * ```ts
+     * const result = await client.messages.list(123);
+     * ```
+     */
+    async list(boardId, options) {
+        return this.requestPaginated({
+            service: "Messages",
+            operation: "ListMessages",
+            resourceType: "message",
+            isMutation: false,
+            resourceId: boardId,
+        }, () => this.client.GET("/message_boards/{boardId}/messages.json", {
+            params: {
+                path: { boardId },
+            },
+        }), options);
+    }
+    /**
+     * Create a new message on a message board
+     * @param boardId - The board ID
+     * @param req - Message creation parameters
+     * @returns The Message
+     * @throws {BasecampError} If required fields are missing or invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.messages.create(123, { subject: "example" });
+     * ```
+     */
+    async create(boardId, req) {
+        if (!req.subject) {
+            throw Errors.validation("Subject is required");
+        }
+        const response = await this.request({
+            service: "Messages",
+            operation: "CreateMessage",
+            resourceType: "message",
+            isMutation: true,
+            resourceId: boardId,
+        }, () => this.client.POST("/message_boards/{boardId}/messages.json", {
+            params: {
+                path: { boardId },
+            },
+            body: {
+                subject: req.subject,
+                content: req.content,
+                status: req.status,
+                category_id: req.categoryId,
+            },
+        }));
+        return response;
+    }
+    /**
+     * Get a single message by id
+     * @param messageId - The message ID
+     * @returns The Message
+     * @throws {BasecampError} If the resource is not found
+     *
+     * @example
+     * ```ts
+     * const result = await client.messages.get(123);
+     * ```
+     */
+    async get(messageId) {
+        const response = await this.request({
+            service: "Messages",
+            operation: "GetMessage",
+            resourceType: "message",
+            isMutation: false,
+            resourceId: messageId,
+        }, () => this.client.GET("/messages/{messageId}", {
+            params: {
+                path: { messageId },
+            },
+        }));
+        return response;
+    }
+    /**
+     * Update an existing message
+     * @param messageId - The message ID
+     * @param req - Message update parameters
+     * @returns The Message
+     * @throws {BasecampError} If the resource is not found or fields are invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.messages.update(123, { });
+     * ```
+     */
+    async update(messageId, req) {
+        const response = await this.request({
+            service: "Messages",
+            operation: "UpdateMessage",
+            resourceType: "message",
+            isMutation: true,
+            resourceId: messageId,
+        }, () => this.client.PUT("/messages/{messageId}", {
+            params: {
+                path: { messageId },
+            },
+            body: {
+                subject: req.subject,
+                content: req.content,
+                status: req.status,
+                category_id: req.categoryId,
+            },
+        }));
+        return response;
+    }
+    /**
+     * Pin a message to the top of the message board
+     * @param messageId - The message ID
+     * @returns void
+     * @throws {BasecampError} If the request fails
+     *
+     * @example
+     * ```ts
+     * await client.messages.pin(123);
+     * ```
+     */
+    async pin(messageId) {
+        await this.request({
+            service: "Messages",
+            operation: "PinMessage",
+            resourceType: "message",
+            isMutation: true,
+            resourceId: messageId,
+        }, () => this.client.POST("/recordings/{messageId}/pin.json", {
+            params: {
+                path: { messageId },
+            },
+        }));
+    }
+    /**
+     * Unpin a message from the message board
+     * @param messageId - The message ID
+     * @returns void
+     * @throws {BasecampError} If the request fails
+     *
+     * @example
+     * ```ts
+     * await client.messages.unpin(123);
+     * ```
+     */
+    async unpin(messageId) {
+        await this.request({
+            service: "Messages",
+            operation: "UnpinMessage",
+            resourceType: "message",
+            isMutation: true,
+            resourceId: messageId,
+        }, () => this.client.DELETE("/recordings/{messageId}/pin.json", {
+            params: {
+                path: { messageId },
+            },
+        }));
+    }
+}
+//# sourceMappingURL=messages.js.map

package/dist/generated/services/messages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../../src/generated/services/messages.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAIrD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AA4CzC,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,WAAW;IAE9C;;;;;;;;;;OAUG;IACH,KAAK,CAAC,IAAI,CAAC,OAAe,EAAE,OAA4B;QACtD,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,UAAU;YACnB,SAAS,EAAE,cAAc;YACzB,YAAY,EAAE,SAAS;YACvB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,OAAO;SACpB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,yCAAyC,EAAE;YACzD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,OAAO,EAAE;aAClB;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,GAAyB;QACrD,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,MAAM,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;QACjD,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,UAAU;YACnB,SAAS,EAAE,eAAe;YAC1B,YAAY,EAAE,SAAS;YACvB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,OAAO;SACpB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,yCAAyC,EAAE;YAC1D,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,OAAO,EAAE;aAClB;YACD,IAAI,EAAE;gBACJ,OAAO,EAAE,GAAG,CAAC,OAAO;gBACpB,OAAO,EAAE,GAAG,CAAC,OAAO;gBACpB,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,WAAW,EAAE,GAAG,CAAC,UAAU;aAC5B;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,CAAC,SAAiB;QACzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,UAAU;YACnB,SAAS,EAAE,YAAY;YACvB,YAAY,EAAE,SAAS;YACvB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,SAAS;SACtB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,uBAAuB,EAAE;YACvC,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,SAAS,EAAE;aACpB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,CAAC,SAAiB,EAAE,GAAyB;QACvD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,UAAU;YACnB,SAAS,EAAE,eAAe;YAC1B,YAAY,EAAE,SAAS;YACvB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,SAAS;SACtB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,uBAAuB,EAAE;YACvC,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,SAAS,EAAE;aACpB;YACD,IAAI,EAAE;gBACJ,OAAO,EAAE,GAAG,CAAC,OAAO;gBACpB,OAAO,EAAE,GAAG,CAAC,OAAO;gBACpB,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,WAAW,EAAE,GAAG,CAAC,UAAU;aAC5B;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,CAAC,SAAiB;QACzB,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,UAAU;YACnB,SAAS,EAAE,YAAY;YACvB,YAAY,EAAE,SAAS;YACvB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,SAAS;SACtB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kCAAkC,EAAE;YACnD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,SAAS,EAAE;aACpB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,KAAK,CAAC,SAAiB;QAC3B,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,UAAU;YACnB,SAAS,EAAE,cAAc;YACzB,YAAY,EAAE,SAAS;YACvB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,SAAS;SACtB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,kCAAkC,EAAE;YACrD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,SAAS,EAAE;aACpB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;CACF"}