@37signals/basecamp 0.2.0

package/dist/generated/services/messages.ts

@@ -0,0 +1,258 @@
+/**
+ * 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";
+import { Errors } from "../../errors.js";
+
+// =============================================================================
+// Types
+// =============================================================================
+
+/** 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
+// =============================================================================
+
+/**
+ * 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: number, options?: ListMessageOptions): Promise<ListResult<Message>> {
+    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: number, req: CreateMessageRequest): Promise<Message> {
+    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: number): Promise<Message> {
+    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: number, req: UpdateMessageRequest): Promise<Message> {
+    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: number): Promise<void> {
+    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: number): Promise<void> {
+    await this.request(
+      {
+        service: "Messages",
+        operation: "UnpinMessage",
+        resourceType: "message",
+        isMutation: true,
+        resourceId: messageId,
+      },
+      () =>
+        this.client.DELETE("/recordings/{messageId}/pin.json", {
+          params: {
+            path: { messageId },
+          },
+        })
+    );
+  }
+}

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

@@ -0,0 +1,122 @@
+/**
+ * People 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";
+/** Person entity from the Basecamp API. */
+export type Person = components["schemas"]["Person"];
+/**
+ * Options for listPingable.
+ */
+export interface ListPingablePeopleOptions extends PaginationOptions {
+}
+/**
+ * Options for list.
+ */
+export interface ListPeopleOptions extends PaginationOptions {
+}
+/**
+ * Options for listForProject.
+ */
+export interface ListForProjectPeopleOptions extends PaginationOptions {
+}
+/**
+ * Request parameters for updateProjectAccess.
+ */
+export interface UpdateProjectAccessPeopleRequest {
+    /** Grant */
+    grant?: number[];
+    /** Revoke */
+    revoke?: number[];
+    /** Create */
+    create?: components["schemas"]["CreatePersonRequest"][];
+}
+/**
+ * Service for People operations.
+ */
+export declare class PeopleService extends BaseService {
+    /**
+     * List all account users who can be pinged
+     * @param options - Optional query parameters
+     * @returns All Person across all pages, with .meta.totalCount
+     *
+     * @example
+     * ```ts
+     * const result = await client.people.listPingable();
+     * ```
+     */
+    listPingable(options?: ListPingablePeopleOptions): Promise<ListResult<Person>>;
+    /**
+     * Get the current authenticated user's profile
+     * @returns The Person
+     *
+     * @example
+     * ```ts
+     * const result = await client.people.me();
+     * ```
+     */
+    me(): Promise<Person>;
+    /**
+     * List all people visible to the current user
+     * @param options - Optional query parameters
+     * @returns All Person across all pages, with .meta.totalCount
+     *
+     * @example
+     * ```ts
+     * const result = await client.people.list();
+     * ```
+     */
+    list(options?: ListPeopleOptions): Promise<ListResult<Person>>;
+    /**
+     * Get a person by ID
+     * @param personId - The person ID
+     * @returns The Person
+     * @throws {BasecampError} If the resource is not found
+     *
+     * @example
+     * ```ts
+     * const result = await client.people.get(123);
+     * ```
+     */
+    get(personId: number): Promise<Person>;
+    /**
+     * List all active people on a project
+     * @param projectId - The project ID
+     * @param options - Optional query parameters
+     * @returns All Person across all pages, with .meta.totalCount
+     *
+     * @example
+     * ```ts
+     * const result = await client.people.listForProject(123);
+     * ```
+     */
+    listForProject(projectId: number, options?: ListForProjectPeopleOptions): Promise<ListResult<Person>>;
+    /**
+     * Update project access (grant/revoke/create people)
+     * @param projectId - The project ID
+     * @param req - Project_access update parameters
+     * @returns The project_access
+     * @throws {BasecampError} If the resource is not found or fields are invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.people.updateProjectAccess(123, { });
+     * ```
+     */
+    updateProjectAccess(projectId: number, req: UpdateProjectAccessPeopleRequest): Promise<components["schemas"]["UpdateProjectAccessResponseContent"]>;
+    /**
+     * List people who can be assigned todos
+     * @returns Array of Person
+     *
+     * @example
+     * ```ts
+     * const result = await client.people.listAssignable();
+     * ```
+     */
+    listAssignable(): Promise<Person[]>;
+}
+//# sourceMappingURL=people.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"people.d.ts","sourceRoot":"","sources":["../../../src/generated/services/people.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;AAM7D,2CAA2C;AAC3C,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;CACnE;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;CAC3D;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,iBAAiB;CACrE;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C,YAAY;IACZ,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,aAAa;IACb,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,aAAa;IACb,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,EAAE,CAAC;CACzD;AAOD;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAE5C;;;;;;;;;OASG;IACG,YAAY,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAepF;;;;;;;;OAQG;IACG,EAAE,IAAI,OAAO,CAAC,MAAM,CAAC;IAe3B;;;;;;;;;OASG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAepE;;;;;;;;;;OAUG;IACG,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAmB5C;;;;;;;;;;OAUG;IACG,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAmB3G;;;;;;;;;;;OAWG;IACG,mBAAmB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,gCAAgC,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,oCAAoC,CAAC,CAAC;IAwBzJ;;;;;;;;OAQG;IACG,cAAc,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;CAc1C"}

