@typeship-ax/mcp 0.10.0 → 0.19.0

package/dist/resources/projects.js

@@ -1,7 +1,7 @@
 // typeship — projects resource.
-// Generated by typeship — https://typeship.dev — do not edit by hand.
+// Generated by typeship — https://typeship.dev
 import { paginate } from "../core/pagination.js";
-import { BadGatewayError, BadRequestError, ConflictError, ForbiddenError, InternalServerError, NotFoundError, PaymentRequiredError, RateLimitedError, UnauthorizedError, UnprocessableEntityError, } from "../errors.js";
+import { BadGatewayError, BadRequestError, ConflictError, ForbiddenError, InternalServerError, NotFoundError, PayloadTooLargeError, PaymentRequiredError, PreconditionFailedError, RateLimitedError, UnauthorizedError, UnprocessableEntityError, } from "../errors.js";
 export class ProjectsResource {
     _core;
     constructor(_core) {
@@ -27,6 +27,7 @@ export class ProjectsResource {
                 "401": UnauthorizedError,
                 "403": ForbiddenError,
                 "429": RateLimitedError,
+                "500": InternalServerError,
             },
             idempotent: true,
             schemaKey: "projects.list",
@@ -43,10 +44,11 @@ export class ProjectsResource {
     /**
      * Create a project
      *
-     * Stores a URL- or GitHub-sourced project. Free includes one stored project, every selected
-     * target, and the first 25 operations, while keeping manual and automatic regeneration, history,
-     * destination pull requests, and preview checks. Stateless POST /generate does not consume this
-     * slot. Pro adds projects and generates every operation in the Definition.
+     * Creates a Project from a URL or GitHub Definition.
+     *
+     * Free includes one saved Project, all selected Targets, and the first 25 operations per Target,
+     * with regeneration, history, delivery pull requests, and previews. Pro supports additional
+     * Projects and all operations. One-shot generation does not use a Project slot.
      *
      * A `Idempotency-Key` UUID is generated per call (stable across retries) unless you pass one.
      * `POST /projects`
@@ -78,7 +80,8 @@ export class ProjectsResource {
     /**
      * Retrieve a project
      *
-     * Returns Project-owned fields only. List Targets separately for Target and Delivery data.
+     * Returns the Project's settings and Definition ID. List its Targets separately to retrieve
+     * Target configuration and Deliveries.
      * `GET /projects/{project_id}`
      */
     async retrieve(projectId, options) {
@@ -91,6 +94,7 @@ export class ProjectsResource {
                 "403": ForbiddenError,
                 "404": NotFoundError,
                 "429": RateLimitedError,
+                "500": InternalServerError,
             },
             idempotent: true,
             schemaKey: "projects.retrieve",
@@ -99,18 +103,31 @@ export class ProjectsResource {
     }
     /**
      * Delete a project
+     *
+     * A `502` response means the Project was not deleted because its release pull requests could not
+     * be retired. Retry deletion to finish retiring the remaining reviews. Repeating a completed
+     * deletion returns `404`.
+     * See [conditional writes](https://typeship.dev/docs/typeship-api#conditional-writes) for ETag
+     * and If-Match.
      * `DELETE /projects/{project_id}`
      */
-    async delete(projectId, options) {
+    async delete(projectId, params, options) {
         return this._core.request({
             method: "DELETE",
             path: `/projects/${encodeURIComponent(String(projectId))}`,
             security: [{ "apiKey": [] }],
+            headers: {
+                "If-Match": params?.ifMatch === undefined ? undefined : String(params?.ifMatch),
+            },
             errors: {
+                "400": BadRequestError,
                 "401": UnauthorizedError,
                 "403": ForbiddenError,
                 "404": NotFoundError,
+                "412": PreconditionFailedError,
                 "429": RateLimitedError,
+                "500": InternalServerError,
+                "502": BadGatewayError,
             },
             idempotent: true,
             schemaKey: "projects.delete",
@@ -119,13 +136,29 @@ export class ProjectsResource {
     }
     /**
      * Update a project
+     *
+     * Omitted fields keep their current values. A supplied config replaces the entire stored object;
+     * null or an empty object clears it.
+     * Omitting If-Match applies the update to the current resource; with If-Match, a stale ETag
+     * returns 412 precondition_failed without saving.
+     *
+     * A `409 target_busy` means a Target is publishing. Retrieve the Project, wait for publication to
+     * finish, reconcile your update, and retry.
+     * A `502` response means the Project was saved, but an obsolete release pull request could not be
+     * retired. Retrieve the Project and retry the same update to finish retiring reviews if that
+     * update is still desired.
+     * See [conditional writes](https://typeship.dev/docs/typeship-api#conditional-writes) for ETag
+     * and If-Match.
      * `PATCH /projects/{project_id}`
      */
-    async update(projectId, body, options) {
+    async update(projectId, body, params, options) {
         return this._core.request({
             method: "PATCH",
             path: `/projects/${encodeURIComponent(String(projectId))}`,
             security: [{ "apiKey": [] }],
+            headers: {
+                "If-Match": params?.ifMatch === undefined ? undefined : String(params?.ifMatch),
+            },
             body,
             errors: {
                 "400": BadRequestError,
@@ -134,8 +167,10 @@ export class ProjectsResource {
                 "403": ForbiddenError,
                 "404": NotFoundError,
                 "409": ConflictError,
+                "412": PreconditionFailedError,
                 "422": UnprocessableEntityError,
                 "429": RateLimitedError,
+                "500": InternalServerError,
                 "502": BadGatewayError,
             },
             schemaKey: "projects.update",
@@ -145,10 +180,9 @@ export class ProjectsResource {
     /**
      * Analyze a project's latest Definition Revision
      *
-     * Runs deterministic OpenAPI or GraphQL authorship checks against the latest observed immutable
-     * Definition Revision after applying the Definition's existing patches. Diagnostics group every
-     * affected location under a stable rule. Exact patches are included only when Typeship can derive
-     * the change without inventing API behavior.
+     * Checks the latest Definition Revision after applying its saved patches. Each finding groups
+     * affected locations under a stable rule ID. A suggested patch is included only when the
+     * Definition provides enough information to determine the correction.
      * `GET /projects/{project_id}/diagnostics`
      */
     async retrieveDiagnostics(projectId, options) {
@@ -161,6 +195,7 @@ export class ProjectsResource {
                 "403": ForbiddenError,
                 "404": NotFoundError,
                 "429": RateLimitedError,
+                "500": InternalServerError,
             },
             idempotent: true,
             schemaKey: "projects.retrieveDiagnostics",
@@ -170,9 +205,8 @@ export class ProjectsResource {
     /**
      * Refresh a project's Diagnostics from its configured source
      *
-     * Fetches the complete configured source, records a new immutable revision only when content
-     * changed, and returns its Diagnostics. This does not generate targets or consume a metered
-     * generation.
+     * Fetches the configured source and returns updated Diagnostics. Creates a Definition Revision
+     * only when the content changes. Does not generate Targets or use a metered generation.
      *
      * A `Idempotency-Key` UUID is generated per call (stable across retries) unless you pass one.
      * `POST /projects/{project_id}/diagnostics`
@@ -186,12 +220,14 @@ export class ProjectsResource {
                 "Idempotency-Key": params?.idempotencyKey === undefined ? undefined : String(params?.idempotencyKey),
             },
             errors: {
+                "400": BadRequestError,
                 "401": UnauthorizedError,
                 "403": ForbiddenError,
                 "404": NotFoundError,
                 "409": ConflictError,
                 "422": UnprocessableEntityError,
                 "429": RateLimitedError,
+                "500": InternalServerError,
             },
             idempotencyKey: "Idempotency-Key",
             schemaKey: "projects.refreshDiagnostics",
@@ -201,9 +237,11 @@ export class ProjectsResource {
     /**
      * Apply exact, reviewed diagnostic remediations
      *
-     * Applies only deterministic patches. Repository sources receive an updateable source pull
-     * request; URL sources receive project overlays. Diagnostics that require API-owner intent return
-     * 422 and include an authoring_brief in the Diagnostic instead.
+     * Applies reviewed patches from Diagnostics. For a repository source, opens or updates a source
+     * pull request. For a URL source, saves Definition patches.
+     *
+     * Findings that need an API-owner decision return `422`. Read the finding's `authoring_brief` and
+     * update the source instead.
      *
      * A `Idempotency-Key` UUID is generated per call (stable across retries) unless you pass one.
      * `POST /projects/{project_id}/diagnostics/remediations`
@@ -225,6 +263,7 @@ export class ProjectsResource {
                 "409": ConflictError,
                 "422": UnprocessableEntityError,
                 "429": RateLimitedError,
+                "500": InternalServerError,
             },
             idempotencyKey: "Idempotency-Key",
             schemaKey: "projects.remediateDiagnostics",
@@ -234,9 +273,8 @@ export class ProjectsResource {
     /**
      * Diagnose a project's repository integrations
      *
-     * Returns provider-neutral, machine-actionable source and destination access, Definition
-     * readability, source-approval label setup, required status names, and the latest durable webhook
-     * delivery. The Console renders this same result.
+     * Checks repository access, Definition readability, source-approval labels, and required checks.
+     * Includes the latest webhook delivery so you can investigate missing updates.
      * `GET /projects/{project_id}/integration-health`
      */
     async retrieveIntegrationHealth(projectId, options) {
@@ -249,6 +287,7 @@ export class ProjectsResource {
                 "403": ForbiddenError,
                 "404": NotFoundError,
                 "429": RateLimitedError,
+                "500": InternalServerError,
             },
             idempotent: true,
             schemaKey: "projects.retrieveIntegrationHealth",
@@ -277,6 +316,7 @@ export class ProjectsResource {
                 "403": ForbiddenError,
                 "404": NotFoundError,
                 "429": RateLimitedError,
+                "500": InternalServerError,
             },
             idempotent: true,
             schemaKey: "projects.listGenerations",
@@ -291,20 +331,23 @@ export class ProjectsResource {
         });
     }
     /**
-     * Generate targets and open pull requests
+     * Start generation for active Targets
+     *
+     * Queues one Generation per active Target and returns their IDs. Retrieve each Generation until
+     * its status moves from `queued` to `running` and then `succeeded` or `failed`. `succeeded` means
+     * generated files are saved; check Delivery and Draft status separately for repository delivery
+     * and pull requests. A Target already queued or running is returned without starting another
+     * Generation. A matching Idempotency-Key replay returns the same Generations with their current
+     * statuses.
      *
-     * Resolves the project's URL or GitHub source, generates every
-     * configured delivery package, stores each result in the project's history,
-     * and attempts to open a pull request in every configured destination.
-     * When the complete generated tree already matches a destination, no
-     * commit, branch, or pull request is created and that generation reports
-     * `pr_status: no_changes`. This is the same pipeline automatic
-     * regeneration runs after a source change.
+     * If the package already matches a destination and no Draft is open, delivery reports `pr_status:
+     * no_changes` without creating a commit, branch, or pull request. An existing Draft stays open.
+     * Automatic generation uses the same workflow.
      *
      * A `Idempotency-Key` UUID is generated per call (stable across retries) unless you pass one.
      * `POST /projects/{project_id}/generations`
      */
-    async generate(projectId, params, options) {
+    async generate(projectId, body, params, options) {
         return this._core.request({
             method: "POST",
             path: `/projects/${encodeURIComponent(String(projectId))}/generations`,
@@ -312,15 +355,19 @@ export class ProjectsResource {
             headers: {
                 "Idempotency-Key": params?.idempotencyKey === undefined ? undefined : String(params?.idempotencyKey),
             },
+            body,
             errors: {
+                "400": BadRequestError,
                 "401": UnauthorizedError,
                 "402": PaymentRequiredError,
                 "403": ForbiddenError,
                 "404": NotFoundError,
                 "409": ConflictError,
+                "413": PayloadTooLargeError,
                 "422": UnprocessableEntityError,
                 "429": RateLimitedError,
                 "500": InternalServerError,
+                "502": BadGatewayError,
             },
             idempotencyKey: "Idempotency-Key",
             schemaKey: "projects.generate",