@shipstatic/ship 2.0.0-beta.7 → 2.0.0-beta.8

package/dist/index.d.cts

@@ -276,6 +276,10 @@ interface DnsLookup {
     /** The provider serving this domain's DNS, absent when unidentified */
     provider?: DnsProvider;
 }
+/**
+ * A report: it answers a question and carries only the answer (`CLAUDE.md`,
+ * "A report answers a question").
+ */
 interface DomainDnsResponse {
     /** The domain name */
     domain: string;
@@ -288,6 +292,9 @@ interface DomainDnsResponse {
  *
  * `/admin/domains/:domain/share` answers the same shape, which is the admin
  * law working: the operator surface is the public grammar with a prefix.
+ *
+ * A report: it answers a question and carries only the answer (`CLAUDE.md`,
+ * "A report answers a question").
  */
 interface DomainShareResponse {
     /** The domain the setup link is for */
@@ -297,6 +304,9 @@ interface DomainShareResponse {
 }
 /**
  * Response for domain DNS records
+ *
+ * A report: it answers a question and carries only the answer (`CLAUDE.md`,
+ * "A report answers a question").
  */
 interface DomainRecordsResponse {
     /** The domain name */
@@ -332,6 +342,9 @@ declare function validateIdempotencyKey(value: unknown): string | undefined;
  * no identity, no row and no `created`, so there is nothing for a keyset
  * cursor to resume after, and its consumer is an autocomplete that wants the
  * whole set. Bounded by `PAGINATION.GLOBAL_LIMIT` rather than paginated.
+ *
+ * A report: it answers a question and carries only the answer (`CLAUDE.md`,
+ * "A report answers a question").
  */
 interface LabelsResponse {
     readonly labels: string[];
@@ -342,8 +355,13 @@ interface LabelsResponse {
  *
  * `custom` is the provider-specific walkthrough when the provider is known;
  * `generic` always answers, so a caller never has nothing to show.
+ *
+ * A report: it answers a question and carries only the answer (`CLAUDE.md`,
+ * "A report answers a question").
  */
 interface SetupInstructionsResponse {
+    /** The domain the instructions are for — a report names its subject */
+    readonly domain: string;
     /** One-line summary of what to do */
     readonly tldr: string;
     /** Provider-specific instructions, null when the provider is unknown */
@@ -354,7 +372,14 @@ interface SetupInstructionsResponse {
     readonly provider: string | null;
 }
 /**
- * Response for domain validation
+ * `POST /domains/validate` — a report answering "is this name usable, and if
+ * not, why".
+ *
+ * An unusable name is a legitimate ANSWER, not a failure, so this is a 200 and
+ * the verdict rides the body. `reason` was named `error` until 2026-07-29,
+ * which collided with {@link ErrorResponse}'s reserved key — there `error` is
+ * an `ErrorType` a client branches on, here it is prose a client displays, and
+ * one key cannot mean both. See {@link DeploymentDeleteResponse} for the law.
  */
 interface DomainValidateResponse {
     /** Whether the domain is valid */
@@ -363,8 +388,8 @@ interface DomainValidateResponse {
     normalized: string | null;
     /** Whether the domain is available, null when invalid */
     available: boolean | null;
-    /** Error message, null when valid */
-    error: string | null;
+    /** Why the name is unusable, null when valid — displayed verbatim. */
+    reason: string | null;
 }
 /**
  * Core deploy token object - used in both API responses and SDK.
@@ -521,6 +546,9 @@ interface AccountDeleteResponse {
  * (`Account.hint`), and the plaintext exists exactly once, in this response.
  * The raw credential is `secret` on every surface that mints one — the same
  * field `TokenCreateResponse` carries — because one concept gets one name.
+ *
+ * A report: it answers a question and carries only the answer (`CLAUDE.md`,
+ * "A report answers a question").
  */
 interface AccountKeyResponse {
     /** The raw API key (shown once at mint, then never again) */
@@ -711,6 +739,9 @@ declare function isShipError(error: unknown): error is ShipError;
  *
  * These are the *platform's* posted caps for the current account — server
  * truth delivered at runtime, never hard-coded on the client.
+ *
+ * A report: it answers a question and carries only the answer (`CLAUDE.md`,
+ * "A report answers a question").
  */
 interface PlatformLimits {
     /** Maximum size in bytes for a single file. */
@@ -781,13 +812,20 @@ declare const UNBUILT_PROJECT_MARKERS: ReadonlySet<string>;
  */
 declare function hasUnbuiltMarker(filePath: string): boolean;
 /**
- * Simple ping response for health checks
+ * `GET /ping` — a report of the server clock.
+ *
+ * Liveness is the STATUS CODE's answer, not a field's: a 200 means reachable,
+ * and any other outcome throws before a body is read. So the body carries the
+ * one thing a status code cannot — the server's own clock, which is what lets a
+ * client detect skew against a token expiry. It read `{ success: true,
+ * timestamp? }` until 2026-07-29, where `success` was a literal constant in the
+ * route (zero bits, and the platform's own named anti-pattern) while the field
+ * that IS the payload was optional. See {@link DeploymentDeleteResponse} for
+ * the law, and `tests/response-shapes.test.ts` for the fence that holds it.
  */
 interface PingResponse {
-    /** Always true if service is healthy */
-    success: boolean;
     /** Server time in unix seconds — the one wire unit for timestamps. */
-    timestamp?: number;
+    readonly timestamp: number;
 }
 /**
  * Where human identity is mounted on the API host. The API mounts Better
@@ -992,6 +1030,10 @@ interface SPACheckDebug {
     /** The reason for the detection result */
     reason: string;
 }
+/**
+ * A report: it answers a question and carries only the answer (`CLAUDE.md`,
+ * "A report answers a question").
+ */
 interface SPACheckResponse {
     /** Whether the project is detected as a Single Page Application */
     isSPA: boolean;
@@ -1150,7 +1192,7 @@ interface DeploymentResource<UploadOptions extends DeploymentUploadOptions = Dep
     list: (options?: ListOptions) => Promise<DeploymentListResponse>;
     get: (id: string) => Promise<Deployment>;
     set: (id: string, options: DeploymentSetOptions) => Promise<Deployment>;
-    remove: (id: string) => Promise<DeploymentDeleteResponse>;
+    delete: (id: string) => Promise<DeploymentDeleteResponse>;
 }
 /**
  * Domain resource interface - the contract all implementations must follow
@@ -1159,7 +1201,7 @@ interface DomainResource {
     set: (name: string, options?: DomainSetOptions) => Promise<DomainSetResult>;
     list: (options?: ListOptions) => Promise<DomainListResponse>;
     get: (name: string) => Promise<Domain>;
-    remove: (name: string) => Promise<DomainDeleteResponse>;
+    delete: (name: string) => Promise<DomainDeleteResponse>;
     verify: (name: string) => Promise<DomainVerifyResponse>;
     validate: (name: string) => Promise<DomainValidateResponse>;
     dns: (name: string) => Promise<DomainDnsResponse>;
@@ -1179,7 +1221,7 @@ interface TokenResource {
     create: (options?: TokenCreateOptions) => Promise<TokenCreateResponse>;
     list: (options?: ListOptions) => Promise<TokenListResponse>;
     get: (token: string) => Promise<Token>;
-    remove: (token: string) => Promise<TokenDeleteResponse>;
+    delete: (token: string) => Promise<TokenDeleteResponse>;
 }
 /**
  * Billing status response from GET /billing/status
@@ -1199,6 +1241,25 @@ interface BillingStatus {
     /** Link to Creem customer portal for billing management, null if unavailable */
     portal: string | null;
 }
+/**
+ * Acknowledgement of `POST /billing/cancel`.
+ *
+ * Cancelling leaves no billing entity to return, so it answers with the
+ * account and the one field of the account the call changed — the plan it
+ * landed on. See {@link DeploymentDeleteResponse} for the law.
+ *
+ * This read `{ success: true, message: 'Subscription canceled successfully…' }`
+ * until 2026-07-29, an anonymous shape that `web/my` redeclared inline and
+ * whose prose no surface ever displayed: both callers await the promise and
+ * discard the body, then compose their own toast. The message was written,
+ * serialized, and thrown away on every cancellation.
+ */
+interface BillingCancelResponse {
+    /** The account whose subscription was cancelled */
+    readonly account: string;
+    /** The plan the account now holds — `free` on a successful cancellation */
+    readonly plan: AccountPlanType;
+}
 /**
  * Checkout session response from POST /billing/checkout
  */
@@ -1723,11 +1784,11 @@ declare class ApiHttp extends SimpleEvents {
     listDeployments(options?: ListOptions): Promise<DeploymentListResponse>;
     getDeployment(id: string): Promise<Deployment>;
     updateDeploymentLabels(id: string, labels: string[]): Promise<Deployment>;
-    removeDeployment(id: string): Promise<DeploymentDeleteResponse>;
+    deleteDeployment(id: string): Promise<DeploymentDeleteResponse>;
     setDomain(name: string, deployment?: string, labels?: string[]): Promise<DomainSetResult>;
     listDomains(options?: ListOptions): Promise<DomainListResponse>;
     getDomain(name: string): Promise<Domain>;
-    removeDomain(name: string): Promise<DomainDeleteResponse>;
+    deleteDomain(name: string): Promise<DomainDeleteResponse>;
     verifyDomain(name: string): Promise<DomainVerifyResponse>;
     getDomainDns(name: string): Promise<DomainDnsResponse>;
     getDomainRecords(name: string): Promise<DomainRecordsResponse>;
@@ -1735,11 +1796,11 @@ declare class ApiHttp extends SimpleEvents {
     validateDomain(name: string): Promise<DomainValidateResponse>;
     createToken(ttl?: number, labels?: string[]): Promise<TokenCreateResponse>;
     listTokens(options?: ListOptions): Promise<TokenListResponse>;
-    removeToken(token: string): Promise<TokenDeleteResponse>;
+    deleteToken(token: string): Promise<TokenDeleteResponse>;
     getToken(token: string): Promise<Token>;
     getAccount(): Promise<AccountGetResponse>;
     getLimits(): Promise<PlatformLimits>;
-    ping(): Promise<boolean>;
+    ping(): Promise<PingResponse>;
     checkSPA(files: StaticFile[], _options?: ApiDeployOptions): Promise<boolean>;
 }
 
@@ -1809,9 +1870,16 @@ declare abstract class Ship$1 {
     protected ensureInitialized(): Promise<void>;
     private fetchPlatformLimits;
     /**
-     * Ping the API server to check connectivity.
+     * Ping the API server, resolving its answer: `{ success, timestamp }`, where
+     * `timestamp` is the server clock in unix SECONDS.
+     *
+     * It resolves the response rather than a bare `true` because every other
+     * method here does — narrowing to a boolean discarded the one thing ping
+     * carries beyond liveness, and made `success` mean a boolean on the wire and
+     * something else by the time it reached a caller. A non-OK response throws in
+     * transport, so a resolved value always means the API answered.
      */
-    ping(): Promise<boolean>;
+    ping(): Promise<PingResponse>;
     /**
      * Deploy project (convenience shortcut to `ship.deployments.upload()`).
      */
@@ -2172,6 +2240,6 @@ declare class Ship extends Ship$1 {
 }
 
 declare namespace Ship {
-  export { API_KEY, API_PATHS, AUTH_BASE_PATH, Account, AccountDeleteResponse, AccountGetResponse, AccountKeyResponse, AccountOverrides, AccountPlan, AccountPlanType, AccountResource, AccountUsage, Activity, ActivityEvent, ActivityListResponse, ActivityMeta, ApiDeployOptions, ApiHttp, ApiHttpOptions, AuthMethod, AuthMethodType, BLOCKED_EXTENSIONS, BillingStatus, CALLER, CheckoutSession, DEFAULT_API, DEPLOYMENT_CONFIG_FILENAME, DEPLOY_TOKEN, DeployBody, DeployBodyContext, DeployBodyCreator, DeployFile, DeployInput, Deployment, DeploymentCreateResponse, DeploymentDeleteResponse, DeploymentListResponse, DeploymentOptions, DeploymentResource, DeploymentResourceContext, DeploymentSetOptions, DeploymentStatus, DeploymentStatusType, DeploymentUploadOptions, DnsLookup, DnsProvider, DnsRecord, DnsRecordType, Domain, DomainDeleteResponse, DomainDnsResponse, DomainListResponse, DomainRecordsResponse, DomainResource, DomainSetOptions, DomainSetResult, DomainShareResponse, DomainStatus, DomainStatusType, DomainValidateResponse, DomainVerifyResponse, ErrorResponse, ErrorType, ExecutionEnvironment, FileValidationStatus as FILE_VALIDATION_STATUS, Fetch, FileValidationResult, FileValidationStatus, FileValidationStatusType, IDEMPOTENCY_KEY_CONSTRAINTS, JUNK_DIRECTORIES, LABEL_CONSTRAINTS, LABEL_PATTERN, LabelsResponse, ListOptions, ListResponse, MD5Result, OAuthScope, OAuthScopeType, PASSWORD_CONSTRAINTS, PingResponse, PlatformLimits, ResourceContext, SPACheckDebug, SPACheckRequest, SPACheckResponse, SPA_DEFAULT_CONFIG, SetupInstructionsResponse, ShipClientOptions, ShipError, ShipEvents, StaticFile, Token, TokenCreateOptions, TokenCreateResponse, TokenDeleteResponse, TokenKind, TokenKindType, TokenListResponse, TokenProvider, TokenResource, UNBUILT_PROJECT_MARKERS, UNSAFE_FILENAME_CHARS, UploadedFile, UserVisibleActivityEvent, ValidatableFile, ValidationIssue, __setTestEnvironment, allValidFilesReady, assertShipJsonSyntax, calculateMD5, classifyToken, createAccountResource, createDeploymentResource, createDomainResource, createTokenResource, deserializeLabels, extractSubdomain, filterJunk, formatFileSize, generateDeploymentUrl, generateDomainUrl, getENV, getValidFiles, hasUnbuiltMarker, hasUnsafeChars, isBlockedExtension, isCustomDomain, isDeployment, isPlatformDomain, isShipError, optimizeDeployPaths, pluralize, processFilesForNode, serializeLabels, validateApiKey, validateApiUrl, validateCaller, validateDeployFile, validateDeployPath, validateDeployToken, validateFileName, validateFiles, validateIdempotencyKey, validatePassword, validateToken };
+  export { API_KEY, API_PATHS, AUTH_BASE_PATH, Account, AccountDeleteResponse, AccountGetResponse, AccountKeyResponse, AccountOverrides, AccountPlan, AccountPlanType, AccountResource, AccountUsage, Activity, ActivityEvent, ActivityListResponse, ActivityMeta, ApiDeployOptions, ApiHttp, ApiHttpOptions, AuthMethod, AuthMethodType, BLOCKED_EXTENSIONS, BillingCancelResponse, BillingStatus, CALLER, CheckoutSession, DEFAULT_API, DEPLOYMENT_CONFIG_FILENAME, DEPLOY_TOKEN, DeployBody, DeployBodyContext, DeployBodyCreator, DeployFile, DeployInput, Deployment, DeploymentCreateResponse, DeploymentDeleteResponse, DeploymentListResponse, DeploymentOptions, DeploymentResource, DeploymentResourceContext, DeploymentSetOptions, DeploymentStatus, DeploymentStatusType, DeploymentUploadOptions, DnsLookup, DnsProvider, DnsRecord, DnsRecordType, Domain, DomainDeleteResponse, DomainDnsResponse, DomainListResponse, DomainRecordsResponse, DomainResource, DomainSetOptions, DomainSetResult, DomainShareResponse, DomainStatus, DomainStatusType, DomainValidateResponse, DomainVerifyResponse, ErrorResponse, ErrorType, ExecutionEnvironment, FileValidationStatus as FILE_VALIDATION_STATUS, Fetch, FileValidationResult, FileValidationStatus, FileValidationStatusType, IDEMPOTENCY_KEY_CONSTRAINTS, JUNK_DIRECTORIES, LABEL_CONSTRAINTS, LABEL_PATTERN, LabelsResponse, ListOptions, ListResponse, MD5Result, OAuthScope, OAuthScopeType, PASSWORD_CONSTRAINTS, PingResponse, PlatformLimits, ResourceContext, SPACheckDebug, SPACheckRequest, SPACheckResponse, SPA_DEFAULT_CONFIG, SetupInstructionsResponse, ShipClientOptions, ShipError, ShipEvents, StaticFile, Token, TokenCreateOptions, TokenCreateResponse, TokenDeleteResponse, TokenKind, TokenKindType, TokenListResponse, TokenProvider, TokenResource, UNBUILT_PROJECT_MARKERS, UNSAFE_FILENAME_CHARS, UploadedFile, UserVisibleActivityEvent, ValidatableFile, ValidationIssue, __setTestEnvironment, allValidFilesReady, assertShipJsonSyntax, calculateMD5, classifyToken, createAccountResource, createDeploymentResource, createDomainResource, createTokenResource, deserializeLabels, extractSubdomain, filterJunk, formatFileSize, generateDeploymentUrl, generateDomainUrl, getENV, getValidFiles, hasUnbuiltMarker, hasUnsafeChars, isBlockedExtension, isCustomDomain, isDeployment, isPlatformDomain, isShipError, optimizeDeployPaths, pluralize, processFilesForNode, serializeLabels, validateApiKey, validateApiUrl, validateCaller, validateDeployFile, validateDeployPath, validateDeployToken, validateFileName, validateFiles, validateIdempotencyKey, validatePassword, validateToken };
 }
 export = Ship;

package/dist/index.d.ts

@@ -276,6 +276,10 @@ interface DnsLookup {
     /** The provider serving this domain's DNS, absent when unidentified */
     provider?: DnsProvider;
 }
+/**
+ * A report: it answers a question and carries only the answer (`CLAUDE.md`,
+ * "A report answers a question").
+ */
 interface DomainDnsResponse {
     /** The domain name */
     domain: string;
@@ -288,6 +292,9 @@ interface DomainDnsResponse {
  *
  * `/admin/domains/:domain/share` answers the same shape, which is the admin
  * law working: the operator surface is the public grammar with a prefix.
+ *
+ * A report: it answers a question and carries only the answer (`CLAUDE.md`,
+ * "A report answers a question").
  */
 interface DomainShareResponse {
     /** The domain the setup link is for */
@@ -297,6 +304,9 @@ interface DomainShareResponse {
 }
 /**
  * Response for domain DNS records
+ *
+ * A report: it answers a question and carries only the answer (`CLAUDE.md`,
+ * "A report answers a question").
  */
 interface DomainRecordsResponse {
     /** The domain name */
@@ -332,6 +342,9 @@ declare function validateIdempotencyKey(value: unknown): string | undefined;
  * no identity, no row and no `created`, so there is nothing for a keyset
  * cursor to resume after, and its consumer is an autocomplete that wants the
  * whole set. Bounded by `PAGINATION.GLOBAL_LIMIT` rather than paginated.
+ *
+ * A report: it answers a question and carries only the answer (`CLAUDE.md`,
+ * "A report answers a question").
  */
 interface LabelsResponse {
     readonly labels: string[];
@@ -342,8 +355,13 @@ interface LabelsResponse {
  *
  * `custom` is the provider-specific walkthrough when the provider is known;
  * `generic` always answers, so a caller never has nothing to show.
+ *
+ * A report: it answers a question and carries only the answer (`CLAUDE.md`,
+ * "A report answers a question").
  */
 interface SetupInstructionsResponse {
+    /** The domain the instructions are for — a report names its subject */
+    readonly domain: string;
     /** One-line summary of what to do */
     readonly tldr: string;
     /** Provider-specific instructions, null when the provider is unknown */
@@ -354,7 +372,14 @@ interface SetupInstructionsResponse {
     readonly provider: string | null;
 }
 /**
- * Response for domain validation
+ * `POST /domains/validate` — a report answering "is this name usable, and if
+ * not, why".
+ *
+ * An unusable name is a legitimate ANSWER, not a failure, so this is a 200 and
+ * the verdict rides the body. `reason` was named `error` until 2026-07-29,
+ * which collided with {@link ErrorResponse}'s reserved key — there `error` is
+ * an `ErrorType` a client branches on, here it is prose a client displays, and
+ * one key cannot mean both. See {@link DeploymentDeleteResponse} for the law.
  */
 interface DomainValidateResponse {
     /** Whether the domain is valid */
@@ -363,8 +388,8 @@ interface DomainValidateResponse {
     normalized: string | null;
     /** Whether the domain is available, null when invalid */
     available: boolean | null;
-    /** Error message, null when valid */
-    error: string | null;
+    /** Why the name is unusable, null when valid — displayed verbatim. */
+    reason: string | null;
 }
 /**
  * Core deploy token object - used in both API responses and SDK.
@@ -521,6 +546,9 @@ interface AccountDeleteResponse {
  * (`Account.hint`), and the plaintext exists exactly once, in this response.
  * The raw credential is `secret` on every surface that mints one — the same
  * field `TokenCreateResponse` carries — because one concept gets one name.
+ *
+ * A report: it answers a question and carries only the answer (`CLAUDE.md`,
+ * "A report answers a question").
  */
 interface AccountKeyResponse {
     /** The raw API key (shown once at mint, then never again) */
@@ -711,6 +739,9 @@ declare function isShipError(error: unknown): error is ShipError;
  *
  * These are the *platform's* posted caps for the current account — server
  * truth delivered at runtime, never hard-coded on the client.
+ *
+ * A report: it answers a question and carries only the answer (`CLAUDE.md`,
+ * "A report answers a question").
  */
 interface PlatformLimits {
     /** Maximum size in bytes for a single file. */
@@ -781,13 +812,20 @@ declare const UNBUILT_PROJECT_MARKERS: ReadonlySet<string>;
  */
 declare function hasUnbuiltMarker(filePath: string): boolean;
 /**
- * Simple ping response for health checks
+ * `GET /ping` — a report of the server clock.
+ *
+ * Liveness is the STATUS CODE's answer, not a field's: a 200 means reachable,
+ * and any other outcome throws before a body is read. So the body carries the
+ * one thing a status code cannot — the server's own clock, which is what lets a
+ * client detect skew against a token expiry. It read `{ success: true,
+ * timestamp? }` until 2026-07-29, where `success` was a literal constant in the
+ * route (zero bits, and the platform's own named anti-pattern) while the field
+ * that IS the payload was optional. See {@link DeploymentDeleteResponse} for
+ * the law, and `tests/response-shapes.test.ts` for the fence that holds it.
  */
 interface PingResponse {
-    /** Always true if service is healthy */
-    success: boolean;
     /** Server time in unix seconds — the one wire unit for timestamps. */
-    timestamp?: number;
+    readonly timestamp: number;
 }
 /**
  * Where human identity is mounted on the API host. The API mounts Better
@@ -992,6 +1030,10 @@ interface SPACheckDebug {
     /** The reason for the detection result */
     reason: string;
 }
+/**
+ * A report: it answers a question and carries only the answer (`CLAUDE.md`,
+ * "A report answers a question").
+ */
 interface SPACheckResponse {
     /** Whether the project is detected as a Single Page Application */
     isSPA: boolean;
@@ -1150,7 +1192,7 @@ interface DeploymentResource<UploadOptions extends DeploymentUploadOptions = Dep
     list: (options?: ListOptions) => Promise<DeploymentListResponse>;
     get: (id: string) => Promise<Deployment>;
     set: (id: string, options: DeploymentSetOptions) => Promise<Deployment>;
-    remove: (id: string) => Promise<DeploymentDeleteResponse>;
+    delete: (id: string) => Promise<DeploymentDeleteResponse>;
 }
 /**
  * Domain resource interface - the contract all implementations must follow
@@ -1159,7 +1201,7 @@ interface DomainResource {
     set: (name: string, options?: DomainSetOptions) => Promise<DomainSetResult>;
     list: (options?: ListOptions) => Promise<DomainListResponse>;
     get: (name: string) => Promise<Domain>;
-    remove: (name: string) => Promise<DomainDeleteResponse>;
+    delete: (name: string) => Promise<DomainDeleteResponse>;
     verify: (name: string) => Promise<DomainVerifyResponse>;
     validate: (name: string) => Promise<DomainValidateResponse>;
     dns: (name: string) => Promise<DomainDnsResponse>;
@@ -1179,7 +1221,7 @@ interface TokenResource {
     create: (options?: TokenCreateOptions) => Promise<TokenCreateResponse>;
     list: (options?: ListOptions) => Promise<TokenListResponse>;
     get: (token: string) => Promise<Token>;
-    remove: (token: string) => Promise<TokenDeleteResponse>;
+    delete: (token: string) => Promise<TokenDeleteResponse>;
 }
 /**
  * Billing status response from GET /billing/status
@@ -1199,6 +1241,25 @@ interface BillingStatus {
     /** Link to Creem customer portal for billing management, null if unavailable */
     portal: string | null;
 }
+/**
+ * Acknowledgement of `POST /billing/cancel`.
+ *
+ * Cancelling leaves no billing entity to return, so it answers with the
+ * account and the one field of the account the call changed — the plan it
+ * landed on. See {@link DeploymentDeleteResponse} for the law.
+ *
+ * This read `{ success: true, message: 'Subscription canceled successfully…' }`
+ * until 2026-07-29, an anonymous shape that `web/my` redeclared inline and
+ * whose prose no surface ever displayed: both callers await the promise and
+ * discard the body, then compose their own toast. The message was written,
+ * serialized, and thrown away on every cancellation.
+ */
+interface BillingCancelResponse {
+    /** The account whose subscription was cancelled */
+    readonly account: string;
+    /** The plan the account now holds — `free` on a successful cancellation */
+    readonly plan: AccountPlanType;
+}
 /**
  * Checkout session response from POST /billing/checkout
  */
@@ -1723,11 +1784,11 @@ declare class ApiHttp extends SimpleEvents {
     listDeployments(options?: ListOptions): Promise<DeploymentListResponse>;
     getDeployment(id: string): Promise<Deployment>;
     updateDeploymentLabels(id: string, labels: string[]): Promise<Deployment>;
-    removeDeployment(id: string): Promise<DeploymentDeleteResponse>;
+    deleteDeployment(id: string): Promise<DeploymentDeleteResponse>;
     setDomain(name: string, deployment?: string, labels?: string[]): Promise<DomainSetResult>;
     listDomains(options?: ListOptions): Promise<DomainListResponse>;
     getDomain(name: string): Promise<Domain>;
-    removeDomain(name: string): Promise<DomainDeleteResponse>;
+    deleteDomain(name: string): Promise<DomainDeleteResponse>;
     verifyDomain(name: string): Promise<DomainVerifyResponse>;
     getDomainDns(name: string): Promise<DomainDnsResponse>;
     getDomainRecords(name: string): Promise<DomainRecordsResponse>;
@@ -1735,11 +1796,11 @@ declare class ApiHttp extends SimpleEvents {
     validateDomain(name: string): Promise<DomainValidateResponse>;
     createToken(ttl?: number, labels?: string[]): Promise<TokenCreateResponse>;
     listTokens(options?: ListOptions): Promise<TokenListResponse>;
-    removeToken(token: string): Promise<TokenDeleteResponse>;
+    deleteToken(token: string): Promise<TokenDeleteResponse>;
     getToken(token: string): Promise<Token>;
     getAccount(): Promise<AccountGetResponse>;
     getLimits(): Promise<PlatformLimits>;
-    ping(): Promise<boolean>;
+    ping(): Promise<PingResponse>;
     checkSPA(files: StaticFile[], _options?: ApiDeployOptions): Promise<boolean>;
 }
 
@@ -1809,9 +1870,16 @@ declare abstract class Ship$1 {
     protected ensureInitialized(): Promise<void>;
     private fetchPlatformLimits;
     /**
-     * Ping the API server to check connectivity.
+     * Ping the API server, resolving its answer: `{ success, timestamp }`, where
+     * `timestamp` is the server clock in unix SECONDS.
+     *
+     * It resolves the response rather than a bare `true` because every other
+     * method here does — narrowing to a boolean discarded the one thing ping
+     * carries beyond liveness, and made `success` mean a boolean on the wire and
+     * something else by the time it reached a caller. A non-OK response throws in
+     * transport, so a resolved value always means the API answered.
      */
-    ping(): Promise<boolean>;
+    ping(): Promise<PingResponse>;
     /**
      * Deploy project (convenience shortcut to `ship.deployments.upload()`).
      */
@@ -2171,4 +2239,4 @@ declare class Ship extends Ship$1 {
     protected getDeployBodyCreator(): DeployBodyCreator;
 }
 
-export { API_KEY, API_PATHS, AUTH_BASE_PATH, type Account, type AccountDeleteResponse, type AccountGetResponse, type AccountKeyResponse, type AccountOverrides, AccountPlan, type AccountPlanType, type AccountResource, type AccountUsage, type Activity, type ActivityEvent, type ActivityListResponse, type ActivityMeta, type ApiDeployOptions, ApiHttp, type ApiHttpOptions, AuthMethod, type AuthMethodType, BLOCKED_EXTENSIONS, type BillingStatus, CALLER, type CheckoutSession, DEFAULT_API, DEPLOYMENT_CONFIG_FILENAME, DEPLOY_TOKEN, type DeployBody, type DeployBodyContext, type DeployBodyCreator, type DeployFile, type DeployInput, type Deployment, type DeploymentCreateResponse, type DeploymentDeleteResponse, type DeploymentListResponse, type DeploymentOptions, type DeploymentResource, type DeploymentResourceContext, type DeploymentSetOptions, DeploymentStatus, type DeploymentStatusType, type DeploymentUploadOptions, type DnsLookup, type DnsProvider, type DnsRecord, type DnsRecordType, type Domain, type DomainDeleteResponse, type DomainDnsResponse, type DomainListResponse, type DomainRecordsResponse, type DomainResource, type DomainSetOptions, type DomainSetResult, type DomainShareResponse, DomainStatus, type DomainStatusType, type DomainValidateResponse, type DomainVerifyResponse, type ErrorResponse, ErrorType, type ExecutionEnvironment, FileValidationStatus as FILE_VALIDATION_STATUS, type Fetch, type FileValidationResult, FileValidationStatus, type FileValidationStatusType, IDEMPOTENCY_KEY_CONSTRAINTS, JUNK_DIRECTORIES, LABEL_CONSTRAINTS, LABEL_PATTERN, type LabelsResponse, type ListOptions, type ListResponse, type MD5Result, OAuthScope, type OAuthScopeType, PASSWORD_CONSTRAINTS, type PingResponse, type PlatformLimits, type ResourceContext, type SPACheckDebug, type SPACheckRequest, type SPACheckResponse, SPA_DEFAULT_CONFIG, type SetupInstructionsResponse, Ship, type ShipClientOptions, ShipError, type ShipEvents, type StaticFile, type Token, type TokenCreateOptions, type TokenCreateResponse, type TokenDeleteResponse, TokenKind, type TokenKindType, type TokenListResponse, type TokenProvider, type TokenResource, UNBUILT_PROJECT_MARKERS, UNSAFE_FILENAME_CHARS, type UploadedFile, type UserVisibleActivityEvent, type ValidatableFile, type ValidationIssue, __setTestEnvironment, allValidFilesReady, assertShipJsonSyntax, calculateMD5, classifyToken, createAccountResource, createDeploymentResource, createDomainResource, createTokenResource, Ship as default, deserializeLabels, extractSubdomain, filterJunk, formatFileSize, generateDeploymentUrl, generateDomainUrl, getENV, getValidFiles, hasUnbuiltMarker, hasUnsafeChars, isBlockedExtension, isCustomDomain, isDeployment, isPlatformDomain, isShipError, optimizeDeployPaths, pluralize, processFilesForNode, serializeLabels, validateApiKey, validateApiUrl, validateCaller, validateDeployFile, validateDeployPath, validateDeployToken, validateFileName, validateFiles, validateIdempotencyKey, validatePassword, validateToken };
+export { API_KEY, API_PATHS, AUTH_BASE_PATH, type Account, type AccountDeleteResponse, type AccountGetResponse, type AccountKeyResponse, type AccountOverrides, AccountPlan, type AccountPlanType, type AccountResource, type AccountUsage, type Activity, type ActivityEvent, type ActivityListResponse, type ActivityMeta, type ApiDeployOptions, ApiHttp, type ApiHttpOptions, AuthMethod, type AuthMethodType, BLOCKED_EXTENSIONS, type BillingCancelResponse, type BillingStatus, CALLER, type CheckoutSession, DEFAULT_API, DEPLOYMENT_CONFIG_FILENAME, DEPLOY_TOKEN, type DeployBody, type DeployBodyContext, type DeployBodyCreator, type DeployFile, type DeployInput, type Deployment, type DeploymentCreateResponse, type DeploymentDeleteResponse, type DeploymentListResponse, type DeploymentOptions, type DeploymentResource, type DeploymentResourceContext, type DeploymentSetOptions, DeploymentStatus, type DeploymentStatusType, type DeploymentUploadOptions, type DnsLookup, type DnsProvider, type DnsRecord, type DnsRecordType, type Domain, type DomainDeleteResponse, type DomainDnsResponse, type DomainListResponse, type DomainRecordsResponse, type DomainResource, type DomainSetOptions, type DomainSetResult, type DomainShareResponse, DomainStatus, type DomainStatusType, type DomainValidateResponse, type DomainVerifyResponse, type ErrorResponse, ErrorType, type ExecutionEnvironment, FileValidationStatus as FILE_VALIDATION_STATUS, type Fetch, type FileValidationResult, FileValidationStatus, type FileValidationStatusType, IDEMPOTENCY_KEY_CONSTRAINTS, JUNK_DIRECTORIES, LABEL_CONSTRAINTS, LABEL_PATTERN, type LabelsResponse, type ListOptions, type ListResponse, type MD5Result, OAuthScope, type OAuthScopeType, PASSWORD_CONSTRAINTS, type PingResponse, type PlatformLimits, type ResourceContext, type SPACheckDebug, type SPACheckRequest, type SPACheckResponse, SPA_DEFAULT_CONFIG, type SetupInstructionsResponse, Ship, type ShipClientOptions, ShipError, type ShipEvents, type StaticFile, type Token, type TokenCreateOptions, type TokenCreateResponse, type TokenDeleteResponse, TokenKind, type TokenKindType, type TokenListResponse, type TokenProvider, type TokenResource, UNBUILT_PROJECT_MARKERS, UNSAFE_FILENAME_CHARS, type UploadedFile, type UserVisibleActivityEvent, type ValidatableFile, type ValidationIssue, __setTestEnvironment, allValidFilesReady, assertShipJsonSyntax, calculateMD5, classifyToken, createAccountResource, createDeploymentResource, createDomainResource, createTokenResource, Ship as default, deserializeLabels, extractSubdomain, filterJunk, formatFileSize, generateDeploymentUrl, generateDomainUrl, getENV, getValidFiles, hasUnbuiltMarker, hasUnsafeChars, isBlockedExtension, isCustomDomain, isDeployment, isPlatformDomain, isShipError, optimizeDeployPaths, pluralize, processFilesForNode, serializeLabels, validateApiKey, validateApiUrl, validateCaller, validateDeployFile, validateDeployPath, validateDeployToken, validateFileName, validateFiles, validateIdempotencyKey, validatePassword, validateToken };