@typeship-ax/cli 0.10.0 → 0.20.0

package/dist/polling-login.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"polling-login.d.ts","sourceRoot":"","sources":["../src/polling-login.ts"],"names":[],"mappings":"AAGA,qBAAa,iBAAkB,SAAQ,KAAK;IAC9B,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,SAAS,GAAG,QAAQ,GAAG,kBAAkB,GAAG,gBAAgB;gBAAhF,IAAI,EAAE,WAAW,GAAG,SAAS,GAAG,QAAQ,GAAG,kBAAkB,GAAG,gBAAgB;CAItG;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAQhD;AAkCD,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,aAAa,EAAE,MAAM,EAAE,CAAC;IAClE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpD,MAAM,EAAE,MAAM,EAAE,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACxD;AACD,MAAM,WAAW,kBAAkB;IACjC,WAAW,EAAE,MAAM,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC/D,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CAChG;AAED;gFACgF;AAChF,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,iBAAiB,EAAE,WAAW,EAAE;IAC7E,SAAS,CAAC,KAAK,EAAE;QAAE,eAAe,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IACzF,MAAM,CAAC,EAAE,WAAW,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC1C,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAsD9B;AAED,MAAM,WAAW,kBAAkB;IAAG,OAAO,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE;AAEjH;kFACkF;AAClF,wBAAsB,qBAAqB,CAAC,MAAM,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,OAAO,GAAG,KAAK,CAAA;CAAE,EAAE,WAAW,EAAE;IAC3H,SAAS,CAAC,KAAK,EAAE;QAAE,eAAe,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IACvE,MAAM,CAAC,EAAE,WAAW,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC1C,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAkC9B"}
+{"version":3,"file":"polling-login.d.ts","sourceRoot":"","sources":["../src/polling-login.ts"],"names":[],"mappings":"AAGA,qBAAa,iBAAkB,SAAQ,KAAK;IAC9B,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,SAAS,GAAG,QAAQ,GAAG,kBAAkB,GAAG,gBAAgB;gBAAhF,IAAI,EAAE,WAAW,GAAG,SAAS,GAAG,QAAQ,GAAG,kBAAkB,GAAG,gBAAgB;CAItG;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAQhD;AAkCD,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,aAAa,EAAE,MAAM,EAAE,CAAC;IAClE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpD,MAAM,EAAE,MAAM,EAAE,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACxD;AACD,MAAM,WAAW,kBAAkB;IACjC,WAAW,EAAE,MAAM,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC/D,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CAChG;AAED;gFACgF;AAChF,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,iBAAiB,EAAE,WAAW,EAAE;IAC7E,SAAS,CAAC,KAAK,EAAE;QAAE,eAAe,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IACzF,MAAM,CAAC,EAAE,WAAW,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC1C,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAsD9B;AAED,MAAM,WAAW,kBAAkB;IAAG,OAAO,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE;AAEjH;kFACkF;AAClF,wBAAsB,qBAAqB,CAAC,MAAM,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,OAAO,GAAG,KAAK,CAAA;CAAE,EAAE,WAAW,EAAE;IAC3H,SAAS,CAAC,KAAK,EAAE;QAAE,eAAe,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IACvE,MAAM,CAAC,EAAE,WAAW,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC1C,GAAG,OAAO,CAAC,kBAAkB,CAAC,CA2C9B"}

package/dist/polling-login.js