package/dist/generated/services/people.js

@@ -0,0 +1,167 @@
+/**
+ * People service for the Basecamp API.
+ *
+ * @generated from OpenAPI spec - do not edit directly
+ */
+import { BaseService } from "../../services/base.js";
+// =============================================================================
+// Service
+// =============================================================================
+/**
+ * Service for People operations.
+ */
+export class PeopleService extends BaseService {
+    /**
+     * List all account users who can be pinged
+     * @param options - Optional query parameters
+     * @returns All Person across all pages, with .meta.totalCount
+     *
+     * @example
+     * ```ts
+     * const result = await client.people.listPingable();
+     * ```
+     */
+    async listPingable(options) {
+        return this.requestPaginated({
+            service: "People",
+            operation: "ListPingablePeople",
+            resourceType: "pingable_people",
+            isMutation: false,
+        }, () => this.client.GET("/circles/people.json", {}), options);
+    }
+    /**
+     * Get the current authenticated user's profile
+     * @returns The Person
+     *
+     * @example
+     * ```ts
+     * const result = await client.people.me();
+     * ```
+     */
+    async me() {
+        const response = await this.request({
+            service: "People",
+            operation: "GetMyProfile",
+            resourceType: "my_profile",
+            isMutation: false,
+        }, () => this.client.GET("/my/profile.json", {}));
+        return response;
+    }
+    /**
+     * List all people visible to the current user
+     * @param options - Optional query parameters
+     * @returns All Person across all pages, with .meta.totalCount
+     *
+     * @example
+     * ```ts
+     * const result = await client.people.list();
+     * ```
+     */
+    async list(options) {
+        return this.requestPaginated({
+            service: "People",
+            operation: "ListPeople",
+            resourceType: "people",
+            isMutation: false,
+        }, () => this.client.GET("/people.json", {}), options);
+    }
+    /**
+     * Get a person by ID
+     * @param personId - The person ID
+     * @returns The Person
+     * @throws {BasecampError} If the resource is not found
+     *
+     * @example
+     * ```ts
+     * const result = await client.people.get(123);
+     * ```
+     */
+    async get(personId) {
+        const response = await this.request({
+            service: "People",
+            operation: "GetPerson",
+            resourceType: "person",
+            isMutation: false,
+            resourceId: personId,
+        }, () => this.client.GET("/people/{personId}", {
+            params: {
+                path: { personId },
+            },
+        }));
+        return response;
+    }
+    /**
+     * List all active people on a project
+     * @param projectId - The project ID
+     * @param options - Optional query parameters
+     * @returns All Person across all pages, with .meta.totalCount
+     *
+     * @example
+     * ```ts
+     * const result = await client.people.listForProject(123);
+     * ```
+     */
+    async listForProject(projectId, options) {
+        return this.requestPaginated({
+            service: "People",
+            operation: "ListProjectPeople",
+            resourceType: "project_people",
+            isMutation: false,
+            projectId,
+        }, () => this.client.GET("/projects/{projectId}/people.json", {
+            params: {
+                path: { projectId },
+            },
+        }), options);
+    }
+    /**
+     * Update project access (grant/revoke/create people)
+     * @param projectId - The project ID
+     * @param req - Project_access update parameters
+     * @returns The project_access
+     * @throws {BasecampError} If the resource is not found or fields are invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.people.updateProjectAccess(123, { });
+     * ```
+     */
+    async updateProjectAccess(projectId, req) {
+        const response = await this.request({
+            service: "People",
+            operation: "UpdateProjectAccess",
+            resourceType: "project_access",
+            isMutation: true,
+            projectId,
+        }, () => this.client.PUT("/projects/{projectId}/people/users.json", {
+            params: {
+                path: { projectId },
+            },
+            body: {
+                grant: req.grant,
+                revoke: req.revoke,
+                create: req.create,
+            },
+        }));
+        return response;
+    }
+    /**
+     * List people who can be assigned todos
+     * @returns Array of Person
+     *
+     * @example
+     * ```ts
+     * const result = await client.people.listAssignable();
+     * ```
+     */
+    async listAssignable() {
+        const response = await this.request({
+            service: "People",
+            operation: "ListAssignablePeople",
+            resourceType: "assignable_people",
+            isMutation: false,
+        }, () => this.client.GET("/reports/todos/assigned.json", {}));
+        return response ?? [];
+    }
+}
+//# sourceMappingURL=people.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"people.js","sourceRoot":"","sources":["../../../src/generated/services/people.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AA2CrD,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAE5C;;;;;;;;;OASG;IACH,KAAK,CAAC,YAAY,CAAC,OAAmC;QACpD,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,oBAAoB;YAC/B,YAAY,EAAE,iBAAiB;YAC/B,UAAU,EAAE,KAAK;SAClB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,sBAAsB,EAAE,EACvC,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE;QACN,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,cAAc;YACzB,YAAY,EAAE,YAAY;YAC1B,UAAU,EAAE,KAAK;SAClB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,kBAAkB,EAAE,EACnC,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,IAAI,CAAC,OAA2B;QACpC,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,YAAY;YACvB,YAAY,EAAE,QAAQ;YACtB,UAAU,EAAE,KAAK;SAClB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,cAAc,EAAE,EAC/B,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,CAAC,QAAgB;QACxB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,WAAW;YACtB,YAAY,EAAE,QAAQ;YACtB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,QAAQ;SACrB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,oBAAoB,EAAE;YACpC,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,QAAQ,EAAE;aACnB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,cAAc,CAAC,SAAiB,EAAE,OAAqC;QAC3E,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,mBAAmB;YAC9B,YAAY,EAAE,gBAAgB;YAC9B,UAAU,EAAE,KAAK;YACjB,SAAS;SACV,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mCAAmC,EAAE;YACnD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,SAAS,EAAE;aACpB;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,mBAAmB,CAAC,SAAiB,EAAE,GAAqC;QAChF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,qBAAqB;YAChC,YAAY,EAAE,gBAAgB;YAC9B,UAAU,EAAE,IAAI;YAChB,SAAS;SACV,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,yCAAyC,EAAE;YACzD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,SAAS,EAAE;aACpB;YACD,IAAI,EAAE;gBACJ,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,MAAM,EAAE,GAAG,CAAC,MAAM;aACnB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,cAAc;QAClB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,sBAAsB;YACjC,YAAY,EAAE,mBAAmB;YACjC,UAAU,EAAE,KAAK;SAClB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,8BAA8B,EAAE,EAC/C,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,IAAI,EAAE,CAAC;IACxB,CAAC;CACF"}