@typeship-ax/cli 0.6.0

package/src/resources/api-keys.ts

@@ -0,0 +1,105 @@
+// typeship — apiKeys resource.
+// Generated by typeship — https://typeship.dev — do not edit by hand.
+
+import { HttpCore, type ApiResult, type RequestOptions } from "../core/http.js";
+import { paginate, PagePromise } from "../core/pagination.js";
+import {
+  TransportError,
+  UnexpectedApiError,
+  ValidationError,
+  BadRequestError,
+  ForbiddenError,
+  NotFoundError,
+  RateLimitedError,
+  UnauthorizedError,
+} from "../errors.js";
+import type { ApiKey, ApiKeyList } from "../types.js";
+
+export class ApiKeysResource {
+  constructor(private readonly _core: HttpCore) {}
+  /**
+   * List API keys
+   *
+   * Keys are never returned in full — only their identity and last four. Creation stays in the
+   * console deliberately: a leaked key that can mint more keys is a leaked account.
+   *
+   * Auto-paginates: `for await (const item of …)` walks every page.
+   * `GET /api_keys`
+   */
+  list(params?: ApiKeysListParams, options?: RequestOptions): PagePromise<ApiKey, ApiKeysListError> {
+    return paginate<ApiKey, ApiKeysListError>(this._core, {
+      method: "GET",
+      path: "/api_keys",
+      query: {
+        limit: params?.limit,
+        cursor: params?.cursor,
+      },
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "429": RateLimitedError,
+      },
+      idempotent: true,
+      schemaKey: "apiKeys.list",
+      options,
+    }, {
+      style: "cursor",
+      itemsField: "data",
+      cursorParam: "cursor",
+      nextCursorField: "next_cursor",
+      hasMoreField: "has_more",
+      limitParam: "limit",
+    });
+  }
+
+  /**
+   * Revoke an API key
+   *
+   * Idempotent: revoking an already-revoked key returns the same body, so a rotation script that
+   * re-runs does not have to special-case having already succeeded.
+   * `DELETE /api_keys/{api_key_id}`
+   */
+  async revoke(apiKeyId: string, options?: RequestOptions): Promise<ApiResult<ApiKey, ApiKeysRevokeError>> {
+    return this._core.request<ApiKey, ApiKeysRevokeError>({
+      method: "DELETE",
+      path: `/api_keys/${encodeURIComponent(String(apiKeyId))}`,
+      errors: {
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+      },
+      idempotent: true,
+      schemaKey: "apiKeys.revoke",
+      options,
+    });
+  }
+}
+
+export interface ApiKeysListParams {
+  /** Maximum number of resources to return. */
+  limit?: number;
+  /** Opaque cursor from the preceding page's next_cursor. */
+  cursor?: string;
+}
+
+/** Every error `list` can produce, as a discriminated union. */
+export type ApiKeysListError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | RateLimitedError
+  | UnexpectedApiError
+  | TransportError
+  | ValidationError;
+
+/** Every error `revoke` can produce, as a discriminated union. */
+export type ApiKeysRevokeError =
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | UnexpectedApiError
+  | TransportError
+  | ValidationError;

package/src/resources/generate.ts

@@ -0,0 +1,69 @@
+// typeship — generate resource.
+// Generated by typeship — https://typeship.dev — do not edit by hand.
+
+import { HttpCore, type ApiResult, type RequestOptions } from "../core/http.js";
+import {
+  TransportError,
+  UnexpectedApiError,
+  ValidationError,
+  ApiResponseError,
+  BadRequestError,
+  ForbiddenError,
+  PayloadTooLargeError,
+  RateLimitedError,
+  UnauthorizedError,
+  UnprocessableEntityError,
+} from "../errors.js";
+import type { GenerateRequest, GenerationResult } from "../types.js";
+
+export class GenerateResource {
+  constructor(private readonly _core: HttpCore) {}
+  /**
+   * Generate a package from a spec
+   *
+   * Stateless generation: nothing is stored. Returns the full generated
+   * package as files. Works without an API key: anonymous calls generate
+   * the first 25 operations, rate limited per IP address, and the
+   * response's `limits` object says what was held back and where to lift
+   * it; anonymous calls from a spec URL also carry `claim.url`, a link
+   * that turns the run into a project once a person signs in. With a key, the free plan generates
+   * the first 25 operations and
+   * paid plans generate the whole spec. A present but invalid key is a
+   * 401, not a downgrade to anonymous.
+   * `POST /generate`
+   */
+  async run(
+    body: GenerateRequest,
+    options?: RequestOptions,
+  ): Promise<ApiResult<GenerationResult, GenerateRunError>> {
+    return this._core.request<GenerationResult, GenerateRunError>({
+      method: "POST",
+      path: "/generate",
+      body,
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "413": PayloadTooLargeError,
+        "422": UnprocessableEntityError,
+        "429": RateLimitedError,
+        default: ApiResponseError,
+      },
+      schemaKey: "generate.run",
+      options,
+    });
+  }
+}
+
+/** Every error `run` can produce, as a discriminated union. */
+export type GenerateRunError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | PayloadTooLargeError
+  | UnprocessableEntityError
+  | RateLimitedError
+  | ApiResponseError
+  | UnexpectedApiError
+  | TransportError
+  | ValidationError;

package/src/resources/generations.ts

@@ -0,0 +1,100 @@
+// typeship — generations resource.
+// Generated by typeship — https://typeship.dev — do not edit by hand.
+
+import { HttpCore, type ApiResult, type RequestOptions } from "../core/http.js";
+import {
+  TransportError,
+  UnexpectedApiError,
+  ValidationError,
+  BadRequestError,
+  ForbiddenError,
+  NotFoundError,
+  RateLimitedError,
+  UnauthorizedError,
+} from "../errors.js";
+import type { Generation, GenerationId } from "../types.js";
+
+export class GenerationsResource {
+  constructor(private readonly _core: HttpCore) {}
+  /**
+   * Retrieve a generation
+   *
+   * Includes the generated files when the generation succeeded.
+   * `GET /generations/{generation_id}`
+   */
+  async retrieve(
+    generationId: GenerationId,
+    options?: RequestOptions,
+  ): Promise<ApiResult<Generation, GenerationsRetrieveError>> {
+    return this._core.request<Generation, GenerationsRetrieveError>({
+      method: "GET",
+      path: `/generations/${encodeURIComponent(String(generationId))}`,
+      errors: {
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+      },
+      idempotent: true,
+      schemaKey: "generations.retrieve",
+      options,
+    });
+  }
+
+  /**
+   * Fetch one file from a generation
+   *
+   * Raw file content, for generations whose output was too large to inline (files_omitted true).
+   * The generation's files_index lists valid paths.
+   * `GET /generations/{generation_id}/file`
+   */
+  async retrieveFile(
+    generationId: GenerationId,
+    params: GenerationsRetrieveFileParams,
+    options?: RequestOptions,
+  ): Promise<ApiResult<string, GenerationsRetrieveFileError>> {
+    return this._core.request<string, GenerationsRetrieveFileError>({
+      method: "GET",
+      path: `/generations/${encodeURIComponent(String(generationId))}/file`,
+      query: {
+        path: params.path,
+      },
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+      },
+      idempotent: true,
+      schemaKey: "generations.retrieveFile",
+      options,
+    });
+  }
+}
+
+/** Every error `retrieve` can produce, as a discriminated union. */
+export type GenerationsRetrieveError =
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | UnexpectedApiError
+  | TransportError
+  | ValidationError;
+
+export interface GenerationsRetrieveFileParams {
+  /** Repo-relative path inside the generated package. */
+  path: string;
+}
+
+/** Every error `retrieveFile` can produce, as a discriminated union. */
+export type GenerationsRetrieveFileError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | UnexpectedApiError
+  | TransportError
+  | ValidationError;

package/src/resources/projects.ts