@@ -176,7 +176,17 @@ export async function customBrowserApproval(config, interaction) {
             flow.check();
             if (Date.now() >= deadline)
                 throw new LoginPollingError("expired");
-            const result = await oauthJsonRequest(url + "/status", post({ session: start.session, code_verifier: verifier }), Math.min(15_000, deadline - Date.now()));
+            let result;
+            try {
+                result = await oauthJsonRequest(url + "/status", post({ session: start.session, code_verifier: verifier }), Math.min(15_000, deadline - Date.now()));
+            }
+            catch (error) {
+                flow.check();
+                if (error instanceof OAuthResponseError && error.code === "timed_out" && Date.now() >= deadline) {
+                    throw new LoginPollingError("expired");
+                }
+                throw error;
+            }
             flow.check();
             if (Date.now() >= deadline)
                 throw new LoginPollingError("expired");

package/dist/resources/account.d.ts

@@ -1,5 +1,5 @@
 import { HttpCore, type ApiResult, type RequestOptions } from "../core/http.js";
-import { ResponseParseError, TransportError, UnexpectedApiError, ValidationError, ForbiddenError, RateLimitedError, UnauthorizedError } from "../errors.js";
+import { ResponseParseError, TransportError, UnexpectedApiError, ValidationError, ForbiddenError, InternalServerError, RateLimitedError, UnauthorizedError } from "../errors.js";
 import type { AccountRead } from "../types.js";
 export declare class AccountResource {
     private readonly _core;
@@ -7,12 +7,12 @@ export declare class AccountResource {
     /**
      * The account behind the presented credentials
      *
-     * Returns the account that owns the presented API key. This is also the
-     * identity endpoint the generated typeship CLI's `whoami` calls.
+     * Returns the account associated with your credential. The Typeship CLI uses this endpoint for
+     * `whoami`.
      * `GET /me`
      */
     retrieve(options?: RequestOptions): Promise<ApiResult<AccountRead, AccountRetrieveError>>;
 }
 /** Every error `retrieve` can produce, as a discriminated union. */
-export type AccountRetrieveError = UnauthorizedError | ForbiddenError | RateLimitedError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
+export type AccountRetrieveError = UnauthorizedError | ForbiddenError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
 //# sourceMappingURL=account.d.ts.map

package/dist/resources/account.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../src/resources/account.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAW,WAAW,EAAE,MAAM,aAAa,CAAC;AAExD,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAC5C;;;;;;OAMG;IACG,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,WAAW,EAAE,oBAAoB,CAAC,CAAC;CAWhG;AAED,oEAAoE;AACpE,MAAM,MAAM,oBAAoB,GAC5B,iBAAiB,GACjB,cAAc,GACd,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC"}
+{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../src/resources/account.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,cAAc,EACd,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAW,WAAW,EAAE,MAAM,aAAa,CAAC;AAExD,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAC5C;;;;;;OAMG;IACG,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,WAAW,EAAE,oBAAoB,CAAC,CAAC;CAgBhG;AAED,oEAAoE;AACpE,MAAM,MAAM,oBAAoB,GAC5B,iBAAiB,GACjB,cAAc,GACd,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC"}

package/dist/resources/account.js

@@ -1,6 +1,6 @@
 // typeship — account resource.
-// Generated by typeship — https://typeship.dev — do not edit by hand.
-import { ForbiddenError, RateLimitedError, UnauthorizedError, } from "../errors.js";
+// Generated by typeship — https://typeship.dev
+import { ForbiddenError, InternalServerError, RateLimitedError, UnauthorizedError, } from "../errors.js";
 export class AccountResource {
     _core;
     constructor(_core) {
@@ -9,8 +9,8 @@ export class AccountResource {
     /**
      * The account behind the presented credentials
      *
-     * Returns the account that owns the presented API key. This is also the
-     * identity endpoint the generated typeship CLI's `whoami` calls.
+     * Returns the account associated with your credential. The Typeship CLI uses this endpoint for
+     * `whoami`.
      * `GET /me`
      */
     async retrieve(options) {
@@ -18,7 +18,12 @@ export class AccountResource {
             method: "GET",
             path: "/me",
             security: [{ "apiKey": [] }],
-            errors: { "401": UnauthorizedError, "403": ForbiddenError, "429": RateLimitedError },
+            errors: {
+                "401": UnauthorizedError,
+                "403": ForbiddenError,
+                "429": RateLimitedError,
+                "500": InternalServerError,
+            },
             idempotent: true,
             schemaKey: "account.retrieve",
             options,

package/dist/resources/api-keys.d.ts

@@ -1,6 +1,6 @@
 import { HttpCore, type ApiResult, type RequestOptions } from "../core/http.js";
 import { PagePromise } from "../core/pagination.js";
-import { ResponseParseError, TransportError, UnexpectedApiError, ValidationError, BadRequestError, ForbiddenError, NotFoundError, RateLimitedError, UnauthorizedError } from "../errors.js";
+import { ResponseParseError, TransportError, UnexpectedApiError, ValidationError, BadRequestError, ForbiddenError, InternalServerError, NotFoundError, PreconditionFailedError, RateLimitedError, UnauthorizedError } from "../errors.js";
 import type { ApiKeyRead, ApiKeyResponseRead } from "../types.js";
 export declare class ApiKeysResource {
     private readonly _core;
@@ -8,35 +8,61 @@ export declare class ApiKeysResource {
     /**
      * 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.
+     * Lists key metadata and the last four characters of each key. Full keys are not returned. Create
+     * keys in the Console.
      *
      * Auto-paginates: `for await (const item of …)` walks every page.
-     * `GET /api_keys`
+     * `GET /api-keys`
      */
     list(params?: ApiKeysListParams, options?: RequestOptions): PagePromise<ApiKeyRead, ApiKeysListError>;
+    /**
+     * Retrieve an API key
+     *
+     * Returns the key summary and its ETag for conditional revocation.
+     * `GET /api-keys/{api_key_id}`
+     */
+    retrieve(apiKeyId: string, options?: RequestOptions): Promise<ApiResult<ApiKeyResponseRead, ApiKeysRetrieveError>>;
     /**
      * 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. An OAuth member may revoke a
-     * key they created; an organization admin may revoke any key. Organization API keys retain
-     * account-wide authority.
-     * `DELETE /api_keys/{api_key_id}`
+     * 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.
+     * See [conditional writes](https://typeship.dev/docs/typeship-api#conditional-writes) for ETag
+     * and If-Match.
+     * `DELETE /api-keys/{api_key_id}`
      */
-    revoke(apiKeyId: string, options?: RequestOptions): Promise<ApiResult<ApiKeyResponseRead, ApiKeysRevokeError>>;
+    revoke(apiKeyId: string, params?: ApiKeysRevokeParams, options?: RequestOptions): Promise<ApiResult<ApiKeyResponseRead, ApiKeysRevokeError>>;
 }
 export interface ApiKeysListParams {
-    /** 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;
 }
 /** Every error `list` can produce, as a discriminated union. */
-export type ApiKeysListError = BadRequestError | UnauthorizedError | ForbiddenError | RateLimitedError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
+export type ApiKeysListError = BadRequestError | UnauthorizedError | ForbiddenError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
+/** Every error `retrieve` can produce, as a discriminated union. */
+export type ApiKeysRetrieveError = UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
+export interface ApiKeysRevokeParams {
+    /**
+     * 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 `revoke` can produce, as a discriminated union. */
-export type ApiKeysRevokeError = UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
+export type ApiKeysRevokeError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | PreconditionFailedError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
 //# sourceMappingURL=api-keys.d.ts.map

package/dist/resources/api-keys.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api-keys.d.ts","sourceRoot":"","sources":["../../src/resources/api-keys.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EAAY,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAIV,UAAU,EAEV,kBAAkB,EACnB,MAAM,aAAa,CAAC;AAErB,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAC5C;;;;;;;;OAQG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC,UAAU,EAAE,gBAAgB,CAAC;IA4BrG;;;;;;;;OAQG;IACG,MAAM,CACV,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;CAgB9D;AAED,MAAM,WAAW,iBAAiB;IAChC,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,gEAAgE;AAChE,MAAM,MAAM,gBAAgB,GACxB,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,kEAAkE;AAClE,MAAM,MAAM,kBAAkB,GAC1B,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC"}
+{"version":3,"file":"api-keys.d.ts","sourceRoot":"","sources":["../../src/resources/api-keys.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EAAY,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,cAAc,EACd,mBAAmB,EACnB,aAAa,EACb,uBAAuB,EACvB,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAIV,UAAU,EAEV,kBAAkB,EACnB,MAAM,aAAa,CAAC;AAErB,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAC5C;;;;;;;;OAQG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC,UAAU,EAAE,gBAAgB,CAAC;IA6BrG;;;;;OAKG;IACG,QAAQ,CACZ,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,CAAC;IAkB/D;;;;;;;;;;OAUG;IACG,MAAM,CACV,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,mBAAmB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;CAsB9D;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,gEAAgE;AAChE,MAAM,MAAM,gBAAgB,GACxB,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,oEAAoE;AACpE,MAAM,MAAM,oBAAoB,GAC5B,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,kEAAkE;AAClE,MAAM,MAAM,kBAAkB,GAC1B,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,uBAAuB,GACvB,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC"}

package/dist/resources/api-keys.js

@@ -1,7 +1,7 @@
 // typeship — apiKeys 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 { BadRequestError, ForbiddenError, NotFoundError, RateLimitedError, UnauthorizedError, } from "../errors.js";
+import { BadRequestError, ForbiddenError, InternalServerError, NotFoundError, PreconditionFailedError, RateLimitedError, UnauthorizedError, } from "../errors.js";
 export class ApiKeysResource {
     _core;
     constructor(_core) {
@@ -10,16 +10,16 @@ export class ApiKeysResource {
     /**
      * 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.
+     * Lists key metadata and the last four characters of each key. Full keys are not returned. Create
+     * keys in the Console.
      *
      * Auto-paginates: `for await (const item of …)` walks every page.
-     * `GET /api_keys`
+     * `GET /api-keys`
      */
     list(params, options) {
         return paginate(this._core, {
             method: "GET",
-            path: "/api_keys",
+            path: "/api-keys",
             security: [{ "apiKey": [] }],
             query: {
                 limit: params?.limit,
@@ -30,6 +30,7 @@ export class ApiKeysResource {
                 "401": UnauthorizedError,
                 "403": ForbiddenError,
                 "429": RateLimitedError,
+                "500": InternalServerError,
             },
             idempotent: true,
             schemaKey: "apiKeys.list",
@@ -43,25 +44,56 @@ export class ApiKeysResource {
             limitParam: "limit",
         });
     }
+    /**
+     * Retrieve an API key
+     *
+     * Returns the key summary and its ETag for conditional revocation.
+     * `GET /api-keys/{api_key_id}`
+     */
+    async retrieve(apiKeyId, options) {
+        return this._core.request({
+            method: "GET",
+            path: `/api-keys/${encodeURIComponent(String(apiKeyId))}`,
+            security: [{ "apiKey": [] }],
+            errors: {
+                "401": UnauthorizedError,
+                "403": ForbiddenError,
+                "404": NotFoundError,
+                "429": RateLimitedError,
+                "500": InternalServerError,
+            },
+            idempotent: true,
+            schemaKey: "apiKeys.retrieve",
+            options,
+        });
+    }
     /**
      * 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. An OAuth member may revoke a
-     * key they created; an organization admin may revoke any key. Organization API keys retain
-     * account-wide authority.
-     * `DELETE /api_keys/{api_key_id}`
+     * 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.
+     * See [conditional writes](https://typeship.dev/docs/typeship-api#conditional-writes) for ETag
+     * and If-Match.
+     * `DELETE /api-keys/{api_key_id}`
      */
-    async revoke(apiKeyId, options) {
+    async revoke(apiKeyId, params, options) {
         return this._core.request({
             method: "DELETE",
-            path: `/api_keys/${encodeURIComponent(String(apiKeyId))}`,
+            path: `/api-keys/${encodeURIComponent(String(apiKeyId))}`,
             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,
             },
             idempotent: true,
             schemaKey: "apiKeys.revoke",

package/dist/resources/definition-revisions.d.ts

@@ -1,16 +1,15 @@
 import { HttpCore, type ApiResult, type RequestOptions } from "../core/http.js";
 import { PagePromise } from "../core/pagination.js";
-import { ResponseParseError, TransportError, UnexpectedApiError, ValidationError, BadRequestError, ForbiddenError, NotFoundError, RateLimitedError, UnauthorizedError } from "../errors.js";
-import type { DefinitionDocumentId, DefinitionId, DefinitionRevisionId, DefinitionRevisionRead, DefinitionRevisionResponseRead } from "../types.js";
+import { ResponseParseError, TransportError, UnexpectedApiError, ValidationError, BadRequestError, ForbiddenError, InternalServerError, NotFoundError, RateLimitedError, UnauthorizedError } from "../errors.js";
+import type { DefinitionDocumentId, DefinitionDocumentResponseRead, DefinitionId, DefinitionRevisionId, DefinitionRevisionRead, DefinitionRevisionResponseRead } from "../types.js";
 export declare class DefinitionRevisionsResource {
     private readonly _core;
     constructor(_core: HttpCore);
     /**
      * List Definition Revisions
      *
-     * Immutable snapshots of the complete resolved document graph this Definition observed, newest
-     * first. Content is available from the revision and document endpoints and is never embedded in a
-     * list response.
+     * Lists the Definition's revisions, newest first. Source content is not included; retrieve the
+     * revision content or individual documents separately.
      *
      * Auto-paginates: `for await (const item of …)` walks every page.
      * `GET /definitions/{definition_id}/revisions`
@@ -19,40 +18,58 @@ export declare class DefinitionRevisionsResource {
     /**
      * Retrieve a Definition Revision
      *
-     * Metadata for one immutable resolved document graph. Fetch its canonical content or individual
-     * source documents from the content endpoints.
-     * `GET /definition_revisions/{definition_revision_id}`
+     * Returns metadata for a saved Definition Revision. Retrieve its resolved content or individual
+     * source documents separately.
+     * `GET /definition-revisions/{definition_revision_id}`
      */
     retrieve(definitionRevisionId: DefinitionRevisionId, options?: RequestOptions): Promise<ApiResult<DefinitionRevisionResponseRead, DefinitionRevisionsRetrieveError>>;
     /**
      * Retrieve a Definition Revision's canonical content
      *
-     * Returns the exact canonical resolved content identified by the revision's graph digest,
-     * suitable for saving or piping into a diff.
-     * `GET /definition_revisions/{definition_revision_id}/content`
+     * Returns the saved, resolved content for this revision. Save it locally or compare it with
+     * another revision.
+     * `GET /definition-revisions/{definition_revision_id}/content`
      */
     retrieveContent(definitionRevisionId: DefinitionRevisionId, options?: RequestOptions): Promise<ApiResult<string, DefinitionRevisionsRetrieveContentError>>;
     /**
      * Retrieve one source document from a Definition Revision
-     * `GET /definition_revisions/{definition_revision_id}/documents/{document_id}/content`
+     * `GET /definition-revisions/{definition_revision_id}/documents/{document_id}/content`
      */
     retrieveDocumentContent(definitionRevisionId: DefinitionRevisionId, documentId: DefinitionDocumentId, options?: RequestOptions): Promise<ApiResult<string, DefinitionRevisionsRetrieveDocumentContentError>>;
+    /**
+     * Retrieve a Definition Document
+     *
+     * Returns metadata for one source document captured in a Definition Revision. Retrieve its
+     * content through the revision's document content endpoint. A document in another organization
+     * returns 404 not_found.
+     * `GET /definition-documents/{definition_document_id}`
+     */
+    retrieveDocument(definitionDocumentId: DefinitionDocumentId, options?: RequestOptions): Promise<ApiResult<DefinitionDocumentResponseRead, DefinitionRevisionsRetrieveDocumentError>>;
 }
 export interface DefinitionRevisionsListParams {
-    /** 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;
 }
 /** Every error `list` can produce, as a discriminated union. */
-export type DefinitionRevisionsListError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
+export type DefinitionRevisionsListError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
 /** Every error `retrieve` can produce, as a discriminated union. */
-export type DefinitionRevisionsRetrieveError = UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
+export type DefinitionRevisionsRetrieveError = UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
 /** Every error `retrieveContent` can produce, as a discriminated union. */
-export type DefinitionRevisionsRetrieveContentError = UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
+export type DefinitionRevisionsRetrieveContentError = UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
 /** Every error `retrieveDocumentContent` can produce, as a discriminated union. */
-export type DefinitionRevisionsRetrieveDocumentContentError = UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
+export type DefinitionRevisionsRetrieveDocumentContentError = UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
+/** Every error `retrieveDocument` can produce, as a discriminated union. */
+export type DefinitionRevisionsRetrieveDocumentError = UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
 //# sourceMappingURL=definition-revisions.d.ts.map

package/dist/resources/definition-revisions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"definition-revisions.d.ts","sourceRoot":"","sources":["../../src/resources/definition-revisions.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EAAY,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EACV,oBAAoB,EACpB,YAAY,EAEZ,oBAAoB,EAGpB,sBAAsB,EAEtB,8BAA8B,EAC/B,MAAM,aAAa,CAAC;AAErB,qBAAa,2BAA2B;IAC1B,OAAO,CAAC,QAAQ,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAC5C;;;;;;;;;OASG;IACH,IAAI,CACF,YAAY,EAAE,YAAY,EAC1B,MAAM,CAAC,EAAE,6BAA6B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sBAAsB,EAAE,4BAA4B,CAAC;IA6BpE;;;;;;OAMG;IACG,QAAQ,CACZ,oBAAoB,EAAE,oBAAoB,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,8BAA8B,EAAE,gCAAgC,CAAC,CAAC;IAiBvF;;;;;;OAMG;IACG,eAAe,CACnB,oBAAoB,EAAE,oBAAoB,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,uCAAuC,CAAC,CAAC;IAiBtE;;;OAGG;IACG,uBAAuB,CAC3B,oBAAoB,EAAE,oBAAoB,EAC1C,UAAU,EAAE,oBAAoB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,+CAA+C,CAAC,CAAC;CAgB/E;AAED,MAAM,WAAW,6BAA6B;IAC5C,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,gEAAgE;AAChE,MAAM,MAAM,4BAA4B,GACpC,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,oEAAoE;AACpE,MAAM,MAAM,gCAAgC,GACxC,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,2EAA2E;AAC3E,MAAM,MAAM,uCAAuC,GAC/C,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,mFAAmF;AACnF,MAAM,MAAM,+CAA+C,GACvD,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC"}
+{"version":3,"file":"definition-revisions.d.ts","sourceRoot":"","sources":["../../src/resources/definition-revisions.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EAAY,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,cAAc,EACd,mBAAmB,EACnB,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EACV,oBAAoB,EAEpB,8BAA8B,EAC9B,YAAY,EAEZ,oBAAoB,EAGpB,sBAAsB,EAEtB,8BAA8B,EAC/B,MAAM,aAAa,CAAC;AAErB,qBAAa,2BAA2B;IAC1B,OAAO,CAAC,QAAQ,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAC5C;;;;;;;;OAQG;IACH,IAAI,CACF,YAAY,EAAE,YAAY,EAC1B,MAAM,CAAC,EAAE,6BAA6B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sBAAsB,EAAE,4BAA4B,CAAC;IA8BpE;;;;;;OAMG;IACG,QAAQ,CACZ,oBAAoB,EAAE,oBAAoB,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,8BAA8B,EAAE,gCAAgC,CAAC,CAAC;IAkBvF;;;;;;OAMG;IACG,eAAe,CACnB,oBAAoB,EAAE,oBAAoB,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,uCAAuC,CAAC,CAAC;IAkBtE;;;OAGG;IACG,uBAAuB,CAC3B,oBAAoB,EAAE,oBAAoB,EAC1C,UAAU,EAAE,oBAAoB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,+CAA+C,CAAC,CAAC;IAkB9E;;;;;;;OAOG;IACG,gBAAgB,CACpB,oBAAoB,EAAE,oBAAoB,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,8BAA8B,EAAE,wCAAwC,CAAC,CAAC;CAiBhG;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,gEAAgE;AAChE,MAAM,MAAM,4BAA4B,GACpC,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,oEAAoE;AACpE,MAAM,MAAM,gCAAgC,GACxC,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,2EAA2E;AAC3E,MAAM,MAAM,uCAAuC,GAC/C,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,mFAAmF;AACnF,MAAM,MAAM,+CAA+C,GACvD,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,4EAA4E;AAC5E,MAAM,MAAM,wCAAwC,GAChD,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC"}

package/dist/resources/definition-revisions.js

@@ -1,7 +1,7 @@
 // typeship — definitionRevisions 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 { BadRequestError, ForbiddenError, NotFoundError, RateLimitedError, UnauthorizedError, } from "../errors.js";
+import { BadRequestError, ForbiddenError, InternalServerError, NotFoundError, RateLimitedError, UnauthorizedError, } from "../errors.js";
 export class DefinitionRevisionsResource {
     _core;
     constructor(_core) {
@@ -10,9 +10,8 @@ export class DefinitionRevisionsResource {
     /**
      * List Definition Revisions
      *
-     * Immutable snapshots of the complete resolved document graph this Definition observed, newest
-     * first. Content is available from the revision and document endpoints and is never embedded in a
-     * list response.
+     * Lists the Definition's revisions, newest first. Source content is not included; retrieve the
+     * revision content or individual documents separately.
      *
      * Auto-paginates: `for await (const item of …)` walks every page.
      * `GET /definitions/{definition_id}/revisions`
@@ -32,6 +31,7 @@ export class DefinitionRevisionsResource {
                 "403": ForbiddenError,
                 "404": NotFoundError,
                 "429": RateLimitedError,
+                "500": InternalServerError,
             },
             idempotent: true,
             schemaKey: "definitionRevisions.list",
@@ -48,20 +48,21 @@ export class DefinitionRevisionsResource {
     /**
      * Retrieve a Definition Revision
      *
-     * Metadata for one immutable resolved document graph. Fetch its canonical content or individual
-     * source documents from the content endpoints.
-     * `GET /definition_revisions/{definition_revision_id}`
+     * Returns metadata for a saved Definition Revision. Retrieve its resolved content or individual
+     * source documents separately.
+     * `GET /definition-revisions/{definition_revision_id}`
      */
     async retrieve(definitionRevisionId, options) {
         return this._core.request({
             method: "GET",
-            path: `/definition_revisions/${encodeURIComponent(String(definitionRevisionId))}`,
+            path: `/definition-revisions/${encodeURIComponent(String(definitionRevisionId))}`,
             security: [{ "apiKey": [] }],
             errors: {
                 "401": UnauthorizedError,
                 "403": ForbiddenError,
                 "404": NotFoundError,
                 "429": RateLimitedError,
+                "500": InternalServerError,
             },
             idempotent: true,
             schemaKey: "definitionRevisions.retrieve",
@@ -71,20 +72,21 @@ export class DefinitionRevisionsResource {
     /**
      * Retrieve a Definition Revision's canonical content
      *
-     * Returns the exact canonical resolved content identified by the revision's graph digest,
-     * suitable for saving or piping into a diff.
-     * `GET /definition_revisions/{definition_revision_id}/content`
+     * Returns the saved, resolved content for this revision. Save it locally or compare it with
+     * another revision.
+     * `GET /definition-revisions/{definition_revision_id}/content`
      */
     async retrieveContent(definitionRevisionId, options) {
         return this._core.request({
             method: "GET",
-            path: `/definition_revisions/${encodeURIComponent(String(definitionRevisionId))}/content`,
+            path: `/definition-revisions/${encodeURIComponent(String(definitionRevisionId))}/content`,
             security: [{ "apiKey": [] }],
             errors: {
                 "401": UnauthorizedError,
                 "403": ForbiddenError,
                 "404": NotFoundError,
                 "429": RateLimitedError,
+                "500": InternalServerError,
             },
             idempotent: true,
             schemaKey: "definitionRevisions.retrieveContent",
@@ -93,22 +95,48 @@ export class DefinitionRevisionsResource {
     }
     /**
      * Retrieve one source document from a Definition Revision
-     * `GET /definition_revisions/{definition_revision_id}/documents/{document_id}/content`
+     * `GET /definition-revisions/{definition_revision_id}/documents/{document_id}/content`
      */
     async retrieveDocumentContent(definitionRevisionId, documentId, options) {
         return this._core.request({
             method: "GET",
-            path: `/definition_revisions/${encodeURIComponent(String(definitionRevisionId))}/documents/${encodeURIComponent(String(documentId))}/content`,
+            path: `/definition-revisions/${encodeURIComponent(String(definitionRevisionId))}/documents/${encodeURIComponent(String(documentId))}/content`,
             security: [{ "apiKey": [] }],
             errors: {
                 "401": UnauthorizedError,
                 "403": ForbiddenError,
                 "404": NotFoundError,
                 "429": RateLimitedError,
+                "500": InternalServerError,
             },
             idempotent: true,
             schemaKey: "definitionRevisions.retrieveDocumentContent",
             options,
         });
     }
+    /**
+     * Retrieve a Definition Document
+     *
+     * Returns metadata for one source document captured in a Definition Revision. Retrieve its
+     * content through the revision's document content endpoint. A document in another organization
+     * returns 404 not_found.
+     * `GET /definition-documents/{definition_document_id}`
+     */
+    async retrieveDocument(definitionDocumentId, options) {
+        return this._core.request({
+            method: "GET",
+            path: `/definition-documents/${encodeURIComponent(String(definitionDocumentId))}`,
+            security: [{ "apiKey": [] }],
+            errors: {
+                "401": UnauthorizedError,
+                "403": ForbiddenError,
+                "404": NotFoundError,
+                "429": RateLimitedError,
+                "500": InternalServerError,
+            },
+            idempotent: true,
+            schemaKey: "definitionRevisions.retrieveDocument",
+            options,
+        });
+    }
 }

package/dist/resources/definitions.d.ts

@@ -1,5 +1,5 @@
 import { HttpCore, type ApiResult, type RequestOptions } from "../core/http.js";
-import { ResponseParseError, TransportError, UnexpectedApiError, ValidationError, BadRequestError, ConflictError, ForbiddenError, NotFoundError, RateLimitedError, UnauthorizedError, UnprocessableEntityError } from "../errors.js";
+import { ResponseParseError, TransportError, UnexpectedApiError, ValidationError, BadRequestError, ConflictError, ForbiddenError, InternalServerError, NotFoundError, PreconditionFailedError, RateLimitedError, UnauthorizedError, UnprocessableEntityError } from "../errors.js";
 import type { DefinitionId, DefinitionRead, DefinitionUpdateRequest } from "../types.js";
 export declare class DefinitionsResource {
     private readonly _core;
@@ -12,7 +12,16 @@ export declare class DefinitionsResource {
     /**
      * Update and resolve a Definition
      *
-     * Resolves the complete document graph and records a new immutable revision before saving.
+     * Resolves the source documents before saving the update and records a new Definition Revision
+     * when the source changes.
+     * Omitted fields remain unchanged; supplied objects and arrays replace the whole field.
+     * If the Definition or its Project configuration changes during validation, returns 409
+     * definition_changed without saving the rejected update. Retrieve the current Definition 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 /definitions/{definition_id}`
@@ -20,16 +29,22 @@ export declare class DefinitionsResource {
     update(definitionId: DefinitionId, body: DefinitionUpdateRequest, params?: DefinitionsUpdateParams, options?: RequestOptions): Promise<ApiResult<DefinitionRead, DefinitionsUpdateError>>;
 }
 /** Every error `retrieve` can produce, as a discriminated union. */
-export type DefinitionsRetrieveError = UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
+export type DefinitionsRetrieveError = UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
 export interface DefinitionsUpdateParams {
+    /**
+     * 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 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 `update` can produce, as a discriminated union. */
-export type DefinitionsUpdateError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | ConflictError | UnprocessableEntityError | RateLimitedError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
+export type DefinitionsUpdateError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | ConflictError | PreconditionFailedError | UnprocessableEntityError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
 //# sourceMappingURL=definitions.d.ts.map

package/dist/resources/definitions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.d.ts","sourceRoot":"","sources":["../../src/resources/definitions.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,aAAa,EACb,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,wBAAwB,EACzB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAEV,YAAY,EACZ,cAAc,EACd,uBAAuB,EACxB,MAAM,aAAa,CAAC;AAErB,qBAAa,mBAAmB;IAClB,OAAO,CAAC,QAAQ,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAC5C;;;OAGG;IACG,QAAQ,CACZ,YAAY,EAAE,YAAY,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,cAAc,EAAE,wBAAwB,CAAC,CAAC;IAiB/D;;;;;;;OAOG;IACG,MAAM,CACV,YAAY,EAAE,YAAY,EAC1B,IAAI,EAAE,uBAAuB,EAC7B,MAAM,CAAC,EAAE,uBAAuB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,cAAc,EAAE,sBAAsB,CAAC,CAAC;CAuB9D;AAED,oEAAoE;AACpE,MAAM,MAAM,wBAAwB,GAChC,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,MAAM,WAAW,uBAAuB;IACtC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,kEAAkE;AAClE,MAAM,MAAM,sBAAsB,GAC9B,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,aAAa,GACb,wBAAwB,GACxB,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC"}
+{"version":3,"file":"definitions.d.ts","sourceRoot":"","sources":["../../src/resources/definitions.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,aAAa,EACb,cAAc,EACd,mBAAmB,EACnB,aAAa,EACb,uBAAuB,EACvB,gBAAgB,EAChB,iBAAiB,EACjB,wBAAwB,EACzB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAEV,YAAY,EACZ,cAAc,EACd,uBAAuB,EACxB,MAAM,aAAa,CAAC;AAErB,qBAAa,mBAAmB;IAClB,OAAO,CAAC,QAAQ,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAC5C;;;OAGG;IACG,QAAQ,CACZ,YAAY,EAAE,YAAY,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,cAAc,EAAE,wBAAwB,CAAC,CAAC;IAkB/D;;;;;;;;;;;;;;;;OAgBG;IACG,MAAM,CACV,YAAY,EAAE,YAAY,EAC1B,IAAI,EAAE,uBAAuB,EAC7B,MAAM,CAAC,EAAE,uBAAuB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,cAAc,EAAE,sBAAsB,CAAC,CAAC;CA0B9D;AAED,oEAAoE;AACpE,MAAM,MAAM,wBAAwB,GAChC,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,kEAAkE;AAClE,MAAM,MAAM,sBAAsB,GAC9B,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,aAAa,GACb,uBAAuB,GACvB,wBAAwB,GACxB,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC"}