@tangle-network/hub-sdk 0.19.2-develop.20260808074903.e05182e → 0.19.2

package/dist/index.d.ts

@@ -1,3 +1,370 @@
+//#region src/allowances.d.ts
+/**
+ * Allowances: a developer's per-member daily allowance on a meter, and the
+ * paywall decision past it. The platform counts every admitted turn and reads
+ * each payer's dollars from the ledger; the app keeps only its checkout and
+ * records a paying member with {@link HubAllowancesClient.grant}.
+ *
+ * Only the meter's owner may call these, signed in or with a root API key of
+ * their own. A delegated or resource-bound key, such as the key a hosted end
+ * user's sandbox runs on, is refused.
+ */
+type HubAllowanceTier = "free" | "paid" | "owner";
+type HubAllowanceRole = "owner" | "member";
+interface HubAllowancePlanInput {
+  free: {
+    turnsPerDay: number;
+    usdPerDay: number | null;
+  };
+  /** Null turns billing off: past the free allowance nothing lifts the limit. */
+  paid: {
+    turnsPerDay: number;
+    usdPerDay: number | null;
+    priceUsdMonthly: number;
+  } | null;
+  owner?: {
+    turnsPerDay: number;
+  };
+  /** Key resource type whose ledger spend counts against a payer's dollars. */
+  spendResourceType: string | null;
+}
+interface HubAllowancePlan extends HubAllowancePlanInput {
+  meter: string;
+  owner: {
+    turnsPerDay: number;
+  };
+  /** False while the meter runs on the default plan. */
+  configured: boolean;
+  updatedAt: string | null;
+}
+interface HubAllowanceSubject {
+  member: string;
+  role?: HubAllowanceRole;
+  /** The member whose keys pay for the turn, when that is someone else. */
+  payer?: string;
+  payerRole?: HubAllowanceRole;
+}
+interface HubAllowanceDecision {
+  /** `paywall`: paying lifts the limit. `allowance_reached`: nothing does today. */
+  decision: "admit" | "paywall" | "allowance_reached";
+  tier: HubAllowanceTier;
+  paywall: boolean;
+  turns: {
+    used: number;
+    limit: number;
+  };
+  usd: {
+    spent: number;
+    limit: number;
+    remaining: number;
+  } | null;
+  day: string;
+  resetsAt: string;
+  /**
+   * A paying payer's spend in the current paid period against what funds it:
+   * the plan price less Tangle's 10% fee, plus the free daily allowance for
+   * the period. A paid turn is refused once `remaining` is gone.
+   */
+  period?: {
+    spent: number;
+    funded: number;
+    remaining: number;
+    startsAt: string;
+    endsAt: string;
+  };
+  replay?: boolean;
+}
+interface HubAllowanceUsage {
+  day: string;
+  turns: number;
+  members: Array<{
+    member: string;
+    turns: number;
+    tier: HubAllowanceTier;
+    usdSpent: number | null;
+  }>;
+  lines: Array<{
+    line: string;
+    turns: number;
+  }>;
+}
+interface HubAllowanceGrant {
+  member: string;
+  tier: "paid";
+  expiresAt: string;
+  reference: string | null;
+}
+declare class HubAllowancesClient {
+  private readonly request;
+  constructor(request: <T>(path: string, init: RequestInit) => Promise<T>);
+  plan(meter: string): Promise<HubAllowancePlan>;
+  setPlan(meter: string, plan: HubAllowancePlanInput): Promise<HubAllowancePlan>;
+  /** Admit one turn or refuse it. Retrying the same `turnId` never counts twice. */
+  admit(meter: string, input: HubAllowanceSubject & {
+    turnId: string;
+    line?: string;
+    channel?: string;
+  }): Promise<HubAllowanceDecision>;
+  /** What the member's next turn would get, without counting anything. */
+  status(meter: string, subject: HubAllowanceSubject): Promise<HubAllowanceDecision>;
+  /** Move a member to the paid allowance until `expiresAt` (the paid period's end). */
+  grant(meter: string, member: string, input: {
+    expiresAt: string;
+    reference?: string | null;
+  }): Promise<HubAllowanceGrant>;
+  revoke(meter: string, member: string): Promise<void>;
+  /** Turns per member and per line on one UTC day (default today). */
+  usage(meter: string, day?: string): Promise<HubAllowanceUsage>;
+  private path;
+  private memberPath;
+  private body;
+}
+//#endregion
+//#region src/apps.d.ts
+/** App identity and customer permissions over the existing Platform transport.
+ * These operations do not authorize spending or expose upstream credentials. */
+interface HubApp {
+  id: string;
+  clientId: string;
+  oauthClientId: string | null;
+  name: string;
+  redirectUris: string[];
+  allowedScopes: string[];
+  homepageUrl: string | null;
+  status: "active" | "revoked";
+  createdAt: string;
+  updatedAt: string;
+}
+interface HubAppCreateInput {
+  name: string;
+  redirectUris: string[];
+  allowedScopes: string[];
+  homepageUrl?: string;
+  /** Associate an existing owned login client in the same transaction as creation. */
+  oauthClientId?: string;
+}
+interface HubAppGrant {
+  id: string;
+  appId: string;
+  userId: string;
+  connectionId: string;
+  scopes: string[];
+  status: "active" | "revoked";
+  createdAt: string;
+  updatedAt: string;
+  revokedAt: string | null;
+  /** Display metadata is additive; older deployments may omit it. */
+  appName?: string | null;
+  oauthClientId?: string | null;
+  providerId?: string | null;
+  accountDisplay?: string | null;
+  connectionDisplayName?: string | null;
+}
+interface HubAppGrantRevoked {
+  grantId: string;
+  status: "revoked";
+  revokedAt: string | null;
+  tokensRevoked: number;
+}
+declare class HubAppsClient {
+  private readonly request;
+  readonly grants: {
+    list: () => Promise<HubAppGrant[]>;
+    revoke: (grantId: string) => Promise<HubAppGrantRevoked>;
+  };
+  constructor(request: <T>(path: string, init: RequestInit) => Promise<T>);
+  list(): Promise<HubApp[]>;
+  /** The secret is returned only by creation; keep it in your server vault. */
+  create(input: HubAppCreateInput): Promise<{
+    app: HubApp;
+    clientSecret: string;
+  }>;
+  /** Immutable association of two existing records with the same owner. */
+  linkOAuthClient(appId: string, clientId: string): Promise<{
+    appId: string;
+    oauthClientId: string;
+  }>;
+  revoke(appId: string): Promise<{
+    appId: string;
+    grantsRevoked: number;
+    tokensRevoked: number;
+  }>;
+}
+//#endregion
+//#region src/inbound-webhooks.d.ts
+/** Provider setup uses the existing authenticated Hub transport and vault. */
+interface HubInboundWebhookCreateOptions {
+  /** Inkbox identity that owns all selected channels. */
+  identityId?: string;
+  mailboxId?: string;
+  phoneNumberId?: string;
+  imessage?: boolean;
+  /** Linq: explicit owned lines; omitted does not mean every account line. */
+  phoneNumbers?: string[];
+  /** Linq WhatsApp: explicit opaque IDs from numbers.list, not E.164 phone strings. */
+  phoneNumberIds?: string[];
+  /** Contiguity Console secret, or an existing Inkbox identity signing key. */
+  signingSecret?: string;
+}
+interface HubInboundWebhookCreateResponse {
+  url: string;
+  /** True only when the provider subscription was created by the server. */
+  provisioned?: boolean;
+  /** Self-configured legacy providers can return a newly minted secret once. */
+  secret?: string;
+  inboundAddress?: string;
+  requiresProviderSetup?: boolean;
+}
+interface HubInboundWebhookStatus {
+  configured: boolean;
+  url?: string;
+  /** Configuration is not evidence of a real delivered message. */
+  deliveryVerified: false;
+  requiresProviderSetup?: boolean;
+}
+/** Live provider readback for one explicitly selected Linq WhatsApp number. */
+interface HubInboundPhoneNumberScope {
+  configured: true;
+  provisioned: true;
+  subscribed: true;
+  phoneNumberIds: string[];
+}
+declare class HubInboundWebhooksClient {
+  private readonly request;
+  constructor(request: <T>(path: string, init: RequestInit) => Promise<T>);
+  create(connectionId: string, options?: HubInboundWebhookCreateOptions): Promise<HubInboundWebhookCreateResponse>;
+  get(connectionId: string): Promise<HubInboundWebhookStatus>;
+  /** Add one owned Linq WhatsApp number without rotating the webhook secret. */
+  ensurePhoneNumber(connectionId: string, phoneNumberId: string): Promise<HubInboundPhoneNumberScope>;
+  /** Remove event subscriptions first. This does not silently rotate a live URL. */
+  delete(connectionId: string): Promise<{
+    removed: boolean;
+  }>;
+  private path;
+}
+//#endregion
+//#region src/managed-numbers.d.ts
+interface HubNumberReadiness {
+  configured: boolean;
+  provider: "inkbox";
+  transports: Array<"sms" | "imessage">;
+  billing: "prepaid_activation";
+  automaticRentalBilling: false;
+  deliveryVerified: false;
+}
+interface HubNumberQuote {
+  transport: "sms" | "imessage";
+  activationCents: number;
+  currency: "usd";
+  termsVersion: string;
+  terms: string;
+  expiresAt: number;
+  /** The binding the quote was issued for. Absent from older servers. */
+  clientReference?: string;
+  /** Opaque. Pass it back to `create`; never decode it. */
+  token: string;
+}
+/** One page of the owner's orders, newest first. */
+interface HubNumberOrderPage {
+  orders: HubNumberOrder[];
+  /** Present while more orders exist. Older servers omit it and return one
+   * bounded page, so an absent cursor never proves an order does not exist. */
+  nextCursor?: string | null;
+}
+interface HubNumberListQuery {
+  /** Only orders requested for this binding, including closed ones. */
+  clientReference?: string;
+  cursor?: string;
+  /** 1 to 100; the server default is 100. */
+  limit?: number;
+}
+/** An operator's terminal decision on an order stuck in `needs_review`.
+ * Read-only for a creator: the resolution is made through the platform's
+ * admin surface, never through this client. */
+interface HubNumberResolution {
+  action: "release" | "settle" | "abandon";
+  operator: string;
+  reason: string;
+  at: number;
+  /** Present while the operator's action is still running. The decision is
+   * not final and the order can still return to review. */
+  pending?: true;
+  /** Present when a `settle` handed a live, unfinished order back to
+   * provisioning, so the order is working again rather than closed. */
+  requeued?: true;
+}
+interface HubNumberOrder {
+  id: string;
+  clientReference: string;
+  transport: "sms" | "imessage";
+  status: "pending" | "provider_pending" | "needs_review" | "ready_for_setup" | "cancelled";
+  phase: "identity" | "number" | "credential" | "connection" | "complete";
+  address: string | null;
+  connectionId: string | null;
+  identityId: string | null;
+  providerNumberId: string | null;
+  billingStatus: "unreserved" | "reserved" | "settled" | "released";
+  cancellation: "none" | "requested" | "needs_review" | "released" | "abandoned";
+  errorCode: string | null;
+  nextAttemptAt: number | null;
+  resolution: HubNumberResolution | null;
+  deliveryVerified: false;
+  activationCents: number;
+  currency: "usd";
+  terms: string;
+}
+/** Administrative number operations through Hub's authenticated transport.
+ * A mutation is one attempt; an uncertain create reuses its quote and reference. */
+declare class HubManagedNumbersClient {
+  private readonly request;
+  constructor(request: <T>(path: string, init: RequestInit) => Promise<T>);
+  readiness(): Promise<HubNumberReadiness>;
+  /** One page of orders. Scope by `clientReference` to ask about one binding,
+   * and follow `nextCursor` for the rest; a page is never ownership evidence. */
+  list(query?: HubNumberListQuery): Promise<HubNumberOrderPage>;
+  get(id: string): Promise<{
+    order: HubNumberOrder;
+  }>;
+  quote(input: {
+    transport: "sms" | "imessage";
+    clientReference: string;
+  }): Promise<{
+    quote: HubNumberQuote;
+  }>;
+  /** `clientReference` and `transport`, when given, must match the signed
+   * quote or Hub refuses the purchase with a conflict. */
+  create(input: {
+    quoteToken: string;
+    consent: true;
+    state?: string;
+    clientReference?: string;
+    transport?: "sms" | "imessage";
+  }): Promise<{
+    order: HubNumberOrder;
+  }>;
+  /** Fences references so no order can take them again. Call it as the last
+   * step before retiring the resource they name: a purchase that races the
+   * retirement is then refused (`409 number_reference_fenced`) instead of
+   * binding a line to a resource that is gone. Refused with
+   * `409 number_reference_held` while a live order holds one of them; cancel
+   * it first. A cancelled order no longer holds its reference, so the fence
+   * succeeds as soon as `cancel` returns, whether or not its release is still
+   * pending. Repeating a fence is harmless. */
+  fence(input: {
+    clientReferences: string[];
+  }): Promise<{
+    clientReferences: string[];
+  }>;
+  advance(id: string): Promise<{
+    order: HubNumberOrder;
+  }>;
+  cancel(id: string): Promise<{
+    order: HubNumberOrder;
+  }>;
+  private path;
+  private post;
+}
+//#endregion
 //#region src/types.d.ts
 type HubPrincipalKind = "user_session" | "api_key" | "sandbox_runtime";
 interface HubSuccessEnvelope<TData> {
@@ -14,7 +381,7 @@ interface HubErrorBody {
   message: string;
   details?: unknown;
 }
-type HubErrorCode = "HUB_UNAUTHENTICATED" | "HUB_FORBIDDEN" | "HUB_INVALID_INPUT" | "HUB_INVALID_STATE" | "HUB_PROVIDER_MISSING" | "HUB_CONNECTION_MISSING" | "HUB_CONNECTION_REVOKED" | "HUB_TOKEN_EXPIRED" | "HUB_TOKEN_REPLAYED" | "HUB_TOKEN_REVOKED" | "HUB_TOKEN_ACTION_MISMATCH" | "HUB_POLICY_DENIED" | "HUB_APPROVAL_REQUIRED" | "HUB_EXECUTOR_FAILURE" | "HUB_PROVIDER_FAILURE" | "HUB_CONFIG_MISSING" | "HUB_CONFIG_INVALID" | "HUB_NOT_FOUND" | "HUB_NOT_IMPLEMENTED" | "HUB_CONFLICT" | "VALIDATION_ERROR" | "WORKFLOW_INVALID" | "NOT_FOUND" | "UNAUTHORIZED" | "CONFLICT" | "MISSING_RUN_INPUTS" | "WORKFLOW_DISABLED" | "PAYLOAD_TOO_LARGE" | "WORKFLOW_RUN_TIMEOUT" | `HUB_HTTP_${number}`;
+type HubErrorCode = "HUB_UNAUTHENTICATED" | "HUB_FORBIDDEN" | "HUB_INVALID_INPUT" | "HUB_INVALID_STATE" | "HUB_PROVIDER_MISSING" | "HUB_CONNECTION_MISSING" | "HUB_CONNECTION_REVOKED" | "HUB_TOKEN_EXPIRED" | "HUB_TOKEN_REPLAYED" | "HUB_TOKEN_REVOKED" | "HUB_TOKEN_ACTION_MISMATCH" | "HUB_POLICY_DENIED" | "HUB_APPROVAL_REQUIRED" | "HUB_EXECUTOR_FAILURE" | "HUB_PROVIDER_FAILURE" | "HUB_PROVIDER_REJECTED" | "HUB_CONFIG_MISSING" | "HUB_CONFIG_INVALID" | "HUB_NOT_FOUND" | "HUB_NOT_IMPLEMENTED" | "HUB_CONFLICT" | "HUB_IDEMPOTENCY_CONFLICT" | "HUB_IDEMPOTENCY_IN_FLIGHT" | "VALIDATION_ERROR" | "WORKFLOW_INVALID" | "NOT_FOUND" | "UNAUTHORIZED" | "CONFLICT" | "MISSING_RUN_INPUTS" | "WORKFLOW_DISABLED" | "PAYLOAD_TOO_LARGE" | "WORKFLOW_RUN_TIMEOUT" | `HUB_HTTP_${number}`;
 interface HubStatusResponse {
   contract: unknown;
   principal: HubPrincipal;
@@ -36,6 +403,7 @@ interface HubConnection {
   providerId: string;
   displayName: string;
   accountDisplay: string | null;
+  providerAccountId: string | null;
   scopes: string[];
   status: "active" | "revoked" | "unhealthy" | "reconnect_required";
   health: "unknown" | "healthy" | "unhealthy" | "rate_limited";
@@ -168,6 +536,15 @@ interface HubEventDelivery {
 }
 /** A connector's auth model. */
 type HubProviderAuthKind = "oauth2" | "api_key" | "none" | "custom";
+/** One non-secret value needed before an OAuth redirect can be built. Tenant-
+ * scoped providers use this for the account label in their OAuth hostname. */
+interface HubOAuthConnectionParameter {
+  key: string;
+  label: string;
+  description: string;
+  placeholder: string;
+  required: true;
+}
 interface HubProvider {
   providerId: string;
   title: string;
@@ -193,6 +570,9 @@ interface HubProvider {
   /** True when the provider's OAuth app credentials are wired, i.e. a connect
    *  flow can actually start. UIs offer Connect only for configured providers. */
   configured: boolean;
+  /** Values the user must supply before OAuth starts. Empty or absent means the
+   *  provider can redirect immediately. */
+  connectionParameters?: HubOAuthConnectionParameter[];
   /**
    * True when this deployment can receive this provider's inbound events.
    * This is separate from `configured`: OAuth can be ready while the shared
@@ -209,6 +589,7 @@ interface HubOAuthStartRequest {
   provider: string;
   returnUrl?: string;
   cli?: boolean;
+  connectionParameters?: Record<string, string>;
 }
 interface HubOAuthCallbackSuccessQuery {
   provider: string;
@@ -269,7 +650,18 @@ interface HubOAuthCallbackResponse {
 interface HubApiKeyConnectRequest {
   provider: string;
   apiKey: string;
+  /** Connector-owned setup values. Hub validates them before testing the key. */
+  metadata?: HubApiKeyConnectionMetadata;
 }
+type HubApiKeyConnectionMetadata = {
+  propertyId: string;
+  currency?: string;
+} | {
+  listings: Array<{
+    id: string;
+    pms: string;
+  }>;
+};
 /** Result of an api-key connect: the created (or reconnected) connection.
  *  Synchronous — there is no redirect leg, unlike the OAuth flow. */
 interface HubApiKeyConnectResponse {
@@ -285,7 +677,7 @@ interface HubConnectionDeleteResponse {
 interface HubConnectionHealthRequest {
   connectionId: string;
 }
-type HubConnectionHealthStatus = "healthy" | "reconnect_required" | "unhealthy" | "rate_limited";
+type HubConnectionHealthStatus = "healthy" | "reconnect_required" | "unhealthy" | "rate_limited" | "unsupported";
 interface HubConnectionHealthError {
   code: string;
   message: string;
@@ -345,9 +737,18 @@ interface HubExecRequest {
   path: string;
   input?: unknown;
   connectionId?: string;
+  /** Caller-minted key for this exec. The platform ledger replays the first
+   *  call's result for a retry that carries the same key, and rejects a key
+   *  reused for a different request. On the capability-token arm the key only
+   *  reaches the connector for provider-native dedupe: that arm is at-most-once
+   *  per token and replays no stored result. */
+  idempotencyKey?: string;
 }
 interface HubExecResponse<TResult = unknown> {
   result: TResult;
+  /** True when the result was replayed from a previous call with the same
+   *  idempotency key, so the action did not run again. */
+  replayed?: boolean;
 }
 interface HubTokenMintRequest {
   connectionId?: string;
@@ -505,7 +906,7 @@ interface HubGithubAppInstallation {
   accountType: string | null;
   /** "all" ⇒ every repo under the account; "selected" ⇒ only repoFullNames. */
   repositorySelection: "all" | "selected";
-  /** Lowercased "owner/repo" — empty when repositorySelection = "all". */
+  /** Metadata omits names; use githubApp.listRepos(id) for a live caller-safe list. */
   repoFullNames: string[];
   suspended: boolean;
 }
@@ -558,8 +959,10 @@ interface HubGithubAppSyncResponse {
 }
 interface HubGithubAppListReposResponse {
   installationId: number;
-  /** Lowercased "owner/repo" — covers the full registry view of the install. */
+  /** Complete live intersection of App coverage and the caller's GitHub access. */
   repoFullNames: string[];
+  /** True only when both upstream listings completed; failures return an error. */
+  complete: true;
 }
 interface HubGithubAppIsRepoInstalledRequest {
   owner: string;
@@ -1102,6 +1505,14 @@ interface HubWorkflowConnectionRequirement {
   /** Where to satisfy the requirement (App install flow for `github_app`,
    *  integrations page otherwise); null when no target exists. */
   connectUrl: string | null;
+  /** Another requirement in the same list that must be satisfied first — a
+   *  `github_app` install is claimed through the `github` connection, so it is
+   *  refused while that connection is missing. Null when nothing blocks this
+   *  requirement. The list is ordered prerequisite-first. */
+  prerequisite: {
+    provider: string;
+    kind: "integration" | "github_app";
+  } | null;
 }
 /**
  * Result of instantiating a template. `created: false` is NOT an error — an
@@ -1225,8 +1636,11 @@ declare class HubClient {
   readonly fetch: typeof fetch;
   readonly apiKey?: string;
   readonly authHeaders?: HubAuthHeaders;
+  readonly allowances: HubAllowancesClient;
+  readonly apps: HubAppsClient;
   readonly connections: HubConnectionsClient;
   readonly channels: HubChannelsClient;
+  readonly numbers: HubManagedNumbersClient;
   readonly eventSubscriptions: HubEventSubscriptionsClient;
   readonly permissions: HubPermissionsClient;
   readonly tokens: HubTokensClient;
@@ -1304,6 +1718,13 @@ interface HubToolSearchOptions {
 interface HubToolInvokeOptions {
   connectionId?: string;
   approve?: boolean;
+  /** Caller-minted key for this invoke. On the direct exec arm the platform
+   *  ledger replays the first call's result for a retry that carries the same
+   *  key, and refuses a key bound to a different request. The approval and
+   *  capability-token retries re-send the key, and the connector receives it
+   *  for provider-native dedupe. Capability-token execution stays at-most-once
+   *  per token: it refuses a replay instead of replaying a stored result. */
+  idempotencyKey?: string;
 }
 declare class HubToolsClient {
   private readonly request;
@@ -1311,12 +1732,18 @@ declare class HubToolsClient {
   search(query: string, options?: HubToolSearchOptions): Promise<HubToolsSearchResponse>;
   sources(): Promise<HubToolSourcesResponse>;
   describe(path: string): Promise<HubToolsDescribeResponse>;
-  invoke<TResult = unknown>(path: string, input: unknown, options?: HubToolInvokeOptions): Promise<HubExecResponse<TResult>>;
+  /**
+   * Run one hub tool. `raw` is the tool input: the SDK forwards it verbatim as
+   * the request body's `input`, and the server validates it against the tool's
+   * own schema, so the client never gives it a shape.
+   */
+  invoke<TResult = unknown>(path: string, raw: unknown, options?: HubToolInvokeOptions): Promise<HubExecResponse<TResult>>;
   private buildExecInit;
 }
 interface HubConnectionStartOptions {
   returnUrl?: string;
   cli?: boolean;
+  connectionParameters?: Record<string, string>;
 }
 declare class HubChannelsClient {
   private readonly request;
@@ -1334,6 +1761,7 @@ declare class HubEventSubscriptionsClient {
 }
 declare class HubConnectionsClient {
   private readonly request;
+  readonly inboundWebhook: HubInboundWebhooksClient;
   constructor(request: <TData>(path: string, init: RequestInit) => Promise<TData>);
   list(): Promise<HubConnectionsResponse>;
   /** Connector catalog: every provider the hub can expose, each flagged with
@@ -1346,8 +1774,9 @@ declare class HubConnectionsClient {
   /** Connect a non-OAuth (api-key) connector by submitting the user's key.
    *  The server validates the key with a live probe before persisting and
    *  returns the created (or reconnected) connection — there is no redirect,
-   *  unlike `start`. */
-  connectApiKey(provider: string, apiKey: string): Promise<HubApiKeyConnectResponse>;
+   *  unlike `start`. Cloudbeds requires propertyId metadata and PriceLabs
+   *  requires listing ID/PMS pairs; other providers have no metadata. */
+  connectApiKey(provider: string, apiKey: string, metadata?: HubApiKeyConnectRequest["metadata"]): Promise<HubApiKeyConnectResponse>;
   revoke(connectionId: string): Promise<HubConnectionDeleteResponse>;
   health(connectionId: string): Promise<HubConnectionHealthResponse>;
 }
@@ -1629,15 +2058,18 @@ declare class HubWorkflowsClient {
   /**
    * Upsert a key; returns the entry with its NEW version (increments on every
    * write). Throws `HubSdkError(KV_VALUE_TOO_LARGE)` past the 64KiB value cap
-   * or `KV_KEY_LIMIT` past the per-workflow key cap.
+   * or `KV_KEY_LIMIT` past the per-workflow key cap. `raw` is the caller's
+   * value, stored and read back verbatim, so the client never gives it a shape.
    */
-  putKv(id: string, key: string, value: unknown): Promise<HubWorkflowKvEntry>;
+  putKv(id: string, key: string, raw: unknown): Promise<HubWorkflowKvEntry>;
   /**
    * Compare-and-swap: the write lands only when the stored version still
    * equals `expectedVersion`; otherwise `HubSdkError(KV_VERSION_CONFLICT)`
-   * (409) — re-read and retry. Creation is {@link putKv}'s job.
+   * (409) — re-read and retry. Creation is {@link putKv}'s job. `raw` is the
+   * caller's value, stored and read back verbatim, so the client never gives it
+   * a shape.
    */
-  casKv(id: string, key: string, expectedVersion: number, value: unknown): Promise<HubWorkflowKvEntry>;
+  casKv(id: string, key: string, expectedVersion: number, raw: unknown): Promise<HubWorkflowKvEntry>;
   /** Delete a key; idempotent — `deleted` reports whether a row was removed. */
   deleteKv(id: string, key: string): Promise<HubWorkflowKvDeleteResponse>;
   /** The curated starter gallery runnable on THIS deployment: metadata,
@@ -1766,5 +2198,5 @@ declare function parseHubEventDelivery(input: string | unknown): HubEventDeliver
 //#region src/redaction.d.ts
 declare function redactHubValue(value: unknown): unknown;
 //#endregion
-export { type AuthenticateHubEventRequestInput, type DeriveHubEventCallbackSecretInput, HUB_API_KEY_ENV_VAR, HUB_CAPABILITY_TOKEN_ENV_VAR, HUB_URL_ENV_VAR, type HubAgentIterationSpan, type HubAgentRunDetail, type HubApiKeyConnectRequest, type HubApiKeyConnectResponse, type HubApproval, type HubApprovalCapabilityToken, type HubApprovalDecisionResponse, type HubApprovalStatus, HubApprovalsClient, HubAuditClient, type HubAuditEvent, type HubAuditListRequest, type HubAuditResponse, type HubAuthHeaders, type HubCapabilityToken, type HubChannel, type HubChannelCreateResponse, type HubChannelDeleteResponse, HubChannelsClient, type HubChannelsResponse, HubClient, type HubClientFromEnvOptions, type HubClientOptions, type HubConnection, type HubConnectionDeleteRequest, type HubConnectionDeleteResponse, type HubConnectionHealthError, type HubConnectionHealthInfo, type HubConnectionHealthRequest, type HubConnectionHealthResponse, type HubConnectionHealthStatus, type HubConnectionStartOptions, HubConnectionsClient, type HubConnectionsResponse, type HubEmailChannel, type HubEmailChannelCreateRequest, type HubEnv, type HubEnvelope, type HubErrorBody, type HubErrorCode, type HubErrorEnvelope, type HubEventCondition, type HubEventConditionScalar, type HubEventDelivery, HubEventDeliveryError, type HubEventRequestFailureCode, type HubEventRequestResult, type HubEventSignatureFailure, type HubEventSignatureResult, type HubEventSubscription, type HubEventSubscriptionCallback, type HubEventSubscriptionCreateRequest, type HubEventSubscriptionCreateResponse, type HubEventSubscriptionDeleteResponse, type HubEventSubscriptionFilter, type HubEventSubscriptionSource, HubEventSubscriptionsClient, type HubEventSubscriptionsResponse, type HubExecRequest, type HubExecResponse, HubGithubAppClient, type HubGithubAppDisconnectResponse, type HubGithubAppInstallation, type HubGithubAppInstallationResponse, type HubGithubAppIsRepoInstalledRequest, type HubGithubAppIsRepoInstalledResponse, type HubGithubAppListInstallationsResponse, type HubGithubAppListReposResponse, type HubGithubAppManagedInstallation, type HubGithubAppMintInstallationTokenRequest, type HubGithubAppMintInstallationTokenResponse, type HubGithubAppSyncResponse, type HubGithubAppSyncedInstallation, type HubManualRunInput, type HubOAuthCallbackErrorQuery, type HubOAuthCallbackQuery, type HubOAuthCallbackResponse, type HubOAuthCallbackSuccessQuery, type HubOAuthStartRequest, type HubOAuthStartResponse, HubPermissionsClient, type HubPolicy, type HubPolicyDecision, type HubPolicyDeleteRequest, type HubPolicyDeleteResponse, type HubPolicyListRequest, type HubPolicyListResponse, type HubPolicyResponse, type HubPolicyUpdateRequest, type HubPrincipal, type HubPrincipalKind, type HubProvider, type HubProviderAuthKind, type HubProviderEvent, type HubProvidersResponse, HubSdkError, type HubStatusConnections, type HubStatusResponse, type HubSuccessEnvelope, type HubTokenListOptions, type HubTokenMintRequest, type HubTokenMintResponse, type HubTokenRevokeResponse, HubTokensClient, type HubTokensListResponse, type HubTool, type HubToolInvokeOptions, type HubToolRisk, type HubToolSearchOptions, type HubToolSource, type HubToolSourcesResponse, HubToolsClient, type HubToolsDescribeRequest, type HubToolsDescribeResponse, type HubToolsSearchRequest, type HubToolsSearchResponse, type HubUnimplementedErrorEnvelope, type HubWhatsappEmbeddedSignupCompleteRequest, type HubWhatsappEmbeddedSignupCompleteResponse, type HubWhatsappEmbeddedSignupStartRequest, type HubWhatsappEmbeddedSignupStartResponse, type HubWorkflow, type HubWorkflowAction, type HubWorkflowActionResult, type HubWorkflowAgentStep, type HubWorkflowArtifact, type HubWorkflowArtifactDownload, type HubWorkflowArtifactRef, type HubWorkflowArtifactsResponse, type HubWorkflowCondition, type HubWorkflowConditionOp, type HubWorkflowConditionScalar, type HubWorkflowConnectionRequirement, type HubWorkflowDecision, type HubWorkflowDecisionOnTimeout, type HubWorkflowDecisionResolveResult, type HubWorkflowDecisionResolvedVia, type HubWorkflowDecisionStatus, type HubWorkflowDistillationCandidate, type HubWorkflowEdgeVerdicts, type HubWorkflowEventFilter, type HubWorkflowFailureCluster, type HubWorkflowFleetEntry, type HubWorkflowFleetInsights, type HubWorkflowFleetWindow, type HubWorkflowGraphEdge, type HubWorkflowGraphJoinRule, type HubWorkflowGraphNode, type HubWorkflowGraphSpec, type HubWorkflowHealth, type HubWorkflowHookEndpoint, type HubWorkflowHookToken, type HubWorkflowKvDeleteResponse, type HubWorkflowKvEntry, type HubWorkflowKvEntryMeta, type HubWorkflowKvListResponse, type HubWorkflowNodeHealth, type HubWorkflowOnErrorOutcome, type HubWorkflowPendingDecision, type HubWorkflowPendingDecisionsResponse, type HubWorkflowProposal, type HubWorkflowProposalInput, type HubWorkflowRevision, type HubWorkflowRevisionMeta, type HubWorkflowRevisionSource, type HubWorkflowRevisionStatus, type HubWorkflowRun, type HubWorkflowRunCancelResult, type HubWorkflowRunDetail, type HubWorkflowRunEnqueued, type HubWorkflowRunInputs, type HubWorkflowRunRetried, type HubWorkflowRunStatus, type HubWorkflowRunStepsPage, type HubWorkflowRunStreamEvent, type HubWorkflowRunSummary, type HubWorkflowRunsPage, type HubWorkflowSchemaResponse, type HubWorkflowTemplate, type HubWorkflowTemplateCategory, type HubWorkflowTemplateInstantiateResult, type HubWorkflowTemplateParameter, type HubWorkflowTrigger, type HubWorkflowValidateResponse, type HubWorkflowValidationError, HubWorkflowsClient, type VerifyHubEventSignatureInput, authenticateHubEventRequest, deriveHubEventCallbackSecret, parseHubEventDelivery, redactHubValue, resolveHubAuth, resolveHubBaseUrl, verifyHubEventSignature };
+export { type AuthenticateHubEventRequestInput, type DeriveHubEventCallbackSecretInput, HUB_API_KEY_ENV_VAR, HUB_CAPABILITY_TOKEN_ENV_VAR, HUB_URL_ENV_VAR, type HubAgentIterationSpan, type HubAgentRunDetail, type HubAllowanceDecision, type HubAllowanceGrant, type HubAllowancePlan, type HubAllowancePlanInput, type HubAllowanceRole, type HubAllowanceSubject, type HubAllowanceTier, type HubAllowanceUsage, HubAllowancesClient, type HubApiKeyConnectRequest, type HubApiKeyConnectResponse, type HubApiKeyConnectionMetadata, type HubApp, type HubAppCreateInput, type HubAppGrant, type HubAppGrantRevoked, type HubApproval, type HubApprovalCapabilityToken, type HubApprovalDecisionResponse, type HubApprovalStatus, HubApprovalsClient, HubAppsClient, HubAuditClient, type HubAuditEvent, type HubAuditListRequest, type HubAuditResponse, type HubAuthHeaders, type HubCapabilityToken, type HubChannel, type HubChannelCreateResponse, type HubChannelDeleteResponse, HubChannelsClient, type HubChannelsResponse, HubClient, type HubClientFromEnvOptions, type HubClientOptions, type HubConnection, type HubConnectionDeleteRequest, type HubConnectionDeleteResponse, type HubConnectionHealthError, type HubConnectionHealthInfo, type HubConnectionHealthRequest, type HubConnectionHealthResponse, type HubConnectionHealthStatus, type HubConnectionStartOptions, HubConnectionsClient, type HubConnectionsResponse, type HubEmailChannel, type HubEmailChannelCreateRequest, type HubEnv, type HubEnvelope, type HubErrorBody, type HubErrorCode, type HubErrorEnvelope, type HubEventCondition, type HubEventConditionScalar, type HubEventDelivery, HubEventDeliveryError, type HubEventRequestFailureCode, type HubEventRequestResult, type HubEventSignatureFailure, type HubEventSignatureResult, type HubEventSubscription, type HubEventSubscriptionCallback, type HubEventSubscriptionCreateRequest, type HubEventSubscriptionCreateResponse, type HubEventSubscriptionDeleteResponse, type HubEventSubscriptionFilter, type HubEventSubscriptionSource, HubEventSubscriptionsClient, type HubEventSubscriptionsResponse, type HubExecRequest, type HubExecResponse, HubGithubAppClient, type HubGithubAppDisconnectResponse, type HubGithubAppInstallation, type HubGithubAppInstallationResponse, type HubGithubAppIsRepoInstalledRequest, type HubGithubAppIsRepoInstalledResponse, type HubGithubAppListInstallationsResponse, type HubGithubAppListReposResponse, type HubGithubAppManagedInstallation, type HubGithubAppMintInstallationTokenRequest, type HubGithubAppMintInstallationTokenResponse, type HubGithubAppSyncResponse, type HubGithubAppSyncedInstallation, type HubInboundPhoneNumberScope, type HubInboundWebhookCreateOptions, type HubInboundWebhookCreateResponse, type HubInboundWebhookStatus, HubInboundWebhooksClient, HubManagedNumbersClient, type HubManualRunInput, type HubNumberListQuery, type HubNumberOrder, type HubNumberOrderPage, type HubNumberQuote, type HubNumberReadiness, type HubNumberResolution, type HubOAuthCallbackErrorQuery, type HubOAuthCallbackQuery, type HubOAuthCallbackResponse, type HubOAuthCallbackSuccessQuery, type HubOAuthConnectionParameter, type HubOAuthStartRequest, type HubOAuthStartResponse, HubPermissionsClient, type HubPolicy, type HubPolicyDecision, type HubPolicyDeleteRequest, type HubPolicyDeleteResponse, type HubPolicyListRequest, type HubPolicyListResponse, type HubPolicyResponse, type HubPolicyUpdateRequest, type HubPrincipal, type HubPrincipalKind, type HubProvider, type HubProviderAuthKind, type HubProviderEvent, type HubProvidersResponse, HubSdkError, type HubStatusConnections, type HubStatusResponse, type HubSuccessEnvelope, type HubTokenListOptions, type HubTokenMintRequest, type HubTokenMintResponse, type HubTokenRevokeResponse, HubTokensClient, type HubTokensListResponse, type HubTool, type HubToolInvokeOptions, type HubToolRisk, type HubToolSearchOptions, type HubToolSource, type HubToolSourcesResponse, HubToolsClient, type HubToolsDescribeRequest, type HubToolsDescribeResponse, type HubToolsSearchRequest, type HubToolsSearchResponse, type HubUnimplementedErrorEnvelope, type HubWhatsappEmbeddedSignupCompleteRequest, type HubWhatsappEmbeddedSignupCompleteResponse, type HubWhatsappEmbeddedSignupStartRequest, type HubWhatsappEmbeddedSignupStartResponse, type HubWorkflow, type HubWorkflowAction, type HubWorkflowActionResult, type HubWorkflowAgentStep, type HubWorkflowArtifact, type HubWorkflowArtifactDownload, type HubWorkflowArtifactRef, type HubWorkflowArtifactsResponse, type HubWorkflowCondition, type HubWorkflowConditionOp, type HubWorkflowConditionScalar, type HubWorkflowConnectionRequirement, type HubWorkflowDecision, type HubWorkflowDecisionOnTimeout, type HubWorkflowDecisionResolveResult, type HubWorkflowDecisionResolvedVia, type HubWorkflowDecisionStatus, type HubWorkflowDistillationCandidate, type HubWorkflowEdgeVerdicts, type HubWorkflowEventFilter, type HubWorkflowFailureCluster, type HubWorkflowFleetEntry, type HubWorkflowFleetInsights, type HubWorkflowFleetWindow, type HubWorkflowGraphEdge, type HubWorkflowGraphJoinRule, type HubWorkflowGraphNode, type HubWorkflowGraphSpec, type HubWorkflowHealth, type HubWorkflowHookEndpoint, type HubWorkflowHookToken, type HubWorkflowKvDeleteResponse, type HubWorkflowKvEntry, type HubWorkflowKvEntryMeta, type HubWorkflowKvListResponse, type HubWorkflowNodeHealth, type HubWorkflowOnErrorOutcome, type HubWorkflowPendingDecision, type HubWorkflowPendingDecisionsResponse, type HubWorkflowProposal, type HubWorkflowProposalInput, type HubWorkflowRevision, type HubWorkflowRevisionMeta, type HubWorkflowRevisionSource, type HubWorkflowRevisionStatus, type HubWorkflowRun, type HubWorkflowRunCancelResult, type HubWorkflowRunDetail, type HubWorkflowRunEnqueued, type HubWorkflowRunInputs, type HubWorkflowRunRetried, type HubWorkflowRunStatus, type HubWorkflowRunStepsPage, type HubWorkflowRunStreamEvent, type HubWorkflowRunSummary, type HubWorkflowRunsPage, type HubWorkflowSchemaResponse, type HubWorkflowTemplate, type HubWorkflowTemplateCategory, type HubWorkflowTemplateInstantiateResult, type HubWorkflowTemplateParameter, type HubWorkflowTrigger, type HubWorkflowValidateResponse, type HubWorkflowValidationError, HubWorkflowsClient, type VerifyHubEventSignatureInput, authenticateHubEventRequest, deriveHubEventCallbackSecret, parseHubEventDelivery, redactHubValue, resolveHubAuth, resolveHubBaseUrl, verifyHubEventSignature };
 //# sourceMappingURL=index.d.ts.map