@typeship-ax/mcp 0.9.1 → 0.19.0

package/src/resources/generations.ts

@@ -1,5 +1,5 @@
 // typeship — generations resource.
-// Generated by typeship — https://typeship.dev — do not edit by hand.
+// Generated by typeship — https://typeship.dev
 
 import { HttpCore, type ApiResult, type RequestOptions } from "../core/http.js";
 import {
@@ -9,6 +9,7 @@ import {
   ValidationError,
   BadRequestError,
   ForbiddenError,
+  InternalServerError,
   NotFoundError,
   RateLimitedError,
   UnauthorizedError,
@@ -20,7 +21,10 @@ export class GenerationsResource {
   /**
    * Retrieve a generation
    *
-   * Includes the generated files when the generation succeeded.
+   * Returns the current Generation status. `queued` and `running` mean generation is still in
+   * progress. `succeeded` means generated files are saved, not that repository delivery or a Draft
+   * is complete. Successful results include files, or a file index when the package is too large to
+   * inline.
    * `GET /generations/{generation_id}`
    */
   async retrieve(
@@ -36,6 +40,7 @@ export class GenerationsResource {
         "403": ForbiddenError,
         "404": NotFoundError,
         "429": RateLimitedError,
+        "500": InternalServerError,
       },
       idempotent: true,
       schemaKey: "generations.retrieve",
@@ -46,8 +51,8 @@ export class GenerationsResource {
   /**
    * Fetch one file from a generation
    *
-   * Raw file content, for generations whose target was too large to inline (files_omitted true).
-   * The generation's files_index lists valid paths.
+   * Returns one file's raw content. Use a path from `files_index` when the Generation reports
+   * `files_omitted: true`.
    * `GET /generations/{generation_id}/file`
    */
   async retrieveFile(
@@ -68,12 +73,32 @@ export class GenerationsResource {
         "403": ForbiddenError,
         "404": NotFoundError,
         "429": RateLimitedError,
+        "500": InternalServerError,
       },
       idempotent: true,
       schemaKey: "generations.retrieveFile",
       options,
     });
   }
+
+/** Poll until files are generated or the Generation fails. */
+  async wait(
+    generationId: GenerationId,
+    options: RequestOptions & { intervalMs?: number; waitTimeoutMs?: number } = {},
+  ): Promise<ApiResult<GenerationResponseRead, GenerationsRetrieveError>> {
+    const { intervalMs = 1_000, waitTimeoutMs = 600_000, ...requestOptions } = options;
+    const deadline = Date.now() + waitTimeoutMs;
+    while (true) {
+      if (requestOptions.signal?.aborted) {
+        throw requestOptions.signal.reason ?? new Error("Generation wait aborted.");
+      }
+      const result = await this.retrieve(generationId, requestOptions);
+      if (!result.ok || (result.data.status !== "queued" && result.data.status !== "running")) return result;
+      if (Date.now() >= deadline) throw new Error("Timed out waiting for Generation " + generationId + ".");
+      await new Promise<void>((resolve) =>
+        setTimeout(resolve, Math.min(intervalMs, deadline - Date.now())));
+    }
+  }
 }
 
 /** Every error `retrieve` can produce, as a discriminated union. */
@@ -82,6 +107,7 @@ export type GenerationsRetrieveError =
   | ForbiddenError
   | NotFoundError
   | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError
@@ -99,6 +125,7 @@ export type GenerationsRetrieveFileError =
   | ForbiddenError
   | NotFoundError
   | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError

package/src/resources/projects.ts

@@ -1,5 +1,5 @@
 // typeship — projects resource.
-// Generated by typeship — https://typeship.dev — do not edit by hand.
+// Generated by typeship — https://typeship.dev
 
 import { HttpCore, type ApiResult, type RequestOptions } from "../core/http.js";
 import { paginate, PagePromise } from "../core/pagination.js";
@@ -14,7 +14,9 @@ import {
   ForbiddenError,
   InternalServerError,
   NotFoundError,
+  PayloadTooLargeError,
   PaymentRequiredError,
+  PreconditionFailedError,
   RateLimitedError,
   UnauthorizedError,
   UnprocessableEntityError,
@@ -28,6 +30,7 @@ import type {
   DiagnosticRemediationRequest,
   DiagnosticReport,
   DiagnosticReportRead,
+  GenerateProjectRequest,
   GenerationBatch,
   GenerationBatchRead,
   GenerationList,
@@ -72,6 +75,7 @@ export class ProjectsResource {
         "401": UnauthorizedError,
         "403": ForbiddenError,
         "429": RateLimitedError,
+        "500": InternalServerError,
       },
       idempotent: true,
       schemaKey: "projects.list",
@@ -89,10 +93,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`
@@ -129,7 +134,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(
@@ -145,6 +151,7 @@ export class ProjectsResource {
         "403": ForbiddenError,
         "404": NotFoundError,
         "429": RateLimitedError,
+        "500": InternalServerError,
       },
       idempotent: true,
       schemaKey: "projects.retrieve",
@@ -154,21 +161,35 @@ 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: ProjectId,
+    params?: ProjectsDeleteParams,
     options?: RequestOptions,
   ): Promise<ApiResult<DeletedProjectRead, ProjectsDeleteError>> {
     return this._core.request<DeletedProjectRead, ProjectsDeleteError>({
       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",
@@ -178,17 +199,34 @@ 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: ProjectId,
     body: UpdateProjectRequest,
+    params?: ProjectsUpdateParams,
     options?: RequestOptions,
   ): Promise<ApiResult<ProjectRead, ProjectsUpdateError>> {
     return this._core.request<ProjectRead, ProjectsUpdateError>({
       method: "PATCH",
       path: `/projects/${encodeURIComponent(String(projectId))}`,
       security: [{"apiKey":[]}],
+      headers: {
+        "If-Match": params?.ifMatch === undefined ? undefined : String(params?.ifMatch),
+      },
       body,
       errors: {
         "400": BadRequestError,
@@ -197,8 +235,10 @@ export class ProjectsResource {
         "403": ForbiddenError,
         "404": NotFoundError,
         "409": ConflictError,
+        "412": PreconditionFailedError,
         "422": UnprocessableEntityError,
         "429": RateLimitedError,
+        "500": InternalServerError,
         "502": BadGatewayError,
       },
       schemaKey: "projects.update",
@@ -209,10 +249,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(
@@ -228,6 +267,7 @@ export class ProjectsResource {
         "403": ForbiddenError,
         "404": NotFoundError,
         "429": RateLimitedError,
+        "500": InternalServerError,
       },
       idempotent: true,
       schemaKey: "projects.retrieveDiagnostics",
@@ -238,9 +278,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`
@@ -258,12 +297,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",
@@ -274,9 +315,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`
@@ -303,6 +346,7 @@ export class ProjectsResource {
         "409": ConflictError,
         "422": UnprocessableEntityError,
         "429": RateLimitedError,
+        "500": InternalServerError,
       },
       idempotencyKey: "Idempotency-Key",
       schemaKey: "projects.remediateDiagnostics",
@@ -313,9 +357,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(
@@ -331,6 +374,7 @@ export class ProjectsResource {
         "403": ForbiddenError,
         "404": NotFoundError,
         "429": RateLimitedError,
+        "500": InternalServerError,
       },
       idempotent: true,
       schemaKey: "projects.retrieveIntegrationHealth",
@@ -364,6 +408,7 @@ export class ProjectsResource {
         "403": ForbiddenError,
         "404": NotFoundError,
         "429": RateLimitedError,
+        "500": InternalServerError,
       },
       idempotent: true,
       schemaKey: "projects.listGenerations",
@@ -379,21 +424,25 @@ 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: ProjectId,
+    body?: GenerateProjectRequest,
     params?: ProjectsGenerateParams,
     options?: RequestOptions,
   ): Promise<ApiResult<GenerationBatchRead, ProjectsGenerateError>> {
@@ -404,15 +453,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",
@@ -422,11 +475,18 @@ export class ProjectsResource {
 }
 
 export interface ProjectsListParams {
-  /** Maximum number of resources to return. */
+  /**
+   * Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits
+   * representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400
+   * invalid_request. List query parameters must appear only once; unrecognized parameters also
+   * return 400.
+   */
   limit?: number;
   /**
    * Opaque cursor from the preceding page's next_cursor. Valid only for the same account,
-   * operation, filters, and ordering that issued it.
+   * operation, filters, and ordering that issued it. Omit to start at the first page. Empty,
+   * malformed, or repeated cursors return 400 invalid_request. The page limit may change between
+   * requests.
    */
   cursor?: string;
 }
@@ -437,6 +497,7 @@ export type ProjectsListError =
   | UnauthorizedError
   | ForbiddenError
   | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError
@@ -446,8 +507,8 @@ export interface ProjectsCreateParams {
   /**
    * Identifies one logical write for 24 hours. The key is scoped to the authenticated account and
    * operation; account-less generation uses a hashed network identity. Retrying the same method,
-   * path, query, and JSON body replays the original response. Reusing the key with changed intent
-   * returns 409. After expiry the key starts a new write.
+   * path, query, If-Match header, and JSON body replays the original response. Reusing the key with
+   * changed intent returns 409. After expiry the key starts a new write.
    */
   idempotencyKey?: string;
 }
@@ -473,22 +534,45 @@ export type ProjectsRetrieveError =
   | ForbiddenError
   | NotFoundError
   | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError
   | ValidationError;
 
+export interface ProjectsDeleteParams {
+  /**
+   * ETag from a preceding response. The write applies only if the resource still has that version;
+   * otherwise it returns 412 precondition_failed without changes. Omit to write the current
+   * version. See https://typeship.dev/docs/typeship-api#conditional-writes.
+   */
+  ifMatch?: string;
+}
+
 /** Every error `delete` can produce, as a discriminated union. */
 export type ProjectsDeleteError =
+  | BadRequestError
   | UnauthorizedError
   | ForbiddenError
   | NotFoundError
+  | PreconditionFailedError
   | RateLimitedError
+  | InternalServerError
+  | BadGatewayError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError
   | ValidationError;
 
+export interface ProjectsUpdateParams {
+  /**
+   * ETag from a preceding response. The write applies only if the resource still has that version;
+   * otherwise it returns 412 precondition_failed without changes. Omit to write the current
+   * version. See https://typeship.dev/docs/typeship-api#conditional-writes.
+   */
+  ifMatch?: string;
+}
+
 /** Every error `update` can produce, as a discriminated union. */
 export type ProjectsUpdateError =
   | BadRequestError
@@ -497,8 +581,10 @@ export type ProjectsUpdateError =
   | ForbiddenError
   | NotFoundError
   | ConflictError
+  | PreconditionFailedError
   | UnprocessableEntityError
   | RateLimitedError
+  | InternalServerError
   | BadGatewayError
   | UnexpectedApiError
   | ResponseParseError
@@ -511,6 +597,7 @@ export type ProjectsRetrieveDiagnosticsError =
   | ForbiddenError
   | NotFoundError
   | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError
@@ -520,20 +607,22 @@ export interface ProjectsRefreshDiagnosticsParams {
   /**
    * Identifies one logical write for 24 hours. The key is scoped to the authenticated account and
    * operation; account-less generation uses a hashed network identity. Retrying the same method,
-   * path, query, and JSON body replays the original response. Reusing the key with changed intent
-   * returns 409. After expiry the key starts a new write.
+   * path, query, If-Match header, and JSON body replays the original response. Reusing the key with
+   * changed intent returns 409. After expiry the key starts a new write.
    */
   idempotencyKey?: string;
 }
 
 /** Every error `refreshDiagnostics` can produce, as a discriminated union. */
 export type ProjectsRefreshDiagnosticsError =
+  | BadRequestError
   | UnauthorizedError
   | ForbiddenError
   | NotFoundError
   | ConflictError
   | UnprocessableEntityError
   | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError
@@ -543,8 +632,8 @@ export interface ProjectsRemediateDiagnosticsParams {
   /**
    * Identifies one logical write for 24 hours. The key is scoped to the authenticated account and
    * operation; account-less generation uses a hashed network identity. Retrying the same method,
-   * path, query, and JSON body replays the original response. Reusing the key with changed intent
-   * returns 409. After expiry the key starts a new write.
+   * path, query, If-Match header, and JSON body replays the original response. Reusing the key with
+   * changed intent returns 409. After expiry the key starts a new write.
    */
   idempotencyKey?: string;
 }
@@ -558,6 +647,7 @@ export type ProjectsRemediateDiagnosticsError =
   | ConflictError
   | UnprocessableEntityError
   | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError
@@ -569,17 +659,25 @@ export type ProjectsRetrieveIntegrationHealthError =
   | ForbiddenError
   | NotFoundError
   | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError
   | ValidationError;
 
 export interface ProjectsListGenerationsParams {
-  /** Maximum number of resources to return. */
+  /**
+   * Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits
+   * representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400
+   * invalid_request. List query parameters must appear only once; unrecognized parameters also
+   * return 400.
+   */
   limit?: number;
   /**
    * Opaque cursor from the preceding page's next_cursor. Valid only for the same account,
-   * operation, filters, and ordering that issued it.
+   * operation, filters, and ordering that issued it. Omit to start at the first page. Empty,
+   * malformed, or repeated cursors return 400 invalid_request. The page limit may change between
+   * requests.
    */
   cursor?: string;
   /** Only generations for this persisted Target. */
@@ -593,6 +691,7 @@ export type ProjectsListGenerationsError =
   | ForbiddenError
   | NotFoundError
   | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError
@@ -602,22 +701,25 @@ export interface ProjectsGenerateParams {
   /**
    * Identifies one logical write for 24 hours. The key is scoped to the authenticated account and
    * operation; account-less generation uses a hashed network identity. Retrying the same method,
-   * path, query, and JSON body replays the original response. Reusing the key with changed intent
-   * returns 409. After expiry the key starts a new write.
+   * path, query, If-Match header, and JSON body replays the original response. Reusing the key with
+   * changed intent returns 409. After expiry the key starts a new write.
    */
   idempotencyKey?: string;
 }
 
 /** Every error `generate` can produce, as a discriminated union. */
 export type ProjectsGenerateError =
+  | BadRequestError
   | UnauthorizedError
   | PaymentRequiredError
   | ForbiddenError
   | NotFoundError
   | ConflictError
+  | PayloadTooLargeError
   | UnprocessableEntityError
   | RateLimitedError
   | InternalServerError
+  | BadGatewayError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError