@typeship-ax/cli 0.20.0 → 0.21.1

package/src/resources/releases.ts

@@ -0,0 +1,199 @@
+// typeship — releases resource.
+// Generated by typeship — https://typeship.dev
+
+import { HttpCore, type RequestOptions } from "../core/http.js";
+import { paginate, PagePromise } from "../core/pagination.js";
+import {
+  ResponseParseError,
+  TransportError,
+  UnexpectedApiError,
+  ValidationError,
+  BadGatewayError,
+  BadRequestError,
+  ConflictError,
+  ForbiddenError,
+  InternalServerError,
+  NotFoundError,
+  RateLimitedError,
+  UnauthorizedError,
+} from "../errors.js";
+import type {
+  Release,
+  ReleaseId,
+  ReleaseList,
+  ReleaseListRead,
+  ReleaseRead,
+  ReleaseResponse,
+  ReleaseResponseRead,
+  TargetId,
+} from "../types.js";
+
+export class ReleasesResource {
+  constructor(private readonly _core: HttpCore) {}
+  /**
+   * List releases
+   *
+   * Auto-paginates: `for await (const item of …)` walks every page.
+   * `GET /releases`
+   */
+  list(params?: ReleasesListParams, options?: RequestOptions): PagePromise<ReleaseRead, ReleasesListError> {
+    return paginate<ReleaseRead, ReleasesListError>(this._core, {
+      method: "GET",
+      path: "/releases",
+      security: [{"apiKey":[]}],
+      query: {
+        limit: params?.limit,
+        cursor: params?.cursor,
+        target_id: params?.targetId,
+      },
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+      },
+      idempotent: true,
+      schemaKey: "releases.list",
+      options,
+    }, {
+      style: "cursor",
+      itemsField: "data",
+      cursorParam: "cursor",
+      nextCursorField: "next_cursor",
+      hasMoreField: "has_more",
+      limitParam: "limit",
+    });
+  }
+
+  /**
+   * Get an immutable release
+   * `GET /releases/{release_id}`
+   */
+  async get(releaseId: ReleaseId, options?: RequestOptions): Promise<ReleaseResponseRead> {
+    return this._core.requestData<ReleaseResponseRead, ReleasesGetError>({
+      method: "GET",
+      path: `/releases/${encodeURIComponent(String(releaseId))}`,
+      security: [{"apiKey":[]}],
+      errors: {
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+      },
+      idempotent: true,
+      schemaKey: "releases.get",
+      options,
+    });
+  }
+
+  /**
+   * Retry publishing an exact release
+   *
+   * Retries publishing the specified release through its repository workflow. Uses that release's
+   * version and accepted commit, even if a newer Draft or release exists.
+   *
+   * A `502` response means the repository publishing workflow could not be dispatched.
+   *
+   * A `Idempotency-Key` UUID is generated per call (stable across retries) unless you pass one.
+   * `POST /releases/{release_id}/republish`
+   */
+  async republish(
+    releaseId: ReleaseId,
+    params?: ReleasesRepublishParams,
+    options?: RequestOptions,
+  ): Promise<ReleaseResponseRead> {
+    return this._core.requestData<ReleaseResponseRead, ReleasesRepublishError>({
+      method: "POST",
+      path: `/releases/${encodeURIComponent(String(releaseId))}/republish`,
+      security: [{"apiKey":[]}],
+      headers: {
+        "Idempotency-Key": params?.idempotencyKey === undefined ? undefined : String(params?.idempotencyKey),
+      },
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "409": ConflictError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+        "502": BadGatewayError,
+      },
+      idempotencyKey: "Idempotency-Key",
+      schemaKey: "releases.republish",
+      options,
+    });
+  }
+}
+
+export interface ReleasesListParams {
+  /**
+   * 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 organization,
+   * 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 releases of this Target. */
+  targetId?: TargetId;
+}
+
+/** Typed errors `list` can throw. */
+export type ReleasesListError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+/** Typed errors `get` can throw. */
+export type ReleasesGetError =
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+export interface ReleasesRepublishParams {
+  /**
+   * Identifies one logical write for 24 hours. The key is scoped to the authenticated organization
+   * and operation; generation without an organization uses a hashed network identity. Retrying the
+   * same method, 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;
+}
+
+/** Typed errors `republish` can throw. */
+export type ReleasesRepublishError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | ConflictError
+  | RateLimitedError
+  | InternalServerError
+  | BadGatewayError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;

package/src/resources/spec-revisions.ts

@@ -0,0 +1,237 @@
+// typeship — specRevisions resource.
+// Generated by typeship — https://typeship.dev
+
+import { HttpCore, type RequestOptions } from "../core/http.js";
+import { paginate, PagePromise } from "../core/pagination.js";
+import {
+  ResponseParseError,
+  TransportError,
+  UnexpectedApiError,
+  ValidationError,
+  BadRequestError,
+  ForbiddenError,
+  InternalServerError,
+  NotFoundError,
+  RateLimitedError,
+  UnauthorizedError,
+} from "../errors.js";
+import type {
+  SpecId,
+  SpecRevision,
+  SpecRevisionFile,
+  SpecRevisionFileList,
+  SpecRevisionFileListRead,
+  SpecRevisionFileRead,
+  SpecRevisionId,
+  SpecRevisionList,
+  SpecRevisionListRead,
+  SpecRevisionRead,
+  SpecRevisionResponse,
+  SpecRevisionResponseRead,
+} from "../types.js";
+
+export class SpecRevisionsResource {
+  constructor(private readonly _core: HttpCore) {}
+  /**
+   * List Spec Revisions
+   *
+   * Lists Spec Revisions, newest first. Source content is not included; list a revision's files
+   * with listSpecRevisionFiles.
+   *
+   * Auto-paginates: `for await (const item of …)` walks every page.
+   * `GET /spec-revisions`
+   */
+  list(
+    params?: SpecRevisionsListParams,
+    options?: RequestOptions,
+  ): PagePromise<SpecRevisionRead, SpecRevisionsListError> {
+    return paginate<SpecRevisionRead, SpecRevisionsListError>(this._core, {
+      method: "GET",
+      path: "/spec-revisions",
+      security: [{"apiKey":[]}],
+      query: {
+        limit: params?.limit,
+        cursor: params?.cursor,
+        spec_id: params?.specId,
+      },
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+      },
+      idempotent: true,
+      schemaKey: "specRevisions.list",
+      options,
+    }, {
+      style: "cursor",
+      itemsField: "data",
+      cursorParam: "cursor",
+      nextCursorField: "next_cursor",
+      hasMoreField: "has_more",
+      limitParam: "limit",
+    });
+  }
+
+  /**
+   * Get a Spec Revision
+   *
+   * Returns metadata for a saved Spec Revision with a Diagnostics summary. Pass
+   * `include=diagnostics` to add every Diagnostic, evaluated with the Spec's current patches and
+   * Diagnostic policy. List its source files and resolved document with listSpecRevisionFiles.
+   * `GET /spec-revisions/{spec_revision_id}`
+   */
+  async get(
+    specRevisionId: SpecRevisionId,
+    params?: SpecRevisionsGetParams,
+    options?: RequestOptions,
+  ): Promise<SpecRevisionResponseRead> {
+    return this._core.requestData<SpecRevisionResponseRead, SpecRevisionsGetError>({
+      method: "GET",
+      path: `/spec-revisions/${encodeURIComponent(String(specRevisionId))}`,
+      security: [{"apiKey":[]}],
+      query: {
+        include: params?.include,
+      },
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+      },
+      idempotent: true,
+      schemaKey: "specRevisions.get",
+      options,
+    });
+  }
+
+  /**
+   * List a Spec Revision's files
+   *
+   * Lists the captured source files and the resolved document Typeship generated from, ordered by
+   * path. Read content with getFile.
+   *
+   * Auto-paginates: `for await (const item of …)` walks every page.
+   * `GET /spec-revisions/{spec_revision_id}/files`
+   */
+  listFiles(
+    specRevisionId: SpecRevisionId,
+    params?: SpecRevisionsListFilesParams,
+    options?: RequestOptions,
+  ): PagePromise<SpecRevisionFileRead, SpecRevisionsListFilesError> {
+    return paginate<SpecRevisionFileRead, SpecRevisionsListFilesError>(this._core, {
+      method: "GET",
+      path: `/spec-revisions/${encodeURIComponent(String(specRevisionId))}/files`,
+      security: [{"apiKey":[]}],
+      query: {
+        limit: params?.limit,
+        cursor: params?.cursor,
+      },
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+      },
+      idempotent: true,
+      schemaKey: "specRevisions.listFiles",
+      options,
+    }, {
+      style: "cursor",
+      itemsField: "data",
+      cursorParam: "cursor",
+      nextCursorField: "next_cursor",
+      hasMoreField: "has_more",
+      limitParam: "limit",
+    });
+  }
+}
+
+export interface SpecRevisionsListParams {
+  /**
+   * 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 organization,
+   * 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 revisions of this Spec. */
+  specId?: SpecId;
+}
+
+/** Typed errors `list` can throw. */
+export type SpecRevisionsListError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+export interface SpecRevisionsGetParams {
+  /**
+   * Add related data to the response. `diagnostics` adds the `diagnostics` and `patch_diagnostics`
+   * arrays.
+   */
+  include?: "diagnostics";
+}
+
+/** Typed errors `get` can throw. */
+export type SpecRevisionsGetError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+export interface SpecRevisionsListFilesParams {
+  /**
+   * 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 organization,
+   * 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;
+}
+
+/** Typed errors `listFiles` can throw. */
+export type SpecRevisionsListFilesError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;

package/src/resources/specs.ts

@@ -0,0 +1,200 @@
+// typeship — specs resource.
+// Generated by typeship — https://typeship.dev
+
+import { HttpCore, type RequestOptions } from "../core/http.js";
+import {
+  ResponseParseError,
+  TransportError,
+  UnexpectedApiError,
+  ValidationError,
+  BadGatewayError,
+  BadRequestError,
+  ConflictError,
+  ForbiddenError,
+  InternalServerError,
+  NotFoundError,
+  PreconditionFailedError,
+  RateLimitedError,
+  UnauthorizedError,
+  UnprocessableEntityError,
+} from "../errors.js";
+import type { Spec, SpecId, SpecRead, SpecUpdateRequest } from "../types.js";
+
+export class SpecsResource {
+  constructor(private readonly _core: HttpCore) {}
+  /**
+   * Get a Spec
+   * `GET /specs/{spec_id}`
+   */
+  async get(specId: SpecId, options?: RequestOptions): Promise<SpecRead> {
+    return this._core.requestData<SpecRead, SpecsGetError>({
+      method: "GET",
+      path: `/specs/${encodeURIComponent(String(specId))}`,
+      security: [{"apiKey":[]}],
+      errors: {
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+      },
+      idempotent: true,
+      schemaKey: "specs.get",
+      options,
+    });
+  }
+
+  /**
+   * Update and resolve a Spec
+   *
+   * Resolves the source files before saving the update and records a new Spec Revision when the
+   * source changes.
+   * Omitted fields remain unchanged; supplied objects and arrays replace the whole field.
+   * If the Spec or its Project configuration changes during validation, returns 409
+   * resource_changed without saving the rejected update. Retrieve the current Spec and Project,
+   * reconcile your changes,
+   * and submit a new request with a new Idempotency-Key if using one.
+   *
+   * See [conditional writes](https://typeship.dev/docs/typeship-api#conditional-writes) for ETag
+   * and If-Match.
+   *
+   * A `Idempotency-Key` UUID is generated per call (stable across retries) unless you pass one.
+   * `PATCH /specs/{spec_id}`
+   */
+  async update(
+    specId: SpecId,
+    body: SpecUpdateRequest,
+    params?: SpecsUpdateParams,
+    options?: RequestOptions,
+  ): Promise<SpecRead> {
+    return this._core.requestData<SpecRead, SpecsUpdateError>({
+      method: "PATCH",
+      path: `/specs/${encodeURIComponent(String(specId))}`,
+      security: [{"apiKey":[]}],
+      headers: {
+        "If-Match": params?.ifMatch === undefined ? undefined : String(params?.ifMatch),
+        "Idempotency-Key": params?.idempotencyKey === undefined ? undefined : String(params?.idempotencyKey),
+      },
+      body,
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "409": ConflictError,
+        "412": PreconditionFailedError,
+        "422": UnprocessableEntityError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+      },
+      idempotencyKey: "Idempotency-Key",
+      schemaKey: "specs.update",
+      options,
+    });
+  }
+
+  /**
+   * Refresh a Spec from its configured source
+   *
+   * Fetches the configured source now and creates a new Spec Revision only when its content
+   * changes. Diagnostics then reads that revision. If automatic generation is enabled, refresh
+   * queues generation for active Targets even when the source is unchanged.
+   *
+   * A `Idempotency-Key` UUID is generated per call (stable across retries) unless you pass one.
+   * `POST /specs/{spec_id}/refresh`
+   */
+  async refresh(specId: SpecId, params?: SpecsRefreshParams, options?: RequestOptions): Promise<SpecRead> {
+    return this._core.requestData<SpecRead, SpecsRefreshError>({
+      method: "POST",
+      path: `/specs/${encodeURIComponent(String(specId))}/refresh`,
+      security: [{"apiKey":[]}],
+      headers: {
+        "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,
+        "502": BadGatewayError,
+      },
+      idempotencyKey: "Idempotency-Key",
+      schemaKey: "specs.refresh",
+      options,
+    });
+  }
+}
+
+/** Typed errors `get` can throw. */
+export type SpecsGetError =
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+export interface SpecsUpdateParams {
+  /**
+   * 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;
+  /**
+   * Identifies one logical write for 24 hours. The key is scoped to the authenticated organization
+   * and operation; generation without an organization uses a hashed network identity. Retrying the
+   * same method, 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;
+}
+
+/** Typed errors `update` can throw. */
+export type SpecsUpdateError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | ConflictError
+  | PreconditionFailedError
+  | UnprocessableEntityError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+export interface SpecsRefreshParams {
+  /**
+   * Identifies one logical write for 24 hours. The key is scoped to the authenticated organization
+   * and operation; generation without an organization uses a hashed network identity. Retrying the
+   * same method, 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;
+}
+
+/** Typed errors `refresh` can throw. */
+export type SpecsRefreshError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | ConflictError
+  | UnprocessableEntityError
+  | RateLimitedError
+  | InternalServerError
+  | BadGatewayError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;