@@ -0,0 +1,391 @@
+// typeship — projects resource.
+// Generated by typeship — https://typeship.dev — do not edit by hand.
+
+import { HttpCore, type ApiResult, type RequestOptions } from "../core/http.js";
+import { paginate, PagePromise } from "../core/pagination.js";
+import {
+  TransportError,
+  UnexpectedApiError,
+  ValidationError,
+  BadRequestError,
+  ConflictError,
+  ForbiddenError,
+  InternalServerError,
+  NotFoundError,
+  PaymentRequiredError,
+  RateLimitedError,
+  UnauthorizedError,
+  UnprocessableEntityError,
+} from "../errors.js";
+import type {
+  CreateProjectRequest,
+  DeletedProject,
+  Generation,
+  GenerationBatch,
+  GenerationList,
+  GithubIntegrationHealth,
+  OutputId,
+  Project,
+  ProjectId,
+  ProjectList,
+  UpdateProjectRequest,
+} from "../types.js";
+
+export class ProjectsResource {
+  constructor(private readonly _core: HttpCore) {}
+  /**
+   * List projects
+   *
+   * Auto-paginates: `for await (const item of …)` walks every page.
+   * `GET /projects`
+   */
+  list(params?: ProjectsListParams, options?: RequestOptions): PagePromise<Project, ProjectsListError> {
+    return paginate<Project, ProjectsListError>(this._core, {
+      method: "GET",
+      path: "/projects",
+      query: {
+        limit: params?.limit,
+        cursor: params?.cursor,
+      },
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "429": RateLimitedError,
+      },
+      idempotent: true,
+      schemaKey: "projects.list",
+      options,
+    }, {
+      style: "cursor",
+      itemsField: "data",
+      cursorParam: "cursor",
+      nextCursorField: "next_cursor",
+      hasMoreField: "has_more",
+      limitParam: "limit",
+    });
+  }
+
+  /**
+   * Create a project
+   *
+   * Stores a URL- or GitHub-sourced project. Free includes one stored project, every selected
+   * output, 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 the whole spec.
+   *
+   * A `Idempotency-Key` UUID is generated per call (stable across retries) unless you pass one.
+   * `POST /projects`
+   */
+  async create(
+    body: CreateProjectRequest,
+    params?: ProjectsCreateParams,
+    options?: RequestOptions,
+  ): Promise<ApiResult<Project, ProjectsCreateError>> {
+    return this._core.request<Project, ProjectsCreateError>({
+      method: "POST",
+      path: "/projects",
+      headers: {
+        "Idempotency-Key": params?.idempotencyKey === undefined ? undefined : String(params?.idempotencyKey),
+      },
+      body,
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "402": PaymentRequiredError,
+        "403": ForbiddenError,
+        "409": ConflictError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+      },
+      idempotencyKey: "Idempotency-Key",
+      schemaKey: "projects.create",
+      options,
+    });
+  }
+
+  /**
+   * Retrieve a project
+   * `GET /projects/{project_id}`
+   */
+  async retrieve(
+    projectId: ProjectId,
+    options?: RequestOptions,
+  ): Promise<ApiResult<Project, ProjectsRetrieveError>> {
+    return this._core.request<Project, ProjectsRetrieveError>({
+      method: "GET",
+      path: `/projects/${encodeURIComponent(String(projectId))}`,
+      errors: {
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+      },
+      idempotent: true,
+      schemaKey: "projects.retrieve",
+      options,
+    });
+  }
+
+  /**
+   * Delete a project
+   * `DELETE /projects/{project_id}`
+   */
+  async delete(
+    projectId: ProjectId,
+    options?: RequestOptions,
+  ): Promise<ApiResult<DeletedProject, ProjectsDeleteError>> {
+    return this._core.request<DeletedProject, ProjectsDeleteError>({
+      method: "DELETE",
+      path: `/projects/${encodeURIComponent(String(projectId))}`,
+      errors: {
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+      },
+      idempotent: true,
+      schemaKey: "projects.delete",
+      options,
+    });
+  }
+
+  /**
+   * Update a project
+   * `PATCH /projects/{project_id}`
+   */
+  async update(
+    projectId: ProjectId,
+    body: UpdateProjectRequest,
+    options?: RequestOptions,
+  ): Promise<ApiResult<Project, ProjectsUpdateError>> {
+    return this._core.request<Project, ProjectsUpdateError>({
+      method: "PATCH",
+      path: `/projects/${encodeURIComponent(String(projectId))}`,
+      body,
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "402": PaymentRequiredError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+      },
+      schemaKey: "projects.update",
+      options,
+    });
+  }
+
+  /**
+   * Diagnose a project's GitHub integration
+   *
+   * Returns machine-actionable source and destination access, spec readability, optional label
+   * setup, required status names, and the latest durable webhook delivery. The console renders this
+   * same result.
+   * `GET /projects/{project_id}/github`
+   */
+  async retrieveGithubHealth(
+    projectId: ProjectId,
+    options?: RequestOptions,
+  ): Promise<ApiResult<GithubIntegrationHealth, ProjectsRetrieveGithubHealthError>> {
+    return this._core.request<GithubIntegrationHealth, ProjectsRetrieveGithubHealthError>({
+      method: "GET",
+      path: `/projects/${encodeURIComponent(String(projectId))}/github`,
+      errors: {
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+      },
+      idempotent: true,
+      schemaKey: "projects.retrieveGithubHealth",
+      options,
+    });
+  }
+
+  /**
+   * List a project's generations
+   *
+   * Auto-paginates: `for await (const item of …)` walks every page.
+   * `GET /projects/{project_id}/generations`
+   */
+  listGenerations(
+    projectId: ProjectId,
+    params?: ProjectsListGenerationsParams,
+    options?: RequestOptions,
+  ): PagePromise<Generation, ProjectsListGenerationsError> {
+    return paginate<Generation, ProjectsListGenerationsError>(this._core, {
+      method: "GET",
+      path: `/projects/${encodeURIComponent(String(projectId))}/generations`,
+      query: {
+        limit: params?.limit,
+        cursor: params?.cursor,
+        output: params?.output,
+      },
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+      },
+      idempotent: true,
+      schemaKey: "projects.listGenerations",
+      options,
+    }, {
+      style: "cursor",
+      itemsField: "data",
+      cursorParam: "cursor",
+      nextCursorField: "next_cursor",
+      hasMoreField: "has_more",
+      limitParam: "limit",
+    });
+  }
+
+  /**
+   * Generate outputs and open pull requests
+   *
+   * Resolves the project's URL or repository 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.
+   * `POST /projects/{project_id}/generations`
+   */
+  async generate(
+    projectId: ProjectId,
+    options?: RequestOptions,
+  ): Promise<ApiResult<GenerationBatch, ProjectsGenerateError>> {
+    return this._core.request<GenerationBatch, ProjectsGenerateError>({
+      method: "POST",
+      path: `/projects/${encodeURIComponent(String(projectId))}/generations`,
+      errors: {
+        "401": UnauthorizedError,
+        "402": PaymentRequiredError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "422": UnprocessableEntityError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+      },
+      schemaKey: "projects.generate",
+      options,
+    });
+  }
+}
+
+export interface ProjectsListParams {
+  /** Maximum number of resources to return. */
+  limit?: number;
+  /** Opaque cursor from the preceding page's next_cursor. */
+  cursor?: string;
+}
+
+/** Every error `list` can produce, as a discriminated union. */
+export type ProjectsListError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | RateLimitedError
+  | UnexpectedApiError
+  | TransportError
+  | ValidationError;
+
+export interface ProjectsCreateParams {
+  /**
+   * Uniquely identifies this creation attempt. Retrying the same request with the same key returns
+   * the original response instead of creating another project. Reusing a key with different
+   * parameters returns 409.
+   */
+  idempotencyKey?: string;
+}
+
+/** Every error `create` can produce, as a discriminated union. */
+export type ProjectsCreateError =
+  | BadRequestError
+  | UnauthorizedError
+  | PaymentRequiredError
+  | ForbiddenError
+  | ConflictError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | TransportError
+  | ValidationError;
+
+/** Every error `retrieve` can produce, as a discriminated union. */
+export type ProjectsRetrieveError =
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | UnexpectedApiError
+  | TransportError
+  | ValidationError;
+
+/** Every error `delete` can produce, as a discriminated union. */
+export type ProjectsDeleteError =
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | UnexpectedApiError
+  | TransportError
+  | ValidationError;
+
+/** Every error `update` can produce, as a discriminated union. */
+export type ProjectsUpdateError =
+  | BadRequestError
+  | UnauthorizedError
+  | PaymentRequiredError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | UnexpectedApiError
+  | TransportError
+  | ValidationError;
+
+/** Every error `retrieveGithubHealth` can produce, as a discriminated union. */
+export type ProjectsRetrieveGithubHealthError =
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | UnexpectedApiError
+  | TransportError
+  | ValidationError;
+
+export interface ProjectsListGenerationsParams {
+  /** Maximum number of resources to return. */
+  limit?: number;
+  /** Opaque cursor from the preceding page's next_cursor. */
+  cursor?: string;
+  /** Only generations for this output. */
+  output?: OutputId;
+}
+
+/** Every error `listGenerations` can produce, as a discriminated union. */
+export type ProjectsListGenerationsError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | UnexpectedApiError
+  | TransportError
+  | ValidationError;
+
+/** Every error `generate` can produce, as a discriminated union. */
+export type ProjectsGenerateError =
+  | UnauthorizedError
+  | PaymentRequiredError
+  | ForbiddenError
+  | NotFoundError
+  | UnprocessableEntityError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | TransportError
+  | ValidationError;