@typeship-ax/cli 0.20.0 → 0.21.0

package/src/resources/api-keys.ts

@@ -1,7 +1,7 @@
 // typeship — apiKeys resource.
 // Generated by typeship — https://typeship.dev
 
-import { HttpCore, type ApiResult, type RequestOptions } from "../core/http.js";
+import { HttpCore, type RequestOptions } from "../core/http.js";
 import { paginate, PagePromise } from "../core/pagination.js";
 import {
   ResponseParseError,
@@ -66,16 +66,13 @@ export class ApiKeysResource {
   }
 
   /**
-   * Retrieve an API key
+   * Get an API key
    *
    * Returns the key summary and its ETag for conditional revocation.
    * `GET /api-keys/{api_key_id}`
    */
-  async retrieve(
-    apiKeyId: string,
-    options?: RequestOptions,
-  ): Promise<ApiResult<ApiKeyResponseRead, ApiKeysRetrieveError>> {
-    return this._core.request<ApiKeyResponseRead, ApiKeysRetrieveError>({
+  async get(apiKeyId: string, options?: RequestOptions): Promise<ApiKeyResponseRead> {
+    return this._core.requestData<ApiKeyResponseRead, ApiKeysGetError>({
       method: "GET",
       path: `/api-keys/${encodeURIComponent(String(apiKeyId))}`,
       security: [{"apiKey":[]}],
@@ -87,7 +84,7 @@ export class ApiKeysResource {
         "500": InternalServerError,
       },
       idempotent: true,
-      schemaKey: "apiKeys.retrieve",
+      schemaKey: "apiKeys.get",
       options,
     });
   }
@@ -98,7 +95,7 @@ export class ApiKeysResource {
    * Revokes a key. Repeating the request returns the same result.
    *
    * With OAuth, members can revoke their own keys; organization admins can revoke any key.
-   * Organization API keys can revoke any key in their account.
+   * Organization API keys can revoke any key in their organization.
    * See [conditional writes](https://typeship.dev/docs/typeship-api#conditional-writes) for ETag
    * and If-Match.
    * `DELETE /api-keys/{api_key_id}`
@@ -107,8 +104,8 @@ export class ApiKeysResource {
     apiKeyId: string,
     params?: ApiKeysRevokeParams,
     options?: RequestOptions,
-  ): Promise<ApiResult<ApiKeyResponseRead, ApiKeysRevokeError>> {
-    return this._core.request<ApiKeyResponseRead, ApiKeysRevokeError>({
+  ): Promise<ApiKeyResponseRead> {
+    return this._core.requestData<ApiKeyResponseRead, ApiKeysRevokeError>({
       method: "DELETE",
       path: `/api-keys/${encodeURIComponent(String(apiKeyId))}`,
       security: [{"apiKey":[]}],
@@ -140,7 +137,7 @@ export interface ApiKeysListParams {
    */
   limit?: number;
   /**
-   * Opaque cursor from the preceding page's next_cursor. Valid only for the same account,
+   * 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.
@@ -148,7 +145,7 @@ export interface ApiKeysListParams {
   cursor?: string;
 }
 
-/** Every error `list` can produce, as a discriminated union. */
+/** Typed errors `list` can throw. */
 export type ApiKeysListError =
   | BadRequestError
   | UnauthorizedError
@@ -160,8 +157,8 @@ export type ApiKeysListError =
   | TransportError
   | ValidationError;
 
-/** Every error `retrieve` can produce, as a discriminated union. */
-export type ApiKeysRetrieveError =
+/** Typed errors `get` can throw. */
+export type ApiKeysGetError =
   | UnauthorizedError
   | ForbiddenError
   | NotFoundError
@@ -181,7 +178,7 @@ export interface ApiKeysRevokeParams {
   ifMatch?: string;
 }
 
-/** Every error `revoke` can produce, as a discriminated union. */
+/** Typed errors `revoke` can throw. */
 export type ApiKeysRevokeError =
   | BadRequestError
   | UnauthorizedError

package/src/resources/deliveries.ts

@@ -0,0 +1,139 @@
+// typeship — deliveries 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 {
+  Delivery,
+  DeliveryId,
+  DeliveryList,
+  DeliveryListRead,
+  DeliveryRead,
+  DeliveryResponse,
+  DeliveryResponseRead,
+  TargetId,
+} from "../types.js";
+
+export class DeliveriesResource {
+  constructor(private readonly _core: HttpCore) {}
+  /**
+   * List Deliveries
+   *
+   * Auto-paginates: `for await (const item of …)` walks every page.
+   * `GET /deliveries`
+   */
+  list(
+    params?: DeliveriesListParams,
+    options?: RequestOptions,
+  ): PagePromise<DeliveryRead, DeliveriesListError> {
+    return paginate<DeliveryRead, DeliveriesListError>(this._core, {
+      method: "GET",
+      path: "/deliveries",
+      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: "deliveries.list",
+      options,
+    }, {
+      style: "cursor",
+      itemsField: "data",
+      cursorParam: "cursor",
+      nextCursorField: "next_cursor",
+      hasMoreField: "has_more",
+      limitParam: "limit",
+    });
+  }
+
+  /**
+   * Get a Delivery
+   *
+   * Returns the configured repository or hosted MCP Delivery for a Target. A Delivery in another
+   * organization returns 404 not_found.
+   * `GET /deliveries/{delivery_id}`
+   */
+  async get(deliveryId: DeliveryId, options?: RequestOptions): Promise<DeliveryResponseRead> {
+    return this._core.requestData<DeliveryResponseRead, DeliveriesGetError>({
+      method: "GET",
+      path: `/deliveries/${encodeURIComponent(String(deliveryId))}`,
+      security: [{"apiKey":[]}],
+      errors: {
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+      },
+      idempotent: true,
+      schemaKey: "deliveries.get",
+      options,
+    });
+  }
+}
+
+export interface DeliveriesListParams {
+  /**
+   * 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 Deliveries of this Target. */
+  targetId?: TargetId;
+}
+
+/** Typed errors `list` can throw. */
+export type DeliveriesListError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+/** Typed errors `get` can throw. */
+export type DeliveriesGetError =
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;

package/src/resources/drafts.ts

@@ -0,0 +1,422 @@
+// typeship — drafts 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,
+  PreconditionFailedError,
+  RateLimitedError,
+  UnauthorizedError,
+  UnprocessableEntityError,
+} from "../errors.js";
+import type {
+  Draft,
+  DraftFile,
+  DraftFileList,
+  DraftFileListRead,
+  DraftFileRead,
+  DraftId,
+  DraftList,
+  DraftListRead,
+  DraftRead,
+  DraftRecoverRequest,
+  DraftResolveRequest,
+  DraftResponse,
+  DraftResponseRead,
+  DraftStatus,
+  DraftUpdateRequest,
+  TargetId,
+} from "../types.js";
+
+export class DraftsResource {
+  constructor(private readonly _core: HttpCore) {}
+  /**
+   * List Drafts
+   *
+   * Lists open and merged Drafts, newest first. Each Target has one open Draft; each merge adds a
+   * merged Draft.
+   *
+   * Auto-paginates: `for await (const item of …)` walks every page.
+   * `GET /drafts`
+   */
+  list(params?: DraftsListParams, options?: RequestOptions): PagePromise<DraftRead, DraftsListError> {
+    return paginate<DraftRead, DraftsListError>(this._core, {
+      method: "GET",
+      path: "/drafts",
+      security: [{"apiKey":[]}],
+      query: {
+        limit: params?.limit,
+        cursor: params?.cursor,
+        target_id: params?.targetId,
+        status: params?.status,
+      },
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+      },
+      idempotent: true,
+      schemaKey: "drafts.list",
+      options,
+    }, {
+      style: "cursor",
+      itemsField: "data",
+      cursorParam: "cursor",
+      nextCursorField: "next_cursor",
+      hasMoreField: "has_more",
+      limitParam: "limit",
+    });
+  }
+
+  /**
+   * Get a Draft
+   *
+   * Returns the Draft's status. An open Draft also reports its typed reason when action is
+   * required, next version and its source, readiness, checks, and conflict counts. The response
+   * carries an `ETag`; send it in `If-Match` when updating the Draft to avoid changing a newer
+   * version selection.
+   * `GET /drafts/{draft_id}`
+   */
+  async get(draftId: DraftId, options?: RequestOptions): Promise<DraftResponseRead> {
+    return this._core.requestData<DraftResponseRead, DraftsGetError>({
+      method: "GET",
+      path: `/drafts/${encodeURIComponent(String(draftId))}`,
+      security: [{"apiKey":[]}],
+      errors: {
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+      },
+      idempotent: true,
+      schemaKey: "drafts.get",
+      options,
+    });
+  }
+
+  /**
+   * Select an exact Draft version or return to automatic versioning
+   *
+   * Checks your version choice against the required version bump, then regenerates the existing
+   * Draft pull request.
+   *
+   * Send the Draft's `ETag` in `If-Match` to reject an intervening change with 412
+   * precondition_failed before saving or regenerating. Omitting `If-Match` applies the selection to
+   * the current Draft. version_next is required; null restores automatic selection.
+   *
+   * A `502` response means the selected version was saved, but regeneration failed. Follow the
+   * error's retryable and suggested_action fields. Repeating an unfinished selection resumes
+   * generation; repeating a completed selection starts no new work. If using If-Match, retrieve the
+   * Draft and confirm the saved selection before retrying with its current ETag.
+   * A `409 draft_merged` means the Draft merged; retrieve the Target and select a version on its
+   * `draft_id`. A `409 target_busy` means the Target is publishing; wait and retry. A `409
+   * version_occupied` means the version is already released; retrieve the Draft and releases,
+   * choose a new version, and retry.
+   * See [conditional writes](https://typeship.dev/docs/typeship-api#conditional-writes) for ETag
+   * and If-Match.
+   * `PATCH /drafts/{draft_id}`
+   */
+  async update(
+    draftId: DraftId,
+    body: DraftUpdateRequest,
+    params?: DraftsUpdateParams,
+    options?: RequestOptions,
+  ): Promise<DraftResponseRead> {
+    return this._core.requestData<DraftResponseRead, DraftsUpdateError>({
+      method: "PATCH",
+      path: `/drafts/${encodeURIComponent(String(draftId))}`,
+      security: [{"apiKey":[]}],
+      headers: {
+        "If-Match": params?.ifMatch === undefined ? undefined : String(params?.ifMatch),
+      },
+      body,
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "409": ConflictError,
+        "412": PreconditionFailedError,
+        "422": UnprocessableEntityError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+        "502": BadGatewayError,
+      },
+      schemaKey: "drafts.update",
+      options,
+    });
+  }
+
+  /**
+   * List customized and conflicted files on a Draft
+   *
+   * Lists the Draft's files that differ from the last merged package or need a conflict decision,
+   * ordered by path, without file content. Each conflict names its kind, the saved decision, and
+   * the sides you can read with getFile. With `filter=history`, lists files affected by a
+   * default-branch history rewrite; the list is empty when none is pending.
+   *
+   * Returns `409 resource_changed` while Typeship is carrying the Draft's latest commit forward
+   * (status working), or when the Draft changes between pages.
+   *
+   * Auto-paginates: `for await (const item of …)` walks every page.
+   * `GET /drafts/{draft_id}/files`
+   */
+  listFiles(
+    draftId: DraftId,
+    params?: DraftsListFilesParams,
+    options?: RequestOptions,
+  ): PagePromise<DraftFileRead, DraftsListFilesError> {
+    return paginate<DraftFileRead, DraftsListFilesError>(this._core, {
+      method: "GET",
+      path: `/drafts/${encodeURIComponent(String(draftId))}/files`,
+      security: [{"apiKey":[]}],
+      query: {
+        filter: params?.filter,
+        limit: params?.limit,
+        cursor: params?.cursor,
+      },
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "409": ConflictError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+      },
+      idempotent: true,
+      schemaKey: "drafts.listFiles",
+      options,
+    }, {
+      style: "cursor",
+      itemsField: "data",
+      cursorParam: "cursor",
+      nextCursorField: "next_cursor",
+      hasMoreField: "has_more",
+      limitParam: "limit",
+    });
+  }
+
+  /**
+   * Resolve selected Draft files
+   *
+   * Resolves conflicts on the Draft's head_sha: keep yours or generated, or supply final content as
+   * text or, for binary files, base64. Choosing generated for a customized path replaces it with
+   * the generated file, or deletes a Draft-only file.
+   *
+   * Conflict decisions are saved together and can be replaced until applied. Choosing generated for
+   * customized paths commits those changes together on the Draft branch. Returns the Draft. When
+   * every conflict has a decision, `conflicts.decided` equals `conflicts.total` and Typeship
+   * continues the Draft and runs checks. Paths that already match the Draft change nothing.
+   * `POST /drafts/{draft_id}/resolve`
+   */
+  async resolve(
+    draftId: DraftId,
+    body: DraftResolveRequest,
+    options?: RequestOptions,
+  ): Promise<DraftResponseRead> {
+    return this._core.requestData<DraftResponseRead, DraftsResolveError>({
+      method: "POST",
+      path: `/drafts/${encodeURIComponent(String(draftId))}/resolve`,
+      security: [{"apiKey":[]}],
+      body,
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "409": ConflictError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+      },
+      schemaKey: "drafts.resolve",
+      options,
+    });
+  }
+
+  /**
+   * Approve recovery from rewritten default-branch history
+   *
+   * When the Draft has status `action_required` and reason `history_rewritten`, review affected
+   * files with `listDraftFiles` and `filter=history`, then approve with the Draft's
+   * `history_recovery` revisions. Approval saves the recovery without changing Git and returns the
+   * Draft; the next generation rebuilds it from the rewritten default branch. The previous Draft
+   * branch stays available, and overlapping code comes back as conflicts to resolve. A rewritten
+   * Draft branch alone needs no approval.
+   * `POST /drafts/{draft_id}/recover`
+   */
+  async recover(
+    draftId: DraftId,
+    body: DraftRecoverRequest,
+    options?: RequestOptions,
+  ): Promise<DraftResponseRead> {
+    return this._core.requestData<DraftResponseRead, DraftsRecoverError>({
+      method: "POST",
+      path: `/drafts/${encodeURIComponent(String(draftId))}/recover`,
+      security: [{"apiKey":[]}],
+      body,
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "409": ConflictError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+      },
+      schemaKey: "drafts.recover",
+      options,
+    });
+  }
+}
+
+export interface DraftsListParams {
+  /**
+   * 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 Drafts of this Target. */
+  targetId?: TargetId;
+  /** Only Drafts with this status. */
+  status?: DraftStatus;
+}
+
+/** Typed errors `list` can throw. */
+export type DraftsListError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+/** Typed errors `get` can throw. */
+export type DraftsGetError =
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+export interface DraftsUpdateParams {
+  /**
+   * 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;
+}
+
+/** Typed errors `update` can throw. */
+export type DraftsUpdateError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | ConflictError
+  | PreconditionFailedError
+  | UnprocessableEntityError
+  | RateLimitedError
+  | InternalServerError
+  | BadGatewayError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+export interface DraftsListFilesParams {
+  /**
+   * conflicted: conflicts only. customized: files that differ from the last merged package.
+   * history: files affected by a default-branch history rewrite. Omit for conflicted and customized
+   * files.
+   */
+  filter?: "conflicted" | "customized" | "history";
+  /**
+   * 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 DraftsListFilesError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | ConflictError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+/** Typed errors `resolve` can throw. */
+export type DraftsResolveError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | ConflictError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+/** Typed errors `recover` can throw. */
+export type DraftsRecoverError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | ConflictError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;