@37signals/basecamp 0.2.0

package/dist/generated/services/people.ts

@@ -0,0 +1,252 @@
+/**
+ * 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";
+
+// =============================================================================
+// Types
+// =============================================================================
+
+/** 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
+// =============================================================================
+
+/**
+ * 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?: ListPingablePeopleOptions): Promise<ListResult<Person>> {
+    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(): Promise<Person> {
+    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?: ListPeopleOptions): Promise<ListResult<Person>> {
+    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: number): Promise<Person> {
+    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: number, options?: ListForProjectPeopleOptions): Promise<ListResult<Person>> {
+    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: number, req: UpdateProjectAccessPeopleRequest): Promise<components["schemas"]["UpdateProjectAccessResponseContent"]> {
+    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(): Promise<Person[]> {
+    const response = await this.request(
+      {
+        service: "People",
+        operation: "ListAssignablePeople",
+        resourceType: "assignable_people",
+        isMutation: false,
+      },
+      () =>
+        this.client.GET("/reports/todos/assigned.json", {
+        })
+    );
+    return response ?? [];
+  }
+}

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

@@ -0,0 +1,109 @@
+/**
+ * Projects 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";
+/** Project entity from the Basecamp API. */
+export type Project = components["schemas"]["Project"];
+/**
+ * Options for list.
+ */
+export interface ListProjectOptions extends PaginationOptions {
+    /** Filter by status */
+    status?: "active" | "archived" | "trashed";
+}
+/**
+ * Request parameters for create.
+ */
+export interface CreateProjectRequest {
+    /** Display name */
+    name: string;
+    /** Rich text description (HTML) */
+    description?: string;
+}
+/**
+ * Request parameters for update.
+ */
+export interface UpdateProjectRequest {
+    /** Display name */
+    name: string;
+    /** Rich text description (HTML) */
+    description?: string;
+    /** Admissions */
+    admissions?: "invite" | "employee" | "team";
+    /** Schedule date range settings */
+    scheduleAttributes?: components["schemas"]["ScheduleAttributes"];
+}
+/**
+ * Service for Projects operations.
+ */
+export declare class ProjectsService extends BaseService {
+    /**
+     * List projects (active by default; optionally archived/trashed)
+     * @param options - Optional query parameters
+     * @returns All Project across all pages, with .meta.totalCount
+     *
+     * @example
+     * ```ts
+     * const result = await client.projects.list();
+     *
+     * // With options
+     * const filtered = await client.projects.list({ status: "active" });
+     * ```
+     */
+    list(options?: ListProjectOptions): Promise<ListResult<Project>>;
+    /**
+     * Create a new project
+     * @param req - Project creation parameters
+     * @returns The Project
+     * @throws {BasecampError} If required fields are missing or invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.projects.create({ name: "My example" });
+     * ```
+     */
+    create(req: CreateProjectRequest): Promise<Project>;
+    /**
+     * Get a single project by id
+     * @param projectId - The project ID
+     * @returns The Project
+     * @throws {BasecampError} If the resource is not found
+     *
+     * @example
+     * ```ts
+     * const result = await client.projects.get(123);
+     * ```
+     */
+    get(projectId: number): Promise<Project>;
+    /**
+     * Update an existing project
+     * @param projectId - The project ID
+     * @param req - Project update parameters
+     * @returns The Project
+     * @throws {BasecampError} If the resource is not found or fields are invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.projects.update(123, { name: "My example" });
+     * ```
+     */
+    update(projectId: number, req: UpdateProjectRequest): Promise<Project>;
+    /**
+     * Trash a project. Trashed items can be recovered.
+     * @param projectId - The project ID
+     * @returns void
+     * @throws {BasecampError} If the request fails
+     *
+     * @example
+     * ```ts
+     * await client.projects.trash(123);
+     * ```
+     */
+    trash(projectId: number): Promise<void>;
+}
+//# sourceMappingURL=projects.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"projects.d.ts","sourceRoot":"","sources":["../../../src/generated/services/projects.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;IAC3D,uBAAuB;IACvB,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB;IACjB,UAAU,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,MAAM,CAAC;IAC5C,mCAAmC;IACnC,kBAAkB,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,CAAC;CAClE;AAOD;;GAEG;AACH,qBAAa,eAAgB,SAAQ,WAAW;IAE9C;;;;;;;;;;;;OAYG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAkBtE;;;;;;;;;;OAUG;IACG,MAAM,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAsBzD;;;;;;;;;;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;IA4B5E;;;;;;;;;;OAUG;IACG,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAiB9C"}

package/dist/generated/services/projects.js

@@ -0,0 +1,153 @@
+/**
+ * Projects 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 Projects operations.
+ */
+export class ProjectsService extends BaseService {
+    /**
+     * List projects (active by default; optionally archived/trashed)
+     * @param options - Optional query parameters
+     * @returns All Project across all pages, with .meta.totalCount
+     *
+     * @example
+     * ```ts
+     * const result = await client.projects.list();
+     *
+     * // With options
+     * const filtered = await client.projects.list({ status: "active" });
+     * ```
+     */
+    async list(options) {
+        return this.requestPaginated({
+            service: "Projects",
+            operation: "ListProjects",
+            resourceType: "project",
+            isMutation: false,
+        }, () => this.client.GET("/projects.json", {
+            params: {
+                query: { status: options?.status },
+            },
+        }), options);
+    }
+    /**
+     * Create a new project
+     * @param req - Project creation parameters
+     * @returns The Project
+     * @throws {BasecampError} If required fields are missing or invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.projects.create({ name: "My example" });
+     * ```
+     */
+    async create(req) {
+        if (!req.name) {
+            throw Errors.validation("Name is required");
+        }
+        const response = await this.request({
+            service: "Projects",
+            operation: "CreateProject",
+            resourceType: "project",
+            isMutation: true,
+        }, () => this.client.POST("/projects.json", {
+            body: {
+                name: req.name,
+                description: req.description,
+            },
+        }));
+        return response;
+    }
+    /**
+     * Get a single project by id
+     * @param projectId - The project ID
+     * @returns The Project
+     * @throws {BasecampError} If the resource is not found
+     *
+     * @example
+     * ```ts
+     * const result = await client.projects.get(123);
+     * ```
+     */
+    async get(projectId) {
+        const response = await this.request({
+            service: "Projects",
+            operation: "GetProject",
+            resourceType: "project",
+            isMutation: false,
+            projectId,
+        }, () => this.client.GET("/projects/{projectId}", {
+            params: {
+                path: { projectId },
+            },
+        }));
+        return response;
+    }
+    /**
+     * Update an existing project
+     * @param projectId - The project ID
+     * @param req - Project update parameters
+     * @returns The Project
+     * @throws {BasecampError} If the resource is not found or fields are invalid
+     *
+     * @example
+     * ```ts
+     * const result = await client.projects.update(123, { name: "My example" });
+     * ```
+     */
+    async update(projectId, req) {
+        if (!req.name) {
+            throw Errors.validation("Name is required");
+        }
+        const response = await this.request({
+            service: "Projects",
+            operation: "UpdateProject",
+            resourceType: "project",
+            isMutation: true,
+            projectId,
+        }, () => this.client.PUT("/projects/{projectId}", {
+            params: {
+                path: { projectId },
+            },
+            body: {
+                name: req.name,
+                description: req.description,
+                admissions: req.admissions,
+                schedule_attributes: req.scheduleAttributes,
+            },
+        }));
+        return response;
+    }
+    /**
+     * Trash a project. Trashed items can be recovered.
+     * @param projectId - The project ID
+     * @returns void
+     * @throws {BasecampError} If the request fails
+     *
+     * @example
+     * ```ts
+     * await client.projects.trash(123);
+     * ```
+     */
+    async trash(projectId) {
+        await this.request({
+            service: "Projects",
+            operation: "TrashProject",
+            resourceType: "project",
+            isMutation: true,
+            projectId,
+        }, () => this.client.DELETE("/projects/{projectId}", {
+            params: {
+                path: { projectId },
+            },
+        }));
+    }
+}
+//# sourceMappingURL=projects.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"projects.js","sourceRoot":"","sources":["../../../src/generated/services/projects.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAIrD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AA0CzC,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,WAAW;IAE9C;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,IAAI,CAAC,OAA4B;QACrC,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,UAAU;YACnB,SAAS,EAAE,cAAc;YACzB,YAAY,EAAE,SAAS;YACvB,UAAU,EAAE,KAAK;SAClB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gBAAgB,EAAE;YAChC,MAAM,EAAE;gBACN,KAAK,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE;aACnC;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM,CAAC,GAAyB;QACpC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YACd,MAAM,MAAM,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC;QAC9C,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;SACjB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE;YACjC,IAAI,EAAE;gBACJ,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,WAAW,EAAE,GAAG,CAAC,WAAW;aAC7B;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,SAAS;SACV,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,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YACd,MAAM,MAAM,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC;QAC9C,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,SAAS;SACV,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,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,WAAW,EAAE,GAAG,CAAC,WAAW;gBAC5B,UAAU,EAAE,GAAG,CAAC,UAAU;gBAC1B,mBAAmB,EAAE,GAAG,CAAC,kBAAkB;aAC5C;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,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,SAAS;SACV,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,uBAAuB,EAAE;YAC1C,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,SAAS,EAAE;aACpB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;CACF"}