{ "schemaVersion": 1, "packages": { "@farthershore/business": "3.2.0", "@farthershore/backend": "0.21.2", "@farthershore/farthershore-js": "0.32.0", "@farthershore/cli": "0.33.5" }, "capabilities": [ { "id": "cli.agents", "name": "farthershore agents", "kind": "cli", "collection": "cli", "page": "generated/cli/agents", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore agents [options] [command]\n\nEnable, disable, and inspect a business's operating agents\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [businessIdOrSlug] List a business's operating agents +\n enableable roles\n status [businessIdOrSlug] The Operator's activation state, recent\n runs, and usage totals\n runs-show [businessIdOrSlug] [runId] One run's full paper trail: trace,\n launches, action receipts\n enable [businessIdOrSlug] Turn the Operator on (creates it on\n first enable)\n disable [businessIdOrSlug] Turn the Operator off (stops runs +\n billing)\n help [command] display help for command", "signature": "Usage: farthershore agents [options] [command]\n\nEnable, disable, and inspect a business's operating agents\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [businessIdOrSlug] List a business's operating agents +\n enableable roles\n status [businessIdOrSlug] The Operator's activation state, recent\n runs, and usage totals\n runs-show [businessIdOrSlug] [runId] One run's full paper trail: trace,\n launches, action receipts\n enable [businessIdOrSlug] Turn the Operator on (creates it on\n first enable)\n disable [businessIdOrSlug] Turn the Operator off (stops runs +\n billing)\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.agents.disable", "name": "farthershore agents disable", "kind": "cli", "collection": "cli", "page": "generated/cli/agents", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore agents disable [options] [businessIdOrSlug]\n\nTurn the Operator off (stops runs + billing)\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore agents disable [options] [businessIdOrSlug]\n\nTurn the Operator off (stops runs + billing)\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.agents.enable", "name": "farthershore agents enable", "kind": "cli", "collection": "cli", "page": "generated/cli/agents", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore agents enable [options] [businessIdOrSlug]\n\nTurn the Operator on (creates it on first enable)\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore agents enable [options] [businessIdOrSlug]\n\nTurn the Operator on (creates it on first enable)\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.agents.list", "name": "farthershore agents list", "kind": "cli", "collection": "cli", "page": "generated/cli/agents", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore agents list [options] [businessIdOrSlug]\n\nList a business's operating agents + enableable roles\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore agents list [options] [businessIdOrSlug]\n\nList a business's operating agents + enableable roles\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.agents.runs-show", "name": "farthershore agents runs-show", "kind": "cli", "collection": "cli", "page": "generated/cli/agents", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore agents runs-show [options] [businessIdOrSlug] \n\nOne run's full paper trail: trace, launches, action receipts\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore agents runs-show [options] [businessIdOrSlug] \n\nOne run's full paper trail: trace, launches, action receipts\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.agents.status", "name": "farthershore agents status", "kind": "cli", "collection": "cli", "page": "generated/cli/agents", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore agents status [options] [businessIdOrSlug]\n\nThe Operator's activation state, recent runs, and usage totals\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore agents status [options] [businessIdOrSlug]\n\nThe Operator's activation state, recent runs, and usage totals\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.agreements", "name": "farthershore agreements", "kind": "cli", "collection": "cli", "page": "generated/cli/agreements", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore agreements [options] [command]\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrSlug] List a business's economic agreements\n show [businessIdOrSlug] [agreementId] Show one economic agreement with its version history\n pins [businessIdOrSlug] [subscriptionId] Read a subject's subscription pins (recurring-price pin + usage-pricing binding). Read-only; migrate-to-latest is deferred.\n create [options] [businessIdOrSlug] Create an economic agreement (confirm-gated: previews first; pass --confirm to commit)\n amend [options] [businessIdOrSlug] [agreementId] Amend an agreement's contract terms (append-only; confirm-gated: previews first; pass --confirm to commit)\n help [command] display help for command", "signature": "Usage: farthershore agreements [options] [command]\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrSlug] List a business's economic agreements\n show [businessIdOrSlug] [agreementId] Show one economic agreement with its version history\n pins [businessIdOrSlug] [subscriptionId] Read a subject's subscription pins (recurring-price pin + usage-pricing binding). Read-only; migrate-to-latest is deferred.\n create [options] [businessIdOrSlug] Create an economic agreement (confirm-gated: previews first; pass --confirm to commit)\n amend [options] [businessIdOrSlug] [agreementId] Amend an agreement's contract terms (append-only; confirm-gated: previews first; pass --confirm to commit)\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.agreements.amend", "name": "farthershore agreements amend", "kind": "cli", "collection": "cli", "page": "generated/cli/agreements", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore agreements amend [options] [businessIdOrSlug] \n\nAmend an agreement's contract terms (append-only; confirm-gated: previews first;\npass --confirm to commit)\n\nOptions:\n --terms-json Negotiated contract terms as JSON:\n {\"percentDiscount\":{\"num\":\"1\",\"den\":\"5\"},\"floorNanos\":\"…\",\"capNanos\":\"…\",\"selectorScope\":[{\"kind\":\"provider_model_glob\",\"provider\":\"acme\",\"modelGlob\":\"acme-*\"}]}.\n Required for current_with_contract_terms and for\n amend.\n --effective-at When the agreement/version takes effect (ISO-8601).\n Default: now.\n --confirm The confirmationToken returned by the preview run.\n Omit to preview only.\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n\nTwo-step: run once to PREVIEW (prints the effect + confirmationToken; nothing is written), then re-run the SAME command with --confirm to append the new version.", "signature": "Usage: farthershore agreements amend [options] [businessIdOrSlug] \n\nAmend an agreement's contract terms (append-only; confirm-gated: previews first;\npass --confirm to commit)\n\nOptions:\n --terms-json Negotiated contract terms as JSON:\n {\"percentDiscount\":{\"num\":\"1\",\"den\":\"5\"},\"floorNanos\":\"…\",\"capNanos\":\"…\",\"selectorScope\":[{\"kind\":\"provider_model_glob\",\"provider\":\"acme\",\"modelGlob\":\"acme-*\"}]}.\n Required for current_with_contract_terms and for\n amend.\n --effective-at When the agreement/version takes effect (ISO-8601).\n Default: now.\n --confirm The confirmationToken returned by the preview run.\n Omit to preview only.\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n\nTwo-step: run once to PREVIEW (prints the effect + confirmationToken; nothing is written), then re-run the SAME command with --confirm to append the new version.\n", "guide": "cli/overview" }, { "id": "cli.agreements.create", "name": "farthershore agreements create", "kind": "cli", "collection": "cli", "page": "generated/cli/agreements", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore agreements create [options] [businessIdOrSlug]\n\nCreate an economic agreement (confirm-gated: previews first; pass --confirm\n to commit)\n\nOptions:\n --subject The subject (subscription) the agreement binds.\n --binding Usage-pricing binding: current | current_with_contract_terms | fixed_version.\n --policy The pricing policy to bind.\n --policy-version fixed_version only: the immutable policy version to pin.\n --new-meter-policy What a never-negotiated meter does: adopt_at_current_rate | exclude_until_renewal | require_amendment (default require_amendment).\n --new-measure-policy What a new measure on an agreed meter does: adopt_at_current_rate | exclude_until_renewal | require_amendment (default require_amendment).\n --terms-json Negotiated contract terms as JSON: {\"percentDiscount\":{\"num\":\"1\",\"den\":\"5\"},\"floorNanos\":\"…\",\"capNanos\":\"…\",\"selectorScope\":[{\"kind\":\"provider_model_glob\",\"provider\":\"acme\",\"modelGlob\":\"acme-*\"}]}. Required for current_with_contract_terms and for amend.\n --effective-at When the agreement/version takes effect (ISO-8601). Default: now.\n --expires-at Optional expiry (ISO-8601).\n --env Preview environment slug or id (omit for production).\n --confirm The confirmationToken returned by the preview run. Omit to preview only.\n --idempotency-key Required for this mutation. Generate it once and reuse the exact value on retry.\n -h, --help display help for command\n\nTwo-step: run once to PREVIEW (prints the effect + confirmationToken; nothing is written), then re-run the SAME command with --confirm to commit.", "signature": "Usage: farthershore agreements create [options] [businessIdOrSlug]\n\nCreate an economic agreement (confirm-gated: previews first; pass --confirm\n to commit)\n\nOptions:\n --subject The subject (subscription) the agreement binds.\n --binding Usage-pricing binding: current | current_with_contract_terms | fixed_version.\n --policy The pricing policy to bind.\n --policy-version fixed_version only: the immutable policy version to pin.\n --new-meter-policy What a never-negotiated meter does: adopt_at_current_rate | exclude_until_renewal | require_amendment (default require_amendment).\n --new-measure-policy What a new measure on an agreed meter does: adopt_at_current_rate | exclude_until_renewal | require_amendment (default require_amendment).\n --terms-json Negotiated contract terms as JSON: {\"percentDiscount\":{\"num\":\"1\",\"den\":\"5\"},\"floorNanos\":\"…\",\"capNanos\":\"…\",\"selectorScope\":[{\"kind\":\"provider_model_glob\",\"provider\":\"acme\",\"modelGlob\":\"acme-*\"}]}. Required for current_with_contract_terms and for amend.\n --effective-at When the agreement/version takes effect (ISO-8601). Default: now.\n --expires-at Optional expiry (ISO-8601).\n --env Preview environment slug or id (omit for production).\n --confirm The confirmationToken returned by the preview run. Omit to preview only.\n --idempotency-key Required for this mutation. Generate it once and reuse the exact value on retry.\n -h, --help display help for command\n\nTwo-step: run once to PREVIEW (prints the effect + confirmationToken; nothing is written), then re-run the SAME command with --confirm to commit.\n", "guide": "cli/overview" }, { "id": "cli.agreements.list", "name": "farthershore agreements list", "kind": "cli", "collection": "cli", "page": "generated/cli/agreements", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore agreements list [options] [businessIdOrSlug]\n\nList a business's economic agreements\n\nOptions:\n --subject Filter by subject (subscription) id.\n --env Preview environment slug or id (omit for\n production).\n -h, --help display help for command", "signature": "Usage: farthershore agreements list [options] [businessIdOrSlug]\n\nList a business's economic agreements\n\nOptions:\n --subject Filter by subject (subscription) id.\n --env Preview environment slug or id (omit for\n production).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.agreements.pins", "name": "farthershore agreements pins", "kind": "cli", "collection": "cli", "page": "generated/cli/agreements", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore agreements pins [options] [businessIdOrSlug] \n\nRead a subject's subscription pins (recurring-price pin + usage-pricing\nbinding). Read-only; migrate-to-latest is deferred.\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore agreements pins [options] [businessIdOrSlug] \n\nRead a subject's subscription pins (recurring-price pin + usage-pricing\nbinding). Read-only; migrate-to-latest is deferred.\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.agreements.show", "name": "farthershore agreements show", "kind": "cli", "collection": "cli", "page": "generated/cli/agreements", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore agreements show [options] [businessIdOrSlug] \n\nShow one economic agreement with its version history\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore agreements show [options] [businessIdOrSlug] \n\nShow one economic agreement with its version history\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.analytics", "name": "farthershore analytics", "kind": "cli", "collection": "cli", "page": "generated/cli/analytics", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore analytics [options] [command]\n\nQuery the business event archive\n\nOptions:\n -h, --help display help for command\n\nCommands:\n timeseries [options] [businessIdOrName] Request (or denial) volume over time\n latency [options] [businessIdOrName] Request latency percentiles (p50 / p95 / p99)\n top [options] [businessIdOrName] Top callers / event types / environments by volume\n log [options] [businessIdOrName] Recent requests — the live metering signal, newest first\n help [command] display help for command", "signature": "Usage: farthershore analytics [options] [command]\n\nQuery the business event archive\n\nOptions:\n -h, --help display help for command\n\nCommands:\n timeseries [options] [businessIdOrName] Request (or denial) volume over time\n latency [options] [businessIdOrName] Request latency percentiles (p50 / p95 / p99)\n top [options] [businessIdOrName] Top callers / event types / environments by volume\n log [options] [businessIdOrName] Recent requests — the live metering signal, newest first\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.analytics.latency", "name": "farthershore analytics latency", "kind": "cli", "collection": "cli", "page": "generated/cli/analytics", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore analytics latency [options] [businessIdOrName]\n\nRequest latency percentiles (p50 / p95 / p99)\n\nOptions:\n --range Relative window: 1h | 24h | 7d | 30d (default: \"24h\")\n --env Environment id to scope to. Omit for production — never\n for 'all environments'.\n -h, --help display help for command", "signature": "Usage: farthershore analytics latency [options] [businessIdOrName]\n\nRequest latency percentiles (p50 / p95 / p99)\n\nOptions:\n --range Relative window: 1h | 24h | 7d | 30d (default: \"24h\")\n --env Environment id to scope to. Omit for production — never\n for 'all environments'.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.analytics.log", "name": "farthershore analytics log", "kind": "cli", "collection": "cli", "page": "generated/cli/analytics", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore analytics log [options] [businessIdOrName]\n\nRecent requests — the live metering signal, newest first\n\nOptions:\n --range Relative window: 1h | 24h | 7d | 30d (default: \"24h\")\n --env Environment id to scope to. Omit for production — never\n for 'all environments'.\n --domain Archive domain: usage | telemetry | denials | lifecycle\n | consumer_activity | audit (default: \"usage\")\n --limit How many rows (1-100) (default: \"25\")\n -h, --help display help for command", "signature": "Usage: farthershore analytics log [options] [businessIdOrName]\n\nRecent requests — the live metering signal, newest first\n\nOptions:\n --range Relative window: 1h | 24h | 7d | 30d (default: \"24h\")\n --env Environment id to scope to. Omit for production — never\n for 'all environments'.\n --domain Archive domain: usage | telemetry | denials | lifecycle\n | consumer_activity | audit (default: \"usage\")\n --limit How many rows (1-100) (default: \"25\")\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.analytics.timeseries", "name": "farthershore analytics timeseries", "kind": "cli", "collection": "cli", "page": "generated/cli/analytics", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore analytics timeseries [options] [businessIdOrName]\n\nRequest (or denial) volume over time\n\nOptions:\n --range Relative window: 1h | 24h | 7d | 30d (default: \"24h\")\n --env Environment id to scope to. Omit for production — never\n for 'all environments'.\n --domain Archive domain: usage | telemetry | denials | lifecycle\n | consumer_activity | audit (default: \"usage\")\n --interval Bucket size: hour | day (default: \"hour\")\n -h, --help display help for command", "signature": "Usage: farthershore analytics timeseries [options] [businessIdOrName]\n\nRequest (or denial) volume over time\n\nOptions:\n --range Relative window: 1h | 24h | 7d | 30d (default: \"24h\")\n --env Environment id to scope to. Omit for production — never\n for 'all environments'.\n --domain Archive domain: usage | telemetry | denials | lifecycle\n | consumer_activity | audit (default: \"usage\")\n --interval Bucket size: hour | day (default: \"hour\")\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.analytics.top", "name": "farthershore analytics top", "kind": "cli", "collection": "cli", "page": "generated/cli/analytics", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore analytics top [options] [businessIdOrName]\n\nTop callers / event types / environments by volume\n\nOptions:\n --range Relative window: 1h | 24h | 7d | 30d (default: \"24h\")\n --env Environment id to scope to. Omit for production — never\n for 'all environments'.\n --by Break down by: actor_id | type | environment_id\n (default: \"actor_id\")\n --domain Archive domain: usage | telemetry | denials | lifecycle\n | consumer_activity | audit (default: \"usage\")\n --k How many rows (1-50) (default: \"10\")\n -h, --help display help for command", "signature": "Usage: farthershore analytics top [options] [businessIdOrName]\n\nTop callers / event types / environments by volume\n\nOptions:\n --range Relative window: 1h | 24h | 7d | 30d (default: \"24h\")\n --env Environment id to scope to. Omit for production — never\n for 'all environments'.\n --by Break down by: actor_id | type | environment_id\n (default: \"actor_id\")\n --domain Archive domain: usage | telemetry | denials | lifecycle\n | consumer_activity | audit (default: \"usage\")\n --k How many rows (1-50) (default: \"10\")\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.apply-timeline", "name": "farthershore apply-timeline", "kind": "cli", "collection": "cli", "page": "generated/cli/apply-timeline", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore apply-timeline [options] [command]\n\nInspect the Apply Timeline: repo-triggered manifest applies (PRs, pushes,\nreleases), checks, diffs, apply phases\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrName] List a business's Apply Timeline: repo-triggered manifest applies (PRs, pushes, releases), checks, semantic diffs, and apply phases.\n inspect [options] [businessIdOrName] [id|tag|pr|branch|sha] Inspect one Apply Timeline entry by id, release tag, PR number, branch, or commit SHA.\n help [command] display help for command", "signature": "Usage: farthershore apply-timeline [options] [command]\n\nInspect the Apply Timeline: repo-triggered manifest applies (PRs, pushes,\nreleases), checks, diffs, apply phases\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrName] List a business's Apply Timeline: repo-triggered manifest applies (PRs, pushes, releases), checks, semantic diffs, and apply phases.\n inspect [options] [businessIdOrName] [id|tag|pr|branch|sha] Inspect one Apply Timeline entry by id, release tag, PR number, branch, or commit SHA.\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.apply-timeline.inspect", "name": "farthershore apply-timeline inspect", "kind": "cli", "collection": "cli", "page": "generated/cli/apply-timeline", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore apply-timeline inspect [options] [businessIdOrName] \n\nInspect one Apply Timeline entry by id, release tag, PR number, branch, or\ncommit SHA.\n\nOptions:\n --env Environment scope: production, all, or a preview environment\n name.\n -h, --help display help for command", "signature": "Usage: farthershore apply-timeline inspect [options] [businessIdOrName] \n\nInspect one Apply Timeline entry by id, release tag, PR number, branch, or\ncommit SHA.\n\nOptions:\n --env Environment scope: production, all, or a preview environment\n name.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.apply-timeline.list", "name": "farthershore apply-timeline list", "kind": "cli", "collection": "cli", "page": "generated/cli/apply-timeline", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore apply-timeline list [options] [businessIdOrName]\n\nList a business's Apply Timeline: repo-triggered manifest applies (PRs, pushes,\nreleases), checks, semantic diffs, and apply phases.\n\nOptions:\n --env Environment scope: production, all, or a preview environment\n name.\n -h, --help display help for command", "signature": "Usage: farthershore apply-timeline list [options] [businessIdOrName]\n\nList a business's Apply Timeline: repo-triggered manifest applies (PRs, pushes,\nreleases), checks, semantic diffs, and apply phases.\n\nOptions:\n --env Environment scope: production, all, or a preview environment\n name.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.audit-log", "name": "farthershore audit-log", "kind": "cli", "collection": "cli", "page": "generated/cli/audit-log", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore audit-log [options] [command]\n\nRead and export builder audit logs\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] List organization or business-scoped audit-log rows\n business-list [options] List one business's audit-log rows\n export [options] Export organization or business-scoped audit logs as CSV\n business-export [options] Export one business's audit logs as CSV\n help [command] display help for command", "signature": "Usage: farthershore audit-log [options] [command]\n\nRead and export builder audit logs\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] List organization or business-scoped audit-log rows\n business-list [options] List one business's audit-log rows\n export [options] Export organization or business-scoped audit logs as CSV\n business-export [options] Export one business's audit logs as CSV\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.audit-log.business-export", "name": "farthershore audit-log business-export", "kind": "cli", "collection": "cli", "page": "generated/cli/audit-log", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore audit-log business-export [options] \n\nExport one business's audit logs as CSV\n\nOptions:\n --action \n --actor \n --decision \n --from \n --to \n --limit \n --output Write CSV to this file; omit to return it in command\n output.\n -h, --help display help for command", "signature": "Usage: farthershore audit-log business-export [options] \n\nExport one business's audit logs as CSV\n\nOptions:\n --action \n --actor \n --decision \n --from \n --to \n --limit \n --output Write CSV to this file; omit to return it in command\n output.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.audit-log.business-list", "name": "farthershore audit-log business-list", "kind": "cli", "collection": "cli", "page": "generated/cli/audit-log", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore audit-log business-list [options] \n\nList one business's audit-log rows\n\nOptions:\n --action \n --actor \n --decision \n --from \n --to \n --limit \n --cursor \n -h, --help display help for command", "signature": "Usage: farthershore audit-log business-list [options] \n\nList one business's audit-log rows\n\nOptions:\n --action \n --actor \n --decision \n --from \n --to \n --limit \n --cursor \n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.audit-log.export", "name": "farthershore audit-log export", "kind": "cli", "collection": "cli", "page": "generated/cli/audit-log", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore audit-log export [options] \n\nExport organization or business-scoped audit logs as CSV\n\nOptions:\n --action \n --actor \n --decision \n --from \n --to \n --limit \n --output Write CSV to this file; omit to return it in command\n output.\n -h, --help display help for command", "signature": "Usage: farthershore audit-log export [options] \n\nExport organization or business-scoped audit logs as CSV\n\nOptions:\n --action \n --actor \n --decision \n --from \n --to \n --limit \n --output Write CSV to this file; omit to return it in command\n output.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.audit-log.list", "name": "farthershore audit-log list", "kind": "cli", "collection": "cli", "page": "generated/cli/audit-log", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore audit-log list [options] \n\nList organization or business-scoped audit-log rows\n\nOptions:\n --action \n --actor \n --decision \n --from \n --to \n --limit \n --cursor \n -h, --help display help for command", "signature": "Usage: farthershore audit-log list [options] \n\nList organization or business-scoped audit-log rows\n\nOptions:\n --action \n --actor \n --decision \n --from \n --to \n --limit \n --cursor \n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.auth", "name": "farthershore auth", "kind": "cli", "collection": "cli", "page": "generated/cli/auth", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore auth [options] [command]\n\nInspect CLI identity and select an organization\n\nOptions:\n -h, --help display help for command\n\nCommands:\n organization List or select organizations for this CLI session\n whoami Show current auth identity and delegated authority\n context-token [options] [businessIdOrName] Issue a short-lived gateway context token for a subscriber member\n help [command] display help for command", "signature": "Usage: farthershore auth [options] [command]\n\nInspect CLI identity and select an organization\n\nOptions:\n -h, --help display help for command\n\nCommands:\n organization List or select organizations for this CLI session\n whoami Show current auth identity and delegated authority\n context-token [options] [businessIdOrName] Issue a short-lived gateway context token for a subscriber member\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.auth.context-token", "name": "farthershore auth context-token", "kind": "cli", "collection": "cli", "page": "generated/cli/auth", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore auth context-token [options] [businessIdOrName]\n\nIssue a short-lived gateway context token for a subscriber member\n\nOptions:\n --external-org \n --actor \n --ttl-seconds \n -h, --help display help for command", "signature": "Usage: farthershore auth context-token [options] [businessIdOrName]\n\nIssue a short-lived gateway context token for a subscriber member\n\nOptions:\n --external-org \n --actor \n --ttl-seconds \n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.auth.organization", "name": "farthershore auth organization", "kind": "cli", "collection": "cli", "page": "generated/cli/auth", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore auth organization [options] [command]\n\nList or select organizations for this CLI session\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list List organizations available to the signed-in user\n use Set the default organization while retaining this credential\n help [command] display help for command", "signature": "Usage: farthershore auth organization [options] [command]\n\nList or select organizations for this CLI session\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list List organizations available to the signed-in user\n use Set the default organization while retaining this credential\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.auth.organization.list", "name": "farthershore auth organization list", "kind": "cli", "collection": "cli", "page": "generated/cli/auth", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore auth organization list [options]\n\nList organizations available to the signed-in user\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore auth organization list [options]\n\nList organizations available to the signed-in user\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.auth.organization.use", "name": "farthershore auth organization use", "kind": "cli", "collection": "cli", "page": "generated/cli/auth", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore auth organization use [options] \n\nSet the default organization while retaining this credential\n\nArguments:\n id-or-slug Organization id or slug\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore auth organization use [options] \n\nSet the default organization while retaining this credential\n\nArguments:\n id-or-slug Organization id or slug\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.auth.whoami", "name": "farthershore auth whoami", "kind": "cli", "collection": "cli", "page": "generated/cli/auth", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore auth whoami [options]\n\nShow current auth identity and delegated authority\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore auth whoami [options]\n\nShow current auth identity and delegated authority\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.automation", "name": "farthershore automation", "kind": "cli", "collection": "cli", "page": "generated/cli/automation", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore automation [options] [command]\n\nManage platform automation rules\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [businessIdOrName] List automation rules\n create [options] [businessIdOrName] Create an automation rule\n update [options] [businessIdOrName] [ruleId] Update an automation rule\n delete [options] [businessIdOrName] [ruleId] Delete an automation rule\n help [command] display help for command", "signature": "Usage: farthershore automation [options] [command]\n\nManage platform automation rules\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [businessIdOrName] List automation rules\n create [options] [businessIdOrName] Create an automation rule\n update [options] [businessIdOrName] [ruleId] Update an automation rule\n delete [options] [businessIdOrName] [ruleId] Delete an automation rule\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.automation.create", "name": "farthershore automation create", "kind": "cli", "collection": "cli", "page": "generated/cli/automation", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore automation create [options] [businessIdOrName]\n\nCreate an automation rule\n\nOptions:\n --body Closed request body as a JSON object\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore automation create [options] [businessIdOrName]\n\nCreate an automation rule\n\nOptions:\n --body Closed request body as a JSON object\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.automation.delete", "name": "farthershore automation delete", "kind": "cli", "collection": "cli", "page": "generated/cli/automation", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore automation delete [options] [businessIdOrName] \n\nDelete an automation rule\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command", "signature": "Usage: farthershore automation delete [options] [businessIdOrName] \n\nDelete an automation rule\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.automation.list", "name": "farthershore automation list", "kind": "cli", "collection": "cli", "page": "generated/cli/automation", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore automation list [options] [businessIdOrName]\n\nList automation rules\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore automation list [options] [businessIdOrName]\n\nList automation rules\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.automation.update", "name": "farthershore automation update", "kind": "cli", "collection": "cli", "page": "generated/cli/automation", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore automation update [options] [businessIdOrName] \n\nUpdate an automation rule\n\nOptions:\n --body Closed request body as a JSON object\n -h, --help display help for command", "signature": "Usage: farthershore automation update [options] [businessIdOrName] \n\nUpdate an automation rule\n\nOptions:\n --body Closed request body as a JSON object\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.backend", "name": "farthershore backend", "kind": "cli", "collection": "cli", "page": "generated/cli/backend", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore backend [options] [command]\n\nManage BYO backends and their runtime tokens\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrSlug] List backends for a business (id, scope, name, transport, status)\n create [options] [businessIdOrSlug] Create a backend (default transport: direct)\n bind [options] [businessIdOrSlug] Bind a logical backend to a direct upstream in one environment\n delete [options] [businessIdOrSlug] Delete a backend (revokes its runtime tokens). Requires --yes.\n tokens Manage runtime tokens (fsrt_) for BYO backends\n help [command] display help for command", "signature": "Usage: farthershore backend [options] [command]\n\nManage BYO backends and their runtime tokens\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrSlug] List backends for a business (id, scope, name, transport, status)\n create [options] [businessIdOrSlug] Create a backend (default transport: direct)\n bind [options] [businessIdOrSlug] Bind a logical backend to a direct upstream in one environment\n delete [options] [businessIdOrSlug] Delete a backend (revokes its runtime tokens). Requires --yes.\n tokens Manage runtime tokens (fsrt_) for BYO backends\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.backend.bind", "name": "farthershore backend bind", "kind": "cli", "collection": "cli", "page": "generated/cli/backend", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore backend bind [options] [businessIdOrSlug] \n\nBind a logical backend to a direct upstream in one environment\n\nArguments:\n businessIdOrSlug The business id, or a slug (slug lookup requires\n business:read).\n backend\n\nOptions:\n --env Environment name or id. Pass 'production' (or omit) for\n the live business.\n --origin-url Concrete direct upstream URL for this environment\n --dry-run Preview the change without applying it.\n -h, --help display help for command", "signature": "Usage: farthershore backend bind [options] [businessIdOrSlug] \n\nBind a logical backend to a direct upstream in one environment\n\nArguments:\n businessIdOrSlug The business id, or a slug (slug lookup requires\n business:read).\n backend\n\nOptions:\n --env Environment name or id. Pass 'production' (or omit) for\n the live business.\n --origin-url Concrete direct upstream URL for this environment\n --dry-run Preview the change without applying it.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.backend.create", "name": "farthershore backend create", "kind": "cli", "collection": "cli", "page": "generated/cli/backend", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore backend create [options] [businessIdOrSlug]\n\nCreate a backend (default transport: direct)\n\nArguments:\n businessIdOrSlug The business id, or a slug (slug lookup requires\n business:read).\n\nOptions:\n --name Human-friendly backend name\n --slug Stable slug (defaults to a slugified name)\n --env Scope backend to an environment name or id. Pass\n 'production' (or omit) for the live business.\n --transport Transport mode: direct | tunnel (default: \"direct\")\n --runner embedded | sidecar\n --runtime Container/runtime descriptor\n --origin-url Builder origin URL (direct)\n --default Mark this backend the business default\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n --dry-run Preview the change without applying it.\n -h, --help display help for command", "signature": "Usage: farthershore backend create [options] [businessIdOrSlug]\n\nCreate a backend (default transport: direct)\n\nArguments:\n businessIdOrSlug The business id, or a slug (slug lookup requires\n business:read).\n\nOptions:\n --name Human-friendly backend name\n --slug Stable slug (defaults to a slugified name)\n --env Scope backend to an environment name or id. Pass\n 'production' (or omit) for the live business.\n --transport Transport mode: direct | tunnel (default: \"direct\")\n --runner embedded | sidecar\n --runtime Container/runtime descriptor\n --origin-url Builder origin URL (direct)\n --default Mark this backend the business default\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n --dry-run Preview the change without applying it.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.backend.delete", "name": "farthershore backend delete", "kind": "cli", "collection": "cli", "page": "generated/cli/backend", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore backend delete [options] [businessIdOrSlug] \n\nDelete a backend (revokes its runtime tokens). Requires --yes.\n\nArguments:\n businessIdOrSlug The business id, or a slug (slug lookup requires\n business:read).\n backendId\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command", "signature": "Usage: farthershore backend delete [options] [businessIdOrSlug] \n\nDelete a backend (revokes its runtime tokens). Requires --yes.\n\nArguments:\n businessIdOrSlug The business id, or a slug (slug lookup requires\n business:read).\n backendId\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.backend.list", "name": "farthershore backend list", "kind": "cli", "collection": "cli", "page": "generated/cli/backend", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore backend list [options] [businessIdOrSlug]\n\nList backends for a business (id, scope, name, transport, status)\n\nArguments:\n businessIdOrSlug The business id, or a slug (slug lookup requires\n business:read).\n\nOptions:\n --env Only rows in this environment (name or id). Pass\n 'production' for the production scope; omit for every\n scope.\n -h, --help display help for command\n\nScope:\n Backends and their runtime tokens are per-(business, environment) rows.\n Without --env every scope is listed; each row carries scope (production |\n environment), environmentId, and the environment name. Two rows for the same\n declared backend — one production, one environment-scoped — are expected, and\n both may be 'default': the single-default rule is per scope.\n\n 'production' (or 'prod') is a valid --env on EVERY backend verb, read and\n write alike, and selects the live business — the same scope you get by\n omitting --env. It is not a preview environment: it has no environment id and\n no branch, which is why 'farthershore env list' shows it with id: null. The\n words production/prod/main are reserved and cannot name a real environment.", "signature": "Usage: farthershore backend list [options] [businessIdOrSlug]\n\nList backends for a business (id, scope, name, transport, status)\n\nArguments:\n businessIdOrSlug The business id, or a slug (slug lookup requires\n business:read).\n\nOptions:\n --env Only rows in this environment (name or id). Pass\n 'production' for the production scope; omit for every\n scope.\n -h, --help display help for command\n\nScope:\n Backends and their runtime tokens are per-(business, environment) rows.\n Without --env every scope is listed; each row carries scope (production |\n environment), environmentId, and the environment name. Two rows for the same\n declared backend — one production, one environment-scoped — are expected, and\n both may be 'default': the single-default rule is per scope.\n\n 'production' (or 'prod') is a valid --env on EVERY backend verb, read and\n write alike, and selects the live business — the same scope you get by\n omitting --env. It is not a preview environment: it has no environment id and\n no branch, which is why 'farthershore env list' shows it with id: null. The\n words production/prod/main are reserved and cannot name a real environment.\n\n", "guide": "cli/overview" }, { "id": "cli.backend.tokens", "name": "farthershore backend tokens", "kind": "cli", "collection": "cli", "page": "generated/cli/backend", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore backend tokens [options] [command]\n\nManage runtime tokens (fsrt_) for BYO backends\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrSlug] List runtime tokens for a business\n create [options] [businessIdOrSlug] Create a runtime token (returns FS_RUNTIME_TOKEN once)\n rotate [options] [businessIdOrSlug] Rotate a runtime token (returns a fresh FS_RUNTIME_TOKEN once)\n revoke [options] [businessIdOrSlug] Revoke a runtime token. Requires --yes.\n help [command] display help for command", "signature": "Usage: farthershore backend tokens [options] [command]\n\nManage runtime tokens (fsrt_) for BYO backends\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrSlug] List runtime tokens for a business\n create [options] [businessIdOrSlug] Create a runtime token (returns FS_RUNTIME_TOKEN once)\n rotate [options] [businessIdOrSlug] Rotate a runtime token (returns a fresh FS_RUNTIME_TOKEN once)\n revoke [options] [businessIdOrSlug] Revoke a runtime token. Requires --yes.\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.backend.tokens.create", "name": "farthershore backend tokens create", "kind": "cli", "collection": "cli", "page": "generated/cli/backend", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore backend tokens create [options] [businessIdOrSlug]\n\nCreate a runtime token (returns FS_RUNTIME_TOKEN once)\n\nArguments:\n businessIdOrSlug The business id, or a slug (slug lookup requires\n business:read).\n\nOptions:\n --env Scope token to an environment name or id. Pass\n 'production' (or omit) for the live business.\n --backend Bind token to a specific backend, by slug or id\n (resolved in --env, falling back to the\n production row)\n --kind live | test (defaults from env scope)\n --operations Comma-separated operations: gateway_verification\n | metering | health | tunnel. Default: core's\n DEFAULT_OPERATIONS. Use tunnel for tunnel\n backends.\n --meters Comma-separated allowed meters (default: all\n business meters)\n --routes Comma-separated allowed routes\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore backend tokens create [options] [businessIdOrSlug]\n\nCreate a runtime token (returns FS_RUNTIME_TOKEN once)\n\nArguments:\n businessIdOrSlug The business id, or a slug (slug lookup requires\n business:read).\n\nOptions:\n --env Scope token to an environment name or id. Pass\n 'production' (or omit) for the live business.\n --backend Bind token to a specific backend, by slug or id\n (resolved in --env, falling back to the\n production row)\n --kind live | test (defaults from env scope)\n --operations Comma-separated operations: gateway_verification\n | metering | health | tunnel. Default: core's\n DEFAULT_OPERATIONS. Use tunnel for tunnel\n backends.\n --meters Comma-separated allowed meters (default: all\n business meters)\n --routes Comma-separated allowed routes\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.backend.tokens.list", "name": "farthershore backend tokens list", "kind": "cli", "collection": "cli", "page": "generated/cli/backend", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore backend tokens list [options] [businessIdOrSlug]\n\nList runtime tokens for a business\n\nArguments:\n businessIdOrSlug The business id, or a slug (slug lookup requires\n business:read).\n\nOptions:\n --env Only rows in this environment (name or id). Pass\n 'production' for the production scope; omit for every\n scope.\n -h, --help display help for command\n\nScope:\n Backends and their runtime tokens are per-(business, environment) rows.\n Without --env every scope is listed; each row carries scope (production |\n environment), environmentId, and the environment name. Two rows for the same\n declared backend — one production, one environment-scoped — are expected, and\n both may be 'default': the single-default rule is per scope.\n\n 'production' (or 'prod') is a valid --env on EVERY backend verb, read and\n write alike, and selects the live business — the same scope you get by\n omitting --env. It is not a preview environment: it has no environment id and\n no branch, which is why 'farthershore env list' shows it with id: null. The\n words production/prod/main are reserved and cannot name a real environment.", "signature": "Usage: farthershore backend tokens list [options] [businessIdOrSlug]\n\nList runtime tokens for a business\n\nArguments:\n businessIdOrSlug The business id, or a slug (slug lookup requires\n business:read).\n\nOptions:\n --env Only rows in this environment (name or id). Pass\n 'production' for the production scope; omit for every\n scope.\n -h, --help display help for command\n\nScope:\n Backends and their runtime tokens are per-(business, environment) rows.\n Without --env every scope is listed; each row carries scope (production |\n environment), environmentId, and the environment name. Two rows for the same\n declared backend — one production, one environment-scoped — are expected, and\n both may be 'default': the single-default rule is per scope.\n\n 'production' (or 'prod') is a valid --env on EVERY backend verb, read and\n write alike, and selects the live business — the same scope you get by\n omitting --env. It is not a preview environment: it has no environment id and\n no branch, which is why 'farthershore env list' shows it with id: null. The\n words production/prod/main are reserved and cannot name a real environment.\n\n", "guide": "cli/overview" }, { "id": "cli.backend.tokens.revoke", "name": "farthershore backend tokens revoke", "kind": "cli", "collection": "cli", "page": "generated/cli/backend", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore backend tokens revoke [options] [businessIdOrSlug] \n\nRevoke a runtime token. Requires --yes.\n\nArguments:\n businessIdOrSlug The business id, or a slug (slug lookup requires\n business:read).\n tokenId\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command", "signature": "Usage: farthershore backend tokens revoke [options] [businessIdOrSlug] \n\nRevoke a runtime token. Requires --yes.\n\nArguments:\n businessIdOrSlug The business id, or a slug (slug lookup requires\n business:read).\n tokenId\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.backend.tokens.rotate", "name": "farthershore backend tokens rotate", "kind": "cli", "collection": "cli", "page": "generated/cli/backend", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore backend tokens rotate [options] [businessIdOrSlug] \n\nRotate a runtime token (returns a fresh FS_RUNTIME_TOKEN once)\n\nArguments:\n businessIdOrSlug The business id, or a slug (slug lookup requires\n business:read).\n tokenId\n\nOptions:\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore backend tokens rotate [options] [businessIdOrSlug] \n\nRotate a runtime token (returns a fresh FS_RUNTIME_TOKEN once)\n\nArguments:\n businessIdOrSlug The business id, or a slug (slug lookup requires\n business:read).\n tokenId\n\nOptions:\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.build", "name": "farthershore build", "kind": "cli", "collection": "cli", "page": "generated/cli/build", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore build [options]\n\nBuild the business/ program into a Manifest IR envelope\n\nOptions:\n --entry Business-as-code folder or file to compile (default:\n business/)\n --out Output path for the build output (default:\n business-build.json)\n -h, --help display help for command\n\nExamples:\n farthershore build\n farthershore build --entry business/ --out business-build.json\n farthershore build --format json", "signature": "Usage: farthershore build [options]\n\nBuild the business/ program into a Manifest IR envelope\n\nOptions:\n --entry Business-as-code folder or file to compile (default:\n business/)\n --out Output path for the build output (default:\n business-build.json)\n -h, --help display help for command\n\nExamples:\n farthershore build\n farthershore build --entry business/ --out business-build.json\n farthershore build --format json\n\n", "guide": "cli/overview" }, { "id": "cli.bulletin", "name": "farthershore bulletin", "kind": "cli", "collection": "cli", "page": "generated/cli/bulletin", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore bulletin [options] [command]\n\nRead and hand off the operating agents' bulletin board\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrSlug] List the agents' bulletin feed (trends +\n change requests)\n show [businessIdOrSlug] [postId] Show one bulletin post (full body + data\n payload)\n ack [businessIdOrSlug] [postId] Acknowledge a post (the coding agent\n picked it up)\n resolve [businessIdOrSlug] [postId] Resolve a post (the work landed)\n help [command] display help for command", "signature": "Usage: farthershore bulletin [options] [command]\n\nRead and hand off the operating agents' bulletin board\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrSlug] List the agents' bulletin feed (trends +\n change requests)\n show [businessIdOrSlug] [postId] Show one bulletin post (full body + data\n payload)\n ack [businessIdOrSlug] [postId] Acknowledge a post (the coding agent\n picked it up)\n resolve [businessIdOrSlug] [postId] Resolve a post (the work landed)\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.bulletin.ack", "name": "farthershore bulletin ack", "kind": "cli", "collection": "cli", "page": "generated/cli/bulletin", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore bulletin ack [options] [businessIdOrSlug] \n\nAcknowledge a post (the coding agent picked it up)\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore bulletin ack [options] [businessIdOrSlug] \n\nAcknowledge a post (the coding agent picked it up)\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.bulletin.list", "name": "farthershore bulletin list", "kind": "cli", "collection": "cli", "page": "generated/cli/bulletin", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore bulletin list [options] [businessIdOrSlug]\n\nList the agents' bulletin feed (trends + change requests)\n\nOptions:\n --kind Filter: trend | insight | change_request\n --status Filter: open | acknowledged | resolved\n --limit Max rows to return.\n -h, --help display help for command", "signature": "Usage: farthershore bulletin list [options] [businessIdOrSlug]\n\nList the agents' bulletin feed (trends + change requests)\n\nOptions:\n --kind Filter: trend | insight | change_request\n --status Filter: open | acknowledged | resolved\n --limit Max rows to return.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.bulletin.resolve", "name": "farthershore bulletin resolve", "kind": "cli", "collection": "cli", "page": "generated/cli/bulletin", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore bulletin resolve [options] [businessIdOrSlug] \n\nResolve a post (the work landed)\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore bulletin resolve [options] [businessIdOrSlug] \n\nResolve a post (the work landed)\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.bulletin.show", "name": "farthershore bulletin show", "kind": "cli", "collection": "cli", "page": "generated/cli/bulletin", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore bulletin show [options] [businessIdOrSlug] \n\nShow one bulletin post (full body + data payload)\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore bulletin show [options] [businessIdOrSlug] \n\nShow one bulletin post (full body + data payload)\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.business", "name": "farthershore business", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business [options] [command]\n\nBusiness bootstrap, status, release, and presentation metadata\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] List businesses in the current org\n show [options] [businessIdOrName] Show a business\n routes [options] [businessIdOrName] List a business's compiled routes\n subdomain-check Check whether a slug is free to use as a business subdomain before creating it\n config-attempts [businessIdOrName] List rejected configuration attempts for a business\n contract [options] [businessIdOrName] Show a business's accepted contract synopsis\n status [options] [businessIdOrName] Show lifecycle, release, and exact edge-generation coherence for one environment.\n rbac [options] [businessIdOrName] Show a business's Managed-RBAC state: the platform `rbacEnabled` flag.\n create [options] Create a new business and provision its managed GitHub repo\n update [options] [businessIdOrName] Update business presentation metadata\n publish [options] [businessIdOrName] Publish a draft business (make it live) and cut a versioned release with an auto-computed semver. Requires at least one plan, a bound backend, and a verified Stripe connection.\n rollback [options] [businessIdOrName] [workflowExecutionId] Roll back a prior business publish workflow\n preview-env Configure automatic preview environment creation for a business\n docs Enable or disable docs publishing for a business\n help [command] display help for command", "signature": "Usage: farthershore business [options] [command]\n\nBusiness bootstrap, status, release, and presentation metadata\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] List businesses in the current org\n show [options] [businessIdOrName] Show a business\n routes [options] [businessIdOrName] List a business's compiled routes\n subdomain-check Check whether a slug is free to use as a business subdomain before creating it\n config-attempts [businessIdOrName] List rejected configuration attempts for a business\n contract [options] [businessIdOrName] Show a business's accepted contract synopsis\n status [options] [businessIdOrName] Show lifecycle, release, and exact edge-generation coherence for one environment.\n rbac [options] [businessIdOrName] Show a business's Managed-RBAC state: the platform `rbacEnabled` flag.\n create [options] Create a new business and provision its managed GitHub repo\n update [options] [businessIdOrName] Update business presentation metadata\n publish [options] [businessIdOrName] Publish a draft business (make it live) and cut a versioned release with an auto-computed semver. Requires at least one plan, a bound backend, and a verified Stripe connection.\n rollback [options] [businessIdOrName] [workflowExecutionId] Roll back a prior business publish workflow\n preview-env Configure automatic preview environment creation for a business\n docs Enable or disable docs publishing for a business\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.business.config-attempts", "name": "farthershore business config-attempts", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business config-attempts [options] [businessIdOrName]\n\nList rejected configuration attempts for a business\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore business config-attempts [options] [businessIdOrName]\n\nList rejected configuration attempts for a business\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.business.contract", "name": "farthershore business contract", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business contract [options] [businessIdOrName]\n\nShow a business's accepted contract synopsis\n\nOptions:\n --env Environment scope (preview branch name)\n -h, --help display help for command", "signature": "Usage: farthershore business contract [options] [businessIdOrName]\n\nShow a business's accepted contract synopsis\n\nOptions:\n --env Environment scope (preview branch name)\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.business.create", "name": "farthershore business create", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business create [options] \n\nCreate a new business and provision its managed GitHub repo\n\nOptions:\n --display-name Human-friendly business name\n --description \n --docs Enable docs for this business (default when\n omitted).\n --no-docs Opt out of docs for this business.\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore business create [options] \n\nCreate a new business and provision its managed GitHub repo\n\nOptions:\n --display-name Human-friendly business name\n --description \n --docs Enable docs for this business (default when\n omitted).\n --no-docs Opt out of docs for this business.\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.business.docs", "name": "farthershore business docs", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business docs [options] [command]\n\nEnable or disable docs publishing for a business\n\nOptions:\n -h, --help display help for command\n\nCommands:\n enable [businessIdOrName] Enable docs for a business (publish/serve docs\n scaffold).\n disable [businessIdOrName] Disable docs for a business (stop\n publishing/serving docs; scaffold kept in the\n repo).\n help [command] display help for command", "signature": "Usage: farthershore business docs [options] [command]\n\nEnable or disable docs publishing for a business\n\nOptions:\n -h, --help display help for command\n\nCommands:\n enable [businessIdOrName] Enable docs for a business (publish/serve docs\n scaffold).\n disable [businessIdOrName] Disable docs for a business (stop\n publishing/serving docs; scaffold kept in the\n repo).\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.business.docs.disable", "name": "farthershore business docs disable", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business docs disable [options] [businessIdOrName]\n\nDisable docs for a business (stop publishing/serving docs; scaffold kept in the\nrepo).\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore business docs disable [options] [businessIdOrName]\n\nDisable docs for a business (stop publishing/serving docs; scaffold kept in the\nrepo).\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.business.docs.enable", "name": "farthershore business docs enable", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business docs enable [options] [businessIdOrName]\n\nEnable docs for a business (publish/serve docs scaffold).\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore business docs enable [options] [businessIdOrName]\n\nEnable docs for a business (publish/serve docs scaffold).\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.business.list", "name": "farthershore business list", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business list [options]\n\nList businesses in the current org\n\nOptions:\n --filter Exact field filter; repeat for AND. Fields: id,\n name, displayName, subdomain, status. (default: [])\n --sort Server-side sort (default asc). Fields: id, name,\n displayName, createdAt, updatedAt.\n --search Server-side case-insensitive text search.\n -h, --help display help for command", "signature": "Usage: farthershore business list [options]\n\nList businesses in the current org\n\nOptions:\n --filter Exact field filter; repeat for AND. Fields: id,\n name, displayName, subdomain, status. (default: [])\n --sort Server-side sort (default asc). Fields: id, name,\n displayName, createdAt, updatedAt.\n --search Server-side case-insensitive text search.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.business.preview-env", "name": "farthershore business preview-env", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business preview-env [options] [command]\n\nConfigure automatic preview environment creation for a business\n\nOptions:\n -h, --help display help for command\n\nCommands:\n set [options] [businessIdOrName] Configure automatic preview-environment\n creation for a business.\n help [command] display help for command", "signature": "Usage: farthershore business preview-env [options] [command]\n\nConfigure automatic preview environment creation for a business\n\nOptions:\n -h, --help display help for command\n\nCommands:\n set [options] [businessIdOrName] Configure automatic preview-environment\n creation for a business.\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.business.preview-env.set", "name": "farthershore business preview-env set", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business preview-env set [options] [businessIdOrName]\n\nConfigure automatic preview-environment creation for a business.\n\nOptions:\n --trigger Auto-create previews from env branch prefixes, pull requests, or disable automatic creation.\n --branch-prefix Set the env branch prefix used by --trigger branch-prefix (1-50 characters).\n --clear-branch-prefix Reset the env branch prefix to the platform default (env/).\n -h, --help display help for command", "signature": "Usage: farthershore business preview-env set [options] [businessIdOrName]\n\nConfigure automatic preview-environment creation for a business.\n\nOptions:\n --trigger Auto-create previews from env branch prefixes, pull requests, or disable automatic creation.\n --branch-prefix Set the env branch prefix used by --trigger branch-prefix (1-50 characters).\n --clear-branch-prefix Reset the env branch prefix to the platform default (env/).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.business.publish", "name": "farthershore business publish", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business publish [options] [businessIdOrName]\n\nPublish a draft business (make it live) and cut a versioned release with an\nauto-computed semver. Requires at least one plan, a bound backend, and a\nverified Stripe connection.\n\nOptions:\n --bump Force the semver bump (major|minor|patch). Omit to\n auto-derive from the change.\n --version Pin the exact next release tag (vX.Y.Z), skipping\n derivation.\n --accept-breaking Consent to publish a breaking (blocking-risk) change\n as a major release.\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n --dry-run Preview the change without applying it.\n -h, --help display help for command\n\nPublish auto-derives the semver bump from the change and cuts a vX.Y.Z release.\nUse --dry-run to preview the computed bump + reasons without cutting a tag.\nA blocking-risk (breaking) change is refused unless --accept-breaking is passed.", "signature": "Usage: farthershore business publish [options] [businessIdOrName]\n\nPublish a draft business (make it live) and cut a versioned release with an\nauto-computed semver. Requires at least one plan, a bound backend, and a\nverified Stripe connection.\n\nOptions:\n --bump Force the semver bump (major|minor|patch). Omit to\n auto-derive from the change.\n --version Pin the exact next release tag (vX.Y.Z), skipping\n derivation.\n --accept-breaking Consent to publish a breaking (blocking-risk) change\n as a major release.\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n --dry-run Preview the change without applying it.\n -h, --help display help for command\n\nPublish auto-derives the semver bump from the change and cuts a vX.Y.Z release.\nUse --dry-run to preview the computed bump + reasons without cutting a tag.\nA blocking-risk (breaking) change is refused unless --accept-breaking is passed.\n", "guide": "cli/overview" }, { "id": "cli.business.rbac", "name": "farthershore business rbac", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business rbac [options] [command] [businessIdOrName]\n\nShow a business's Managed-RBAC state: the platform `rbacEnabled` flag.\n\nOptions:\n --env Environment scope (preview branch name)\n -h, --help display help for command\n\nCommands:\n enable [businessIdOrName] Enable Managed RBAC for a business (platform-owned\n flag).\n disable [businessIdOrName] Disable Managed RBAC for a business\n (platform-owned flag).\n subjects List a business's custom permission subjects.\n Subjects are repo-owned: declare a\n permission-carrying `fs.group(id, routes, {\n permission })` in business/ and run `farthershore\n validate` + push to change them", "signature": "Usage: farthershore business rbac [options] [command] [businessIdOrName]\n\nShow a business's Managed-RBAC state: the platform `rbacEnabled` flag.\n\nOptions:\n --env Environment scope (preview branch name)\n -h, --help display help for command\n\nCommands:\n enable [businessIdOrName] Enable Managed RBAC for a business (platform-owned\n flag).\n disable [businessIdOrName] Disable Managed RBAC for a business\n (platform-owned flag).\n subjects List a business's custom permission subjects.\n Subjects are repo-owned: declare a\n permission-carrying `fs.group(id, routes, {\n permission })` in business/ and run `farthershore\n validate` + push to change them\n", "guide": "cli/overview" }, { "id": "cli.business.rbac.disable", "name": "farthershore business rbac disable", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business rbac disable [options] [businessIdOrName]\n\nDisable Managed RBAC for a business (platform-owned flag).\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore business rbac disable [options] [businessIdOrName]\n\nDisable Managed RBAC for a business (platform-owned flag).\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.business.rbac.enable", "name": "farthershore business rbac enable", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business rbac enable [options] [businessIdOrName]\n\nEnable Managed RBAC for a business (platform-owned flag).\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore business rbac enable [options] [businessIdOrName]\n\nEnable Managed RBAC for a business (platform-owned flag).\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.business.rbac.subjects", "name": "farthershore business rbac subjects", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business rbac subjects [options] [command]\n\nList a business's custom permission subjects. Subjects are repo-owned: declare a\npermission-carrying `fs.group(id, routes, { permission })` in business/ and run\n`farthershore validate` + push to change them\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [businessIdOrName] List the raw permission subjects subscriber\n organizations can assemble into their own roles\n (repo-owned: authored via fs.group permission config\n in business/).\n help [command] display help for command", "signature": "Usage: farthershore business rbac subjects [options] [command]\n\nList a business's custom permission subjects. Subjects are repo-owned: declare a\npermission-carrying `fs.group(id, routes, { permission })` in business/ and run\n`farthershore validate` + push to change them\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [businessIdOrName] List the raw permission subjects subscriber\n organizations can assemble into their own roles\n (repo-owned: authored via fs.group permission config\n in business/).\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.business.rbac.subjects.list", "name": "farthershore business rbac subjects list", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business rbac subjects list [options] [businessIdOrName]\n\nList the raw permission subjects subscriber organizations can assemble into\ntheir own roles (repo-owned: authored via fs.group permission config in\nbusiness/).\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore business rbac subjects list [options] [businessIdOrName]\n\nList the raw permission subjects subscriber organizations can assemble into\ntheir own roles (repo-owned: authored via fs.group permission config in\nbusiness/).\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.business.rollback", "name": "farthershore business rollback", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business rollback [options] [businessIdOrName] \n\nRoll back a prior business publish workflow\n\nOptions:\n --reason Reason recorded with the rollback\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore business rollback [options] [businessIdOrName] \n\nRoll back a prior business publish workflow\n\nOptions:\n --reason Reason recorded with the rollback\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.business.routes", "name": "farthershore business routes", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business routes [options] [businessIdOrName]\n\nList a business's compiled routes\n\nOptions:\n --env Environment scope (preview branch name)\n -h, --help display help for command", "signature": "Usage: farthershore business routes [options] [businessIdOrName]\n\nList a business's compiled routes\n\nOptions:\n --env Environment scope (preview branch name)\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.business.show", "name": "farthershore business show", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business show [options] [businessIdOrName]\n\nShow a business\n\nOptions:\n --env Environment scope (preview branch name)\n -h, --help display help for command", "signature": "Usage: farthershore business show [options] [businessIdOrName]\n\nShow a business\n\nOptions:\n --env Environment scope (preview branch name)\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.business.status", "name": "farthershore business status", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business status [options] [businessIdOrName]\n\nShow lifecycle, release, and exact edge-generation coherence for one\nenvironment.\n\nOptions:\n --env Environment scope (defaults to production)\n -h, --help display help for command", "signature": "Usage: farthershore business status [options] [businessIdOrName]\n\nShow lifecycle, release, and exact edge-generation coherence for one\nenvironment.\n\nOptions:\n --env Environment scope (defaults to production)\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.business.subdomain-check", "name": "farthershore business subdomain-check", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business subdomain-check [options] \n\nCheck whether a slug is free to use as a business subdomain before creating it\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore business subdomain-check [options] \n\nCheck whether a slug is free to use as a business subdomain before creating it\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.business.update", "name": "farthershore business update", "kind": "cli", "collection": "cli", "page": "generated/cli/business", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore business update [options] [businessIdOrName]\n\nUpdate business presentation metadata\n\nOptions:\n --display-name \n --description \n --icon-url Set the square icon/favicon URL\n --icon-file Upload a local PNG, JPEG, or WEBP square icon\n --clear-icon Remove the current icon asset\n --logo-url Set the wordmark/logo URL\n --logo-file Upload a local PNG, JPEG, or WEBP wordmark/logo\n --clear-logo Remove the current logo asset\n --key-prefix White-label prefix for subscriber API keys (fsk_\n → e.g. acme_). 2-12 lowercase letters/digits;\n fs/fsk/fsc/fsm reserved.\n --clear-key-prefix Reset the subscriber API key prefix to the\n default (fsk).\n --list-on-org-page Show this product on the organization's public\n page (/organization/). Products are listed\n by default.\n --unlist-from-org-page Hide this product from the organization's public\n page. Does not unpublish it.\n --allowed-origins Comma-separated browser origins allowed to call\n the gateway cross-origin (custom frontend\n domains), e.g. https://app.example.com. The\n tenant's own portal origin is always allowed.\n --clear-allowed-origins Remove all custom allowed origins.\n -h, --help display help for command", "signature": "Usage: farthershore business update [options] [businessIdOrName]\n\nUpdate business presentation metadata\n\nOptions:\n --display-name \n --description \n --icon-url Set the square icon/favicon URL\n --icon-file Upload a local PNG, JPEG, or WEBP square icon\n --clear-icon Remove the current icon asset\n --logo-url Set the wordmark/logo URL\n --logo-file Upload a local PNG, JPEG, or WEBP wordmark/logo\n --clear-logo Remove the current logo asset\n --key-prefix White-label prefix for subscriber API keys (fsk_\n → e.g. acme_). 2-12 lowercase letters/digits;\n fs/fsk/fsc/fsm reserved.\n --clear-key-prefix Reset the subscriber API key prefix to the\n default (fsk).\n --list-on-org-page Show this product on the organization's public\n page (/organization/). Products are listed\n by default.\n --unlist-from-org-page Hide this product from the organization's public\n page. Does not unpublish it.\n --allowed-origins Comma-separated browser origins allowed to call\n the gateway cross-origin (custom frontend\n domains), e.g. https://app.example.com. The\n tenant's own portal origin is always allowed.\n --clear-allowed-origins Remove all custom allowed origins.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.commercial-release", "name": "farthershore commercial-release", "kind": "cli", "collection": "cli", "page": "generated/cli/commercial-release", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore commercial-release [options] [command]\n\nInspect immutable commercial release manifests\n\nOptions:\n -h, --help display help for command\n\nCommands:\n diff Compare two compiled CommercialReleaseVersion JSON files\n help [command] display help for command", "signature": "Usage: farthershore commercial-release [options] [command]\n\nInspect immutable commercial release manifests\n\nOptions:\n -h, --help display help for command\n\nCommands:\n diff Compare two compiled CommercialReleaseVersion JSON files\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.commercial-release.diff", "name": "farthershore commercial-release diff", "kind": "cli", "collection": "cli", "page": "generated/cli/commercial-release", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore commercial-release diff [options] \n\nCompare two compiled CommercialReleaseVersion JSON files\n\nArguments:\n from Earlier CommercialReleaseVersion JSON file\n to Later CommercialReleaseVersion JSON file\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore commercial-release diff [options] \n\nCompare two compiled CommercialReleaseVersion JSON files\n\nArguments:\n from Earlier CommercialReleaseVersion JSON file\n to Later CommercialReleaseVersion JSON file\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.consumer", "name": "farthershore consumer", "kind": "cli", "collection": "cli", "page": "generated/cli/consumer", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore consumer [options] [command]\n\nManage business users/consumers\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrSlug] List users/consumers for a business\n block [options] [businessIdOrSlug] [subscriberId] Block a user and revoke their active API keys\n keys List and revoke ONE consumer's API keys. Listing is metadata only — key material is never returned. `consumer block` revokes every key at once; this is the surgical version\n migrate-latest [options] [businessIdOrSlug] [subscriberId] Move one consumer to the active head of their plan lineage\n remove [options] [businessIdOrSlug] [subscriberId] Remove a user from live business access\n rbac Builder-plane Managed RBAC for one subscriber: the per-subscriber enforcement flag, its roles, and member role assignment. Enforcement also requires the product flag (`farthershore business rbac enable`)\n help [command] display help for command", "signature": "Usage: farthershore consumer [options] [command]\n\nManage business users/consumers\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrSlug] List users/consumers for a business\n block [options] [businessIdOrSlug] [subscriberId] Block a user and revoke their active API keys\n keys List and revoke ONE consumer's API keys. Listing is metadata only — key material is never returned. `consumer block` revokes every key at once; this is the surgical version\n migrate-latest [options] [businessIdOrSlug] [subscriberId] Move one consumer to the active head of their plan lineage\n remove [options] [businessIdOrSlug] [subscriberId] Remove a user from live business access\n rbac Builder-plane Managed RBAC for one subscriber: the per-subscriber enforcement flag, its roles, and member role assignment. Enforcement also requires the product flag (`farthershore business rbac enable`)\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.consumer.block", "name": "farthershore consumer block", "kind": "cli", "collection": "cli", "page": "generated/cli/consumer", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore consumer block [options] [businessIdOrSlug] \n\nBlock a user and revoke their active API keys\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command", "signature": "Usage: farthershore consumer block [options] [businessIdOrSlug] \n\nBlock a user and revoke their active API keys\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.consumer.keys", "name": "farthershore consumer keys", "kind": "cli", "collection": "cli", "page": "generated/cli/consumer", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore consumer keys [options] [command]\n\nList and revoke ONE consumer's API keys. Listing is metadata only — key material\nis never returned. `consumer block` revokes every key at once; this is the\nsurgical version\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [businessIdOrSlug] [subscriberId] List a consumer's API keys (metadata only)\n revoke [options] [businessIdOrSlug] [subscriberId] [keyId] Revoke ONE of a consumer's API keys\n help [command] display help for command", "signature": "Usage: farthershore consumer keys [options] [command]\n\nList and revoke ONE consumer's API keys. Listing is metadata only — key material\nis never returned. `consumer block` revokes every key at once; this is the\nsurgical version\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [businessIdOrSlug] [subscriberId] List a consumer's API keys (metadata only)\n revoke [options] [businessIdOrSlug] [subscriberId] [keyId] Revoke ONE of a consumer's API keys\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.consumer.keys.list", "name": "farthershore consumer keys list", "kind": "cli", "collection": "cli", "page": "generated/cli/consumer", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore consumer keys list [options] [businessIdOrSlug] \n\nList a consumer's API keys (metadata only)\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore consumer keys list [options] [businessIdOrSlug] \n\nList a consumer's API keys (metadata only)\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.consumer.keys.revoke", "name": "farthershore consumer keys revoke", "kind": "cli", "collection": "cli", "page": "generated/cli/consumer", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore consumer keys revoke [options] [businessIdOrSlug] \n\nRevoke ONE of a consumer's API keys\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command", "signature": "Usage: farthershore consumer keys revoke [options] [businessIdOrSlug] \n\nRevoke ONE of a consumer's API keys\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.consumer.list", "name": "farthershore consumer list", "kind": "cli", "collection": "cli", "page": "generated/cli/consumer", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore consumer list [options] [businessIdOrSlug]\n\nList users/consumers for a business\n\nOptions:\n --env Environment name for preview-scoped consumers.\n -h, --help display help for command", "signature": "Usage: farthershore consumer list [options] [businessIdOrSlug]\n\nList users/consumers for a business\n\nOptions:\n --env Environment name for preview-scoped consumers.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.consumer.migrate-latest", "name": "farthershore consumer migrate-latest", "kind": "cli", "collection": "cli", "page": "generated/cli/consumer", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore consumer migrate-latest [options] [businessIdOrSlug] \n\nMove one consumer to the active head of their plan lineage\n\nOptions:\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore consumer migrate-latest [options] [businessIdOrSlug] \n\nMove one consumer to the active head of their plan lineage\n\nOptions:\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.consumer.rbac", "name": "farthershore consumer rbac", "kind": "cli", "collection": "cli", "page": "generated/cli/consumer", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore consumer rbac [options] [command]\n\nBuilder-plane Managed RBAC for one subscriber: the per-subscriber enforcement\nflag, its roles, and member role assignment. Enforcement also requires the\nproduct flag (`farthershore business rbac enable`)\n\nOptions:\n -h, --help display help for command\n\nCommands:\n assign [options] [businessIdOrSlug] [subscriberId] [userExternalId] Replace a client-org member's Managed-RBAC business roles (builder support override)\n enable [options] [businessIdOrSlug] [subscriberId] Turn Managed-RBAC enforcement on for one subscriber\n disable [businessIdOrSlug] [subscriberId] Turn Managed-RBAC enforcement off for one subscriber\n roles Create, read, update, and delete one subscriber's Managed-RBAC roles. The subscribing org manages the same rows from its portal (/settings/team)\n help [command] display help for command", "signature": "Usage: farthershore consumer rbac [options] [command]\n\nBuilder-plane Managed RBAC for one subscriber: the per-subscriber enforcement\nflag, its roles, and member role assignment. Enforcement also requires the\nproduct flag (`farthershore business rbac enable`)\n\nOptions:\n -h, --help display help for command\n\nCommands:\n assign [options] [businessIdOrSlug] [subscriberId] [userExternalId] Replace a client-org member's Managed-RBAC business roles (builder support override)\n enable [options] [businessIdOrSlug] [subscriberId] Turn Managed-RBAC enforcement on for one subscriber\n disable [businessIdOrSlug] [subscriberId] Turn Managed-RBAC enforcement off for one subscriber\n roles Create, read, update, and delete one subscriber's Managed-RBAC roles. The subscribing org manages the same rows from its portal (/settings/team)\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.consumer.rbac.assign", "name": "farthershore consumer rbac assign", "kind": "cli", "collection": "cli", "page": "generated/cli/consumer", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore consumer rbac assign [options] [businessIdOrSlug] \n\nReplace a client-org member's Managed-RBAC business roles (builder support\noverride)\n\nOptions:\n --roles Comma-separated business-role keys to set (replaces the\n current assignment; pass an empty string to clear).\n -h, --help display help for command", "signature": "Usage: farthershore consumer rbac assign [options] [businessIdOrSlug] \n\nReplace a client-org member's Managed-RBAC business roles (builder support\noverride)\n\nOptions:\n --roles Comma-separated business-role keys to set (replaces the\n current assignment; pass an empty string to clear).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.consumer.rbac.disable", "name": "farthershore consumer rbac disable", "kind": "cli", "collection": "cli", "page": "generated/cli/consumer", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore consumer rbac disable [options] [businessIdOrSlug] \n\nTurn Managed-RBAC enforcement off for one subscriber\n\nOptions:\n -h, --help display help for command\n\nDisabling is an ACCESS EXPANSION: with enforcement off, credential permission resolution can return ['*']. Role definitions are preserved for re-enable.", "signature": "Usage: farthershore consumer rbac disable [options] [businessIdOrSlug] \n\nTurn Managed-RBAC enforcement off for one subscriber\n\nOptions:\n -h, --help display help for command\n\nDisabling is an ACCESS EXPANSION: with enforcement off, credential permission resolution can return ['*']. Role definitions are preserved for re-enable.\n\n", "guide": "cli/overview" }, { "id": "cli.consumer.rbac.enable", "name": "farthershore consumer rbac enable", "kind": "cli", "collection": "cli", "page": "generated/cli/consumer", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore consumer rbac enable [options] [businessIdOrSlug] \n\nTurn Managed-RBAC enforcement on for one subscriber\n\nOptions:\n --default-role Role key new members fall back to when they have no\n explicit role. Omit to clear it.\n -h, --help display help for command\n\nEnforcement needs BOTH flags: the product flag (`farthershore business rbac enable`) and this per-subscriber flag. With the product flag off, core answers 400 RBAC_NOT_ENABLED_BY_PRODUCT. The subscribing org can flip the same flag itself at the portal's /settings/team page.", "signature": "Usage: farthershore consumer rbac enable [options] [businessIdOrSlug] \n\nTurn Managed-RBAC enforcement on for one subscriber\n\nOptions:\n --default-role Role key new members fall back to when they have no\n explicit role. Omit to clear it.\n -h, --help display help for command\n\nEnforcement needs BOTH flags: the product flag (`farthershore business rbac enable`) and this per-subscriber flag. With the product flag off, core answers 400 RBAC_NOT_ENABLED_BY_PRODUCT. The subscribing org can flip the same flag itself at the portal's /settings/team page.\n\n", "guide": "cli/overview" }, { "id": "cli.consumer.rbac.roles", "name": "farthershore consumer rbac roles", "kind": "cli", "collection": "cli", "page": "generated/cli/consumer", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore consumer rbac roles [options] [command]\n\nCreate, read, update, and delete one subscriber's Managed-RBAC roles. The\nsubscribing org manages the same rows from its portal (/settings/team)\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [businessIdOrSlug] [subscriberId] List one subscriber's Managed-RBAC roles\n create [options] [businessIdOrSlug] [subscriberId] [roleKey] Create a CUSTOM Managed-RBAC role for one subscriber\n update [options] [businessIdOrSlug] [subscriberId] [roleKey] Rename or re-permission one subscriber Managed-RBAC role\n delete [options] [businessIdOrSlug] [subscriberId] [roleKey] Delete one subscriber Managed-RBAC role\n help [command] display help for command", "signature": "Usage: farthershore consumer rbac roles [options] [command]\n\nCreate, read, update, and delete one subscriber's Managed-RBAC roles. The\nsubscribing org manages the same rows from its portal (/settings/team)\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [businessIdOrSlug] [subscriberId] List one subscriber's Managed-RBAC roles\n create [options] [businessIdOrSlug] [subscriberId] [roleKey] Create a CUSTOM Managed-RBAC role for one subscriber\n update [options] [businessIdOrSlug] [subscriberId] [roleKey] Rename or re-permission one subscriber Managed-RBAC role\n delete [options] [businessIdOrSlug] [subscriberId] [roleKey] Delete one subscriber Managed-RBAC role\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.consumer.rbac.roles.create", "name": "farthershore consumer rbac roles create", "kind": "cli", "collection": "cli", "page": "generated/cli/consumer", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore consumer rbac roles create [options] [businessIdOrSlug] \n\nCreate a CUSTOM Managed-RBAC role for one subscriber\n\nOptions:\n --name Human-readable role name.\n --permissions Comma-separated permission keys from the\n business's derived catalog (e.g.\n `reports:read,reports:write`).\n -h, --help display help for command", "signature": "Usage: farthershore consumer rbac roles create [options] [businessIdOrSlug] \n\nCreate a CUSTOM Managed-RBAC role for one subscriber\n\nOptions:\n --name Human-readable role name.\n --permissions Comma-separated permission keys from the\n business's derived catalog (e.g.\n `reports:read,reports:write`).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.consumer.rbac.roles.delete", "name": "farthershore consumer rbac roles delete", "kind": "cli", "collection": "cli", "page": "generated/cli/consumer", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore consumer rbac roles delete [options] [businessIdOrSlug] \n\nDelete one subscriber Managed-RBAC role\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command", "signature": "Usage: farthershore consumer rbac roles delete [options] [businessIdOrSlug] \n\nDelete one subscriber Managed-RBAC role\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.consumer.rbac.roles.list", "name": "farthershore consumer rbac roles list", "kind": "cli", "collection": "cli", "page": "generated/cli/consumer", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore consumer rbac roles list [options] [businessIdOrSlug] \n\nList one subscriber's Managed-RBAC roles\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore consumer rbac roles list [options] [businessIdOrSlug] \n\nList one subscriber's Managed-RBAC roles\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.consumer.rbac.roles.update", "name": "farthershore consumer rbac roles update", "kind": "cli", "collection": "cli", "page": "generated/cli/consumer", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore consumer rbac roles update [options] [businessIdOrSlug] \n\nRename or re-permission one subscriber Managed-RBAC role\n\nOptions:\n --name New human-readable role name.\n --permissions Comma-separated permission keys from the\n business's derived catalog (e.g.\n `reports:read,reports:write`). Set-replace: the\n given list becomes the role's full grant.\n -h, --help display help for command", "signature": "Usage: farthershore consumer rbac roles update [options] [businessIdOrSlug] \n\nRename or re-permission one subscriber Managed-RBAC role\n\nOptions:\n --name New human-readable role name.\n --permissions Comma-separated permission keys from the\n business's derived catalog (e.g.\n `reports:read,reports:write`). Set-replace: the\n given list becomes the role's full grant.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.consumer.remove", "name": "farthershore consumer remove", "kind": "cli", "collection": "cli", "page": "generated/cli/consumer", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore consumer remove [options] [businessIdOrSlug] \n\nRemove a user from live business access\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command", "signature": "Usage: farthershore consumer remove [options] [businessIdOrSlug] \n\nRemove a user from live business access\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.create", "name": "farthershore create", "kind": "cli", "collection": "cli", "page": "generated/cli/create", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore create [options] [command]\n\nCreate local FartherShore project components\n\nOptions:\n -h, --help display help for command\n\nCommands:\n api [options] Scaffold a starter backend from a public template tarball\n help [command] display help for command", "signature": "Usage: farthershore create [options] [command]\n\nCreate local FartherShore project components\n\nOptions:\n -h, --help display help for command\n\nCommands:\n api [options] Scaffold a starter backend from a public template tarball\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.create.api", "name": "farthershore create api", "kind": "cli", "collection": "cli", "page": "generated/cli/create", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore create api [options]\n\nScaffold a starter backend from a public template tarball\n\nOptions:\n --node Node (TypeScript + Express) template (default)\n --path Managed builder repo root (default: current directory)\n --force Overwrite an existing api/ directory if present\n --ref Template tag or branch to download instead of main\n (tags are tried first)\n -h, --help display help for command\n\nLanguages:\n --node Node (TypeScript + Express) (default)\n\nMore languages are coming.", "signature": "Usage: farthershore create api [options]\n\nScaffold a starter backend from a public template tarball\n\nOptions:\n --node Node (TypeScript + Express) template (default)\n --path Managed builder repo root (default: current directory)\n --force Overwrite an existing api/ directory if present\n --ref Template tag or branch to download instead of main\n (tags are tried first)\n -h, --help display help for command\n\nLanguages:\n --node Node (TypeScript + Express) (default)\n\nMore languages are coming.\n\n", "guide": "cli/overview" }, { "id": "cli.denial", "name": "farthershore denial", "kind": "cli", "collection": "cli", "page": "generated/cli/denial", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore denial [options] [command]\n\nExplain gateway denial decisions\n\nOptions:\n -h, --help display help for command\n\nCommands:\n show [businessIdOrName] [requestId] Explain a denied request\n help [command] display help for command", "signature": "Usage: farthershore denial [options] [command]\n\nExplain gateway denial decisions\n\nOptions:\n -h, --help display help for command\n\nCommands:\n show [businessIdOrName] [requestId] Explain a denied request\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.denial.show", "name": "farthershore denial show", "kind": "cli", "collection": "cli", "page": "generated/cli/denial", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore denial show [options] [businessIdOrName] \n\nExplain a denied request\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore denial show [options] [businessIdOrName] \n\nExplain a denied request\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.dependents", "name": "farthershore dependents", "kind": "cli", "collection": "cli", "page": "generated/cli/dependents", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore dependents [options] [command]\n\nInspect active business route dependents\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrName] List active dependents for a business route\n help [command] display help for command", "signature": "Usage: farthershore dependents [options] [command]\n\nInspect active business route dependents\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrName] List active dependents for a business route\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.dependents.list", "name": "farthershore dependents list", "kind": "cli", "collection": "cli", "page": "generated/cli/dependents", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore dependents list [options] [businessIdOrName]\n\nList active dependents for a business route\n\nOptions:\n --route \n --since \n --environment \n -h, --help display help for command", "signature": "Usage: farthershore dependents list [options] [businessIdOrName]\n\nList active dependents for a business route\n\nOptions:\n --route \n --since \n --environment \n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.docs", "name": "farthershore docs", "kind": "cli", "collection": "cli", "page": "generated/cli/docs", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore docs [options] [command]\n\nBrowse public platform documentation as a read-only filesystem (no login)\n\nOptions:\n --stage Read stage docs instead of production\n (independent of --api-url)\n -h, --help display help for command\n\nCommands:\n ls|list [path] List collections, a section directory, or\n the headings in a page\n tree [path] Expand a collection or directory recursively\n into its sections and pages\n read|get [options] Read a complete page by virtual path,\n canonical slug or official docs URL\n search [options] Search literal text; results include\n traversal paths and section links\n collection Read the entire collection corpus, without\n truncation\n help [command] display help for command", "signature": "Usage: farthershore docs [options] [command]\n\nBrowse public platform documentation as a read-only filesystem (no login)\n\nOptions:\n --stage Read stage docs instead of production\n (independent of --api-url)\n -h, --help display help for command\n\nCommands:\n ls|list [path] List collections, a section directory, or\n the headings in a page\n tree [path] Expand a collection or directory recursively\n into its sections and pages\n read|get [options] Read a complete page by virtual path,\n canonical slug or official docs URL\n search [options] Search literal text; results include\n traversal paths and section links\n collection Read the entire collection corpus, without\n truncation\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.docs.collection", "name": "farthershore docs collection", "kind": "cli", "collection": "cli", "page": "generated/cli/docs", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore docs collection [options] \n\nRead the entire collection corpus, without truncation\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore docs collection [options] \n\nRead the entire collection corpus, without truncation\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.docs.ls", "name": "farthershore docs ls", "kind": "cli", "collection": "cli", "page": "generated/cli/docs", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore docs ls|list [options] [path]\n\nList collections, a section directory, or the headings in a page\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore docs ls|list [options] [path]\n\nList collections, a section directory, or the headings in a page\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.docs.read", "name": "farthershore docs read", "kind": "cli", "collection": "cli", "page": "generated/cli/docs", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore docs read|get [options] \n\nRead a complete page by virtual path, canonical slug or official docs URL\n\nOptions:\n --section Read this heading and all its child sections;\n no truncation\n -h, --help display help for command", "signature": "Usage: farthershore docs read|get [options] \n\nRead a complete page by virtual path, canonical slug or official docs URL\n\nOptions:\n --section Read this heading and all its child sections;\n no truncation\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.docs.search", "name": "farthershore docs search", "kind": "cli", "collection": "cli", "page": "generated/cli/docs", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore docs search [options] \n\nSearch literal text; results include traversal paths and section links\n\nOptions:\n --collection Search only this collection\n --limit Maximum results (1–100) (default: \"20\")\n -h, --help display help for command", "signature": "Usage: farthershore docs search [options] \n\nSearch literal text; results include traversal paths and section links\n\nOptions:\n --collection Search only this collection\n --limit Maximum results (1–100) (default: \"20\")\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.docs.tree", "name": "farthershore docs tree", "kind": "cli", "collection": "cli", "page": "generated/cli/docs", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore docs tree [options] [path]\n\nExpand a collection or directory recursively into its sections and pages\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore docs tree [options] [path]\n\nExpand a collection or directory recursively into its sections and pages\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.env", "name": "farthershore env", "kind": "cli", "collection": "cli", "page": "generated/cli/env", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore env [options] [command]\n\nManage business environments (preview branches, prod)\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrName] List environments for a business\n create [options] [businessIdOrName] Create a preview environment bound to a git branch\n delete [options] [businessIdOrName] [envName] Delete an environment by name. Requires --yes.\n help [command] display help for command", "signature": "Usage: farthershore env [options] [command]\n\nManage business environments (preview branches, prod)\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrName] List environments for a business\n create [options] [businessIdOrName] Create a preview environment bound to a git branch\n delete [options] [businessIdOrName] [envName] Delete an environment by name. Requires --yes.\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.env.create", "name": "farthershore env create", "kind": "cli", "collection": "cli", "page": "generated/cli/env", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore env create [options] [businessIdOrName]\n\nCreate a preview environment bound to a git branch\n\nOptions:\n --name Environment name (e.g. preview, staging)\n --branch Git branch to track (e.g. env/preview)\n -h, --help display help for command", "signature": "Usage: farthershore env create [options] [businessIdOrName]\n\nCreate a preview environment bound to a git branch\n\nOptions:\n --name Environment name (e.g. preview, staging)\n --branch Git branch to track (e.g. env/preview)\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.env.delete", "name": "farthershore env delete", "kind": "cli", "collection": "cli", "page": "generated/cli/env", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore env delete [options] [businessIdOrName] \n\nDelete an environment by name. Requires --yes.\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command", "signature": "Usage: farthershore env delete [options] [businessIdOrName] \n\nDelete an environment by name. Requires --yes.\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.env.list", "name": "farthershore env list", "kind": "cli", "collection": "cli", "page": "generated/cli/env", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore env list [options] [businessIdOrName]\n\nList environments for a business\n\nOptions:\n --filter Exact field filter; repeat for AND. Fields: id,\n name, branch. (default: [])\n --sort Server-side sort (default asc). Fields: name,\n createdAt, id.\n --search Server-side case-insensitive text search.\n -h, --help display help for command", "signature": "Usage: farthershore env list [options] [businessIdOrName]\n\nList environments for a business\n\nOptions:\n --filter Exact field filter; repeat for AND. Fields: id,\n name, branch. (default: [])\n --sort Server-side sort (default asc). Fields: name,\n createdAt, id.\n --search Server-side case-insensitive text search.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.farthershore-manifest-build", "name": "farthershore-manifest-build", "kind": "cli", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/src/bin.ts", "description": "Compile the business folder to deterministic Manifest IR and diagnostics.", "signature": "Usage: farthershore-manifest-build [--entry business] [--out business-build.json] [--diagnostics-out manifest-diagnostics.json]\n --entry defaults to the business/ folder (all modules imported; exactly one default fs.business() export is compiled).\n Pass a folder to discover it, or a single file to load only that file.\n", "guide": "define/build-output" }, { "id": "cli.frontend", "name": "farthershore frontend", "kind": "cli", "collection": "cli", "page": "generated/cli/frontend", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore frontend [options] [command]\n\nManaged Frontend Hosting: status/rollback/local preview (deploys are\nGit-triggered)\n\nOptions:\n -h, --help display help for command\n\nCommands:\n status [options] [businessIdOrSlug] Show the current frontend release, recent releases, and recent builds (incl. failure reasons)\n rollback [options] [businessIdOrSlug] Roll the business frontend back to a prior release (re-activate its releaseId)\n dev [options] Run the frontend's HOT-RELOADING `vite` dev server with an injected window.__FS_CONFIG__ shim (mock mode by default) — for active editing.\n preview [options] Build the frontend and serve the BUSINESSION bundle via `vite preview` with the same shim (mock mode by default) — final as-shipped inspection.\n help [command] display help for command", "signature": "Usage: farthershore frontend [options] [command]\n\nManaged Frontend Hosting: status/rollback/local preview (deploys are\nGit-triggered)\n\nOptions:\n -h, --help display help for command\n\nCommands:\n status [options] [businessIdOrSlug] Show the current frontend release, recent releases, and recent builds (incl. failure reasons)\n rollback [options] [businessIdOrSlug] Roll the business frontend back to a prior release (re-activate its releaseId)\n dev [options] Run the frontend's HOT-RELOADING `vite` dev server with an injected window.__FS_CONFIG__ shim (mock mode by default) — for active editing.\n preview [options] Build the frontend and serve the BUSINESSION bundle via `vite preview` with the same shim (mock mode by default) — final as-shipped inspection.\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.frontend.dev", "name": "farthershore frontend dev", "kind": "cli", "collection": "cli", "page": "generated/cli/frontend", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore frontend dev [options]\n\nRun the frontend's HOT-RELOADING `vite` dev server with an injected\nwindow.__FS_CONFIG__ shim (mock mode by default) — for active editing.\n\nOptions:\n --dir Frontend project directory (default:\n ./frontend)\n --mock Force mock mode (this is already the\n default when no Core/Clerk config is given)\n --live Preview against the real platform\n (production Core URL) instead of mock mode\n --business Business for a local persona preview\n --env Test environment for a local persona\n preview\n --persona Existing test persona for a local live\n preview\n --core-url Platform Core base URL to shim (default:\n VITE_FS_CORE_URL)\n --clerk-publishable-key Clerk publishable key for clerk-strategy\n envs (default: VITE_CLERK_PUBLISHABLE_KEY)\n --clerk-sign-in-url Clerk hosted sign-in URL (default:\n VITE_CLERK_SIGN_IN_URL)\n --clerk-satellite-domain Clerk satellite domain (default:\n VITE_CLERK_SATELLITE_DOMAIN)\n --port Public local proxy port (Vite uses a\n private random loopback port for persona\n previews)\n -h, --help display help for command\n\nExamples:\n farthershore frontend dev # HOT-RELOADING dev server, mock mode (default)\n farthershore frontend preview # production build served as-is, mock mode\n farthershore frontend dev --live # against the real production platform\n farthershore frontend dev --live --business acme --env preview --persona persona_123\n farthershore frontend dev --core-url http://localhost:8787\n farthershore frontend dev --dir ./frontend --port 4321\n\nMock mode (the default with no Core/Clerk config):\n Injects { mock: true } — every page renders with placeholder data and\n bypassed auth for local inspection. Point at a real platform with\n --live, --core-url, or VITE_FS_CORE_URL.", "signature": "Usage: farthershore frontend dev [options]\n\nRun the frontend's HOT-RELOADING `vite` dev server with an injected\nwindow.__FS_CONFIG__ shim (mock mode by default) — for active editing.\n\nOptions:\n --dir Frontend project directory (default:\n ./frontend)\n --mock Force mock mode (this is already the\n default when no Core/Clerk config is given)\n --live Preview against the real platform\n (production Core URL) instead of mock mode\n --business Business for a local persona preview\n --env Test environment for a local persona\n preview\n --persona Existing test persona for a local live\n preview\n --core-url Platform Core base URL to shim (default:\n VITE_FS_CORE_URL)\n --clerk-publishable-key Clerk publishable key for clerk-strategy\n envs (default: VITE_CLERK_PUBLISHABLE_KEY)\n --clerk-sign-in-url Clerk hosted sign-in URL (default:\n VITE_CLERK_SIGN_IN_URL)\n --clerk-satellite-domain Clerk satellite domain (default:\n VITE_CLERK_SATELLITE_DOMAIN)\n --port Public local proxy port (Vite uses a\n private random loopback port for persona\n previews)\n -h, --help display help for command\n\nExamples:\n farthershore frontend dev # HOT-RELOADING dev server, mock mode (default)\n farthershore frontend preview # production build served as-is, mock mode\n farthershore frontend dev --live # against the real production platform\n farthershore frontend dev --live --business acme --env preview --persona persona_123\n farthershore frontend dev --core-url http://localhost:8787\n farthershore frontend dev --dir ./frontend --port 4321\n\nMock mode (the default with no Core/Clerk config):\n Injects { mock: true } — every page renders with placeholder data and\n bypassed auth for local inspection. Point at a real platform with\n --live, --core-url, or VITE_FS_CORE_URL.\n\n", "guide": "cli/overview" }, { "id": "cli.frontend.preview", "name": "farthershore frontend preview", "kind": "cli", "collection": "cli", "page": "generated/cli/frontend", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore frontend preview [options]\n\nBuild the frontend and serve the BUSINESSION bundle via `vite preview` with the\nsame shim (mock mode by default) — final as-shipped inspection.\n\nOptions:\n --dir Frontend project directory (default:\n ./frontend)\n --mock Force mock mode (this is already the\n default when no Core/Clerk config is given)\n --live Preview against the real platform\n (production Core URL) instead of mock mode\n --business Business for a local persona preview\n --env Test environment for a local persona\n preview\n --persona Existing test persona for a local live\n preview\n --core-url Platform Core base URL to shim (default:\n VITE_FS_CORE_URL)\n --clerk-publishable-key Clerk publishable key for clerk-strategy\n envs (default: VITE_CLERK_PUBLISHABLE_KEY)\n --clerk-sign-in-url Clerk hosted sign-in URL (default:\n VITE_CLERK_SIGN_IN_URL)\n --clerk-satellite-domain Clerk satellite domain (default:\n VITE_CLERK_SATELLITE_DOMAIN)\n --port Public local proxy port (Vite uses a\n private random loopback port for persona\n previews)\n -h, --help display help for command\n\nExamples:\n farthershore frontend dev # HOT-RELOADING dev server, mock mode (default)\n farthershore frontend preview # production build served as-is, mock mode\n farthershore frontend preview --live # against the real production platform\n farthershore frontend preview --live --business acme --env preview --persona persona_123\n farthershore frontend preview --core-url http://localhost:8787\n farthershore frontend preview --dir ./frontend --port 4321\n\nMock mode (the default with no Core/Clerk config):\n Injects { mock: true } — every page renders with placeholder data and\n bypassed auth for local inspection. Point at a real platform with\n --live, --core-url, or VITE_FS_CORE_URL.", "signature": "Usage: farthershore frontend preview [options]\n\nBuild the frontend and serve the BUSINESSION bundle via `vite preview` with the\nsame shim (mock mode by default) — final as-shipped inspection.\n\nOptions:\n --dir Frontend project directory (default:\n ./frontend)\n --mock Force mock mode (this is already the\n default when no Core/Clerk config is given)\n --live Preview against the real platform\n (production Core URL) instead of mock mode\n --business Business for a local persona preview\n --env Test environment for a local persona\n preview\n --persona Existing test persona for a local live\n preview\n --core-url Platform Core base URL to shim (default:\n VITE_FS_CORE_URL)\n --clerk-publishable-key Clerk publishable key for clerk-strategy\n envs (default: VITE_CLERK_PUBLISHABLE_KEY)\n --clerk-sign-in-url Clerk hosted sign-in URL (default:\n VITE_CLERK_SIGN_IN_URL)\n --clerk-satellite-domain Clerk satellite domain (default:\n VITE_CLERK_SATELLITE_DOMAIN)\n --port Public local proxy port (Vite uses a\n private random loopback port for persona\n previews)\n -h, --help display help for command\n\nExamples:\n farthershore frontend dev # HOT-RELOADING dev server, mock mode (default)\n farthershore frontend preview # production build served as-is, mock mode\n farthershore frontend preview --live # against the real production platform\n farthershore frontend preview --live --business acme --env preview --persona persona_123\n farthershore frontend preview --core-url http://localhost:8787\n farthershore frontend preview --dir ./frontend --port 4321\n\nMock mode (the default with no Core/Clerk config):\n Injects { mock: true } — every page renders with placeholder data and\n bypassed auth for local inspection. Point at a real platform with\n --live, --core-url, or VITE_FS_CORE_URL.\n\n", "guide": "cli/overview" }, { "id": "cli.frontend.rollback", "name": "farthershore frontend rollback", "kind": "cli", "collection": "cli", "page": "generated/cli/frontend", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore frontend rollback [options] [businessIdOrSlug]\n\nRoll the business frontend back to a prior release (re-activate its releaseId)\n\nOptions:\n --release-id The prior release id (manifest hash) to re-activate\n — see `frontend status`.\n --env Scope to a preview environment name or id (omit for\n production).\n --dry-run Preview the change without applying it.\n -h, --help display help for command", "signature": "Usage: farthershore frontend rollback [options] [businessIdOrSlug]\n\nRoll the business frontend back to a prior release (re-activate its releaseId)\n\nOptions:\n --release-id The prior release id (manifest hash) to re-activate\n — see `frontend status`.\n --env Scope to a preview environment name or id (omit for\n production).\n --dry-run Preview the change without applying it.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.frontend.status", "name": "farthershore frontend status", "kind": "cli", "collection": "cli", "page": "generated/cli/frontend", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore frontend status [options] [businessIdOrSlug]\n\nShow the current frontend release, recent releases, and recent builds (incl.\nfailure reasons)\n\nOptions:\n --env Scope to a preview environment name or id (omit for\n production).\n --wait Wait for a build that appears after this command starts;\n exit non-zero if it fails. Pair with --ref after a Git\n push or release for exact source proof.\n --ref Match builds for this immutable Git commit SHA; use with\n --wait to observe the latest known build for that source\n revision.\n --timeout How long --wait waits before giving up (default 600).\n -h, --help display help for command", "signature": "Usage: farthershore frontend status [options] [businessIdOrSlug]\n\nShow the current frontend release, recent releases, and recent builds (incl.\nfailure reasons)\n\nOptions:\n --env Scope to a preview environment name or id (omit for\n production).\n --wait Wait for a build that appears after this command starts;\n exit non-zero if it fails. Pair with --ref after a Git\n push or release for exact source proof.\n --ref Match builds for this immutable Git commit SHA; use with\n --wait to observe the latest known build for that source\n revision.\n --timeout How long --wait waits before giving up (default 600).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.import", "name": "farthershore import", "kind": "cli", "collection": "cli", "page": "generated/cli/import", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore import [options] [command]\n\nImport external definitions into FartherShore authoring\n\nOptions:\n -h, --help display help for command\n\nCommands:\n openapi [options] Scaffold a path-first Business SDK route module from\n an OpenAPI spec\n help [command] display help for command", "signature": "Usage: farthershore import [options] [command]\n\nImport external definitions into FartherShore authoring\n\nOptions:\n -h, --help display help for command\n\nCommands:\n openapi [options] Scaffold a path-first Business SDK route module from\n an OpenAPI spec\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.import.openapi", "name": "farthershore import openapi", "kind": "cli", "collection": "cli", "page": "generated/cli/import", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore import openapi [options] \n\nScaffold a path-first Business SDK route module from an OpenAPI spec\n\nArguments:\n spec Path to an OpenAPI 3.x JSON document\n\nOptions:\n --out Write the generated module to this file (default: print to\n stdout)\n -h, --help display help for command", "signature": "Usage: farthershore import openapi [options] \n\nScaffold a path-first Business SDK route module from an OpenAPI spec\n\nArguments:\n spec Path to an OpenAPI 3.x JSON document\n\nOptions:\n --out Write the generated module to this file (default: print to\n stdout)\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.knowledge", "name": "farthershore knowledge", "kind": "cli", "collection": "cli", "page": "generated/cli/knowledge", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore knowledge [options] [command]\n\nList platform and business knowledge resources\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] List platform guide resources\n business-list [options] [businessIdOrName] List one business's knowledge resources\n help [command] display help for command", "signature": "Usage: farthershore knowledge [options] [command]\n\nList platform and business knowledge resources\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] List platform guide resources\n business-list [options] [businessIdOrName] List one business's knowledge resources\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.knowledge.business-list", "name": "farthershore knowledge business-list", "kind": "cli", "collection": "cli", "page": "generated/cli/knowledge", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore knowledge business-list [options] [businessIdOrName]\n\nList one business's knowledge resources\n\nOptions:\n --cursor \n -h, --help display help for command", "signature": "Usage: farthershore knowledge business-list [options] [businessIdOrName]\n\nList one business's knowledge resources\n\nOptions:\n --cursor \n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.knowledge.list", "name": "farthershore knowledge list", "kind": "cli", "collection": "cli", "page": "generated/cli/knowledge", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore knowledge list [options]\n\nList platform guide resources\n\nOptions:\n --cursor \n -h, --help display help for command", "signature": "Usage: farthershore knowledge list [options]\n\nList platform guide resources\n\nOptions:\n --cursor \n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.limit", "name": "farthershore limit", "kind": "cli", "collection": "cli", "page": "generated/cli/limit", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore limit [options] [command]\n\nManage subscriber-owned usage limits with a portal consumer session\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] \n set [options] \n remove [options] \n help [command] display help for command", "signature": "Usage: farthershore limit [options] [command]\n\nManage subscriber-owned usage limits with a portal consumer session\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] \n set [options] \n remove [options] \n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.limit.list", "name": "farthershore limit list", "kind": "cli", "collection": "cli", "page": "generated/cli/limit", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore limit list [options] \n\nOptions:\n --limit Maximum rows (1-100; default 100)\n --offset Rows to skip (default 0)\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command", "signature": "Usage: farthershore limit list [options] \n\nOptions:\n --limit Maximum rows (1-100; default 100)\n --offset Rows to skip (default 0)\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.limit.remove", "name": "farthershore limit remove", "kind": "cli", "collection": "cli", "page": "generated/cli/limit", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore limit remove [options] \n\nOptions:\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command", "signature": "Usage: farthershore limit remove [options] \n\nOptions:\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.limit.set", "name": "farthershore limit set", "kind": "cli", "collection": "cli", "page": "generated/cli/limit", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore limit set [options] \n\nOptions:\n --quantity Meter quantity key\n --mode BLOCK or NOTIFY (required on create)\n --limit-id Existing limit id to update\n --scope ORG, MEMBER, or SERVICE_ACCOUNT (default:\n \"ORG\")\n --subject-id Membership or service-account id\n --units Unit capacity\n --cents Spend capacity in cents\n --notify-at Notification threshold fraction\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command", "signature": "Usage: farthershore limit set [options] \n\nOptions:\n --quantity Meter quantity key\n --mode BLOCK or NOTIFY (required on create)\n --limit-id Existing limit id to update\n --scope ORG, MEMBER, or SERVICE_ACCOUNT (default:\n \"ORG\")\n --subject-id Membership or service-account id\n --units Unit capacity\n --cents Spend capacity in cents\n --notify-at Notification threshold fraction\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.link", "name": "farthershore link", "kind": "cli", "collection": "cli", "page": "generated/cli/link", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore link [options] [business]\n\nTarget this directory at a business so later commands can omit it (like `railway\nlink`). Omit the argument to show what is currently targeted.\n\nArguments:\n business Business id, name, or hostname slug. Omit to show the\n current link.\n\nOptions:\n --env Also target an environment, so --env can be omitted too.\n Stored by NAME (a recreated preview env re-resolves; a\n stale id would not).\n -h, --help display help for command", "signature": "Usage: farthershore link [options] [business]\n\nTarget this directory at a business so later commands can omit it (like `railway\nlink`). Omit the argument to show what is currently targeted.\n\nArguments:\n business Business id, name, or hostname slug. Omit to show the\n current link.\n\nOptions:\n --env Also target an environment, so --env can be omitted too.\n Stored by NAME (a recreated preview env re-resolves; a\n stale id would not).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.login", "name": "farthershore login", "kind": "cli", "collection": "cli", "page": "generated/cli/login", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore login [options]\n\nAuthenticate the CLI without placing credentials in argv\n\nOptions:\n --token-stdin Read an organization-scoped MakerToken from piped stdin\n --headless Print the verification URL and user code without opening a\n browser\n -h, --help display help for command", "signature": "Usage: farthershore login [options]\n\nAuthenticate the CLI without placing credentials in argv\n\nOptions:\n --token-stdin Read an organization-scoped MakerToken from piped stdin\n --headless Print the verification URL and user code without opening a\n browser\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.logout", "name": "farthershore logout", "kind": "cli", "collection": "cli", "page": "generated/cli/logout", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore logout [options]\n\nRevoke the current CLI session and clear stored credentials\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore logout [options]\n\nRevoke the current CLI session and clear stored credentials\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.notifications", "name": "farthershore notifications", "kind": "cli", "collection": "cli", "page": "generated/cli/notifications", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore notifications [options] [command]\n\nRead notifications and manage delivery preferences\n\nOptions:\n -h, --help display help for command\n\nCommands:\n preferences [businessIdOrSlug] Get notification (email) opt-out preferences\n preferences-update [options] [businessIdOrSlug] Patch notification (email) opt-out preferences\n help [command] display help for command", "signature": "Usage: farthershore notifications [options] [command]\n\nRead notifications and manage delivery preferences\n\nOptions:\n -h, --help display help for command\n\nCommands:\n preferences [businessIdOrSlug] Get notification (email) opt-out preferences\n preferences-update [options] [businessIdOrSlug] Patch notification (email) opt-out preferences\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.notifications.preferences", "name": "farthershore notifications preferences", "kind": "cli", "collection": "cli", "page": "generated/cli/notifications", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore notifications preferences [options] [businessIdOrSlug]\n\nGet notification (email) opt-out preferences\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore notifications preferences [options] [businessIdOrSlug]\n\nGet notification (email) opt-out preferences\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.notifications.preferences-update", "name": "farthershore notifications preferences-update", "kind": "cli", "collection": "cli", "page": "generated/cli/notifications", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore notifications preferences-update [options] [businessIdOrSlug]\n\nPatch notification (email) opt-out preferences\n\nOptions:\n --patch JSON patch, e.g. {\"master\":true} or\n {\"categories\":{\"deployments\":true}} (true = opted out of\n email)\n -h, --help display help for command", "signature": "Usage: farthershore notifications preferences-update [options] [businessIdOrSlug]\n\nPatch notification (email) opt-out preferences\n\nOptions:\n --patch JSON patch, e.g. {\"master\":true} or\n {\"categories\":{\"deployments\":true}} (true = opted out of\n email)\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.operations", "name": "farthershore operations", "kind": "cli", "collection": "cli", "page": "generated/cli/operations", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore operations [options] [command]\n\nMachine-readable catalog of repository-owned and platform-operated actions\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list Print the agent operation boundary catalog\n help [command] display help for command", "signature": "Usage: farthershore operations [options] [command]\n\nMachine-readable catalog of repository-owned and platform-operated actions\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list Print the agent operation boundary catalog\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.operations.list", "name": "farthershore operations list", "kind": "cli", "collection": "cli", "page": "generated/cli/operations", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore operations list [options]\n\nPrint the agent operation boundary catalog\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore operations list [options]\n\nPrint the agent operation boundary catalog\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.organization", "name": "farthershore organization", "kind": "cli", "collection": "cli", "page": "generated/cli/organization", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore organization [options] [command]\n\nManage builder organizations and team membership\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list List builder organizations available to the caller\n create [options] Create a team or company organization\n role\n members [options] List organization members\n invite [options] Invite a member to an organization\n invitation-list List the caller's pending organization invitations\n invitation-list-sent List an organization's outstanding sent invitations\n invitation-revoke [options] Revoke a pending organization invitation\n invitation-accept [options] Accept an organization invitation\n member-role [options] Change an organization member's role\n member-remove [options] Remove a member from an organization\n ownership-transfer [options] Transfer primary ownership of a team or company organization to another member\n delete [options] Delete an organization and its managed state\n overview Read the organization overview shown on the dashboard\n bulletin [options] List the consolidated bulletin across the organization\n help [command] display help for command", "signature": "Usage: farthershore organization [options] [command]\n\nManage builder organizations and team membership\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list List builder organizations available to the caller\n create [options] Create a team or company organization\n role\n members [options] List organization members\n invite [options] Invite a member to an organization\n invitation-list List the caller's pending organization invitations\n invitation-list-sent List an organization's outstanding sent invitations\n invitation-revoke [options] Revoke a pending organization invitation\n invitation-accept [options] Accept an organization invitation\n member-role [options] Change an organization member's role\n member-remove [options] Remove a member from an organization\n ownership-transfer [options] Transfer primary ownership of a team or company organization to another member\n delete [options] Delete an organization and its managed state\n overview Read the organization overview shown on the dashboard\n bulletin [options] List the consolidated bulletin across the organization\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.organization.bulletin", "name": "farthershore organization bulletin", "kind": "cli", "collection": "cli", "page": "generated/cli/organization", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore organization bulletin [options] \n\nList the consolidated bulletin across the organization\n\nOptions:\n --kind \n --status \n --cursor \n --limit \n -h, --help display help for command", "signature": "Usage: farthershore organization bulletin [options] \n\nList the consolidated bulletin across the organization\n\nOptions:\n --kind \n --status \n --cursor \n --limit \n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.organization.create", "name": "farthershore organization create", "kind": "cli", "collection": "cli", "page": "generated/cli/organization", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore organization create [options] \n\nCreate a team or company organization\n\nOptions:\n --type Organization type: team | company (default: \"team\")\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore organization create [options] \n\nCreate a team or company organization\n\nOptions:\n --type Organization type: team | company (default: \"team\")\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.organization.delete", "name": "farthershore organization delete", "kind": "cli", "collection": "cli", "page": "generated/cli/organization", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore organization delete [options] \n\nDelete an organization and its managed state\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command", "signature": "Usage: farthershore organization delete [options] \n\nDelete an organization and its managed state\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.organization.invitation-accept", "name": "farthershore organization invitation-accept", "kind": "cli", "collection": "cli", "page": "generated/cli/organization", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore organization invitation-accept [options] \n\nAccept an organization invitation\n\nOptions:\n --invitation-token One-time token from the invitation email, when\n required.\n -h, --help display help for command", "signature": "Usage: farthershore organization invitation-accept [options] \n\nAccept an organization invitation\n\nOptions:\n --invitation-token One-time token from the invitation email, when\n required.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.organization.invitation-list", "name": "farthershore organization invitation-list", "kind": "cli", "collection": "cli", "page": "generated/cli/organization", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore organization invitation-list [options]\n\nList the caller's pending organization invitations\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore organization invitation-list [options]\n\nList the caller's pending organization invitations\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.organization.invitation-list-sent", "name": "farthershore organization invitation-list-sent", "kind": "cli", "collection": "cli", "page": "generated/cli/organization", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore organization invitation-list-sent [options] \n\nList an organization's outstanding sent invitations\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore organization invitation-list-sent [options] \n\nList an organization's outstanding sent invitations\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.organization.invitation-revoke", "name": "farthershore organization invitation-revoke", "kind": "cli", "collection": "cli", "page": "generated/cli/organization", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore organization invitation-revoke [options] \n\nRevoke a pending organization invitation\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command", "signature": "Usage: farthershore organization invitation-revoke [options] \n\nRevoke a pending organization invitation\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.organization.invite", "name": "farthershore organization invite", "kind": "cli", "collection": "cli", "page": "generated/cli/organization", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore organization invite [options] \n\nInvite a member to an organization\n\nOptions:\n --role Organization role key (see `organization role list`).\n (default: \"member\")\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore organization invite [options] \n\nInvite a member to an organization\n\nOptions:\n --role Organization role key (see `organization role list`).\n (default: \"member\")\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.organization.list", "name": "farthershore organization list", "kind": "cli", "collection": "cli", "page": "generated/cli/organization", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore organization list [options]\n\nList builder organizations available to the caller\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore organization list [options]\n\nList builder organizations available to the caller\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.organization.member-remove", "name": "farthershore organization member-remove", "kind": "cli", "collection": "cli", "page": "generated/cli/organization", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore organization member-remove [options] \n\nRemove a member from an organization\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command", "signature": "Usage: farthershore organization member-remove [options] \n\nRemove a member from an organization\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.organization.member-role", "name": "farthershore organization member-role", "kind": "cli", "collection": "cli", "page": "generated/cli/organization", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore organization member-role [options] \n\nChange an organization member's role\n\nOptions:\n --role New organization role key (see `organization role list`).\n -h, --help display help for command", "signature": "Usage: farthershore organization member-role [options] \n\nChange an organization member's role\n\nOptions:\n --role New organization role key (see `organization role list`).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.organization.members", "name": "farthershore organization members", "kind": "cli", "collection": "cli", "page": "generated/cli/organization", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore organization members [options] \n\nList organization members\n\nOptions:\n --filter Exact field filter; repeat for AND. Fields: userId,\n email, roleKey. (default: [])\n --sort Server-side sort (default asc). Fields: userId,\n email, roleKey, createdAt, updatedAt.\n --search Server-side case-insensitive text search.\n -h, --help display help for command", "signature": "Usage: farthershore organization members [options] \n\nList organization members\n\nOptions:\n --filter Exact field filter; repeat for AND. Fields: userId,\n email, roleKey. (default: [])\n --sort Server-side sort (default asc). Fields: userId,\n email, roleKey, createdAt, updatedAt.\n --search Server-side case-insensitive text search.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.organization.overview", "name": "farthershore organization overview", "kind": "cli", "collection": "cli", "page": "generated/cli/organization", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore organization overview [options] \n\nRead the organization overview shown on the dashboard\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore organization overview [options] \n\nRead the organization overview shown on the dashboard\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.organization.ownership-transfer", "name": "farthershore organization ownership-transfer", "kind": "cli", "collection": "cli", "page": "generated/cli/organization", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore organization ownership-transfer [options] \n\nTransfer primary ownership of a team or company organization to another member\n\nOptions:\n --yes Skip confirmation; required for this destructive\n action\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore organization ownership-transfer [options] \n\nTransfer primary ownership of a team or company organization to another member\n\nOptions:\n --yes Skip confirmation; required for this destructive\n action\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.organization.role", "name": "farthershore organization role", "kind": "cli", "collection": "cli", "page": "generated/cli/organization", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore organization role [options] [command]\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] List the roles available in an organization\n show Show one organization role and its exact permissions\n create [options] Create a custom organization role\n update [options] Update a built-in or custom organization role\n delete [options] Delete an unused custom organization role\n help [command] display help for command", "signature": "Usage: farthershore organization role [options] [command]\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] List the roles available in an organization\n show Show one organization role and its exact permissions\n create [options] Create a custom organization role\n update [options] Update a built-in or custom organization role\n delete [options] Delete an unused custom organization role\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.organization.role.create", "name": "farthershore organization role create", "kind": "cli", "collection": "cli", "page": "generated/cli/organization", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore organization role create [options] \n\nCreate a custom organization role\n\nOptions:\n --name \n --description \n --permissions Exact permission snapshot as JSON, for example\n [\"business:read\"]. Use [] for no permissions.\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore organization role create [options] \n\nCreate a custom organization role\n\nOptions:\n --name \n --description \n --permissions Exact permission snapshot as JSON, for example\n [\"business:read\"]. Use [] for no permissions.\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.organization.role.delete", "name": "farthershore organization role delete", "kind": "cli", "collection": "cli", "page": "generated/cli/organization", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore organization role delete [options] \n\nDelete an unused custom organization role\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command", "signature": "Usage: farthershore organization role delete [options] \n\nDelete an unused custom organization role\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.organization.role.list", "name": "farthershore organization role list", "kind": "cli", "collection": "cli", "page": "generated/cli/organization", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore organization role list [options] \n\nList the roles available in an organization\n\nOptions:\n --filter Exact field filter; repeat for AND. Fields: key,\n name, builtIn. (default: [])\n --sort Server-side sort (default asc). Fields: key, name,\n createdAt, id.\n --search Server-side case-insensitive text search.\n -h, --help display help for command", "signature": "Usage: farthershore organization role list [options] \n\nList the roles available in an organization\n\nOptions:\n --filter Exact field filter; repeat for AND. Fields: key,\n name, builtIn. (default: [])\n --sort Server-side sort (default asc). Fields: key, name,\n createdAt, id.\n --search Server-side case-insensitive text search.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.organization.role.show", "name": "farthershore organization role show", "kind": "cli", "collection": "cli", "page": "generated/cli/organization", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore organization role show [options] \n\nShow one organization role and its exact permissions\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore organization role show [options] \n\nShow one organization role and its exact permissions\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.organization.role.update", "name": "farthershore organization role update", "kind": "cli", "collection": "cli", "page": "generated/cli/organization", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore organization role update [options] \n\nUpdate a built-in or custom organization role\n\nOptions:\n --name \n --description \n --clear-description Clear the role description.\n --permissions Exact permission snapshot as JSON, for example\n [\"business:read\"]. Use [] for no permissions.\n -h, --help display help for command", "signature": "Usage: farthershore organization role update [options] \n\nUpdate a built-in or custom organization role\n\nOptions:\n --name \n --description \n --clear-description Clear the role description.\n --permissions Exact permission snapshot as JSON, for example\n [\"business:read\"]. Use [] for no permissions.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.persona", "name": "farthershore persona", "kind": "cli", "collection": "cli", "page": "generated/cli/persona", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore persona [options] [command]\n\nMint and manage test-env personas (test API keys)\n\nOptions:\n -h, --help display help for command\n\nCommands:\n bootstrap [options] [businessIdOrName] Issue a fresh fsk_test_ API key in a test environment\n list [options] [businessIdOrName] List personas for a test environment\n login [options] [businessIdOrName] [personaId] Open a browser signed in as a test persona\n rotate [options] [businessIdOrName] [personaId] Rotate a persona's test API key and return the new key once\n delete [options] [businessIdOrName] [personaId] Delete a temporary persona and its test-owned identity state\n help [command] display help for command", "signature": "Usage: farthershore persona [options] [command]\n\nMint and manage test-env personas (test API keys)\n\nOptions:\n -h, --help display help for command\n\nCommands:\n bootstrap [options] [businessIdOrName] Issue a fresh fsk_test_ API key in a test environment\n list [options] [businessIdOrName] List personas for a test environment\n login [options] [businessIdOrName] [personaId] Open a browser signed in as a test persona\n rotate [options] [businessIdOrName] [personaId] Rotate a persona's test API key and return the new key once\n delete [options] [businessIdOrName] [personaId] Delete a temporary persona and its test-owned identity state\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.persona.bootstrap", "name": "farthershore persona bootstrap", "kind": "cli", "collection": "cli", "page": "generated/cli/persona", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore persona bootstrap [options] [businessIdOrName]\n\nIssue a fresh fsk_test_ API key in a test environment\n\nOptions:\n --env Environment name (must be test-strategy)\n --plan Plan key to assign (required when creating a\n subscriber; e.g. starter)\n --display-name Persona display name\n --subscriber-id Join an existing persona test subscriber; omit to\n create a new subscriber owned by this persona\n --account-role Subscriber-organization account role: owner, admin,\n or member — the canonical lowercase vocabulary\n (stored as Membership.role OWNER/ADMIN/VIEWER, where\n member ⇢ VIEWER). Default: owner for a new\n subscriber, member when joining\n --role Subscriber-owned product role key(s); omit to use the\n subscriber's configured default role\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore persona bootstrap [options] [businessIdOrName]\n\nIssue a fresh fsk_test_ API key in a test environment\n\nOptions:\n --env Environment name (must be test-strategy)\n --plan Plan key to assign (required when creating a\n subscriber; e.g. starter)\n --display-name Persona display name\n --subscriber-id Join an existing persona test subscriber; omit to\n create a new subscriber owned by this persona\n --account-role Subscriber-organization account role: owner, admin,\n or member — the canonical lowercase vocabulary\n (stored as Membership.role OWNER/ADMIN/VIEWER, where\n member ⇢ VIEWER). Default: owner for a new\n subscriber, member when joining\n --role Subscriber-owned product role key(s); omit to use the\n subscriber's configured default role\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.persona.delete", "name": "farthershore persona delete", "kind": "cli", "collection": "cli", "page": "generated/cli/persona", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore persona delete [options] [businessIdOrName] \n\nDelete a temporary persona and its test-owned identity state\n\nOptions:\n --env Environment name\n -h, --help display help for command", "signature": "Usage: farthershore persona delete [options] [businessIdOrName] \n\nDelete a temporary persona and its test-owned identity state\n\nOptions:\n --env Environment name\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.persona.list", "name": "farthershore persona list", "kind": "cli", "collection": "cli", "page": "generated/cli/persona", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore persona list [options] [businessIdOrName]\n\nList personas for a test environment\n\nOptions:\n --env Environment name\n -h, --help display help for command", "signature": "Usage: farthershore persona list [options] [businessIdOrName]\n\nList personas for a test environment\n\nOptions:\n --env Environment name\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.persona.login", "name": "farthershore persona login", "kind": "cli", "collection": "cli", "page": "generated/cli/persona", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore persona login [options] [businessIdOrName] \n\nOpen a browser signed in as a test persona\n\nOptions:\n --env Environment name\n -h, --help display help for command", "signature": "Usage: farthershore persona login [options] [businessIdOrName] \n\nOpen a browser signed in as a test persona\n\nOptions:\n --env Environment name\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.persona.rotate", "name": "farthershore persona rotate", "kind": "cli", "collection": "cli", "page": "generated/cli/persona", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore persona rotate [options] [businessIdOrName] \n\nRotate a persona's test API key and return the new key once\n\nOptions:\n --env Environment name\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore persona rotate [options] [businessIdOrName] \n\nRotate a persona's test API key and return the new key once\n\nOptions:\n --env Environment name\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.plan", "name": "farthershore plan", "kind": "cli", "collection": "cli", "page": "generated/cli/plan", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore plan [options] [command]\n\nPlan operations: list code-managed plans and migrate subscribers\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrName] List plans for a business\n help [command] display help for command", "signature": "Usage: farthershore plan [options] [command]\n\nPlan operations: list code-managed plans and migrate subscribers\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrName] List plans for a business\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.plan.list", "name": "farthershore plan list", "kind": "cli", "collection": "cli", "page": "generated/cli/plan", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore plan list [options] [businessIdOrName]\n\nList plans for a business\n\nOptions:\n --env List the plans this environment serves (name or id). Omit\n for production.\n -h, --help display help for command\n\nScope:\n Without --env this lists the PRODUCTION plans. A preview environment serves\n its own compiled program, so pass --env to see what that\n environment actually serves.\n\nOutput:\n --format json — stable agent-friendly JSON envelope (default for non-TTY)\n --format table — human-readable summary table (default for TTY)", "signature": "Usage: farthershore plan list [options] [businessIdOrName]\n\nList plans for a business\n\nOptions:\n --env List the plans this environment serves (name or id). Omit\n for production.\n -h, --help display help for command\n\nScope:\n Without --env this lists the PRODUCTION plans. A preview environment serves\n its own compiled program, so pass --env to see what that\n environment actually serves.\n\nOutput:\n --format json — stable agent-friendly JSON envelope (default for non-TTY)\n --format table — human-readable summary table (default for TTY)\n\n", "guide": "cli/overview" }, { "id": "cli.promo-code", "name": "farthershore promo-code", "kind": "cli", "collection": "cli", "page": "generated/cli/promo-code", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore promo-code [options] [command]\n\nManage API-controlled checkout promo codes\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [businessIdOrSlug] List API-managed promo codes for checkout\n create [options] [businessIdOrSlug] Create an API-managed checkout promo code\n update [options] [businessIdOrSlug] [promoCodeId] Update an API-managed checkout promo code\n archive [businessIdOrSlug] [promoCodeId] Archive a checkout promo code\n reactivate [businessIdOrSlug] [promoCodeId] Reactivate an archived checkout promo code\n help [command] display help for command", "signature": "Usage: farthershore promo-code [options] [command]\n\nManage API-controlled checkout promo codes\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [businessIdOrSlug] List API-managed promo codes for checkout\n create [options] [businessIdOrSlug] Create an API-managed checkout promo code\n update [options] [businessIdOrSlug] [promoCodeId] Update an API-managed checkout promo code\n archive [businessIdOrSlug] [promoCodeId] Archive a checkout promo code\n reactivate [businessIdOrSlug] [promoCodeId] Reactivate an archived checkout promo code\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.promo-code.archive", "name": "farthershore promo-code archive", "kind": "cli", "collection": "cli", "page": "generated/cli/promo-code", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore promo-code archive [options] [businessIdOrSlug] \n\nArchive a checkout promo code\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore promo-code archive [options] [businessIdOrSlug] \n\nArchive a checkout promo code\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.promo-code.create", "name": "farthershore promo-code create", "kind": "cli", "collection": "cli", "page": "generated/cli/promo-code", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore promo-code create [options] [businessIdOrSlug]\n\nCreate an API-managed checkout promo code\n\nOptions:\n --code Customer-entered promo code.\n --kind percent_off, amount_off, or free_months.\n --percent Percent discount for percent_off promos.\n --amount-cents Fixed discount in cents for amount_off promos.\n --duration-months Discount duration in months.\n --max-redemptions Optional maximum redemption count.\n --active-from Optional ISO-8601 activation timestamp.\n --active-until Optional ISO-8601 expiration timestamp.\n --plan Limit to a plan id. Repeatable. Omit for all launch\n plans; use --all-plans on update to clear scoped\n plans. (default: [])\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore promo-code create [options] [businessIdOrSlug]\n\nCreate an API-managed checkout promo code\n\nOptions:\n --code Customer-entered promo code.\n --kind percent_off, amount_off, or free_months.\n --percent Percent discount for percent_off promos.\n --amount-cents Fixed discount in cents for amount_off promos.\n --duration-months Discount duration in months.\n --max-redemptions Optional maximum redemption count.\n --active-from Optional ISO-8601 activation timestamp.\n --active-until Optional ISO-8601 expiration timestamp.\n --plan Limit to a plan id. Repeatable. Omit for all launch\n plans; use --all-plans on update to clear scoped\n plans. (default: [])\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.promo-code.list", "name": "farthershore promo-code list", "kind": "cli", "collection": "cli", "page": "generated/cli/promo-code", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore promo-code list [options] [businessIdOrSlug]\n\nList API-managed promo codes for checkout\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore promo-code list [options] [businessIdOrSlug]\n\nList API-managed promo codes for checkout\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.promo-code.reactivate", "name": "farthershore promo-code reactivate", "kind": "cli", "collection": "cli", "page": "generated/cli/promo-code", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore promo-code reactivate [options] [businessIdOrSlug] \n\nReactivate an archived checkout promo code\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore promo-code reactivate [options] [businessIdOrSlug] \n\nReactivate an archived checkout promo code\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.promo-code.update", "name": "farthershore promo-code update", "kind": "cli", "collection": "cli", "page": "generated/cli/promo-code", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore promo-code update [options] [businessIdOrSlug] \n\nUpdate an API-managed checkout promo code\n\nOptions:\n --code Replacement customer-entered promo code.\n --kind percent_off, amount_off, or free_months.\n --percent Percent discount for percent_off promos.\n --amount-cents Fixed discount in cents for amount_off promos.\n --duration-months Discount duration in months.\n --max-redemptions Set maximum redemption count.\n --clear-max-redemptions Clear the maximum redemption count.\n --active-from Set ISO-8601 activation timestamp.\n --clear-active-from Clear activation timestamp.\n --active-until Set ISO-8601 expiration timestamp.\n --clear-active-until Clear expiration timestamp.\n --plan Limit to a plan id. Repeatable. Omit for all launch\n plans; use --all-plans on update to clear scoped\n plans. (default: [])\n --all-plans Clear plan scoping so the promo applies to all launch\n plans.\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore promo-code update [options] [businessIdOrSlug] \n\nUpdate an API-managed checkout promo code\n\nOptions:\n --code Replacement customer-entered promo code.\n --kind percent_off, amount_off, or free_months.\n --percent Percent discount for percent_off promos.\n --amount-cents Fixed discount in cents for amount_off promos.\n --duration-months Discount duration in months.\n --max-redemptions Set maximum redemption count.\n --clear-max-redemptions Clear the maximum redemption count.\n --active-from Set ISO-8601 activation timestamp.\n --clear-active-from Clear activation timestamp.\n --active-until Set ISO-8601 expiration timestamp.\n --clear-active-until Clear expiration timestamp.\n --plan Limit to a plan id. Repeatable. Omit for all launch\n plans; use --all-plans on update to clear scoped\n plans. (default: [])\n --all-plans Clear plan scoping so the promo applies to all launch\n plans.\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.proposal", "name": "farthershore proposal", "kind": "cli", "collection": "cli", "page": "generated/cli/proposal", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore proposal [options] [command]\n\nOptions:\n -h, --help display help for command\n\nCommands:\n create [options] [businessIdOrSlug] [subscriberId] Propose a governed ChangeSet against a subscriber (agent/builder proposer; a human approves + applies in the portal)\n preview [options] [businessIdOrSlug] [subscriberId] [changeSetId] Simulate + store a preview on a proposed ChangeSet (rides the propose authority)\n list [options] [businessIdOrSlug] [subscriberId] List governed ChangeSets proposed against a subscriber\n get [options] [businessIdOrSlug] [subscriberId] [changeSetId] Read one governed ChangeSet proposed against a subscriber\n help [command] display help for command", "signature": "Usage: farthershore proposal [options] [command]\n\nOptions:\n -h, --help display help for command\n\nCommands:\n create [options] [businessIdOrSlug] [subscriberId] Propose a governed ChangeSet against a subscriber (agent/builder proposer; a human approves + applies in the portal)\n preview [options] [businessIdOrSlug] [subscriberId] [changeSetId] Simulate + store a preview on a proposed ChangeSet (rides the propose authority)\n list [options] [businessIdOrSlug] [subscriberId] List governed ChangeSets proposed against a subscriber\n get [options] [businessIdOrSlug] [subscriberId] [changeSetId] Read one governed ChangeSet proposed against a subscriber\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.proposal.create", "name": "farthershore proposal create", "kind": "cli", "collection": "cli", "page": "generated/cli/proposal", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore proposal create [options] [businessIdOrSlug] \n\nPropose a governed ChangeSet against a subscriber (agent/builder proposer; a\nhuman approves + applies in the portal)\n\nOptions:\n --intent Human-readable description of the proposed change.\n --operations JSON array of governed operations (e.g.\n update_role_permissions).\n --env Environment name/id to scope the proposal to.\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n --dry-run Preview the change without applying it.\n -h, --help display help for command", "signature": "Usage: farthershore proposal create [options] [businessIdOrSlug] \n\nPropose a governed ChangeSet against a subscriber (agent/builder proposer; a\nhuman approves + applies in the portal)\n\nOptions:\n --intent Human-readable description of the proposed change.\n --operations JSON array of governed operations (e.g.\n update_role_permissions).\n --env Environment name/id to scope the proposal to.\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n --dry-run Preview the change without applying it.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.proposal.get", "name": "farthershore proposal get", "kind": "cli", "collection": "cli", "page": "generated/cli/proposal", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore proposal get [options] [businessIdOrSlug] \n\nRead one governed ChangeSet proposed against a subscriber\n\nOptions:\n --env Environment name/id to scope the proposal to.\n -h, --help display help for command", "signature": "Usage: farthershore proposal get [options] [businessIdOrSlug] \n\nRead one governed ChangeSet proposed against a subscriber\n\nOptions:\n --env Environment name/id to scope the proposal to.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.proposal.list", "name": "farthershore proposal list", "kind": "cli", "collection": "cli", "page": "generated/cli/proposal", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore proposal list [options] [businessIdOrSlug] \n\nList governed ChangeSets proposed against a subscriber\n\nOptions:\n --status Filter by status (e.g. draft, approval_required).\n --env Environment name/id to scope the proposal to.\n -h, --help display help for command", "signature": "Usage: farthershore proposal list [options] [businessIdOrSlug] \n\nList governed ChangeSets proposed against a subscriber\n\nOptions:\n --status Filter by status (e.g. draft, approval_required).\n --env Environment name/id to scope the proposal to.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.proposal.preview", "name": "farthershore proposal preview", "kind": "cli", "collection": "cli", "page": "generated/cli/proposal", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore proposal preview [options] [businessIdOrSlug] \n\nSimulate + store a preview on a proposed ChangeSet (rides the propose authority)\n\nOptions:\n --env Environment name/id to scope the proposal to.\n -h, --help display help for command", "signature": "Usage: farthershore proposal preview [options] [businessIdOrSlug] \n\nSimulate + store a preview on a proposed ChangeSet (rides the propose authority)\n\nOptions:\n --env Environment name/id to scope the proposal to.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.resource-count", "name": "farthershore resource-count", "kind": "cli", "collection": "cli", "page": "generated/cli/resource-count", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore resource-count [options] [command]\n\nReport subscription resource counts\n\nOptions:\n -h, --help display help for command\n\nCommands:\n report [options] [businessIdOrName] [resource] Report a subscription resource count\n help [command] display help for command", "signature": "Usage: farthershore resource-count [options] [command]\n\nReport subscription resource counts\n\nOptions:\n -h, --help display help for command\n\nCommands:\n report [options] [businessIdOrName] [resource] Report a subscription resource count\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.resource-count.report", "name": "farthershore resource-count report", "kind": "cli", "collection": "cli", "page": "generated/cli/resource-count", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore resource-count report [options] [businessIdOrName] \n\nReport a subscription resource count\n\nOptions:\n --subscription \n --count \n --environment \n -h, --help display help for command", "signature": "Usage: farthershore resource-count report [options] [businessIdOrName] \n\nReport a subscription resource count\n\nOptions:\n --subscription \n --count \n --environment \n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.service-account", "name": "farthershore service-account", "kind": "cli", "collection": "cli", "page": "generated/cli/service-account", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore service-account [options] [command]\n\nManage subscriber-owned service accounts using an ephemeral portal consumer\nsession\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] List managed service accounts and pending changes\n create [options] Create or request approval for a managed service account\n update [options] Replace a service account's grants or request approval for the change\n approvals [options] List pending managed service-account approval requests\n approve [options] Approve a service-account request, optionally trimming its grants\n deny [options] Deny a managed service-account approval request\n rotate [options] Rotate a service account and reveal its replacement key once\n revoke [options] Permanently revoke a service account and all active keys\n help [command] display help for command", "signature": "Usage: farthershore service-account [options] [command]\n\nManage subscriber-owned service accounts using an ephemeral portal consumer\nsession\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] List managed service accounts and pending changes\n create [options] Create or request approval for a managed service account\n update [options] Replace a service account's grants or request approval for the change\n approvals [options] List pending managed service-account approval requests\n approve [options] Approve a service-account request, optionally trimming its grants\n deny [options] Deny a managed service-account approval request\n rotate [options] Rotate a service account and reveal its replacement key once\n revoke [options] Permanently revoke a service account and all active keys\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.service-account.approvals", "name": "farthershore service-account approvals", "kind": "cli", "collection": "cli", "page": "generated/cli/service-account", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore service-account approvals [options] \n\nList pending managed service-account approval requests\n\nOptions:\n --limit Maximum rows (1-100; default 100)\n --offset Rows to skip (default 0)\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command", "signature": "Usage: farthershore service-account approvals [options] \n\nList pending managed service-account approval requests\n\nOptions:\n --limit Maximum rows (1-100; default 100)\n --offset Rows to skip (default 0)\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.service-account.approve", "name": "farthershore service-account approve", "kind": "cli", "collection": "cli", "page": "generated/cli/service-account", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore service-account approve [options] \n\nApprove a service-account request, optionally trimming its grants\n\nOptions:\n --permissions Optional approved subset. Omit to approve\n the complete request.\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command", "signature": "Usage: farthershore service-account approve [options] \n\nApprove a service-account request, optionally trimming its grants\n\nOptions:\n --permissions Optional approved subset. Omit to approve\n the complete request.\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.service-account.create", "name": "farthershore service-account create", "kind": "cli", "collection": "cli", "page": "generated/cli/service-account", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore service-account create [options] \n\nCreate or request approval for a managed service account\n\nOptions:\n --permissions Exact permission set, for example\n [\"route:read\"].\n --scopes Optional exact scope strings as a JSON\n array.\n --idempotency-key Stable replay key. Reuse the same value when\n retrying this provisioning request.\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command", "signature": "Usage: farthershore service-account create [options] \n\nCreate or request approval for a managed service account\n\nOptions:\n --permissions Exact permission set, for example\n [\"route:read\"].\n --scopes Optional exact scope strings as a JSON\n array.\n --idempotency-key Stable replay key. Reuse the same value when\n retrying this provisioning request.\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.service-account.deny", "name": "farthershore service-account deny", "kind": "cli", "collection": "cli", "page": "generated/cli/service-account", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore service-account deny [options] \n\nDeny a managed service-account approval request\n\nOptions:\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command", "signature": "Usage: farthershore service-account deny [options] \n\nDeny a managed service-account approval request\n\nOptions:\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.service-account.list", "name": "farthershore service-account list", "kind": "cli", "collection": "cli", "page": "generated/cli/service-account", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore service-account list [options] \n\nList managed service accounts and pending changes\n\nOptions:\n --limit Maximum rows (1-100; default 100)\n --offset Rows to skip (default 0)\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command", "signature": "Usage: farthershore service-account list [options] \n\nList managed service accounts and pending changes\n\nOptions:\n --limit Maximum rows (1-100; default 100)\n --offset Rows to skip (default 0)\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.service-account.revoke", "name": "farthershore service-account revoke", "kind": "cli", "collection": "cli", "page": "generated/cli/service-account", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore service-account revoke [options] \n\nPermanently revoke a service account and all active keys\n\nOptions:\n --yes Confirm the destructive revocation\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command", "signature": "Usage: farthershore service-account revoke [options] \n\nPermanently revoke a service account and all active keys\n\nOptions:\n --yes Confirm the destructive revocation\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.service-account.rotate", "name": "farthershore service-account rotate", "kind": "cli", "collection": "cli", "page": "generated/cli/service-account", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore service-account rotate [options] \n\nRotate a service account and reveal its replacement key once\n\nOptions:\n --idempotency-key Required live-attempt key. Reuse the exact\n value on retry.\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command", "signature": "Usage: farthershore service-account rotate [options] \n\nRotate a service account and reveal its replacement key once\n\nOptions:\n --idempotency-key Required live-attempt key. Reuse the exact\n value on retry.\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.service-account.update", "name": "farthershore service-account update", "kind": "cli", "collection": "cli", "page": "generated/cli/service-account", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore service-account update [options] \n\nReplace a service account's grants or request approval for the change\n\nOptions:\n --permissions Exact replacement permission set.\n --idempotency-key Stable replay key. Reuse the same value when\n retrying this provisioning request.\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command", "signature": "Usage: farthershore service-account update [options] \n\nReplace a service account's grants or request approval for the change\n\nOptions:\n --permissions Exact replacement permission set.\n --idempotency-key Stable replay key. Reuse the same value when\n retrying this provisioning request.\n --environment-id Portal environment UUID (or\n FARTHERSHORE_ENVIRONMENT_ID).\n --subscriber-organization Subscriber organization UUID (or\n FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.skills", "name": "farthershore skills", "kind": "cli", "collection": "cli", "page": "generated/cli/skills", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore skills [options] [command]\n\nManage the platform-verified Farther Shore agent skills\n\nOptions:\n -h, --help display help for command\n\nCommands:\n install Install the platform-pinned, SHA-512-verified skills release\n help [command] display help for command", "signature": "Usage: farthershore skills [options] [command]\n\nManage the platform-verified Farther Shore agent skills\n\nOptions:\n -h, --help display help for command\n\nCommands:\n install Install the platform-pinned, SHA-512-verified skills release\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.skills.install", "name": "farthershore skills install", "kind": "cli", "collection": "cli", "page": "generated/cli/skills", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore skills install [options]\n\nInstall the platform-pinned, SHA-512-verified skills release\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore skills install [options]\n\nInstall the platform-pinned, SHA-512-verified skills release\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.stripe", "name": "farthershore stripe", "kind": "cli", "collection": "cli", "page": "generated/cli/stripe", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore stripe [options] [command]\n\nRead a business's Stripe connection and remove a per-business override\n(connecting is browser-only)\n\nOptions:\n -h, --help display help for command\n\nCommands:\n status [businessIdOrName] Show the Stripe connection a business bills through (business override or org default)\n disconnect [options] [businessIdOrName] Remove a business's per-business Stripe override so it bills through the org default again\n help [command] display help for command", "signature": "Usage: farthershore stripe [options] [command]\n\nRead a business's Stripe connection and remove a per-business override\n(connecting is browser-only)\n\nOptions:\n -h, --help display help for command\n\nCommands:\n status [businessIdOrName] Show the Stripe connection a business bills through (business override or org default)\n disconnect [options] [businessIdOrName] Remove a business's per-business Stripe override so it bills through the org default again\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.stripe.disconnect", "name": "farthershore stripe disconnect", "kind": "cli", "collection": "cli", "page": "generated/cli/stripe", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore stripe disconnect [options] [businessIdOrName]\n\nRemove a business's per-business Stripe override so it bills through the org\ndefault again\n\nOptions:\n --delete-account Also delete the platform-created Express account at Stripe\n (only when it was created for this business).\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command", "signature": "Usage: farthershore stripe disconnect [options] [businessIdOrName]\n\nRemove a business's per-business Stripe override so it bills through the org\ndefault again\n\nOptions:\n --delete-account Also delete the platform-created Express account at Stripe\n (only when it was created for this business).\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.stripe.status", "name": "farthershore stripe status", "kind": "cli", "collection": "cli", "page": "generated/cli/stripe", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore stripe status [options] [businessIdOrName]\n\nShow the Stripe connection a business bills through (business override or org\ndefault)\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore stripe status [options] [businessIdOrName]\n\nShow the Stripe connection a business bills through (business override or org\ndefault)\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.tax-settings", "name": "farthershore tax-settings", "kind": "cli", "collection": "cli", "page": "generated/cli/tax-settings", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore tax-settings [options] [command]\n\nRead and update Stripe Tax settings for a business\n\nOptions:\n -h, --help display help for command\n\nCommands:\n show [businessIdOrName] Show a business's Stripe Tax settings\n update [options] [businessIdOrName] Update a business's Stripe Tax settings\n help [command] display help for command", "signature": "Usage: farthershore tax-settings [options] [command]\n\nRead and update Stripe Tax settings for a business\n\nOptions:\n -h, --help display help for command\n\nCommands:\n show [businessIdOrName] Show a business's Stripe Tax settings\n update [options] [businessIdOrName] Update a business's Stripe Tax settings\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.tax-settings.show", "name": "farthershore tax-settings show", "kind": "cli", "collection": "cli", "page": "generated/cli/tax-settings", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore tax-settings show [options] [businessIdOrName]\n\nShow a business's Stripe Tax settings\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore tax-settings show [options] [businessIdOrName]\n\nShow a business's Stripe Tax settings\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.tax-settings.update", "name": "farthershore tax-settings update", "kind": "cli", "collection": "cli", "page": "generated/cli/tax-settings", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore tax-settings update [options] [businessIdOrName]\n\nUpdate a business's Stripe Tax settings\n\nOptions:\n --body Closed request body as a JSON object\n -h, --help display help for command", "signature": "Usage: farthershore tax-settings update [options] [businessIdOrName]\n\nUpdate a business's Stripe Tax settings\n\nOptions:\n --body Closed request body as a JSON object\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.token", "name": "farthershore token", "kind": "cli", "collection": "cli", "page": "generated/cli/token", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore token [options] [command]\n\nManage organization-owned MakerTokens (signed-in user CLI sessions only)\n\nOptions:\n -h, --help display help for command\n\nCommands:\n permission-catalog [options] List the exact permissions a human may\n delegate to an org MakerToken\n list [options] List organization-owned MakerTokens\n create [options] Create or request approval for an\n organization-owned MakerToken\n update [options] Replace an org MakerToken's grants or request\n approval for the change\n approvals [options] List pending org MakerToken approval requests\n approve [options] Approve an org MakerToken request, optionally\n trimming its grants\n deny [options] Deny an org MakerToken approval request\n rotate [options] Rotate an org MakerToken and reveal its\n replacement once\n revoke [options] Permanently revoke an org MakerToken\n help [command] display help for command", "signature": "Usage: farthershore token [options] [command]\n\nManage organization-owned MakerTokens (signed-in user CLI sessions only)\n\nOptions:\n -h, --help display help for command\n\nCommands:\n permission-catalog [options] List the exact permissions a human may\n delegate to an org MakerToken\n list [options] List organization-owned MakerTokens\n create [options] Create or request approval for an\n organization-owned MakerToken\n update [options] Replace an org MakerToken's grants or request\n approval for the change\n approvals [options] List pending org MakerToken approval requests\n approve [options] Approve an org MakerToken request, optionally\n trimming its grants\n deny [options] Deny an org MakerToken approval request\n rotate [options] Rotate an org MakerToken and reveal its\n replacement once\n revoke [options] Permanently revoke an org MakerToken\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.token.approvals", "name": "farthershore token approvals", "kind": "cli", "collection": "cli", "page": "generated/cli/token", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore token approvals [options]\n\nList pending org MakerToken approval requests\n\nOptions:\n --org Administer an organization-owned MakerToken (requires a signed-in\n user CLI session).\n -h, --help display help for command", "signature": "Usage: farthershore token approvals [options]\n\nList pending org MakerToken approval requests\n\nOptions:\n --org Administer an organization-owned MakerToken (requires a signed-in\n user CLI session).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.token.approve", "name": "farthershore token approve", "kind": "cli", "collection": "cli", "page": "generated/cli/token", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore token approve [options] \n\nApprove an org MakerToken request, optionally trimming its grants\n\nOptions:\n --org Administer an organization-owned MakerToken (requires\n a signed-in user CLI session).\n --permissions Exact platform permission set as JSON, for example\n [\"business:read\"].\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore token approve [options] \n\nApprove an org MakerToken request, optionally trimming its grants\n\nOptions:\n --org Administer an organization-owned MakerToken (requires\n a signed-in user CLI session).\n --permissions Exact platform permission set as JSON, for example\n [\"business:read\"].\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.token.create", "name": "farthershore token create", "kind": "cli", "collection": "cli", "page": "generated/cli/token", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore token create [options] \n\nCreate or request approval for an organization-owned MakerToken\n\nOptions:\n --org Administer an organization-owned MakerToken (requires\n a signed-in user CLI session).\n --permissions Exact platform permission set as JSON, for example\n [\"business:read\"].\n --idempotency-key Stable replay key. Reuse the same value when retrying\n this provisioning request.\n --businesses Comma-separated business ids. Omit to authorize all\n current and future businesses.\n -h, --help display help for command", "signature": "Usage: farthershore token create [options] \n\nCreate or request approval for an organization-owned MakerToken\n\nOptions:\n --org Administer an organization-owned MakerToken (requires\n a signed-in user CLI session).\n --permissions Exact platform permission set as JSON, for example\n [\"business:read\"].\n --idempotency-key Stable replay key. Reuse the same value when retrying\n this provisioning request.\n --businesses Comma-separated business ids. Omit to authorize all\n current and future businesses.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.token.deny", "name": "farthershore token deny", "kind": "cli", "collection": "cli", "page": "generated/cli/token", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore token deny [options] \n\nDeny an org MakerToken approval request\n\nOptions:\n --org Administer an organization-owned MakerToken (requires a signed-in\n user CLI session).\n -h, --help display help for command", "signature": "Usage: farthershore token deny [options] \n\nDeny an org MakerToken approval request\n\nOptions:\n --org Administer an organization-owned MakerToken (requires a signed-in\n user CLI session).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.token.list", "name": "farthershore token list", "kind": "cli", "collection": "cli", "page": "generated/cli/token", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore token list [options]\n\nList organization-owned MakerTokens\n\nOptions:\n --org Administer an organization-owned MakerToken (requires a\n signed-in user CLI session).\n --limit Page size (1-100; default 20).\n --offset Row offset for paging (default 0).\n -h, --help display help for command", "signature": "Usage: farthershore token list [options]\n\nList organization-owned MakerTokens\n\nOptions:\n --org Administer an organization-owned MakerToken (requires a\n signed-in user CLI session).\n --limit Page size (1-100; default 20).\n --offset Row offset for paging (default 0).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.token.permission-catalog", "name": "farthershore token permission-catalog", "kind": "cli", "collection": "cli", "page": "generated/cli/token", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore token permission-catalog [options]\n\nList the exact permissions a human may delegate to an org MakerToken\n\nOptions:\n --org Administer an organization-owned MakerToken (requires a signed-in\n user CLI session).\n -h, --help display help for command", "signature": "Usage: farthershore token permission-catalog [options]\n\nList the exact permissions a human may delegate to an org MakerToken\n\nOptions:\n --org Administer an organization-owned MakerToken (requires a signed-in\n user CLI session).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.token.revoke", "name": "farthershore token revoke", "kind": "cli", "collection": "cli", "page": "generated/cli/token", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore token revoke [options] \n\nPermanently revoke an org MakerToken\n\nOptions:\n --org Administer an organization-owned MakerToken (requires a signed-in\n user CLI session).\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command", "signature": "Usage: farthershore token revoke [options] \n\nPermanently revoke an org MakerToken\n\nOptions:\n --org Administer an organization-owned MakerToken (requires a signed-in\n user CLI session).\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.token.rotate", "name": "farthershore token rotate", "kind": "cli", "collection": "cli", "page": "generated/cli/token", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore token rotate [options] \n\nRotate an org MakerToken and reveal its replacement once\n\nOptions:\n --org Administer an organization-owned MakerToken (requires\n a signed-in user CLI session).\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore token rotate [options] \n\nRotate an org MakerToken and reveal its replacement once\n\nOptions:\n --org Administer an organization-owned MakerToken (requires\n a signed-in user CLI session).\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.token.update", "name": "farthershore token update", "kind": "cli", "collection": "cli", "page": "generated/cli/token", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore token update [options] \n\nReplace an org MakerToken's grants or request approval for the change\n\nOptions:\n --org Administer an organization-owned MakerToken (requires\n a signed-in user CLI session).\n --permissions Exact platform permission set as JSON, for example\n [\"business:read\"].\n --idempotency-key Stable replay key. Reuse the same value when retrying\n this provisioning request.\n -h, --help display help for command", "signature": "Usage: farthershore token update [options] \n\nReplace an org MakerToken's grants or request approval for the change\n\nOptions:\n --org Administer an organization-owned MakerToken (requires\n a signed-in user CLI session).\n --permissions Exact platform permission set as JSON, for example\n [\"business:read\"].\n --idempotency-key Stable replay key. Reuse the same value when retrying\n this provisioning request.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.unlink", "name": "farthershore unlink", "kind": "cli", "collection": "cli", "page": "generated/cli/unlink", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore unlink [options]\n\nStop targeting a business from this directory.\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore unlink [options]\n\nStop targeting a business from this directory.\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.usage", "name": "farthershore usage", "kind": "cli", "collection": "cli", "page": "generated/cli/usage", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore usage [options] [command]\n\nUsage observability for a business\n\nOptions:\n -h, --help display help for command\n\nCommands:\n summary [options] [businessIdOrName] Show usage summary for the last 30 days\n help [command] display help for command", "signature": "Usage: farthershore usage [options] [command]\n\nUsage observability for a business\n\nOptions:\n -h, --help display help for command\n\nCommands:\n summary [options] [businessIdOrName] Show usage summary for the last 30 days\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.usage.summary", "name": "farthershore usage summary", "kind": "cli", "collection": "cli", "page": "generated/cli/usage", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore usage summary [options] [businessIdOrName]\n\nShow usage summary for the last 30 days\n\nOptions:\n --env Narrow the summary to one environment (name or id). Omit\n for the product-wide rollup.\n -h, --help display help for command\n\nScope:\n Without --env this rolls up usage across EVERY environment, so a preview\n environment's traffic is mixed into the totals. Pass --env to see\n only that environment's requests and per-member slice.", "signature": "Usage: farthershore usage summary [options] [businessIdOrName]\n\nShow usage summary for the last 30 days\n\nOptions:\n --env Narrow the summary to one environment (name or id). Omit\n for the product-wide rollup.\n -h, --help display help for command\n\nScope:\n Without --env this rolls up usage across EVERY environment, so a preview\n environment's traffic is mixed into the totals. Pass --env to see\n only that environment's requests and per-member slice.\n\n", "guide": "cli/overview" }, { "id": "cli.validate", "name": "farthershore validate", "kind": "cli", "collection": "cli", "page": "generated/cli/validate", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore validate [options]\n\nValidate the business/ program the way the PR check does, before pushing\n\nOptions:\n --entry Business-as-code folder or file to validate (default:\n business/)\n --business Business id or name — runs the server dry-run\n validate for the full verdict (diff + economic\n change)\n --env Environment for the server validate\n --local-only Build + determinism only; skip the server dry-run\n validate\n -h, --help display help for command\n\nExamples:\n farthershore validate # local build + determinism\n farthershore validate --business weather-api # + server verdict\n farthershore validate --local-only --format json", "signature": "Usage: farthershore validate [options]\n\nValidate the business/ program the way the PR check does, before pushing\n\nOptions:\n --entry Business-as-code folder or file to validate (default:\n business/)\n --business Business id or name — runs the server dry-run\n validate for the full verdict (diff + economic\n change)\n --env Environment for the server validate\n --local-only Build + determinism only; skip the server dry-run\n validate\n -h, --help display help for command\n\nExamples:\n farthershore validate # local build + determinism\n farthershore validate --business weather-api # + server verdict\n farthershore validate --local-only --format json\n\n", "guide": "cli/overview" }, { "id": "cli.variables", "name": "farthershore variables", "kind": "cli", "collection": "cli", "page": "generated/cli/variables", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore variables [options] [command]\n\nManage FS_PUBLIC_ bundle variables and write-only secrets (the name is the\nclass: FS_PUBLIC_ = public, everything else = secret)\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrSlug] List variables: FS_PUBLIC_* values, secret metadata only\n set [options] [businessIdOrSlug] [name] Create a variable from stdin (secret unless named FS_PUBLIC_*)\n rotate [options] [businessIdOrSlug] [name] Rotate a variable from stdin (the name, and so the class, is unchanged)\n revoke [options] [businessIdOrSlug] [name] Revoke runtime access to a secret. Requires --yes.\n rm [options] [businessIdOrSlug] [name] Destroy a revoked secret in Main or preview. Requires --yes.\n status [businessIdOrSlug] [operationId] Read a durable secret mutation operation\n help [command] display help for command", "signature": "Usage: farthershore variables [options] [command]\n\nManage FS_PUBLIC_ bundle variables and write-only secrets (the name is the\nclass: FS_PUBLIC_ = public, everything else = secret)\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrSlug] List variables: FS_PUBLIC_* values, secret metadata only\n set [options] [businessIdOrSlug] [name] Create a variable from stdin (secret unless named FS_PUBLIC_*)\n rotate [options] [businessIdOrSlug] [name] Rotate a variable from stdin (the name, and so the class, is unchanged)\n revoke [options] [businessIdOrSlug] [name] Revoke runtime access to a secret. Requires --yes.\n rm [options] [businessIdOrSlug] [name] Destroy a revoked secret in Main or preview. Requires --yes.\n status [businessIdOrSlug] [operationId] Read a durable secret mutation operation\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.variables.list", "name": "farthershore variables list", "kind": "cli", "collection": "cli", "page": "generated/cli/variables", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore variables list [options] [businessIdOrSlug]\n\nList variables: FS_PUBLIC_* values, secret metadata only\n\nOptions:\n --env Preview environment slug or id (omit for Main).\n -h, --help display help for command", "signature": "Usage: farthershore variables list [options] [businessIdOrSlug]\n\nList variables: FS_PUBLIC_* values, secret metadata only\n\nOptions:\n --env Preview environment slug or id (omit for Main).\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.variables.revoke", "name": "farthershore variables revoke", "kind": "cli", "collection": "cli", "page": "generated/cli/variables", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore variables revoke [options] [businessIdOrSlug] \n\nRevoke runtime access to a secret. Requires --yes.\n\nOptions:\n --env Preview environment slug or id (omit for Main).\n --yes Skip confirmation; required for this destructive\n action\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore variables revoke [options] [businessIdOrSlug] \n\nRevoke runtime access to a secret. Requires --yes.\n\nOptions:\n --env Preview environment slug or id (omit for Main).\n --yes Skip confirmation; required for this destructive\n action\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.variables.rm", "name": "farthershore variables rm", "kind": "cli", "collection": "cli", "page": "generated/cli/variables", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore variables rm [options] [businessIdOrSlug] \n\nDestroy a revoked secret in Main or preview. Requires --yes.\n\nOptions:\n --env Preview environment slug or id (omit for Main).\n --yes Skip confirmation; required for this destructive\n action\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore variables rm [options] [businessIdOrSlug] \n\nDestroy a revoked secret in Main or preview. Requires --yes.\n\nOptions:\n --env Preview environment slug or id (omit for Main).\n --yes Skip confirmation; required for this destructive\n action\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.variables.rotate", "name": "farthershore variables rotate", "kind": "cli", "collection": "cli", "page": "generated/cli/variables", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore variables rotate [options] [businessIdOrSlug] \n\nRotate a variable from stdin (the name, and so the class, is unchanged)\n\nOptions:\n --env Preview environment slug or id (omit for Main).\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n\nExample:\n printf %s \"$VALUE\" | farthershore variables rotate my-biz POSTHOG_TOKEN", "signature": "Usage: farthershore variables rotate [options] [businessIdOrSlug] \n\nRotate a variable from stdin (the name, and so the class, is unchanged)\n\nOptions:\n --env Preview environment slug or id (omit for Main).\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n\nExample:\n printf %s \"$VALUE\" | farthershore variables rotate my-biz POSTHOG_TOKEN\n", "guide": "cli/overview" }, { "id": "cli.variables.set", "name": "farthershore variables set", "kind": "cli", "collection": "cli", "page": "generated/cli/variables", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore variables set [options] [businessIdOrSlug] \n\nCreate a variable from stdin (secret unless named FS_PUBLIC_*)\n\nOptions:\n --env Preview environment slug or id (omit for Main).\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n\nExample:\n printf %s \"$VALUE\" | farthershore variables set my-biz POSTHOG_TOKEN", "signature": "Usage: farthershore variables set [options] [businessIdOrSlug] \n\nCreate a variable from stdin (secret unless named FS_PUBLIC_*)\n\nOptions:\n --env Preview environment slug or id (omit for Main).\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n\nExample:\n printf %s \"$VALUE\" | farthershore variables set my-biz POSTHOG_TOKEN\n", "guide": "cli/overview" }, { "id": "cli.variables.status", "name": "farthershore variables status", "kind": "cli", "collection": "cli", "page": "generated/cli/variables", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore variables status [options] [businessIdOrSlug] \n\nRead a durable secret mutation operation\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore variables status [options] [businessIdOrSlug] \n\nRead a durable secret mutation operation\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.webhook", "name": "farthershore webhook", "kind": "cli", "collection": "cli", "page": "generated/cli/webhook", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore webhook [options] [command]\n\nManage outbound webhook endpoints\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrSlug] List API-managed webhook endpoints\n create [options] [businessIdOrSlug] Create an API-managed webhook endpoint\n update [options] [businessIdOrSlug] [webhookId] Update a webhook endpoint's URL, events, environment or enabled state\n delete [options] [businessIdOrSlug] [webhookId] Delete an API-managed webhook endpoint. Requires --yes.\n test [options] [businessIdOrSlug] [webhookId] Send a signed test event to a webhook endpoint\n trigger [options] [businessIdOrSlug] [webhookId] Send a signed sample of a specific event (e.g. payment.failed) to a webhook endpoint\n listen [options] [businessIdOrSlug] Tunnel platform webhooks to a local receiver and tail deliveries until Ctrl-C\n rotate [options] [businessIdOrSlug] [webhookId] Issue a new signing secret (returned once); the old one keeps verifying for 24h\n event-types [businessIdOrSlug] List the event names a webhook endpoint can subscribe to\n deliveries [options] [businessIdOrSlug] [webhookId] List recent delivery attempts for a webhook endpoint\n help [command] display help for command", "signature": "Usage: farthershore webhook [options] [command]\n\nManage outbound webhook endpoints\n\nOptions:\n -h, --help display help for command\n\nCommands:\n list [options] [businessIdOrSlug] List API-managed webhook endpoints\n create [options] [businessIdOrSlug] Create an API-managed webhook endpoint\n update [options] [businessIdOrSlug] [webhookId] Update a webhook endpoint's URL, events, environment or enabled state\n delete [options] [businessIdOrSlug] [webhookId] Delete an API-managed webhook endpoint. Requires --yes.\n test [options] [businessIdOrSlug] [webhookId] Send a signed test event to a webhook endpoint\n trigger [options] [businessIdOrSlug] [webhookId] Send a signed sample of a specific event (e.g. payment.failed) to a webhook endpoint\n listen [options] [businessIdOrSlug] Tunnel platform webhooks to a local receiver and tail deliveries until Ctrl-C\n rotate [options] [businessIdOrSlug] [webhookId] Issue a new signing secret (returned once); the old one keeps verifying for 24h\n event-types [businessIdOrSlug] List the event names a webhook endpoint can subscribe to\n deliveries [options] [businessIdOrSlug] [webhookId] List recent delivery attempts for a webhook endpoint\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.webhook.create", "name": "farthershore webhook create", "kind": "cli", "collection": "cli", "page": "generated/cli/webhook", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore webhook create [options] [businessIdOrSlug]\n\nCreate an API-managed webhook endpoint\n\nOptions:\n --url HTTPS receiver URL.\n --events Comma-separated event names, e.g.\n subscription.created,payment.failed\n --env Only deliver events from this environment (default:\n every environment).\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore webhook create [options] [businessIdOrSlug]\n\nCreate an API-managed webhook endpoint\n\nOptions:\n --url HTTPS receiver URL.\n --events Comma-separated event names, e.g.\n subscription.created,payment.failed\n --env Only deliver events from this environment (default:\n every environment).\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.webhook.delete", "name": "farthershore webhook delete", "kind": "cli", "collection": "cli", "page": "generated/cli/webhook", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore webhook delete [options] [businessIdOrSlug] \n\nDelete an API-managed webhook endpoint. Requires --yes.\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command", "signature": "Usage: farthershore webhook delete [options] [businessIdOrSlug] \n\nDelete an API-managed webhook endpoint. Requires --yes.\n\nOptions:\n --yes Skip confirmation; required for this destructive action\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.webhook.deliveries", "name": "farthershore webhook deliveries", "kind": "cli", "collection": "cli", "page": "generated/cli/webhook", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore webhook deliveries [options] [businessIdOrSlug] \n\nList recent delivery attempts for a webhook endpoint\n\nOptions:\n --limit Max rows to return.\n -h, --help display help for command", "signature": "Usage: farthershore webhook deliveries [options] [businessIdOrSlug] \n\nList recent delivery attempts for a webhook endpoint\n\nOptions:\n --limit Max rows to return.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.webhook.event-types", "name": "farthershore webhook event-types", "kind": "cli", "collection": "cli", "page": "generated/cli/webhook", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore webhook event-types [options] [businessIdOrSlug]\n\nList the event names a webhook endpoint can subscribe to\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore webhook event-types [options] [businessIdOrSlug]\n\nList the event names a webhook endpoint can subscribe to\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.webhook.list", "name": "farthershore webhook list", "kind": "cli", "collection": "cli", "page": "generated/cli/webhook", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore webhook list [options] [businessIdOrSlug]\n\nList API-managed webhook endpoints\n\nOptions:\n --limit Max rows to return.\n -h, --help display help for command", "signature": "Usage: farthershore webhook list [options] [businessIdOrSlug]\n\nList API-managed webhook endpoints\n\nOptions:\n --limit Max rows to return.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.webhook.listen", "name": "farthershore webhook listen", "kind": "cli", "collection": "cli", "page": "generated/cli/webhook", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore webhook listen [options] [businessIdOrSlug]\n\nTunnel platform webhooks to a local receiver and tail deliveries until Ctrl-C\n\nOptions:\n --forward-to Local receiver URL, e.g.\n http://localhost:3000/webhooks/farthershore\n --events Comma-separated event names to subscribe (default:\n every catalog event)\n --print-secret Print the temporary endpoint's FS_WEBHOOK_SECRET so\n the local receiver can verify signatures\n --trigger Fire a signed sample of this event as soon as the\n tunnel is up\n -h, --help display help for command\n\nRequires cloudflared: bundled via the @farthershore/cloudflared-\noptional dependency, or a `cloudflared` on PATH. Ctrl-C deletes the\ntemporary endpoint; a killed listener leaves a *.trycloudflare.com endpoint\nthat `farthershore webhook delete --yes` removes.\n\nExamples:\n farthershore webhook listen acme --forward-to http://localhost:3000/webhooks --print-secret\n farthershore webhook listen acme --forward-to localhost:3000/webhooks --events payment.failed --trigger payment.failed", "signature": "Usage: farthershore webhook listen [options] [businessIdOrSlug]\n\nTunnel platform webhooks to a local receiver and tail deliveries until Ctrl-C\n\nOptions:\n --forward-to Local receiver URL, e.g.\n http://localhost:3000/webhooks/farthershore\n --events Comma-separated event names to subscribe (default:\n every catalog event)\n --print-secret Print the temporary endpoint's FS_WEBHOOK_SECRET so\n the local receiver can verify signatures\n --trigger Fire a signed sample of this event as soon as the\n tunnel is up\n -h, --help display help for command\n\nRequires cloudflared: bundled via the @farthershore/cloudflared-\noptional dependency, or a `cloudflared` on PATH. Ctrl-C deletes the\ntemporary endpoint; a killed listener leaves a *.trycloudflare.com endpoint\nthat `farthershore webhook delete --yes` removes.\n\nExamples:\n farthershore webhook listen acme --forward-to http://localhost:3000/webhooks --print-secret\n farthershore webhook listen acme --forward-to localhost:3000/webhooks --events payment.failed --trigger payment.failed\n", "guide": "cli/overview" }, { "id": "cli.webhook.rotate", "name": "farthershore webhook rotate", "kind": "cli", "collection": "cli", "page": "generated/cli/webhook", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore webhook rotate [options] [businessIdOrSlug] \n\nIssue a new signing secret (returned once); the old one keeps verifying for 24h\n\nOptions:\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore webhook rotate [options] [businessIdOrSlug] \n\nIssue a new signing secret (returned once); the old one keeps verifying for 24h\n\nOptions:\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.webhook.test", "name": "farthershore webhook test", "kind": "cli", "collection": "cli", "page": "generated/cli/webhook", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore webhook test [options] [businessIdOrSlug] \n\nSend a signed test event to a webhook endpoint\n\nOptions:\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore webhook test [options] [businessIdOrSlug] \n\nSend a signed test event to a webhook endpoint\n\nOptions:\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.webhook.trigger", "name": "farthershore webhook trigger", "kind": "cli", "collection": "cli", "page": "generated/cli/webhook", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore webhook trigger [options] [businessIdOrSlug] \n\nSend a signed sample of a specific event (e.g. payment.failed) to a webhook\nendpoint\n\nOptions:\n --type Envelope type to send: one of subscription.created,\n subscription.updated, subscription.canceled,\n payment.succeeded, payment.failed,\n entitlement.changed, usage.threshold_reached,\n webhook.test. A catalog event is delivered with a\n realistic sample payload.\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command", "signature": "Usage: farthershore webhook trigger [options] [businessIdOrSlug] \n\nSend a signed sample of a specific event (e.g. payment.failed) to a webhook\nendpoint\n\nOptions:\n --type Envelope type to send: one of subscription.created,\n subscription.updated, subscription.canceled,\n payment.succeeded, payment.failed,\n entitlement.changed, usage.threshold_reached,\n webhook.test. A catalog event is delivered with a\n realistic sample payload.\n --idempotency-key Required for this mutation. Generate it once and\n reuse the exact value on retry.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.webhook.update", "name": "farthershore webhook update", "kind": "cli", "collection": "cli", "page": "generated/cli/webhook", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore webhook update [options] [businessIdOrSlug] \n\nUpdate a webhook endpoint's URL, events, environment or enabled state\n\nOptions:\n --url Replacement HTTPS receiver URL.\n --events Comma-separated event names, e.g.\n subscription.created,payment.failed\n --env Only deliver events from this environment.\n --all-envs Clear the environment scope: deliver events from every\n environment again.\n --enable Enable delivery for this endpoint.\n --disable Disable delivery for this endpoint.\n -h, --help display help for command", "signature": "Usage: farthershore webhook update [options] [businessIdOrSlug] \n\nUpdate a webhook endpoint's URL, events, environment or enabled state\n\nOptions:\n --url Replacement HTTPS receiver URL.\n --events Comma-separated event names, e.g.\n subscription.created,payment.failed\n --env Only deliver events from this environment.\n --all-envs Clear the environment scope: deliver events from every\n environment again.\n --enable Enable delivery for this endpoint.\n --disable Disable delivery for this endpoint.\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.workflow-control", "name": "farthershore workflow-control", "kind": "cli", "collection": "cli", "page": "generated/cli/workflow-control", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore workflow-control [options] [command]\n\nPreview replay and config rollback operations\n\nOptions:\n -h, --help display help for command\n\nCommands:\n replay [options] [businessIdOrName] Preview a historical billing replay\n rollback-to-config [businessIdOrName] [commitSha] Preview restoring a business config commit\n help [command] display help for command", "signature": "Usage: farthershore workflow-control [options] [command]\n\nPreview replay and config rollback operations\n\nOptions:\n -h, --help display help for command\n\nCommands:\n replay [options] [businessIdOrName] Preview a historical billing replay\n rollback-to-config [businessIdOrName] [commitSha] Preview restoring a business config commit\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.workflow-control.replay", "name": "farthershore workflow-control replay", "kind": "cli", "collection": "cli", "page": "generated/cli/workflow-control", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore workflow-control replay [options] [businessIdOrName]\n\nPreview a historical billing replay\n\nOptions:\n --period-start \n --period-end \n -h, --help display help for command", "signature": "Usage: farthershore workflow-control replay [options] [businessIdOrName]\n\nPreview a historical billing replay\n\nOptions:\n --period-start \n --period-end \n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.workflow-control.rollback-to-config", "name": "farthershore workflow-control rollback-to-config", "kind": "cli", "collection": "cli", "page": "generated/cli/workflow-control", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore workflow-control rollback-to-config [options] [businessIdOrName] \n\nPreview restoring a business config commit\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore workflow-control rollback-to-config [options] [businessIdOrName] \n\nPreview restoring a business config commit\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.workflows", "name": "farthershore workflows", "kind": "cli", "collection": "cli", "page": "generated/cli/workflows", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore workflows [options] [command]\n\nInspect durable lifecycle workflow executions (list / show)\n\nOptions:\n -h, --help display help for command\n\nCommands:\n ls [options] List workflow executions as a table\n show Show a single workflow execution: header, steps,\n events, convergence panel\n help [command] display help for command", "signature": "Usage: farthershore workflows [options] [command]\n\nInspect durable lifecycle workflow executions (list / show)\n\nOptions:\n -h, --help display help for command\n\nCommands:\n ls [options] List workflow executions as a table\n show Show a single workflow execution: header, steps,\n events, convergence panel\n help [command] display help for command\n", "guide": "cli/overview" }, { "id": "cli.workflows.ls", "name": "farthershore workflows ls", "kind": "cli", "collection": "cli", "page": "generated/cli/workflows", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore workflows ls [options]\n\nList workflow executions as a table\n\nOptions:\n --status Filter by status (one of: RUNNING, COMPLETED, FAILED,\n ROLLED_BACK, STALLED, REQUIRES_HUMAN_INTERVENTION,\n WAITING_FOR_APPROVAL, CANCELLED)\n --type Filter by workflow type (e.g. BusinessApplyWorkflow,\n RollbackWorkflow, StripeSyncWorkflow,\n WebhookDispatchWorkflow)\n --business Filter by businessId\n --limit Maximum number of rows to return (default 50)\n -h, --help display help for command", "signature": "Usage: farthershore workflows ls [options]\n\nList workflow executions as a table\n\nOptions:\n --status Filter by status (one of: RUNNING, COMPLETED, FAILED,\n ROLLED_BACK, STALLED, REQUIRES_HUMAN_INTERVENTION,\n WAITING_FOR_APPROVAL, CANCELLED)\n --type Filter by workflow type (e.g. BusinessApplyWorkflow,\n RollbackWorkflow, StripeSyncWorkflow,\n WebhookDispatchWorkflow)\n --business Filter by businessId\n --limit Maximum number of rows to return (default 50)\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "cli.workflows.show", "name": "farthershore workflows show", "kind": "cli", "collection": "cli", "page": "generated/cli/workflows", "source": "apps/cli/src/index.ts", "description": "Usage: farthershore workflows show [options] \n\nShow a single workflow execution: header, steps, events, convergence panel\n\nOptions:\n -h, --help display help for command", "signature": "Usage: farthershore workflows show [options] \n\nShow a single workflow execution: header, steps, events, convergence panel\n\nOptions:\n -h, --help display help for command\n", "guide": "cli/overview" }, { "id": "deny.admission_bound_exceeded", "name": "admission_bound_exceeded", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 422; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 422\n ],\n \"source\": \"constraint\",\n \"retryAfter\": false,\n \"verifiedAt\": [\n \"engine/pipeline/commercial-admission.ts:382\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.admission_descriptor_no_admissible_tuple", "name": "admission_descriptor_no_admissible_tuple", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 503; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 503\n ],\n \"source\": \"constraint\",\n \"retryAfter\": true,\n \"verifiedAt\": [\n \"engine/pipeline/commercial-admission.ts:257\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.admission_descriptor_unavailable", "name": "admission_descriptor_unavailable", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 503; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 503\n ],\n \"source\": \"constraint\",\n \"retryAfter\": true,\n \"verifiedAt\": [\n \"engine/pipeline/commercial-admission.ts:196\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.commercial_release_unprovable", "name": "commercial_release_unprovable", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 503; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 503\n ],\n \"source\": \"constraint\",\n \"retryAfter\": true,\n \"verifiedAt\": [\n \"engine/pipeline/commercial-admission.ts:165\",\n \"engine/enforcement/batcher.ts:182\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.concurrency_context_unavailable", "name": "concurrency_context_unavailable", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 503; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 503\n ],\n \"source\": \"constraint\",\n \"retryAfter\": true,\n \"verifiedAt\": [\n \"engine/enforcement/constraints/concurrency.ts:291\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.concurrency_coordinator_unavailable", "name": "concurrency_coordinator_unavailable", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 503; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 503\n ],\n \"source\": \"constraint\",\n \"retryAfter\": true,\n \"verifiedAt\": [\n \"engine/enforcement/constraints/concurrency.ts:305\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.concurrency_limit_exceeded", "name": "concurrency_limit_exceeded", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 429; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 429\n ],\n \"source\": \"constraint\",\n \"retryAfter\": true,\n \"verifiedAt\": [\n \"engine/enforcement/constraints/concurrency.ts\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.credential_env_reset", "name": "credential_env_reset", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 401; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 401\n ],\n \"source\": \"runtime-inline\",\n \"retryAfter\": false,\n \"verifiedAt\": [\n \"engine/pipeline/resolve-tenant.ts\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.credential_resolver_miss_rate_limited", "name": "credential_resolver_miss_rate_limited", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 429; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 429\n ],\n \"source\": \"gateway-error\",\n \"retryAfter\": true,\n \"verifiedAt\": [\n \"engine/errors.ts:89\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.credential_revoked", "name": "credential_revoked", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 401; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 401\n ],\n \"source\": \"runtime-inline\",\n \"retryAfter\": false,\n \"verifiedAt\": [\n \"engine/pipeline/resolve-tenant.ts\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.credential_rotated", "name": "credential_rotated", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 401; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 401\n ],\n \"source\": \"runtime-inline\",\n \"retryAfter\": false,\n \"verifiedAt\": [\n \"engine/pipeline/resolve-tenant.ts\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.credit_exhausted", "name": "credit_exhausted", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 402; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 402\n ],\n \"source\": \"batcher-enum\",\n \"retryAfter\": true,\n \"verifiedAt\": [\n \"engine/enforcement/batcher.ts\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.credit_state_unavailable", "name": "credit_state_unavailable", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 503; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 503\n ],\n \"source\": \"batcher-enum\",\n \"retryAfter\": true,\n \"verifiedAt\": [\n \"engine/enforcement/batcher.ts\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.enforcement_denied", "name": "enforcement_denied", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 402; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 402\n ],\n \"source\": \"batcher-enum\",\n \"retryAfter\": true,\n \"verifiedAt\": [\n \"engine/enforcement/batcher.ts:335\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.enforcement_dependency_unavailable", "name": "enforcement_dependency_unavailable", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 503; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 503\n ],\n \"source\": \"runtime-inline\",\n \"retryAfter\": false,\n \"verifiedAt\": [\n \"engine/enforcement/runtime.ts:427\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.enforcement_error", "name": "enforcement_error", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 500; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 500\n ],\n \"source\": \"runtime-inline\",\n \"retryAfter\": false,\n \"verifiedAt\": [\n \"engine/enforcement/runtime.ts:342\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.geo_blocked", "name": "geo_blocked", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 403; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 403\n ],\n \"source\": \"constraint\",\n \"retryAfter\": false,\n \"verifiedAt\": [\n \"engine/enforcement/constraints/geo-restriction.ts:51\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.geo_context_unavailable", "name": "geo_context_unavailable", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 503; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 503\n ],\n \"source\": \"constraint\",\n \"retryAfter\": true,\n \"verifiedAt\": [\n \"engine/enforcement/constraints/geo-restriction.ts:44\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.geo_not_allowed", "name": "geo_not_allowed", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 403; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 403\n ],\n \"source\": \"constraint\",\n \"retryAfter\": false,\n \"verifiedAt\": [\n \"engine/enforcement/constraints/geo-restriction.ts:58\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.invalid_admission_knob", "name": "invalid_admission_knob", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 422; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 422\n ],\n \"source\": \"constraint\",\n \"retryAfter\": false,\n \"verifiedAt\": [\n \"engine/pipeline/commercial-admission.ts:392\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.invalid_entitlement_shape", "name": "invalid_entitlement_shape", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 503; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 503\n ],\n \"source\": \"runtime-inline\",\n \"retryAfter\": true,\n \"verifiedAt\": [\n \"engine/enforcement/runtime.ts:144\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.key_expired", "name": "key_expired", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 401; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 401\n ],\n \"source\": \"constraint\",\n \"retryAfter\": false,\n \"verifiedAt\": [\n \"engine/enforcement/constraints/credential-validity.ts:33\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.limit_allocator_unavailable", "name": "limit_allocator_unavailable", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 503; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 503\n ],\n \"source\": \"batcher-enum\",\n \"retryAfter\": true,\n \"verifiedAt\": [\n \"engine/enforcement/runtime.ts:471\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.limit_exceeded", "name": "limit_exceeded", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 402; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 402\n ],\n \"source\": \"batcher-enum\",\n \"retryAfter\": true,\n \"verifiedAt\": [\n \"engine/enforcement/batcher.ts:326\",\n \"engine/enforcement/constraints/quota.ts:69\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.permission_denied", "name": "permission_denied", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 403; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 403\n ],\n \"source\": \"constraint\",\n \"retryAfter\": false,\n \"verifiedAt\": [\n \"engine/enforcement/constraints/permission.ts:63\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.permission_unresolved", "name": "permission_unresolved", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 403; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 403\n ],\n \"source\": \"constraint\",\n \"retryAfter\": false,\n \"verifiedAt\": [\n \"engine/enforcement/constraints/permission.ts\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.post_stream_overspend", "name": "post_stream_overspend", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 402; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 402\n ],\n \"source\": \"constraint\",\n \"retryAfter\": true,\n \"verifiedAt\": [\n \"engine/enforcement/constraints/lifecycle-block.ts\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.provider_throttled", "name": "provider_throttled", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 503; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 503\n ],\n \"source\": \"gateway-error\",\n \"retryAfter\": true,\n \"verifiedAt\": [\n \"engine/pipeline/provider-adapter.ts\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.rate_limited", "name": "rate_limited", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 429; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 429\n ],\n \"source\": \"batcher-enum\",\n \"retryAfter\": true,\n \"verifiedAt\": [\n \"engine/enforcement/batcher.ts:328\",\n \"engine/enforcement/constraints/rate-limit.ts:74\",\n \"engine/pipeline/rate-limit.ts:83\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.request_too_large", "name": "request_too_large", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 413; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 413\n ],\n \"source\": \"constraint\",\n \"retryAfter\": false,\n \"verifiedAt\": [\n \"engine/enforcement/constraints/capacity.ts\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.resolver_rate_limited", "name": "resolver_rate_limited", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 503; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 503\n ],\n \"source\": \"gateway-error\",\n \"retryAfter\": true,\n \"verifiedAt\": [\n \"engine/errors.ts:55\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.resolver_unavailable", "name": "resolver_unavailable", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 503; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 503\n ],\n \"source\": \"gateway-error\",\n \"retryAfter\": true,\n \"verifiedAt\": [\n \"engine/errors.ts:73\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.resource_count_limit_exceeded", "name": "resource_count_limit_exceeded", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 402; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 402\n ],\n \"source\": \"gateway-error\",\n \"retryAfter\": false,\n \"verifiedAt\": [\n \"apps/core:routes/internal/gateway-resources.ts:144\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.route_not_enabled", "name": "route_not_enabled", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 403; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 403\n ],\n \"source\": \"runtime-inline\",\n \"retryAfter\": false,\n \"verifiedAt\": [\n \"engine/pipeline/pre-vec-costs.ts\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "deny.unsupported_constraint_schema", "name": "unsupported_constraint_schema", "kind": "schema", "collection": "gateway", "page": "reference/response-codes", "source": "packages/contracts/src/gateway-deny.ts", "description": "Gateway denial at HTTP 503; inspect the response code and any Retry-After before choosing recovery.", "signature": "{\n \"statuses\": [\n 503\n ],\n \"source\": \"runtime-inline\",\n \"retryAfter\": false,\n \"verifiedAt\": [\n \"engine/enforcement/runtime.ts:154\"\n ]\n}\n", "guide": "cookbook/diagnose-denied-request" }, { "id": "event.entitlement.changed", "name": "entitlement.changed", "kind": "schema", "collection": "operations", "page": "generated/operations/events", "source": "packages/contracts/src/events/catalog.ts", "description": "A compiled entitlement/plan was (re)published.", "guide": "define/webhooks" }, { "id": "event.payment.failed", "name": "payment.failed", "kind": "schema", "collection": "operations", "page": "generated/operations/events", "source": "packages/contracts/src/events/catalog.ts", "description": "A Stripe payment failed for a subscription.", "guide": "define/webhooks" }, { "id": "event.payment.succeeded", "name": "payment.succeeded", "kind": "schema", "collection": "operations", "page": "generated/operations/events", "source": "packages/contracts/src/events/catalog.ts", "description": "A Stripe payment succeeded for a subscription.", "guide": "define/webhooks" }, { "id": "event.subscription.canceled", "name": "subscription.canceled", "kind": "schema", "collection": "operations", "page": "generated/operations/events", "source": "packages/contracts/src/events/catalog.ts", "description": "A subscriber subscription was canceled.", "guide": "define/webhooks" }, { "id": "event.subscription.created", "name": "subscription.created", "kind": "schema", "collection": "operations", "page": "generated/operations/events", "source": "packages/contracts/src/events/catalog.ts", "description": "A subscriber subscription was created.", "guide": "define/webhooks" }, { "id": "event.subscription.updated", "name": "subscription.updated", "kind": "schema", "collection": "operations", "page": "generated/operations/events", "source": "packages/contracts/src/events/catalog.ts", "description": "A subscriber subscription changed (plan, status, trial).", "guide": "define/webhooks" }, { "id": "event.usage.threshold_reached", "name": "usage.threshold_reached", "kind": "schema", "collection": "operations", "page": "generated/operations/events", "source": "packages/contracts/src/events/catalog.ts", "description": "A metered-usage threshold was crossed. Gateway producers use a deterministic event id keyed by subscription, limit, window, threshold, and actor scope so at-least-once delivery is dedupable.", "guide": "define/webhooks" }, { "id": "mcp.fs_agents_disable", "name": "fs_agents_disable", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Turn the Operator off: the dispatcher stops scheduling runs and agent-work billing stops accruing. Re-enable at any time.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_agents_enable", "name": "fs_agents_enable", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Turn the business's Operator agent on (created on first enable). It runs autonomously on its cadence; agent-work billing accrues while enabled.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_agents_list", "name": "fs_agents_list", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "The agent roster for a business: the enabled/disabled Operator plus any roles that can still be enabled. Read-only.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_agents_run_show", "name": "fs_agents_run_show", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "One run's full audit view: the orchestrator's trace summary (composed launches, verify flags, catalog changes), the per-launch performance ledger, and every platform-action receipt. Read-only.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"runId\": {\n \"type\": \"string\",\n \"description\": \"The agent run id.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"runId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_agents_status", "name": "fs_agents_status", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "The Operator's activation state, recent run history (newest-first), and lifetime usage totals (LLM tokens + actions). Read-only.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_agreement_list", "name": "fs_agreement_list", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "List a business's economic agreements (subject-scoped usage-pricing bindings and their append-only contract pricing versions).", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"subjectId\": {\n \"description\": \"Filter by subject id.\",\n \"type\": \"string\"\n },\n \"environmentId\": {\n \"description\": \"Preview environment slug or id (omit for production).\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_agreement_show", "name": "fs_agreement_show", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Fetch one economic agreement with every contract pricing version.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"agreementId\": {\n \"type\": \"string\",\n \"description\": \"The agreement id.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"agreementId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_analytics_latency", "name": "fs_analytics_latency", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Gateway request latency at p50/p95/p99 for one business. NOTE: this is the WHOLE request including the builder's own backend, so a high number is not necessarily platform overhead. Read-only.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"pattern\": \"^[^/?#\\\\s]+$\",\n \"description\": \"The business whose archive to query.\"\n },\n \"range\": {\n \"default\": \"24h\",\n \"description\": \"Relative window.\",\n \"type\": \"string\",\n \"enum\": [\n \"1h\",\n \"24h\",\n \"7d\",\n \"30d\"\n ]\n },\n \"environmentId\": {\n \"description\": \"Environment id to scope to. Omit for production. Never returns all environments summed.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"businessId\",\n \"range\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_analytics_log", "name": "fs_analytics_log", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "The most recent archived events for one business, newest first. Each row's `payload` carries the request detail (path, statusCode, latencyMs, orgId). Read-only.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"pattern\": \"^[^/?#\\\\s]+$\",\n \"description\": \"The business whose archive to query.\"\n },\n \"range\": {\n \"default\": \"24h\",\n \"description\": \"Relative window.\",\n \"type\": \"string\",\n \"enum\": [\n \"1h\",\n \"24h\",\n \"7d\",\n \"30d\"\n ]\n },\n \"environmentId\": {\n \"description\": \"Environment id to scope to. Omit for production. Never returns all environments summed.\",\n \"type\": \"string\"\n },\n \"domain\": {\n \"default\": \"usage\",\n \"type\": \"string\",\n \"enum\": [\n \"usage\",\n \"telemetry\",\n \"denials\",\n \"lifecycle\",\n \"consumer_activity\",\n \"audit\"\n ]\n },\n \"limit\": {\n \"default\": 25,\n \"type\": \"integer\",\n \"minimum\": 1,\n \"maximum\": 100\n }\n },\n \"required\": [\n \"businessId\",\n \"range\",\n \"domain\",\n \"limit\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_analytics_timeseries", "name": "fs_analytics_timeseries", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Event volume bucketed over time for one business, from the event archive. Read-only. Scoped to production unless environmentId is given.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"pattern\": \"^[^/?#\\\\s]+$\",\n \"description\": \"The business whose archive to query.\"\n },\n \"range\": {\n \"default\": \"24h\",\n \"description\": \"Relative window.\",\n \"type\": \"string\",\n \"enum\": [\n \"1h\",\n \"24h\",\n \"7d\",\n \"30d\"\n ]\n },\n \"environmentId\": {\n \"description\": \"Environment id to scope to. Omit for production. Never returns all environments summed.\",\n \"type\": \"string\"\n },\n \"domain\": {\n \"default\": \"usage\",\n \"type\": \"string\",\n \"enum\": [\n \"usage\",\n \"telemetry\",\n \"denials\",\n \"lifecycle\",\n \"consumer_activity\",\n \"audit\"\n ]\n },\n \"interval\": {\n \"default\": \"hour\",\n \"type\": \"string\",\n \"enum\": [\n \"hour\",\n \"day\"\n ]\n }\n },\n \"required\": [\n \"businessId\",\n \"range\",\n \"domain\",\n \"interval\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_analytics_top", "name": "fs_analytics_top", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Ranked breakdown of archive events by caller, event type, or environment. Read-only.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"pattern\": \"^[^/?#\\\\s]+$\",\n \"description\": \"The business whose archive to query.\"\n },\n \"range\": {\n \"default\": \"24h\",\n \"description\": \"Relative window.\",\n \"type\": \"string\",\n \"enum\": [\n \"1h\",\n \"24h\",\n \"7d\",\n \"30d\"\n ]\n },\n \"environmentId\": {\n \"description\": \"Environment id to scope to. Omit for production. Never returns all environments summed.\",\n \"type\": \"string\"\n },\n \"by\": {\n \"default\": \"actor_id\",\n \"type\": \"string\",\n \"enum\": [\n \"actor_id\",\n \"type\",\n \"environment_id\"\n ]\n },\n \"domain\": {\n \"default\": \"usage\",\n \"type\": \"string\",\n \"enum\": [\n \"usage\",\n \"telemetry\",\n \"denials\",\n \"lifecycle\",\n \"consumer_activity\",\n \"audit\"\n ]\n },\n \"k\": {\n \"default\": 10,\n \"type\": \"integer\",\n \"minimum\": 1,\n \"maximum\": 50\n }\n },\n \"required\": [\n \"businessId\",\n \"range\",\n \"by\",\n \"domain\",\n \"k\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_backend_bind", "name": "fs_backend_bind", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Bind a logical backend id to a concrete direct upstream URL in one environment. Previews inherit the production backend until a concrete override is bound. Omit environmentId for production.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id.\"\n },\n \"backend\": {\n \"type\": \"string\",\n \"description\": \"Logical backend slug.\"\n },\n \"environmentId\": {\n \"description\": \"Preview environment id; omit for production.\",\n \"type\": \"string\"\n },\n \"originUrl\": {\n \"type\": \"string\",\n \"format\": \"uri\",\n \"description\": \"Concrete direct upstream URL.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"backend\",\n \"originUrl\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_backend_create", "name": "fs_backend_create", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Create a backend (origin) for a business. Pick a transport mode: direct (public HTTPS URL, secured by Ed25519 request signing) or tunnel (private outbound-only cloudflared, secure bring-your-own-backend). Mark it default to route traffic to it.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id to create the backend in.\"\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Backend name (e.g. 'prod-origin').\"\n },\n \"slug\": {\n \"description\": \"URL-safe slug; derived from name if omitted.\",\n \"type\": \"string\"\n },\n \"transportMode\": {\n \"description\": \"How the gateway reaches the origin; defaults to direct.\",\n \"type\": \"string\",\n \"enum\": [\n \"direct\",\n \"tunnel\"\n ]\n },\n \"originUrl\": {\n \"description\": \"The origin URL (for direct mode).\",\n \"type\": \"string\"\n },\n \"isDefault\": {\n \"description\": \"Route traffic to this backend by default.\",\n \"type\": \"boolean\"\n },\n \"idempotencyKey\": {\n \"description\": \"One caller-persisted key for this exact live intent. Reuse it only when retrying the same request; a replay is historical and must be followed by the operation's reconcile read when current state matters.\",\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 200\n }\n },\n \"required\": [\n \"businessId\",\n \"name\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_backend_delete", "name": "fs_backend_delete", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Delete a backend (origin). Traffic routed to it stops; re-create to restore.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id.\"\n },\n \"backendId\": {\n \"type\": \"string\",\n \"description\": \"The backend id to delete.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"backendId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_backend_list", "name": "fs_backend_list", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "List a business's backends (origins) — id, scope (production|environment), environmentId, name, slug, transport (direct|tunnel), default flag, and derived status. Backends are per-(business, environment) rows, so the same declared backend can legitimately appear once per scope and be default in each. Read-only.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id whose backends to list.\"\n },\n \"environmentId\": {\n \"description\": \"Only backends in this environment id, or 'production' for the production scope. Omit for every scope.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_brand_update", "name": "fs_brand_update", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Update a business's brand and presentation — display name, description, icon, logo (wordmark), key prefix, and organization-page visibility. Plans, pricing, routes, and backend origins are managed through their dedicated surfaces. Only the fields you pass are changed.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug to update.\"\n },\n \"displayName\": {\n \"description\": \"Display name.\",\n \"type\": \"string\"\n },\n \"description\": {\n \"description\": \"Short business description.\",\n \"type\": \"string\"\n },\n \"iconUrl\": {\n \"description\": \"Square icon/favicon URL, or null to clear it.\",\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"logoUrl\": {\n \"description\": \"Wordmark/logo URL, or null to clear it.\",\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"keyPrefix\": {\n \"description\": \"White-label prefix for subscriber API keys (fsk_ → e.g. acme_). 2-12 lowercase letters/digits; fs/fsk/fsc/fsm reserved. Null clears to the default fsk.\",\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"listedOnOrganizationPage\": {\n \"description\": \"Show (true) or hide (false) this product on the organization's public page at /organization/. Listed by default.\",\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_bulletin_ack", "name": "fs_bulletin_ack", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Mark a bulletin post acknowledged — the hand-off signal that the coding agent (or builder) has picked the item up. Forward-only; idempotent on an already-acknowledged post.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"postId\": {\n \"type\": \"string\",\n \"description\": \"The bulletin post id.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"postId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_bulletin_list", "name": "fs_bulletin_list", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "The agents' bulletin feed for a business: trend/insight posts (aggregated data + deltas) and change_request posts (the coding agent's backlog — filter --kind change_request --status open). Read-only.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"kind\": {\n \"description\": \"Filter by post kind.\",\n \"type\": \"string\",\n \"enum\": [\n \"trend\",\n \"insight\",\n \"change_request\"\n ]\n },\n \"status\": {\n \"description\": \"Filter by post status.\",\n \"type\": \"string\",\n \"enum\": [\n \"open\",\n \"acknowledged\",\n \"resolved\"\n ]\n },\n \"limit\": {\n \"description\": \"Max rows to return.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_bulletin_resolve", "name": "fs_bulletin_resolve", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Mark a bulletin post resolved — the referenced work landed (or the trend was addressed). Terminal state.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"postId\": {\n \"type\": \"string\",\n \"description\": \"The bulletin post id.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"postId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_bulletin_show", "name": "fs_bulletin_show", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "One bulletin post in full: markdown body, the dataJson payload backing the claim, and for change requests the referenced ChangeSet id + proposal. Read-only.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"postId\": {\n \"type\": \"string\",\n \"description\": \"The bulletin post id.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"postId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_business_docs_disable", "name": "fs_business_docs_disable", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Disable docs for a business — closes the publish/sync gate so docs are no longer served and `boot.docsEnabled=false` is emitted to the portal. The docs scaffold stays in the repo; re-enabling is a pure flag flip. Idempotent if docs are already disabled.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug to disable docs on.\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_business_docs_enable", "name": "fs_business_docs_enable", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Enable docs for a business — opens the publish/sync gate so docs are served from R2 and `boot.docsEnabled=true` is emitted to the portal. Idempotent if docs are already enabled.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug to enable docs on.\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_business_list", "name": "fs_business_list", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "List every business in the authenticated FartherShore workspace (id, name, status). Read-only; use this to discover business ids for the other tools.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {},\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_business_preview_env_set", "name": "fs_business_preview_env_set", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Configure automatic preview environment creation for a business. Modes: BRANCH_PREFIX creates previews from matching env branches, PULL_REQUEST creates previews for PRs against the default branch, and DISABLED stops automatic creation while explicit `farthershore env create` continues to work. Pass envBranchPrefix to customize the branch-prefix mode, or null to reset to env/.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug to update.\"\n },\n \"previewEnvTrigger\": {\n \"description\": \"Automatic preview mode: BRANCH_PREFIX, PULL_REQUEST, or DISABLED.\",\n \"type\": \"string\",\n \"enum\": [\n \"BRANCH_PREFIX\",\n \"PULL_REQUEST\",\n \"DISABLED\"\n ]\n },\n \"envBranchPrefix\": {\n \"description\": \"Branch prefix for BRANCH_PREFIX mode, or null for env/.\",\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 50\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_business_publish", "name": "fs_business_publish", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Publish a business — validate its current spec and queue a versioned release with an auto-computed semver. Use business status to prove it is live.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id to publish.\"\n },\n \"bump\": {\n \"description\": \"Force the semver bump. Omit to auto-derive from the change.\",\n \"type\": \"string\",\n \"enum\": [\n \"major\",\n \"minor\",\n \"patch\"\n ]\n },\n \"version\": {\n \"description\": \"Pin the exact next release tag (vX.Y.Z).\",\n \"type\": \"string\"\n },\n \"acceptBreaking\": {\n \"description\": \"Consent to publish a breaking (blocking-risk) change as major.\",\n \"type\": \"boolean\"\n },\n \"dryRun\": {\n \"description\": \"Preview the change (computed semver + reasons) without cutting a release.\",\n \"type\": \"boolean\"\n },\n \"idempotencyKey\": {\n \"description\": \"One caller-persisted key for this exact live intent. Reuse it only when retrying the same request; a replay is historical and must be followed by the operation's reconcile read when current state matters.\",\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 200\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_business_rbac_disable", "name": "fs_business_rbac_disable", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Disable Managed RBAC for a business — flips the platform-owned flag back off via PUT /businesses/:id/rbac. Subscriber role/assignment state is kept server-side; re-enabling is a pure flag flip. Idempotent if RBAC is already disabled.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug to disable Managed RBAC on.\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_business_rbac_enable", "name": "fs_business_rbac_enable", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Enable Managed RBAC for a business — a platform-owned flag (like docsEnabled) toggled via PUT /businesses/:id/rbac. Subscriber orgs can then manage roles in their portal. Idempotent if RBAC is already enabled.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug to enable Managed RBAC on.\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_business_rbac_subjects_list", "name": "fs_business_rbac_subjects_list", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "List a business's raw permission vocabulary (subject, verbs, escalatory verbs, description). The SDK/compiler do not create roles: each subscribing organization assembles this catalog into its own CUSTOM roles, default, and assignments. Subjects are declared via permission-carrying `fs.group(id, routes, { permission })` in the business/ repo; run `farthershore validate` and push to change them. Read-only.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug to list subjects for.\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_business_status", "name": "fs_business_status", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Verify lifecycle, release, and the complete environment edge generation by id or slug. Reports Core G, published G, observed G, the expected/observed manifest digests, and whether they cohere. Read-only.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug to check.\"\n },\n \"env\": {\n \"description\": \"Environment name; omit for production.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_business_subdomain_check", "name": "fs_business_subdomain_check", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Check whether a candidate slug is free to use as a business subdomain (normalized, blocked-word and collision checked). Read-only; run before fs_business_create.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"slug\": {\n \"type\": \"string\",\n \"description\": \"Candidate business slug (normalized to the subdomain).\"\n }\n },\n \"required\": [\n \"slug\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_consumer_block", "name": "fs_consumer_block", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Block a user/consumer for a business and revoke their active API keys. Destructive live-state operation; it does not edit repo-authored business behavior.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"subscriberId\": {\n \"type\": \"string\",\n \"description\": \"The subscriber id from `consumer list`.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"subscriberId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_consumer_keys_list", "name": "fs_consumer_keys_list", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "List one consumer's API keys for a business. Read-only and metadata only — the response never contains key material. Use it to discover the keyId needed to revoke a single key.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"subscriberId\": {\n \"type\": \"string\",\n \"description\": \"The subscriber id from `consumer list`.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"subscriberId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_consumer_keys_revoke", "name": "fs_consumer_keys_revoke", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Revoke ONE of a consumer's API keys for a business. The surgical alternative to blocking the whole consumer (which revokes every key). Irreversible: the credential stops working at the edge and cannot be un-revoked — mint a new key instead. Destructive live-state operation; it does not edit repo-authored business behavior.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"subscriberId\": {\n \"type\": \"string\",\n \"description\": \"The subscriber id from `consumer list`.\"\n },\n \"keyId\": {\n \"type\": \"string\",\n \"description\": \"The API key id from `consumer keys list`.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"subscriberId\",\n \"keyId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_consumer_list", "name": "fs_consumer_list", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "List users/consumers for a business. Read-only; use this to discover subscriber ids before blocking or removing a user.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"env\": {\n \"description\": \"Environment name for preview-scoped consumers.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_consumer_migrate_latest", "name": "fs_consumer_migrate_latest", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Move one consumer onto the current head of their plan lineage immediately. Operates on live subscription state.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"subscriberId\": {\n \"type\": \"string\",\n \"description\": \"The subscriber id from `consumer list`.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"subscriberId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_consumer_rbac_assign", "name": "fs_consumer_rbac_assign", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Support override: replace a client-org member's Managed-RBAC business-role assignment on a business (set-replace — the given list becomes the member's full assignment; an empty list clears it). Role keys must exist in the org's role set. Live-state operation; it does not edit repo-authored business behavior.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"subscriberId\": {\n \"type\": \"string\",\n \"description\": \"The subscriber id from `consumer list`.\"\n },\n \"userExternalId\": {\n \"type\": \"string\",\n \"description\": \"The member's external identity id (Clerk userId) within the client org.\"\n },\n \"roles\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"Business-role keys to set (replaces the current assignment; [] clears it).\"\n }\n },\n \"required\": [\n \"businessId\",\n \"subscriberId\",\n \"userExternalId\",\n \"roles\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_consumer_rbac_disable", "name": "fs_consumer_rbac_disable", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Turn Managed-RBAC enforcement OFF for ONE subscriber. This is an access EXPANSION — with enforcement off, credential permission resolution can return ['*']. Role definitions are preserved for re-enable. Returns 409 GOVERNED_BY_CHANGE_SET when the subscriber org has mandatory change control on. Live-state operation; it does not edit repo-authored business behavior.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"subscriberId\": {\n \"type\": \"string\",\n \"description\": \"The subscriber id from `consumer list`.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"subscriberId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_consumer_rbac_enable", "name": "fs_consumer_rbac_enable", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Turn Managed-RBAC enforcement ON for ONE subscriber, and optionally set the org's default role. Enforcement requires BOTH this flag and the product flag (fs_business_rbac_enable); with the product flag off this returns 400 RBAC_NOT_ENABLED_BY_PRODUCT. Returns 409 GOVERNED_BY_CHANGE_SET when the subscriber org has mandatory change control on — that org must approve a governed ChangeSet instead. Live-state operation; it does not edit repo-authored business behavior.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"subscriberId\": {\n \"type\": \"string\",\n \"description\": \"The subscriber id from `consumer list`.\"\n },\n \"defaultRoleKey\": {\n \"description\": \"Role key new members fall back to when they have no explicit role. Omit to clear it.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"businessId\",\n \"subscriberId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_consumer_rbac_roles_create", "name": "fs_consumer_rbac_roles_create", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Create a CUSTOM Managed-RBAC role for ONE subscriber from the business's derived permission catalog. An unknown permission is rejected with 400 UNKNOWN_PERMISSION; the reserved key `owner` is rejected with 409 OWNER_ROLE_IMMUTABLE (owners always hold every permission); a duplicate key is a 409. Live-state operation; it does not edit repo-authored business behavior.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"subscriberId\": {\n \"type\": \"string\",\n \"description\": \"The subscriber id from `consumer list`.\"\n },\n \"roleKey\": {\n \"type\": \"string\",\n \"description\": \"The subscriber-owned role key (lowercase slug). `owner` is reserved and immutable.\"\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Human-readable role name.\"\n },\n \"permissions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"Permission keys from the business's derived catalog. Grant-by-exact-name; a custom subject's `:*` is never grantable.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"subscriberId\",\n \"roleKey\",\n \"name\",\n \"permissions\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_consumer_rbac_roles_delete", "name": "fs_consumer_rbac_roles_delete", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Delete ONE subscriber Managed-RBAC role. Atomic and convergent: the key is stripped from every member and credential that holds it and cleared as the org default. The reserved key `owner` is rejected with 409 OWNER_ROLE_IMMUTABLE. Destructive live-state operation; it does not edit repo-authored business behavior.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"subscriberId\": {\n \"type\": \"string\",\n \"description\": \"The subscriber id from `consumer list`.\"\n },\n \"roleKey\": {\n \"type\": \"string\",\n \"description\": \"The subscriber-owned role key (lowercase slug). `owner` is reserved and immutable.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"subscriberId\",\n \"roleKey\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_consumer_rbac_roles_list", "name": "fs_consumer_rbac_roles_list", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "List ONE subscriber's Managed-RBAC role rows (ACCOUNT and CUSTOM), with each role's permission keys. Read-only; use it to discover role keys before creating, updating, deleting, or assigning them. Returns 400 RBAC_NOT_ENABLED_BY_PRODUCT when the product's RBAC flag is off.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"subscriberId\": {\n \"type\": \"string\",\n \"description\": \"The subscriber id from `consumer list`.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"subscriberId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_consumer_rbac_roles_update", "name": "fs_consumer_rbac_roles_update", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Rename and/or re-permission ONE subscriber Managed-RBAC role. `permissions` is set-replace — the given list becomes the role's full grant. Provide name and/or permissions. An unknown permission is rejected with 400 UNKNOWN_PERMISSION; the reserved key `owner` is rejected with 409 OWNER_ROLE_IMMUTABLE. Role edits republish live-bound key claims asynchronously, so retest EXISTING credentials after the change reaches the edge.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"subscriberId\": {\n \"type\": \"string\",\n \"description\": \"The subscriber id from `consumer list`.\"\n },\n \"roleKey\": {\n \"type\": \"string\",\n \"description\": \"The subscriber-owned role key (lowercase slug). `owner` is reserved and immutable.\"\n },\n \"name\": {\n \"description\": \"New human-readable role name.\",\n \"type\": \"string\"\n },\n \"permissions\": {\n \"description\": \"Replacement permission keys (set-replace, from the derived catalog).\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"businessId\",\n \"subscriberId\",\n \"roleKey\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_consumer_remove", "name": "fs_consumer_remove", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Remove a user/consumer from live business access: cancel subscriptions, revoke credentials, purge related live state, and archive the subscriber while retaining billing/audit history. Destructive and convergent on retry; it does not edit repo-authored business behavior.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"subscriberId\": {\n \"type\": \"string\",\n \"description\": \"The subscriber id from `consumer list`.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"subscriberId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_env_create", "name": "fs_env_create", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Create a preview environment bound to a git branch. Provide a name and the git branch it tracks.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id to create the environment in.\"\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Environment name (e.g. 'staging', 'preview-pr-42').\"\n },\n \"branch\": {\n \"type\": \"string\",\n \"description\": \"The git branch this environment tracks.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"name\",\n \"branch\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_env_list", "name": "fs_env_list", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "List a business's environments (name, branch, hostnames). The first row is always the `production` scope, which has `id: null` and no branch — it is the live business, not a preview environment row, and `--env production` addresses it on every verb that takes `--env`. Read-only.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id whose environments to list.\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_frontend_rollback", "name": "fs_frontend_rollback", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Roll a business's frontend back to a prior release by its releaseId (manifest hash, from fs_frontend_status). Flips the live pointer back and pins it. The releaseId must belong to this target's build history.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"releaseId\": {\n \"type\": \"string\",\n \"description\": \"The prior release id (manifest hash) to re-activate.\"\n },\n \"environmentId\": {\n \"description\": \"Scope to a preview environment (omit for production).\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"businessId\",\n \"releaseId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_frontend_status", "name": "fs_frontend_status", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Read a business's current frontend serve state (uiMode, active release hash + producing build, pin flag), the recent SUCCEEDED releases (rollback targets), and the recent builds — a FAILED build's `error` explains why a deploy didn't go live. Read-only.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"environmentId\": {\n \"description\": \"Scope to a preview environment (omit for production).\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_organization_ownership_transfer", "name": "fs_organization_ownership_transfer", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Transfer primary ownership of a team or company organization to another existing member. Destructive and irreversible for the caller; requires the signed-in owner's session.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"organizationId\": {\n \"type\": \"string\",\n \"description\": \"Builder organization id.\"\n },\n \"newOwnerUserId\": {\n \"type\": \"string\",\n \"description\": \"User id of the existing member who becomes primary owner.\"\n },\n \"idempotencyKey\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"Required live-attempt key. Reuse this exact value only when retrying the same uncertain ownership transfer.\"\n }\n },\n \"required\": [\n \"organizationId\",\n \"newOwnerUserId\",\n \"idempotencyKey\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_persona_bootstrap", "name": "fs_persona_bootstrap", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Issue a one-time test bootstrap key for a business environment — use it to provision a test persona. Returns the key ONCE; store it now.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id.\"\n },\n \"environmentId\": {\n \"type\": \"string\",\n \"description\": \"The environment id to scope the persona to.\"\n },\n \"idempotencyKey\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"Required live-attempt key. Reuse this exact value only when retrying the same uncertain persona bootstrap.\"\n },\n \"subscriberId\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"planKey\": {\n \"description\": \"Plan key to assign. Required when creating a new subscriber; omit only when subscriberId joins an existing subscriber.\",\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"accountRole\": {\n \"type\": \"string\",\n \"enum\": [\n \"owner\",\n \"admin\",\n \"member\"\n ]\n },\n \"roleKeys\": {\n \"description\": \"Subscriber-owned product role keys. Omit to use its configured default role.\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\",\n \"minLength\": 1\n }\n }\n },\n \"required\": [\n \"businessId\",\n \"environmentId\",\n \"idempotencyKey\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_persona_delete", "name": "fs_persona_delete", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Delete a temporary test persona, including its credential, browser access, and test-owned identity state.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id.\"\n },\n \"environmentId\": {\n \"type\": \"string\",\n \"description\": \"The environment id.\"\n },\n \"personaId\": {\n \"type\": \"string\",\n \"description\": \"The persona id to delete.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"environmentId\",\n \"personaId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_persona_list", "name": "fs_persona_list", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "List a business environment's test personas (id, label, status). Read-only.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id.\"\n },\n \"environmentId\": {\n \"type\": \"string\",\n \"description\": \"The environment id whose personas to list.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"environmentId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_persona_rotate", "name": "fs_persona_rotate", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Rotate a test persona's API key. Returns the replacement key once.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id.\"\n },\n \"environmentId\": {\n \"type\": \"string\",\n \"description\": \"The environment id.\"\n },\n \"personaId\": {\n \"type\": \"string\",\n \"description\": \"The persona id to rotate.\"\n },\n \"idempotencyKey\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"Required live-attempt key. Reuse this exact value only when retrying the same uncertain persona rotation.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"environmentId\",\n \"personaId\",\n \"idempotencyKey\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_plan_list", "name": "fs_plan_list", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "List a business's pricing plans (read-only). Plans are managed as code in the business's GitHub repo — to add/change/remove a plan, edit business/ and push; this tool only reads the current state. Without environmentId the PRODUCTION plans are returned; pass environmentId to see what a preview environment serves. Pass the business id from fs_business_list.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id whose plans to list.\"\n },\n \"environmentId\": {\n \"description\": \"Return the plans this environment serves; omit for production.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "contract", "guide": "cli/overview" }, { "id": "mcp.fs_promo_code_archive", "name": "fs_promo_code_archive", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Archive an API-managed checkout promo code.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"promoCodeId\": {\n \"type\": \"string\",\n \"description\": \"The promo code id.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"promoCodeId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_promo_code_create", "name": "fs_promo_code_create", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Create an API-managed checkout promo code. Use percent for percent_off, amountCents for amount_off, and no amount for free_months.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 64\n },\n \"kind\": {\n \"type\": \"string\",\n \"enum\": [\n \"percent_off\",\n \"amount_off\",\n \"free_months\"\n ]\n },\n \"percent\": {\n \"type\": \"integer\",\n \"minimum\": 1,\n \"maximum\": 100\n },\n \"amountCents\": {\n \"type\": \"integer\",\n \"exclusiveMinimum\": 0,\n \"maximum\": 9007199254740991\n },\n \"durationMonths\": {\n \"type\": \"integer\",\n \"minimum\": 1,\n \"maximum\": 24\n },\n \"maxRedemptions\": {\n \"type\": \"integer\",\n \"exclusiveMinimum\": 0,\n \"maximum\": 9007199254740991\n },\n \"activeFrom\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"pattern\": \"^(?:(?:\\\\d\\\\d[2468][048]|\\\\d\\\\d[13579][26]|\\\\d\\\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\\\d|30)|(?:02)-(?:0[1-9]|1\\\\d|2[0-8])))T(?:(?:[01]\\\\d|2[0-3]):[0-5]\\\\d(?::[0-5]\\\\d(?:\\\\.\\\\d+)?)?(?:Z))$\"\n },\n \"activeUntil\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"pattern\": \"^(?:(?:\\\\d\\\\d[2468][048]|\\\\d\\\\d[13579][26]|\\\\d\\\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\\\d|30)|(?:02)-(?:0[1-9]|1\\\\d|2[0-8])))T(?:(?:[01]\\\\d|2[0-3]):[0-5]\\\\d(?::[0-5]\\\\d(?:\\\\.\\\\d+)?)?(?:Z))$\"\n },\n \"applicablePlanIds\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"idempotencyKey\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"Required live-attempt key. Reuse this exact value only when retrying the same uncertain promo-code creation.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"code\",\n \"kind\",\n \"durationMonths\",\n \"idempotencyKey\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_promo_code_list", "name": "fs_promo_code_list", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "List API-managed promo codes for a business. Promo codes are checkout operational state, not repo-authored Business SDK state.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_promo_code_reactivate", "name": "fs_promo_code_reactivate", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Reactivate an archived API-managed checkout promo code.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"promoCodeId\": {\n \"type\": \"string\",\n \"description\": \"The promo code id.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"promoCodeId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_promo_code_update", "name": "fs_promo_code_update", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Update an API-managed checkout promo code. Spec changes rotate the Stripe coupon/promotion code behind the scenes.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"promoCodeId\": {\n \"type\": \"string\",\n \"description\": \"The promo code id.\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 64\n },\n \"kind\": {\n \"type\": \"string\",\n \"enum\": [\n \"percent_off\",\n \"amount_off\",\n \"free_months\"\n ]\n },\n \"percent\": {\n \"type\": \"integer\",\n \"minimum\": 1,\n \"maximum\": 100\n },\n \"amountCents\": {\n \"type\": \"integer\",\n \"exclusiveMinimum\": 0,\n \"maximum\": 9007199254740991\n },\n \"durationMonths\": {\n \"type\": \"integer\",\n \"minimum\": 1,\n \"maximum\": 24\n },\n \"maxRedemptions\": {\n \"anyOf\": [\n {\n \"type\": \"integer\",\n \"exclusiveMinimum\": 0,\n \"maximum\": 9007199254740991\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"activeFrom\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"pattern\": \"^(?:(?:\\\\d\\\\d[2468][048]|\\\\d\\\\d[13579][26]|\\\\d\\\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\\\d|30)|(?:02)-(?:0[1-9]|1\\\\d|2[0-8])))T(?:(?:[01]\\\\d|2[0-3]):[0-5]\\\\d(?::[0-5]\\\\d(?:\\\\.\\\\d+)?)?(?:Z))$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"activeUntil\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"pattern\": \"^(?:(?:\\\\d\\\\d[2468][048]|\\\\d\\\\d[13579][26]|\\\\d\\\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\\\d|30)|(?:02)-(?:0[1-9]|1\\\\d|2[0-8])))T(?:(?:[01]\\\\d|2[0-3]):[0-5]\\\\d(?::[0-5]\\\\d(?:\\\\.\\\\d+)?)?(?:Z))$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"applicablePlanIds\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"businessId\",\n \"promoCodeId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_proposal_create", "name": "fs_proposal_create", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Propose a governed ChangeSet against a subscriber's live RBAC state (Agent Proposal Flow). Creates a DRAFT proposal that a HUMAN in the subscriber org must preview, approve, and apply in the portal — an agent can propose but never self-approve or apply. Operate-class live-state action; does not edit repo-authored business behavior.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"subscriberId\": {\n \"type\": \"string\",\n \"description\": \"The subscriber (client org) id — from `consumer list`.\"\n },\n \"intent\": {\n \"type\": \"string\",\n \"description\": \"Human-readable description of the proposed change.\"\n },\n \"operations\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"propertyNames\": {\n \"type\": \"string\"\n },\n \"additionalProperties\": {}\n },\n \"description\": \"Governed operations, e.g. [{ type: 'update_role_permissions', schemaVersion: 1, target: { resourceType: 'subscriber_business_role', resourceId: '' }, payload: { permissions: [...] } }].\"\n },\n \"env\": {\n \"description\": \"Environment name/id to scope the proposal to.\",\n \"type\": \"string\"\n },\n \"idempotencyKey\": {\n \"description\": \"Replay-safe idempotency key for the proposal.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"businessId\",\n \"subscriberId\",\n \"intent\",\n \"operations\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_proposal_get", "name": "fs_proposal_get", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Read one governed ChangeSet proposed against a subscriber (Agent Proposal Flow) — its operations, risk, simulation, approvals, and status. Read-only.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"subscriberId\": {\n \"type\": \"string\",\n \"description\": \"The subscriber (client org) id — from `consumer list`.\"\n },\n \"changeSetId\": {\n \"type\": \"string\",\n \"description\": \"The governed ChangeSet id.\"\n },\n \"env\": {\n \"description\": \"Environment name/id.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"businessId\",\n \"subscriberId\",\n \"changeSetId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_proposal_list", "name": "fs_proposal_list", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "List governed ChangeSets proposed against a subscriber (Agent Proposal Flow). Read-only; use it to discover proposal ids + their status before previewing.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"subscriberId\": {\n \"type\": \"string\",\n \"description\": \"The subscriber (client org) id — from `consumer list`.\"\n },\n \"status\": {\n \"description\": \"Filter by status (e.g. draft, approval_required).\",\n \"type\": \"string\"\n },\n \"env\": {\n \"description\": \"Environment name/id.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"businessId\",\n \"subscriberId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_proposal_preview", "name": "fs_proposal_preview", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Simulate the impact of a proposed ChangeSet and store the preview (Agent Proposal Flow). Enforced by the same authority as propose — there is no separate preview permission. Read-shaped but writes the stored simulation; does not apply the change.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"subscriberId\": {\n \"type\": \"string\",\n \"description\": \"The subscriber (client org) id — from `consumer list`.\"\n },\n \"changeSetId\": {\n \"type\": \"string\",\n \"description\": \"The governed ChangeSet id.\"\n },\n \"env\": {\n \"description\": \"Environment name/id.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"businessId\",\n \"subscriberId\",\n \"changeSetId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_runtime_token_list", "name": "fs_runtime_token_list", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "List a business's runtime tokens (fsrt_) — id, last-four, operations, status, and env scope. Read-only; secrets are never shown.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id.\"\n },\n \"environmentId\": {\n \"description\": \"Only tokens scoped to this environment id, or 'production' for the production scope. Omit for every scope.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_runtime_token_mint", "name": "fs_runtime_token_mint", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Mint a new runtime token (fsrt_) for a backend. Returns the plaintext token ONCE — store it now (e.g. as FS_RUNTIME_TOKEN). Operations default to the backend's needs (gateway_verification, metering, health).", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id.\"\n },\n \"backendId\": {\n \"description\": \"Bind the token to this backend, by slug or id. Resolved in the selected environment, falling back to the production row.\",\n \"type\": \"string\"\n },\n \"environmentId\": {\n \"description\": \"Scope to a preview environment (omit for production).\",\n \"type\": \"string\"\n },\n \"kind\": {\n \"description\": \"Token kind; defaults from the env scope.\",\n \"type\": \"string\",\n \"enum\": [\n \"live\",\n \"test\"\n ]\n },\n \"operations\": {\n \"description\": \"Operations (gateway_verification, metering, health, tunnel).\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"idempotencyKey\": {\n \"description\": \"One caller-persisted key for this exact live intent. Reuse it only when retrying the same request; a replay is historical and must be followed by the operation's reconcile read when current state matters.\",\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 200\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_runtime_token_revoke", "name": "fs_runtime_token_revoke", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Revoke a runtime token. The backend using it stops verifying.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id.\"\n },\n \"tokenId\": {\n \"type\": \"string\",\n \"description\": \"The runtime token id to revoke.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"tokenId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_runtime_token_rotate", "name": "fs_runtime_token_rotate", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Rotate a runtime token: mint a fresh secret carrying the same scope and revoke the old one. Returns the new plaintext token ONCE.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id.\"\n },\n \"tokenId\": {\n \"type\": \"string\",\n \"description\": \"The runtime token id to rotate.\"\n },\n \"idempotencyKey\": {\n \"description\": \"One caller-persisted key for this exact live intent. Reuse it only when retrying the same request; a replay is historical and must be followed by the operation's reconcile read when current state matters.\",\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 200\n }\n },\n \"required\": [\n \"businessId\",\n \"tokenId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_stripe_disconnect", "name": "fs_stripe_disconnect", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Remove a business's per-business Stripe Connect override so it bills through the organization default again. Refused while any subscription is still money-bearing. Destructive live-state operation; it does not edit repo-authored business behavior.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"deleteAccount\": {\n \"description\": \"Also delete the platform-created Express account at Stripe.\",\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_stripe_status", "name": "fs_stripe_status", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Read the Stripe Connect account a business bills through — a per-business override when present, otherwise the organization default — including onboarding and tax-enrollment state. Read-only. Connecting Stripe is browser-only and has no tool.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_usage_read", "name": "fs_usage_read", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Read a business's usage summary — metered request counts and tier utilization. Without environmentId this rolls up EVERY environment. Read-only.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id whose usage to read.\"\n },\n \"environmentId\": {\n \"description\": \"Narrow the summary to this environment; omit for the product-wide rollup.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_variable_list", "name": "fs_variable_list", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Lists variables. Returns readable FS_PUBLIC_* values; every other variable is a write-only secret and only its lifecycle metadata is returned.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"environmentId\": {\n \"description\": \"Preview environment slug or id (omit for Main).\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_variable_operation_get", "name": "fs_variable_operation_get", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Reads publication status and frozen impact metadata.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\"\n },\n \"operationId\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"businessId\",\n \"operationId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_variable_revoke", "name": "fs_variable_revoke", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Revokes runtime access after explicit confirmation and returns a durable operation.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"environmentId\": {\n \"type\": \"string\"\n },\n \"confirmation\": {\n \"type\": \"string\",\n \"const\": \"REVOKE\"\n },\n \"idempotencyKey\": {\n \"description\": \"One caller-persisted key for this exact live intent. Reuse it only when retrying the same request; a replay is historical and must be followed by the operation's reconcile read when current state matters.\",\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 200\n }\n },\n \"required\": [\n \"businessId\",\n \"name\",\n \"confirmation\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_variable_rm", "name": "fs_variable_rm", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Permanently destroys ciphertext after acknowledged revocation. Main and preview use the same contract.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"environmentId\": {\n \"type\": \"string\"\n },\n \"confirmation\": {\n \"type\": \"string\",\n \"const\": \"DELETE\"\n },\n \"idempotencyKey\": {\n \"description\": \"One caller-persisted key for this exact live intent. Reuse it only when retrying the same request; a replay is historical and must be followed by the operation's reconcile read when current state matters.\",\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 200\n }\n },\n \"required\": [\n \"businessId\",\n \"name\",\n \"confirmation\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_variable_rotate", "name": "fs_variable_rotate", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Creates an immutable variable generation. An FS_PUBLIC_-prefixed name is public (inlined into the frontend bundle); any other name is a write-only secret whose plaintext is accepted once and never returned.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Variable name, e.g. POSTHOG_TOKEN. The name is the class: an FS_PUBLIC_ prefix makes it public (inlined into the frontend bundle, readable by every visitor); any other name is a write-only secret.\"\n },\n \"value\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The value.\"\n },\n \"environmentId\": {\n \"description\": \"Preview environment slug or id (omit for Main).\",\n \"type\": \"string\"\n },\n \"idempotencyKey\": {\n \"description\": \"One caller-persisted key for this exact live intent. Reuse it only when retrying the same request; a replay is historical and must be followed by the operation's reconcile read when current state matters.\",\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 200\n }\n },\n \"required\": [\n \"businessId\",\n \"name\",\n \"value\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_variable_set", "name": "fs_variable_set", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Creates an immutable variable generation. An FS_PUBLIC_-prefixed name is public (inlined into the frontend bundle); any other name is a write-only secret whose plaintext is accepted once and never returned.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Variable name, e.g. POSTHOG_TOKEN. The name is the class: an FS_PUBLIC_ prefix makes it public (inlined into the frontend bundle, readable by every visitor); any other name is a write-only secret.\"\n },\n \"value\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The value.\"\n },\n \"environmentId\": {\n \"description\": \"Preview environment slug or id (omit for Main).\",\n \"type\": \"string\"\n },\n \"idempotencyKey\": {\n \"description\": \"One caller-persisted key for this exact live intent. Reuse it only when retrying the same request; a replay is historical and must be followed by the operation's reconcile read when current state matters.\",\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 200\n }\n },\n \"required\": [\n \"businessId\",\n \"name\",\n \"value\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_webhook_create", "name": "fs_webhook_create", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Create an outbound webhook endpoint for a business. Returns the signing secret once.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"url\": {\n \"type\": \"string\",\n \"format\": \"uri\",\n \"description\": \"HTTPS receiver URL.\"\n },\n \"events\": {\n \"minItems\": 1,\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"Webhook event names to subscribe to.\"\n },\n \"environmentId\": {\n \"description\": \"Only deliver events from this environment (default: every environment).\",\n \"type\": \"string\"\n },\n \"idempotencyKey\": {\n \"description\": \"One caller-persisted key for this exact live intent. Reuse it only when retrying the same request; a replay is historical and must be followed by the operation's reconcile read when current state matters.\",\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 200\n }\n },\n \"required\": [\n \"businessId\",\n \"url\",\n \"events\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_webhook_delete", "name": "fs_webhook_delete", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Delete an outbound webhook endpoint.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"webhookId\": {\n \"type\": \"string\",\n \"description\": \"The webhook endpoint id.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"webhookId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_webhook_deliveries", "name": "fs_webhook_deliveries", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "List recent delivery attempts for a webhook endpoint. Payload and response body are intentionally omitted by Core.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"webhookId\": {\n \"type\": \"string\",\n \"description\": \"The webhook endpoint id.\"\n },\n \"limit\": {\n \"description\": \"Max rows to return.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"businessId\",\n \"webhookId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_webhook_event_types", "name": "fs_webhook_event_types", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "List the event names a webhook endpoint can subscribe to, with descriptions.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_webhook_list", "name": "fs_webhook_list", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "List API-managed outbound webhook endpoints for a business. Read-only; signing secrets are never returned.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"limit\": {\n \"description\": \"Max rows to return.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"businessId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_webhook_rotate_secret", "name": "fs_webhook_rotate_secret", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Issue a replacement signing secret for a webhook endpoint. Returns the new secret once; deliveries carry both signatures for 24 hours so the receiver can roll over without a gap.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"webhookId\": {\n \"type\": \"string\",\n \"description\": \"The webhook endpoint id.\"\n }\n },\n \"required\": [\n \"businessId\",\n \"webhookId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_webhook_test", "name": "fs_webhook_test", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Send a signed test event to an API-managed webhook endpoint and persist the delivery result.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"webhookId\": {\n \"type\": \"string\",\n \"description\": \"The webhook endpoint id.\"\n },\n \"type\": {\n \"description\": \"Envelope type to send: one of subscription.created, subscription.updated, subscription.canceled, payment.succeeded, payment.failed, entitlement.changed, usage.threshold_reached, webhook.test. A catalog event is delivered with a realistic sample payload. Defaults to webhook.test.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"businessId\",\n \"webhookId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "mcp.fs_webhook_update", "name": "fs_webhook_update", "kind": "mcp", "collection": "cli", "page": "generated/cli/mcp", "source": "apps/cli/src/operations/registry.ts", "description": "Update an API-managed webhook endpoint's URL, event list, environment scope and/or enabled state. Use fs_webhook_rotate_secret for a new signing secret.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"businessId\": {\n \"type\": \"string\",\n \"description\": \"The business id or slug.\"\n },\n \"webhookId\": {\n \"type\": \"string\",\n \"description\": \"The webhook endpoint id.\"\n },\n \"url\": {\n \"description\": \"Replacement HTTPS receiver URL.\",\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n \"events\": {\n \"description\": \"Replacement webhook event list.\",\n \"minItems\": 1,\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"environmentId\": {\n \"description\": \"Only deliver events from this environment; null clears the scope (every environment).\",\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"enabled\": {\n \"description\": \"Enable or disable delivery.\",\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"businessId\",\n \"webhookId\"\n ],\n \"additionalProperties\": false\n}\n", "operationClass": "operate", "guide": "cli/overview" }, { "id": "operation.agents.disable", "name": "agents.disable", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write agents through farthershore agents disable.", "operationClass": "operate", "permission": "agent:configure", "unavailableReason": null, "guide": "agents/platform-agent" }, { "id": "operation.agents.enable", "name": "agents.enable", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write agents through farthershore agents enable.", "operationClass": "operate", "permission": "agent:configure", "unavailableReason": null, "guide": "agents/platform-agent" }, { "id": "operation.agents.list", "name": "agents.list", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read agents through farthershore agents list.", "operationClass": "operate", "permission": "agent:read", "unavailableReason": null, "guide": "agents/platform-agent" }, { "id": "operation.agents.runs.show", "name": "agents.runs.show", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read agents through farthershore agents runs-show.", "operationClass": "operate", "permission": "agent:read", "unavailableReason": null, "guide": "agents/platform-agent" }, { "id": "operation.agents.status", "name": "agents.status", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read agents through farthershore agents status.", "operationClass": "operate", "permission": "agent:read", "unavailableReason": null, "guide": "agents/platform-agent" }, { "id": "operation.agreement.amend", "name": "agreement.amend", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write agreements through farthershore agreements amend.", "operationClass": "operate", "permission": "agreement:amend", "unavailableReason": null, "guide": "reference/economic-agreements" }, { "id": "operation.agreement.create", "name": "agreement.create", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write agreements through farthershore agreements create.", "operationClass": "operate", "permission": "agreement:create", "unavailableReason": null, "guide": "reference/economic-agreements" }, { "id": "operation.agreement.read", "name": "agreement.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read agreements through farthershore agreements list.", "operationClass": "operate", "permission": "agreement:read", "unavailableReason": null, "guide": "reference/economic-agreements" }, { "id": "operation.analytics.latency", "name": "analytics.latency", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read analytics through farthershore analytics latency.", "operationClass": "operate", "permission": "analytics:read", "unavailableReason": null, "guide": "operate/observability-and-troubleshooting" }, { "id": "operation.analytics.log", "name": "analytics.log", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read analytics through farthershore analytics log.", "operationClass": "operate", "permission": "analytics:read", "unavailableReason": null, "guide": "operate/observability-and-troubleshooting" }, { "id": "operation.analytics.timeseries", "name": "analytics.timeseries", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read analytics through farthershore analytics timeseries.", "operationClass": "operate", "permission": "analytics:read", "unavailableReason": null, "guide": "operate/observability-and-troubleshooting" }, { "id": "operation.analytics.top", "name": "analytics.top", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read analytics through farthershore analytics top.", "operationClass": "operate", "permission": "analytics:read", "unavailableReason": null, "guide": "operate/observability-and-troubleshooting" }, { "id": "operation.apply_timeline.list", "name": "apply_timeline.list", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read change-sets through farthershore apply-timeline list.", "operationClass": "operate", "permission": "apply_timeline:read", "unavailableReason": null, "guide": "operate/apply-timeline" }, { "id": "operation.apply_timeline.read", "name": "apply_timeline.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read change-sets through farthershore apply-timeline inspect.", "operationClass": "operate", "permission": "apply_timeline:read", "unavailableReason": null, "guide": "operate/apply-timeline" }, { "id": "operation.audit_log.business.export", "name": "audit_log.business.export", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read audit-logs through farthershore audit-log business-export.", "operationClass": "operate", "permission": "audit_log:export", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.audit_log.business.read", "name": "audit_log.business.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read audit-logs through farthershore audit-log business-list.", "operationClass": "operate", "permission": "audit_log:read", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.audit_log.export", "name": "audit_log.export", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read audit-logs through farthershore audit-log export.", "operationClass": "operate", "permission": "audit_log:export", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.audit_log.read", "name": "audit_log.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read audit-logs through farthershore audit-log list.", "operationClass": "operate", "permission": "audit_log:read", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.auth_strategy.update", "name": "auth_strategy.update", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "Declare the auth strategy on `fs.business()` in the business repo's business/ folder and push — the platform applies it.", "operationClass": "contract", "permission": "local_repository:write", "unavailableReason": "repo_authored", "guide": "define/tenancy" }, { "id": "operation.auth.context.issue", "name": "auth.context.issue", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write authentication through farthershore auth context-token.", "operationClass": "operate", "permission": "auth_context:issue", "unavailableReason": null, "guide": "agents/overview" }, { "id": "operation.auth.context.read", "name": "auth.context.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "Use `farthershore auth whoami`.", "operationClass": "operate", "permission": "auth_context:read", "unavailableReason": "served_by_other_command", "guide": "agents/overview" }, { "id": "operation.automation_rule.create", "name": "automation_rule.create", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write automation through farthershore automation create.", "operationClass": "operate", "permission": "automation_rule:create", "unavailableReason": null, "guide": "agents/automation" }, { "id": "operation.automation_rule.delete", "name": "automation_rule.delete", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write automation through farthershore automation delete.", "operationClass": "operate", "permission": "automation_rule:delete", "unavailableReason": null, "guide": "agents/automation" }, { "id": "operation.automation_rule.read", "name": "automation_rule.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read automation through farthershore automation list.", "operationClass": "operate", "permission": "automation_rule:read", "unavailableReason": null, "guide": "agents/automation" }, { "id": "operation.automation_rule.update", "name": "automation_rule.update", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write automation through farthershore automation update.", "operationClass": "operate", "permission": "automation_rule:update", "unavailableReason": null, "guide": "agents/automation" }, { "id": "operation.backend.bind", "name": "backend.bind", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write backends through farthershore backend bind.", "operationClass": "operate", "permission": "backend:bind", "unavailableReason": null, "guide": "backend/transport-modes" }, { "id": "operation.backend.create", "name": "backend.create", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write backends through farthershore backend create.", "operationClass": "operate", "permission": "backend:create", "unavailableReason": null, "guide": "backend/transport-modes" }, { "id": "operation.backend.define", "name": "backend.define", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "Declare the backend with `fs.backend()` in the business repo's business/ folder and push — the platform applies it.", "operationClass": "contract", "permission": "local_repository:write", "unavailableReason": "repo_authored", "guide": "backend/transport-modes" }, { "id": "operation.backend.delete", "name": "backend.delete", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write backends through farthershore backend delete.", "operationClass": "operate", "permission": "backend:delete", "unavailableReason": null, "guide": "backend/transport-modes" }, { "id": "operation.backend.read", "name": "backend.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read backends through farthershore backend list.", "operationClass": "operate", "permission": "backend:read", "unavailableReason": null, "guide": "backend/transport-modes" }, { "id": "operation.backend.status.read", "name": "backend.status.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "`farthershore backend list` (backend.read) already returns each backend's derived status — there is no separate status command.", "operationClass": "operate", "permission": "backend:read", "unavailableReason": "served_by_other_command", "guide": "backend/transport-modes" }, { "id": "operation.brand.update", "name": "brand.update", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write branding through farthershore business update.", "operationClass": "operate", "permission": "brand:update", "unavailableReason": null, "guide": "operations/overview" }, { "id": "operation.bulletin.ack", "name": "bulletin.ack", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write agents through farthershore bulletin ack.", "operationClass": "operate", "permission": "bulletin:ack", "unavailableReason": null, "guide": "agents/platform-agent" }, { "id": "operation.bulletin.list", "name": "bulletin.list", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read agents through farthershore bulletin list.", "operationClass": "operate", "permission": "bulletin:read", "unavailableReason": null, "guide": "agents/platform-agent" }, { "id": "operation.bulletin.read", "name": "bulletin.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read agents through farthershore bulletin show.", "operationClass": "operate", "permission": "bulletin:read", "unavailableReason": null, "guide": "agents/platform-agent" }, { "id": "operation.bulletin.resolve", "name": "bulletin.resolve", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write agents through farthershore bulletin resolve.", "operationClass": "operate", "permission": "bulletin:resolve", "unavailableReason": null, "guide": "agents/platform-agent" }, { "id": "operation.business_dependents.read", "name": "business_dependents.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read businesses through farthershore dependents list.", "operationClass": "operate", "permission": "business_dependents:read", "unavailableReason": null, "guide": "operations/overview" }, { "id": "operation.business_variable.create", "name": "business_variable.create", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write variables through farthershore variables set.", "operationClass": "operate", "permission": "business_variable:create", "unavailableReason": null, "guide": "frontend/variables" }, { "id": "operation.business_variable.delete", "name": "business_variable.delete", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write variables through farthershore variables rm.", "operationClass": "operate", "permission": "business_variable:delete", "unavailableReason": null, "guide": "frontend/variables" }, { "id": "operation.business_variable.operation.read", "name": "business_variable.operation.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read variables through farthershore variables status.", "operationClass": "operate", "permission": "business_variable:operation_read", "unavailableReason": null, "guide": "frontend/variables" }, { "id": "operation.business_variable.read", "name": "business_variable.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read variables through farthershore variables list.", "operationClass": "operate", "permission": "business_variable:read", "unavailableReason": null, "guide": "frontend/variables" }, { "id": "operation.business_variable.revoke", "name": "business_variable.revoke", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write variables through farthershore variables revoke.", "operationClass": "operate", "permission": "business_variable:revoke", "unavailableReason": null, "guide": "frontend/variables" }, { "id": "operation.business_variable.rotate", "name": "business_variable.rotate", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write variables through farthershore variables rotate.", "operationClass": "operate", "permission": "business_variable:rotate", "unavailableReason": null, "guide": "frontend/variables" }, { "id": "operation.business.compile", "name": "business.compile", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read businesses through farthershore validate.", "operationClass": "operate", "permission": "business:compile", "unavailableReason": null, "guide": "get-started/quickstart" }, { "id": "operation.business.config_attempts.read", "name": "business.config_attempts.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read businesses through farthershore business config-attempts.", "operationClass": "operate", "permission": "business:read", "unavailableReason": null, "guide": "get-started/quickstart" }, { "id": "operation.business.contract_field.update", "name": "business.contract_field.update", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "Declare the field (name / meters / subscriberChangePolicy) on `fs.business()` in the business repo's business/ folder and push — the platform applies it.", "operationClass": "contract", "permission": "local_repository:write", "unavailableReason": "repo_authored", "guide": "get-started/quickstart" }, { "id": "operation.business.contract.read", "name": "business.contract.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read businesses through farthershore business contract.", "operationClass": "contract", "permission": "business:read", "unavailableReason": null, "guide": "get-started/quickstart" }, { "id": "operation.business.cors.update", "name": "business.cors.update", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "Run `farthershore business update --allowed-origins ` (or `--clear-allowed-origins`). That shared metadata command is registered under `brand.update`.", "operationClass": "operate", "permission": "business:cors_update", "unavailableReason": "served_by_other_command", "guide": "get-started/quickstart" }, { "id": "operation.business.create", "name": "business.create", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write businesses through farthershore business create.", "operationClass": "operate", "permission": "business:create", "unavailableReason": null, "guide": "get-started/quickstart" }, { "id": "operation.business.delete", "name": "business.delete", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write businesses through farthershore business delete.", "operationClass": "operate", "permission": "business:delete", "unavailableReason": null, "guide": "get-started/quickstart" }, { "id": "operation.business.docs.disable", "name": "business.docs.disable", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write businesses through farthershore business docs disable.", "operationClass": "operate", "permission": "business:docs_update", "unavailableReason": null, "guide": "get-started/quickstart" }, { "id": "operation.business.docs.enable", "name": "business.docs.enable", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write businesses through farthershore business docs enable.", "operationClass": "operate", "permission": "business:docs_update", "unavailableReason": null, "guide": "get-started/quickstart" }, { "id": "operation.business.list", "name": "business.list", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read businesses through farthershore business list.", "operationClass": "operate", "permission": "business:read", "unavailableReason": null, "guide": "get-started/quickstart" }, { "id": "operation.business.preview_env.set", "name": "business.preview_env.set", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write businesses through farthershore business preview-env set.", "operationClass": "operate", "permission": "business:preview_env_update", "unavailableReason": null, "guide": "get-started/quickstart" }, { "id": "operation.business.publish", "name": "business.publish", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write lifecycle through farthershore business publish.", "operationClass": "operate", "permission": "business:publish", "unavailableReason": null, "guide": "get-started/quickstart" }, { "id": "operation.business.read", "name": "business.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read businesses through farthershore business show.", "operationClass": "operate", "permission": "business:read", "unavailableReason": null, "guide": "get-started/quickstart" }, { "id": "operation.business.rollback", "name": "business.rollback", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write lifecycle through farthershore business rollback.", "operationClass": "operate", "permission": "business:rollback", "unavailableReason": null, "guide": "get-started/quickstart" }, { "id": "operation.business.routes.read", "name": "business.routes.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read businesses through farthershore business routes.", "operationClass": "contract", "permission": "business:read", "unavailableReason": null, "guide": "get-started/quickstart" }, { "id": "operation.business.status", "name": "business.status", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read businesses through farthershore business status.", "operationClass": "operate", "permission": "business:read", "unavailableReason": null, "guide": "get-started/quickstart" }, { "id": "operation.business.subdomain_availability.read", "name": "business.subdomain_availability.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read businesses through farthershore business subdomain-check.", "operationClass": "operate", "permission": "business:read", "unavailableReason": null, "guide": "get-started/quickstart" }, { "id": "operation.change_set.preview", "name": "change_set.preview", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write change-sets through farthershore proposal preview.", "operationClass": "operate", "permission": "change_set:propose", "unavailableReason": null, "guide": "operate/customer-operations" }, { "id": "operation.change_set.proposal_list", "name": "change_set.proposal_list", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read change-sets through farthershore proposal list.", "operationClass": "operate", "permission": "change_set:read", "unavailableReason": null, "guide": "operate/customer-operations" }, { "id": "operation.change_set.proposal_read", "name": "change_set.proposal_read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read change-sets through farthershore proposal get.", "operationClass": "operate", "permission": "change_set:read", "unavailableReason": null, "guide": "operate/customer-operations" }, { "id": "operation.change_set.propose", "name": "change_set.propose", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write change-sets through farthershore proposal create.", "operationClass": "operate", "permission": "change_set:propose", "unavailableReason": null, "guide": "operate/customer-operations" }, { "id": "operation.consumer.block", "name": "consumer.block", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write consumers through farthershore consumer block.", "operationClass": "operate", "permission": "consumer:block", "unavailableReason": null, "guide": "operate/customer-operations" }, { "id": "operation.consumer.migrate_latest", "name": "consumer.migrate_latest", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write consumers through farthershore consumer migrate-latest.", "operationClass": "operate", "permission": "consumer:migrate_latest", "unavailableReason": null, "guide": "operate/customer-operations" }, { "id": "operation.consumer.read", "name": "consumer.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read consumers through farthershore consumer list.", "operationClass": "operate", "permission": "consumer:read", "unavailableReason": null, "guide": "operate/customer-operations" }, { "id": "operation.consumer.remove", "name": "consumer.remove", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write consumers through farthershore consumer remove.", "operationClass": "operate", "permission": "consumer:remove", "unavailableReason": null, "guide": "operate/customer-operations" }, { "id": "operation.consumer.roles.assign", "name": "consumer.roles.assign", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write consumers through farthershore consumer rbac assign.", "operationClass": "operate", "permission": "consumer:roles_assign", "unavailableReason": null, "guide": "operate/customer-operations" }, { "id": "operation.denial.read", "name": "denial.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read observability through farthershore denial show.", "operationClass": "operate", "permission": "denial:read", "unavailableReason": null, "guide": "cookbook/diagnose-denied-request" }, { "id": "operation.environment.create", "name": "environment.create", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write environments through farthershore env create.", "operationClass": "operate", "permission": "environment:create", "unavailableReason": null, "guide": "operate/environments" }, { "id": "operation.environment.delete", "name": "environment.delete", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write environments through farthershore env delete.", "operationClass": "operate", "permission": "environment:delete", "unavailableReason": null, "guide": "operate/environments" }, { "id": "operation.environment.read", "name": "environment.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read environments through farthershore env list.", "operationClass": "operate", "permission": "environment:read", "unavailableReason": null, "guide": "operate/environments" }, { "id": "operation.frontend.rollback", "name": "frontend.rollback", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write frontend through farthershore frontend rollback.", "operationClass": "operate", "permission": "frontend:rollback", "unavailableReason": null, "guide": "operate/releases" }, { "id": "operation.frontend.status", "name": "frontend.status", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read frontend through farthershore frontend status.", "operationClass": "operate", "permission": "frontend:read", "unavailableReason": null, "guide": "operate/releases" }, { "id": "operation.funding.top_up.purchase", "name": "funding.top_up.purchase", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "POST /portal/businesses/:businessId/me/balance-top-up — a signed-in subscriber with invoice:pay starts Stripe Checkout from its own portal. Use the public Frontend SDK fs.core() handoff documented in /cookbook/prepaid-credits; builder CLI and MCP credentials cannot act as the subscriber.", "operationClass": "operate", "unavailableReason": "subscriber_portal", "guide": "cookbook/prepaid-credits" }, { "id": "operation.gateway.config", "name": "gateway.config", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "Declare the gateway block on `fs.business()` in the business repo's business/ folder and push — the platform applies it.", "operationClass": "contract", "permission": "local_repository:write", "unavailableReason": "repo_authored", "guide": "gateway/overview" }, { "id": "operation.knowledge.business.read", "name": "knowledge.business.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read knowledge through farthershore knowledge business-list.", "operationClass": "operate", "permission": "knowledge:read", "unavailableReason": null, "guide": "agents/navigation" }, { "id": "operation.knowledge.guide.read", "name": "knowledge.guide.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read knowledge through farthershore knowledge list.", "operationClass": "operate", "permission": "knowledge:read", "unavailableReason": null, "guide": "agents/navigation" }, { "id": "operation.manifest.apply", "name": "manifest.apply", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "The repo pipeline applies the compiled IR on a push/release through the same neutral apply service. `farthershore validate` runs the identical verdict locally WITHOUT applying; `farthershore apply-timeline list` shows what the platform applied.", "operationClass": "contract", "permission": "local_repository:write", "unavailableReason": "git_triggered", "guide": "define/build-output" }, { "id": "operation.meter.define", "name": "meter.define", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "Declare the meter with `fs.meter()` in the business repo's business/ folder and push — the platform applies it.", "operationClass": "contract", "permission": "local_repository:write", "unavailableReason": "repo_authored", "guide": "define/meters" }, { "id": "operation.notification.preferences.read", "name": "notification.preferences.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read notifications through farthershore notifications preferences.", "operationClass": "operate", "permission": "notification:preferences_read", "unavailableReason": null, "guide": "operate/notifications" }, { "id": "operation.notification.preferences.update", "name": "notification.preferences.update", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write notifications through farthershore notifications preferences-update.", "operationClass": "operate", "permission": "notification:preferences_update", "unavailableReason": null, "guide": "operate/notifications" }, { "id": "operation.org_maker_token.approval_list", "name": "org_maker_token.approval_list", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read authentication through farthershore token approvals.", "operationClass": "operate", "permission": "maker_token:create_org", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.org_maker_token.approve", "name": "org_maker_token.approve", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write authentication through farthershore token approve.", "operationClass": "operate", "permission": "maker_token:create_org", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.org_maker_token.create", "name": "org_maker_token.create", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write authentication through farthershore token create.", "operationClass": "operate", "permission": "maker_token:create_org", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.org_maker_token.deny", "name": "org_maker_token.deny", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write authentication through farthershore token deny.", "operationClass": "operate", "permission": "maker_token:create_org", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.org_maker_token.list", "name": "org_maker_token.list", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read authentication through farthershore token list.", "operationClass": "operate", "permission": "maker_token:read", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.org_maker_token.permission_catalog.read", "name": "org_maker_token.permission_catalog.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read authentication through farthershore token permission-catalog.", "operationClass": "operate", "permission": "maker_token:read", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.org_maker_token.revoke", "name": "org_maker_token.revoke", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write authentication through farthershore token revoke.", "operationClass": "operate", "permission": "maker_token:create_org", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.org_maker_token.rotate", "name": "org_maker_token.rotate", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write authentication through farthershore token rotate.", "operationClass": "operate", "permission": "maker_token:create_org", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.org_maker_token.update", "name": "org_maker_token.update", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write authentication through farthershore token update.", "operationClass": "operate", "permission": "maker_token:create_org", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.organization.active.select", "name": "organization.active.select", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "Run `farthershore auth organization use ` to change the stored default organization, or pass `--org ` on any command for a one-off selection. The dashboard's active-organization cookie is browser-local and is not emulated.", "operationClass": "operate", "permission": "organization:read", "unavailableReason": "served_by_other_command", "guide": "operate/platform-access" }, { "id": "operation.organization.bulletin.read", "name": "organization.bulletin.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read organizations through farthershore organization bulletin.", "operationClass": "operate", "permission": "organization_bulletin:read", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.organization.create", "name": "organization.create", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write organizations through farthershore organization create.", "operationClass": "operate", "permission": "organization:create", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.organization.delete", "name": "organization.delete", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write organizations through farthershore organization delete.", "operationClass": "operate", "permission": "organization:delete", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.organization.invitation.accept", "name": "organization.invitation.accept", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write organizations through farthershore organization invitation-accept.", "operationClass": "operate", "permission": "organization_invitation:accept", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.organization.invitation.create", "name": "organization.invitation.create", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write organizations through farthershore organization invite.", "operationClass": "operate", "permission": "organization_invitation:create", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.organization.invitation.list", "name": "organization.invitation.list", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read organizations through farthershore organization invitation-list.", "operationClass": "operate", "permission": "organization_invitation:list", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.organization.invitation.list_sent", "name": "organization.invitation.list_sent", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read organizations through farthershore organization invitation-list-sent.", "operationClass": "operate", "permission": "organization_invitation:list", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.organization.invitation.revoke", "name": "organization.invitation.revoke", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write organizations through farthershore organization invitation-revoke.", "operationClass": "operate", "permission": "organization_invitation:revoke", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.organization.list", "name": "organization.list", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read organizations through farthershore organization list.", "operationClass": "operate", "permission": "organization:read", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.organization.member.list", "name": "organization.member.list", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read organizations through farthershore organization members.", "operationClass": "operate", "permission": "organization_member:list", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.organization.member.remove", "name": "organization.member.remove", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write organizations through farthershore organization member-remove.", "operationClass": "operate", "permission": "organization_member:remove", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.organization.member.update", "name": "organization.member.update", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write organizations through farthershore organization member-role.", "operationClass": "operate", "permission": "organization_member:update", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.organization.overview.read", "name": "organization.overview.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read organizations through farthershore organization overview.", "operationClass": "operate", "permission": "organization:read", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.organization.ownership.transfer", "name": "organization.ownership.transfer", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write organizations through farthershore organization ownership-transfer.", "operationClass": "operate", "permission": "organization:ownership_transfer", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.organization.role.create", "name": "organization.role.create", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write organizations through farthershore organization role create.", "operationClass": "operate", "permission": "organization_role:create", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.organization.role.delete", "name": "organization.role.delete", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write organizations through farthershore organization role delete.", "operationClass": "operate", "permission": "organization_role:delete", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.organization.role.list", "name": "organization.role.list", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read organizations through farthershore organization role list.", "operationClass": "operate", "permission": "organization_role:read", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.organization.role.show", "name": "organization.role.show", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read organizations through farthershore organization role show.", "operationClass": "operate", "permission": "organization_role:read", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.organization.role.update", "name": "organization.role.update", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write organizations through farthershore organization role update.", "operationClass": "operate", "permission": "organization_role:update", "unavailableReason": null, "guide": "operate/platform-access" }, { "id": "operation.persona.bootstrap", "name": "persona.bootstrap", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write personas through farthershore persona bootstrap.", "operationClass": "operate", "permission": "persona:issue", "unavailableReason": null, "guide": "operate/customer-operations" }, { "id": "operation.persona.delete", "name": "persona.delete", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write personas through farthershore persona delete.", "operationClass": "operate", "permission": "persona:revoke", "unavailableReason": null, "guide": "operate/customer-operations" }, { "id": "operation.persona.local_preview.issue", "name": "persona.local_preview.issue", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "Sign a persona in with `farthershore persona login` (hosted portal). This lease is CLI-process-only machinery for the localhost preview that `farthershore frontend dev|preview --live --business --env --persona` drives automatically; never call it by hand.", "operationClass": "operate", "permission": "persona:issue", "unavailableReason": "served_by_other_command", "guide": "operate/customer-operations" }, { "id": "operation.persona.local_preview.renew", "name": "persona.local_preview.renew", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "Renewed automatically by the running `farthershore frontend dev|preview --live --persona` process (CLI local-preview proxy); there is no standalone command and nothing to call by hand. Use `farthershore persona login` for hosted sign-in.", "operationClass": "operate", "permission": "persona:issue", "unavailableReason": "served_by_other_command", "guide": "operate/customer-operations" }, { "id": "operation.persona.local_preview.revoke", "name": "persona.local_preview.revoke", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "Revoked automatically when the `farthershore frontend dev|preview --live --persona` process exits; a lease otherwise expires within five minutes. Nothing to call by hand.", "operationClass": "operate", "permission": "persona:issue", "unavailableReason": "served_by_other_command", "guide": "operate/customer-operations" }, { "id": "operation.persona.login", "name": "persona.login", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write personas through farthershore persona login.", "operationClass": "operate", "permission": "persona:issue", "unavailableReason": null, "guide": "operate/customer-operations" }, { "id": "operation.persona.read", "name": "persona.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read personas through farthershore persona list.", "operationClass": "operate", "permission": "persona:read", "unavailableReason": null, "guide": "operate/customer-operations" }, { "id": "operation.persona.rotate", "name": "persona.rotate", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write personas through farthershore persona rotate.", "operationClass": "operate", "permission": "persona:rotate", "unavailableReason": null, "guide": "operate/customer-operations" }, { "id": "operation.plan.create", "name": "plan.create", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "Declare the plan with `fs.plan()` in the business repo's business/ folder and push — the platform applies it.", "operationClass": "contract", "permission": "local_repository:write", "unavailableReason": "repo_authored", "guide": "monetize/plan-changes" }, { "id": "operation.plan.delete", "name": "plan.delete", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "Declare the removal (delete the `fs.plan()` call) in the business repo's business/ folder and push — the platform applies it.", "operationClass": "contract", "permission": "local_repository:write", "unavailableReason": "repo_authored", "guide": "monetize/plan-changes" }, { "id": "operation.plan.promote", "name": "plan.promote", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "Declare the promoted plan version in the business repo's business/ folder and push — the platform applies it.", "operationClass": "contract", "permission": "local_repository:write", "unavailableReason": "repo_authored", "guide": "monetize/plan-changes" }, { "id": "operation.plan.read", "name": "plan.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read plans through farthershore plan list.", "operationClass": "contract", "permission": "plan:read", "unavailableReason": null, "guide": "monetize/plan-changes" }, { "id": "operation.plan.rollback", "name": "plan.rollback", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "Declare the prior plan shape (revert the commit) in the business repo's business/ folder and push — the platform applies it.", "operationClass": "contract", "permission": "local_repository:write", "unavailableReason": "repo_authored", "guide": "monetize/plan-changes" }, { "id": "operation.plan.update", "name": "plan.update", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "Declare the plan's new shape with `fs.plan()` in the business repo's business/ folder and push — the platform applies it.", "operationClass": "contract", "permission": "local_repository:write", "unavailableReason": "repo_authored", "guide": "monetize/plan-changes" }, { "id": "operation.plan.variant.create", "name": "plan.variant.create", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "Declare the plan variant with `fs.plan()` in the business repo's business/ folder and push — the platform applies it.", "operationClass": "contract", "permission": "local_repository:write", "unavailableReason": "repo_authored", "guide": "monetize/plan-changes" }, { "id": "operation.promo_code.archive", "name": "promo_code.archive", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write promo-codes through farthershore promo-code archive.", "operationClass": "operate", "permission": "promo_code:archive", "unavailableReason": null, "guide": "operate/customer-operations" }, { "id": "operation.promo_code.create", "name": "promo_code.create", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write promo-codes through farthershore promo-code create.", "operationClass": "operate", "permission": "promo_code:create", "unavailableReason": null, "guide": "operate/customer-operations" }, { "id": "operation.promo_code.reactivate", "name": "promo_code.reactivate", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write promo-codes through farthershore promo-code reactivate.", "operationClass": "operate", "permission": "promo_code:reactivate", "unavailableReason": null, "guide": "operate/customer-operations" }, { "id": "operation.promo_code.read", "name": "promo_code.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read promo-codes through farthershore promo-code list.", "operationClass": "operate", "permission": "promo_code:read", "unavailableReason": null, "guide": "operate/customer-operations" }, { "id": "operation.promo_code.update", "name": "promo_code.update", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write promo-codes through farthershore promo-code update.", "operationClass": "operate", "permission": "promo_code:update", "unavailableReason": null, "guide": "operate/customer-operations" }, { "id": "operation.rate_limit.update", "name": "rate_limit.update", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "Declare the limits on the plan or route in the business repo's business/ folder and push — the platform applies it.", "operationClass": "contract", "permission": "local_repository:write", "unavailableReason": "repo_authored", "guide": "operate/limits" }, { "id": "operation.rbac.disable", "name": "rbac.disable", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write businesses through farthershore business rbac disable.", "operationClass": "operate", "permission": "business:rbac_update", "unavailableReason": null, "guide": "define/team-rbac" }, { "id": "operation.rbac.enable", "name": "rbac.enable", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write businesses through farthershore business rbac enable.", "operationClass": "operate", "permission": "business:rbac_update", "unavailableReason": null, "guide": "define/team-rbac" }, { "id": "operation.rbac.read", "name": "rbac.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read products through farthershore business rbac.", "operationClass": "contract", "permission": "rbac:read", "unavailableReason": null, "guide": "define/team-rbac" }, { "id": "operation.rbac.subjects.read", "name": "rbac.subjects.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read businesses through farthershore business rbac subjects list.", "operationClass": "operate", "permission": "rbac:read", "unavailableReason": null, "guide": "define/team-rbac" }, { "id": "operation.resource_count.report", "name": "resource_count.report", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write resources through farthershore resource-count report.", "operationClass": "operate", "permission": "resource_count:report", "unavailableReason": null, "guide": "define/resources" }, { "id": "operation.route.define", "name": "route.define", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "Declare the route with `fs.route()` in the business repo's business/ folder and push — the platform applies it.", "operationClass": "contract", "permission": "local_repository:write", "unavailableReason": "repo_authored", "guide": "define/routes" }, { "id": "operation.runtime_token.mint", "name": "runtime_token.mint", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write runtime-tokens through farthershore backend tokens create.", "operationClass": "operate", "permission": "runtime_token:mint", "unavailableReason": null, "guide": "backend/runtime-tokens" }, { "id": "operation.runtime_token.read", "name": "runtime_token.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read runtime-tokens through farthershore backend tokens list.", "operationClass": "operate", "permission": "runtime_token:read", "unavailableReason": null, "guide": "backend/runtime-tokens" }, { "id": "operation.runtime_token.revoke", "name": "runtime_token.revoke", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write runtime-tokens through farthershore backend tokens revoke.", "operationClass": "operate", "permission": "runtime_token:revoke", "unavailableReason": null, "guide": "backend/runtime-tokens" }, { "id": "operation.runtime_token.rotate", "name": "runtime_token.rotate", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write runtime-tokens through farthershore backend tokens rotate.", "operationClass": "operate", "permission": "runtime_token:rotate", "unavailableReason": null, "guide": "backend/runtime-tokens" }, { "id": "operation.stripe_connection.delete", "name": "stripe_connection.delete", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write billing through farthershore stripe disconnect.", "operationClass": "operate", "permission": "stripe_connection:delete", "unavailableReason": null, "guide": "monetize/stripe" }, { "id": "operation.stripe_connection.read", "name": "stripe_connection.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read billing through farthershore stripe status.", "operationClass": "operate", "permission": "stripe_connection:read", "unavailableReason": null, "guide": "monetize/stripe" }, { "id": "operation.tax_settings.read", "name": "tax_settings.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read billing through farthershore tax-settings show.", "operationClass": "operate", "permission": "tax_settings:read", "unavailableReason": null, "guide": "monetize/stripe" }, { "id": "operation.tax_settings.update", "name": "tax_settings.update", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write billing through farthershore tax-settings update.", "operationClass": "operate", "permission": "tax_settings:update", "unavailableReason": null, "guide": "monetize/stripe" }, { "id": "operation.usage.read", "name": "usage.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read usage through farthershore usage summary.", "operationClass": "operate", "permission": "usage:read", "unavailableReason": null, "guide": "operate/usage-billing-policy" }, { "id": "operation.webhook.create", "name": "webhook.create", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write webhooks through farthershore webhook create.", "operationClass": "operate", "permission": "webhook:create", "unavailableReason": null, "guide": "define/webhooks" }, { "id": "operation.webhook.delete", "name": "webhook.delete", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write webhooks through farthershore webhook delete.", "operationClass": "operate", "permission": "webhook:delete", "unavailableReason": null, "guide": "define/webhooks" }, { "id": "operation.webhook.delivery.read", "name": "webhook.delivery.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read webhooks through farthershore webhook deliveries.", "operationClass": "operate", "permission": "webhook:delivery_read", "unavailableReason": null, "guide": "define/webhooks" }, { "id": "operation.webhook.event_type.read", "name": "webhook.event_type.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read webhooks through farthershore webhook event-types.", "operationClass": "operate", "permission": "webhook:read", "unavailableReason": null, "guide": "define/webhooks" }, { "id": "operation.webhook.listen", "name": "webhook.listen", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write webhooks through farthershore webhook listen.", "operationClass": "operate", "permission": "webhook:create", "unavailableReason": null, "guide": "define/webhooks" }, { "id": "operation.webhook.read", "name": "webhook.read", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read webhooks through farthershore webhook list.", "operationClass": "operate", "permission": "webhook:read", "unavailableReason": null, "guide": "define/webhooks" }, { "id": "operation.webhook.rotate_secret", "name": "webhook.rotate_secret", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write webhooks through farthershore webhook rotate.", "operationClass": "operate", "permission": "webhook:update", "unavailableReason": null, "guide": "define/webhooks" }, { "id": "operation.webhook.test", "name": "webhook.test", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write webhooks through farthershore webhook test.", "operationClass": "operate", "permission": "webhook:test", "unavailableReason": null, "guide": "define/webhooks" }, { "id": "operation.webhook.trigger", "name": "webhook.trigger", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write webhooks through farthershore webhook trigger.", "operationClass": "operate", "permission": "webhook:test", "unavailableReason": null, "guide": "define/webhooks" }, { "id": "operation.webhook.update", "name": "webhook.update", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "write webhooks through farthershore webhook update.", "operationClass": "operate", "permission": "webhook:update", "unavailableReason": null, "guide": "define/webhooks" }, { "id": "operation.workflow.replay", "name": "workflow.replay", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read workflows through farthershore workflow-control replay.", "operationClass": "operate", "permission": "workflow:replay", "unavailableReason": null, "guide": "operate/apply-timeline" }, { "id": "operation.workflow.rollback", "name": "workflow.rollback", "kind": "operation", "collection": "cli", "page": "generated/cli/operation-catalog", "source": "packages/contracts/src/operation-class.ts", "description": "read workflows through farthershore workflow-control rollback-to-config.", "operationClass": "operate", "permission": "workflow:rollback", "unavailableReason": null, "guide": "operate/apply-timeline" }, { "id": "rest.cancelPortalConsumerSubscription", "name": "POST /portal/businesses/{businessId}/me/cancel", "kind": "rest", "collection": "commerce", "page": "generated/commerce/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1cancel/post", "description": "Cancel the signed-in consumer's subscription", "signature": "{\n \"openapi\": {\n \"operationId\": \"cancelPortalConsumerSubscription\",\n \"summary\": \"Cancel the signed-in consumer's subscription\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Cancellation result\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"400\": {\n \"description\": \"Bad request\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"companion\": {\n \"limitation\": \"OpenAPI uses GenericObject or GenericObjectArray here and does not fully specify the HTTP contract. These are documentation placeholders, not permission to send arbitrary fields. SDK signatures describe normalized SDK inputs and outputs, not exact wire response envelopes. Source validators specify structural inputs; route authorization and semantic checks still apply.\",\n \"sdk\": {\n \"usage\": \"client.billing.cancelSubscription(...)\",\n \"signature\": \"cancelSubscription(input?: {\\n reason?: string;\\n }): Promise;\",\n \"source\": \"packages/farthershore-js/dist/resources/billing.d.ts#L13\",\n \"declarationName\": \"BillingResource\",\n \"page\": \"generated/frontend-sdk/root\",\n \"typeReferences\": [\n {\n \"name\": \"BillPreview\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1284\"\n },\n {\n \"name\": \"CancelSubscriptionResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1122\"\n },\n {\n \"name\": \"ChangePlanResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1144\"\n },\n {\n \"name\": \"RestoreSubscriptionResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1134\"\n },\n {\n \"name\": \"SpendCapResult\",\n \"source\": \"packages/farthershore-js/dist/resources/billing.d.ts#L5\"\n },\n {\n \"name\": \"Subscription\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L739\"\n }\n ]\n },\n \"requestValidator\": {\n \"name\": \"cancelSchema\",\n \"source\": \"apps/core/src/validation/portal-schemas.ts#L58\",\n \"declaration\": \"export const cancelSchema = z\\n .object({\\n organizationId: z.string().uuid().optional(),\\n reason: z.string().optional(),\\n returnUrl: z.string().url().optional(),\\n })\\n // .strict() to match the sibling portal schemas (onboarding /\\n // checkoutSession / restore / changePlan). Unknown keys are rejected\\n // so a future mass-assignment regression can't sneak in.\\n .strict();\"\n }\n }\n}\n", "guide": "commerce/overview" }, { "id": "rest.changePortalConsumerPlan", "name": "POST /portal/businesses/{businessId}/me/change-plan", "kind": "rest", "collection": "commerce", "page": "generated/commerce/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1change-plan/post", "description": "Upgrade or downgrade the signed-in consumer's plan", "signature": "{\n \"openapi\": {\n \"operationId\": \"changePortalConsumerPlan\",\n \"summary\": \"Upgrade or downgrade the signed-in consumer's plan\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"requestBody\": {\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"responses\": {\n \"200\": {\n \"description\": \"Plan change result\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"400\": {\n \"description\": \"Bad request\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"companion\": {\n \"limitation\": \"OpenAPI uses GenericObject or GenericObjectArray here and does not fully specify the HTTP contract. These are documentation placeholders, not permission to send arbitrary fields. SDK signatures describe normalized SDK inputs and outputs, not exact wire response envelopes. Source validators specify structural inputs; route authorization and semantic checks still apply.\",\n \"sdk\": {\n \"usage\": \"client.billing.changePlan(...)\",\n \"signature\": \"changePlan(input: {\\n compiledPlanId: string;\\n }): Promise;\",\n \"source\": \"packages/farthershore-js/dist/resources/billing.d.ts#L13\",\n \"declarationName\": \"BillingResource\",\n \"page\": \"generated/frontend-sdk/root\",\n \"typeReferences\": [\n {\n \"name\": \"BillPreview\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1284\"\n },\n {\n \"name\": \"CancelSubscriptionResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1122\"\n },\n {\n \"name\": \"ChangePlanResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1144\"\n },\n {\n \"name\": \"RestoreSubscriptionResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1134\"\n },\n {\n \"name\": \"SpendCapResult\",\n \"source\": \"packages/farthershore-js/dist/resources/billing.d.ts#L5\"\n },\n {\n \"name\": \"Subscription\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L739\"\n }\n ]\n },\n \"requestValidator\": {\n \"name\": \"changePlanSchema\",\n \"source\": \"apps/core/src/validation/portal-schemas.ts#L87\",\n \"declaration\": \"export const changePlanSchema = z\\n .object({\\n compiledPlanId: z.string().min(1, \\\"compiledPlanId is required\\\"),\\n organizationId: z.string().uuid().optional(),\\n })\\n .strict();\"\n },\n \"note\": \"SDK/Core mismatch: the SDK advertises successUrl and cancelUrl, but Core's strict validator does not accept those keys. Omit them. The validator below is authoritative for HTTP input; SDK result types describe normalized output, not the exact wire envelope.\"\n }\n}\n", "guide": "commerce/overview" }, { "id": "rest.createContextToken", "name": "POST /management/businesses/{businessId}/auth/context-token", "kind": "rest", "collection": "gateway", "page": "generated/gateway/http", "source": "apps/core/openapi.json#/paths/~1management~1businesses~1{businessId}~1auth~1context-token/post", "description": "Create a signed context token (fsc_) for gateway auth", "signature": "{\n \"openapi\": {\n \"operationId\": \"createContextToken\",\n \"summary\": \"Create a signed context token (fsc_) for gateway auth\",\n \"tags\": [\n \"Management Billing\"\n ],\n \"security\": [\n {\n \"browserBearerAuth\": []\n },\n {\n \"cliUserSessionBearerAuth\": []\n },\n {\n \"makerTokenAccessBearerAuth\": []\n }\n ],\n \"x-farthershore-agent-operations\": [\n \"auth.context.issue\"\n ],\n \"x-farthershore-agent-target\": {\n \"kind\": \"path\",\n \"targetKind\": \"business\",\n \"parameter\": \"businessId\"\n },\n \"x-farthershore-agent-retry\": [\n {\n \"operationKey\": \"auth.context.issue\",\n \"kind\": \"no_automatic_retry\",\n \"keyRequired\": false,\n \"enforcement\": \"reconcile_before_repeat\",\n \"responseSemantics\": \"outcome_may_be_unknown\"\n }\n ],\n \"requestBody\": {\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"responses\": {\n \"200\": {\n \"description\": \"Signed context token\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"400\": {\n \"description\": \"Bad request\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"companion\": {\n \"limitation\": \"OpenAPI uses GenericObject or GenericObjectArray here and does not fully specify the HTTP contract. These are documentation placeholders, not permission to send arbitrary fields. SDK signatures describe normalized SDK inputs and outputs, not exact wire response envelopes. Source validators specify structural inputs; route authorization and semantic checks still apply.\",\n \"requestValidator\": {\n \"name\": \"contextTokenSchema\",\n \"source\": \"apps/core/src/validation/management-billing-schemas.ts#L93\",\n \"declaration\": \"export const contextTokenSchema = z.object({\\n externalOrgId: z.string().min(1).max(255),\\n actorType: z.enum([\\\"org\\\", \\\"user\\\"]).optional(),\\n actorId: z.string().optional(),\\n ttlSeconds: z.number().int().min(60).max(86400).default(3600),\\n});\"\n },\n \"responseEvidence\": {\n \"name\": \"MintContextTokenSuccess\",\n \"source\": \"apps/core/src/services/management/mint-context-token.ts#L31\",\n \"declaration\": \"type MintContextTokenSuccess = {\\n ok: true;\\n data: { token: string; expiresAt: string };\\n};\"\n },\n \"note\": \"No public SDK method. Use the management credential context in the owning gateway guide. HTTP success is { data: { token, expiresAt } }; ok:true is an internal service discriminator and is not part of the HTTP body.\"\n }\n}\n", "guide": "backend/consume" }, { "id": "rest.createPortalBillingPortalSession", "name": "POST /portal/businesses/{businessId}/me/billing-portal-session", "kind": "rest", "collection": "commerce", "page": "generated/commerce/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1billing-portal-session/post", "description": "Create a Stripe billing portal session for subscription management", "signature": "{\n \"openapi\": {\n \"operationId\": \"createPortalBillingPortalSession\",\n \"summary\": \"Create a Stripe billing portal session for subscription management\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"requestBody\": {\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"responses\": {\n \"200\": {\n \"description\": \"Billing portal session created\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"400\": {\n \"description\": \"Bad request\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"companion\": {\n \"limitation\": \"OpenAPI uses GenericObject or GenericObjectArray here and does not fully specify the HTTP contract. These are documentation placeholders, not permission to send arbitrary fields. SDK signatures describe normalized SDK inputs and outputs, not exact wire response envelopes. Source validators specify structural inputs; route authorization and semantic checks still apply.\",\n \"sdk\": {\n \"usage\": \"client.billing.openBillingPortal(...)\",\n \"signature\": \"openBillingPortal(input?: {\\n returnUrl?: string;\\n }): Promise<{\\n url: string;\\n }>;\",\n \"source\": \"packages/farthershore-js/dist/resources/billing.d.ts#L13\",\n \"declarationName\": \"BillingResource\",\n \"page\": \"generated/frontend-sdk/root\",\n \"typeReferences\": [\n {\n \"name\": \"BillPreview\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1284\"\n },\n {\n \"name\": \"CancelSubscriptionResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1122\"\n },\n {\n \"name\": \"ChangePlanResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1144\"\n },\n {\n \"name\": \"RestoreSubscriptionResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1134\"\n },\n {\n \"name\": \"SpendCapResult\",\n \"source\": \"packages/farthershore-js/dist/resources/billing.d.ts#L5\"\n },\n {\n \"name\": \"Subscription\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L739\"\n }\n ]\n },\n \"requestValidator\": {\n \"name\": \"billingPortalSessionSchema\",\n \"source\": \"apps/core/src/validation/portal-subscription-schemas.ts#L4\",\n \"declaration\": \"export const billingPortalSessionSchema = z.object({\\n returnUrl: z.string().url().optional(),\\n});\"\n }\n }\n}\n", "guide": "commerce/overview" }, { "id": "rest.createPortalCheckoutSession", "name": "POST /portal/businesses/{businessId}/me/checkout-session", "kind": "rest", "collection": "commerce", "page": "generated/commerce/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1checkout-session/post", "description": "Create a Stripe Checkout session for the signed-in consumer", "signature": "{\n \"openapi\": {\n \"operationId\": \"createPortalCheckoutSession\",\n \"summary\": \"Create a Stripe Checkout session for the signed-in consumer\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"requestBody\": {\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"responses\": {\n \"200\": {\n \"description\": \"Checkout session created. Repeated calls with the same plan return the same `checkoutAttemptId` and provider URL.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"oneOf\": [\n {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"url\",\n \"checkoutAttemptId\"\n ],\n \"properties\": {\n \"url\": {\n \"type\": \"string\",\n \"format\": \"uri\",\n \"description\": \"Stripe Checkout session URL\"\n },\n \"checkoutAttemptId\": {\n \"type\": \"string\",\n \"description\": \"Stable id of the CheckoutAttempt row\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"required\": [\n \"subscriber\",\n \"subscription\",\n \"checkoutAttemptId\"\n ],\n \"properties\": {\n \"subscriber\": {\n \"type\": \"object\",\n \"required\": [\n \"id\",\n \"businessId\",\n \"status\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"businessId\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n }\n }\n },\n \"subscription\": {\n \"type\": [\n \"object\",\n \"null\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"compiledPlanId\": {\n \"type\": \"string\"\n },\n \"lifecycle\": {\n \"type\": \"string\"\n }\n }\n },\n \"checkoutAttemptId\": {\n \"type\": \"string\"\n },\n \"autoApiKey\": {\n \"type\": \"object\"\n },\n \"autoApiKeyError\": {\n \"type\": \"string\"\n }\n }\n }\n ],\n \"description\": \"Discriminated by `url` (paid) vs `subscriber` (free plan). Both shapes carry `checkoutAttemptId`.\"\n }\n }\n }\n },\n \"400\": {\n \"description\": \"Bad request\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"409\": {\n \"description\": \"Conflict\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"503\": {\n \"description\": \"Billing provider unavailable\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"companion\": {\n \"limitation\": \"OpenAPI uses GenericObject or GenericObjectArray here and does not fully specify the HTTP contract. These are documentation placeholders, not permission to send arbitrary fields. SDK signatures describe normalized SDK inputs and outputs, not exact wire response envelopes. Source validators specify structural inputs; route authorization and semantic checks still apply.\",\n \"sdk\": {\n \"usage\": \"client.plans.subscribe(...)\",\n \"signature\": \"subscribe(input: SubscribeInput): Promise;\",\n \"source\": \"packages/farthershore-js/dist/resources/plans.d.ts#L61\",\n \"declarationName\": \"PlansResource\",\n \"page\": \"generated/frontend-sdk/root\",\n \"typeReferences\": [\n {\n \"name\": \"OnboardingResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1104\"\n },\n {\n \"name\": \"Plan\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L127\"\n },\n {\n \"name\": \"PlanOffer__5ab47cb32b7d\",\n \"source\": \"packages/farthershore-js/dist/resources/plans.d.ts#L31\"\n },\n {\n \"name\": \"StartOnboardingInput\",\n \"source\": \"packages/farthershore-js/dist/resources/plans.d.ts#L27\"\n },\n {\n \"name\": \"SubscribeInput\",\n \"source\": \"packages/farthershore-js/dist/resources/plans.d.ts#L5\"\n },\n {\n \"name\": \"SubscribeResult\",\n \"source\": \"packages/farthershore-js/dist/resources/plans.d.ts#L44\"\n }\n ]\n },\n \"requestValidator\": {\n \"name\": \"checkoutSessionSchema\",\n \"source\": \"apps/core/src/validation/portal-schemas.ts#L35\",\n \"declaration\": \"export const checkoutSessionSchema = z\\n .object({\\n compiledPlanId: z.string().min(1, \\\"compiledPlanId is required\\\"),\\n organizationId: z.string().uuid().optional(),\\n successUrl: z.string().url().optional(),\\n cancelUrl: z.string().url().optional(),\\n // E2 (Managed Stripe Price Integrity) — OPTIONAL price-consent echo: the\\n // `offerFingerprint` from GET /me/plan-offers. When present and stale\\n // (target plan's economics changed) the route 409s PLAN_OFFER_CHANGED\\n // before any provider session is created. Absent -> legacy behavior.\\n offerFingerprint: z.string().min(1).optional(),\\n })\\n .strict();\"\n }\n }\n}\n", "guide": "commerce/overview" }, { "id": "rest.createPortalConsumerApiKey", "name": "POST /portal/businesses/{businessId}/me/api-keys", "kind": "rest", "collection": "frontend-sdk", "page": "generated/frontend-sdk/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1api-keys/post", "description": "Create a consumer-scoped API key for the signed-in user on a product portal", "signature": "{\n \"openapi\": {\n \"operationId\": \"createPortalConsumerApiKey\",\n \"summary\": \"Create a consumer-scoped API key for the signed-in user on a product portal\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"requestBody\": {\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"responses\": {\n \"201\": {\n \"description\": \"Customer API key created\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"400\": {\n \"description\": \"Bad request\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"companion\": {\n \"limitation\": \"OpenAPI uses GenericObject or GenericObjectArray here and does not fully specify the HTTP contract. These are documentation placeholders, not permission to send arbitrary fields. SDK signatures describe normalized SDK inputs and outputs, not exact wire response envelopes. Source validators specify structural inputs; route authorization and semantic checks still apply.\",\n \"sdk\": {\n \"usage\": \"client.keys.create(...)\",\n \"signature\": \"create(input?: {\\n label?: string;\\n scopes?: string[];\\n roleKeys?: string[];\\n restrictedPermissions?: string[];\\n kind?: \\\"PERSONAL\\\";\\n /** PERSONAL — mint FOR this member (their `Membership.id`); admin-gated. */\\n memberId?: string;\\n }): Promise;\",\n \"source\": \"packages/farthershore-js/dist/resources/keys.d.ts#L3\",\n \"declarationName\": \"KeysResource\",\n \"page\": \"generated/frontend-sdk/root\",\n \"typeReferences\": [\n {\n \"name\": \"ApiKey\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L347\"\n },\n {\n \"name\": \"CreatedApiKey\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L375\"\n },\n {\n \"name\": \"ServiceAccountsResource\",\n \"source\": \"packages/farthershore-js/dist/resources/keys.d.ts#L53\"\n }\n ]\n },\n \"requestValidator\": {\n \"name\": \"createConsumerApiKeySchema\",\n \"source\": \"apps/core/src/validation/portal-schemas.ts#L129\",\n \"declaration\": \"export const createConsumerApiKeySchema = z.object({\\n label: z.string().max(100, \\\"Label must be at most 100 characters\\\").optional(),\\n environment: z.enum([\\\"production\\\", \\\"sandbox\\\"]).optional(),\\n organizationId: z.string().uuid().optional(),\\n /**\\n * Phase 3 RBAC: optional scope strings restricting what the gateway will\\n * permit on this key. Empty / missing array = god-mode (the historical\\n * behaviour of every existing key). Each entry is validated against the\\n * `:` grammar in the route handler before persist\\n * — see `services/scope-matcher.ts`.\\n */\\n scopes: z.array(z.string()).max(50, \\\"At most 50 scopes per key\\\").optional(),\\n /** UA-5 — live role bindings (SubscriberBusinessRole.roleKey refs). The\\n * key's effective permission claim tracks the CURRENT role rows; role\\n * edits reach the key without reprovisioning. */\\n roleKeys: z\\n .array(z.string().min(1).max(80))\\n .max(20, \\\"At most 20 role bindings per key\\\")\\n .optional(),\\n /** UA-5 — optional Stripe-style narrowing of the bound roles' union. */\\n restrictedPermissions: z\\n .array(z.string().min(1).max(160))\\n .max(100, \\\"At most 100 restricted permissions per key\\\")\\n .optional(),\\n /**\\n * Consumer-principal (D2). Which subject the key credentials:\\n * - `PERSONAL` (default) — a member key. Self-mint binds it to the caller;\\n * passing `memberId` mints it FOR another member (admin-gated, D2a).\\n * - `SERVICE` — an org-owned service key (admin-gated). Attach to an\\n * existing account via `serviceAccountId`, or name a new one with\\n * `serviceAccountName`.\\n */\\n kind: z.enum([\\\"PERSONAL\\\", \\\"SERVICE\\\"]).optional(),\\n /** PERSONAL — the target member's stable Membership.id to bind the key to\\n * (admin-gated when it isn't the caller's own). Omit for self-mint. */\\n memberId: z.string().uuid().optional(),\\n /** SERVICE — an existing ServiceAccount.id to attach the key to. */\\n serviceAccountId: z.string().uuid().optional(),\\n /** SERVICE — name for a new ServiceAccount when `serviceAccountId` is\\n * omitted. */\\n serviceAccountName: z\\n .string()\\n .max(100, \\\"Service account name must be at most 100 characters\\\")\\n .optional(),\\n});\"\n },\n \"note\": \"Use the SDK PERSONAL-key surface. Managed service credentials use the separate serviceAccounts lifecycle; the validator alone does not authorize every key kind.\"\n }\n}\n", "guide": "reference/frontend-sdk" }, { "id": "rest.createPortalConsumerBalanceTopUp", "name": "POST /portal/businesses/{businessId}/me/balance-top-up", "kind": "rest", "collection": "commerce", "page": "generated/commerce/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1balance-top-up/post", "description": "Create a Stripe Checkout session that adds funds to the signed-in consumer's usage balance", "signature": "{\n \"openapi\": {\n \"operationId\": \"createPortalConsumerBalanceTopUp\",\n \"summary\": \"Create a Stripe Checkout session that adds funds to the signed-in consumer's usage balance\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"requestBody\": {\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"responses\": {\n \"200\": {\n \"description\": \"Balance checkout created\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"400\": {\n \"description\": \"Bad request\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"409\": {\n \"description\": \"Conflict\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"502\": {\n \"description\": \"Billing provider rejected checkout creation\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"companion\": {\n \"limitation\": \"OpenAPI uses GenericObject or GenericObjectArray here and does not fully specify the HTTP contract. These are documentation placeholders, not permission to send arbitrary fields. SDK signatures describe normalized SDK inputs and outputs, not exact wire response envelopes. Source validators specify structural inputs; route authorization and semantic checks still apply.\",\n \"requestValidator\": {\n \"name\": \"prepaidTopUpSchema\",\n \"source\": \"apps/core/src/validation/portal-schemas.ts#L108\",\n \"declaration\": \"export const prepaidTopUpSchema = z\\n .object({\\n amountCents: z.number().int().min(100).max(100_000),\\n requestId: z.string().uuid(),\\n successUrl: z.string().url().optional(),\\n cancelUrl: z.string().url().optional(),\\n })\\n .strict();\"\n },\n \"responseEvidence\": {\n \"name\": \"CreatePrepaidTopUpResult\",\n \"source\": \"apps/core/src/services/stripe/prepaid-top-up-checkout.ts#L17\",\n \"declaration\": \"export type CreatePrepaidTopUpResult =\\n | Readonly<{ ok: true; checkoutUrl: string }>\\n | Readonly<{\\n ok: false;\\n reason:\\n | \\\"amount_out_of_range\\\"\\n | \\\"subscription_or_billing_missing\\\"\\n | \\\"top_up_not_enabled\\\"\\n | \\\"policy_unresolvable\\\"\\n | \\\"stripe_error\\\";\\n message?: string;\\n }>;\"\n },\n \"note\": \"No typed resource method. A signed-in subscriber calls POST /portal/businesses/:businessId/me/balance-top-up through the public Frontend SDK fs.core() escape hatch, which supplies authentication and portal scope. POST the validator's exact JSON fields. Success is the ok:true branch with checkoutUrl; the other result branches become HTTP errors in apps/core/src/services/portal-customer/create-prepaid-top-up.ts.\"\n }\n}\n", "guide": "commerce/overview" }, { "id": "rest.createPortalConsumerGatewayToken", "name": "POST /portal/businesses/{businessId}/me/gateway-token", "kind": "rest", "collection": "gateway", "page": "generated/gateway/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1gateway-token/post", "description": "Create a short-lived gateway context token for the signed-in consumer", "signature": "{\n \"openapi\": {\n \"operationId\": \"createPortalConsumerGatewayToken\",\n \"summary\": \"Create a short-lived gateway context token for the signed-in consumer\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"requestBody\": {\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"responses\": {\n \"200\": {\n \"description\": \"Signed gateway context token\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"400\": {\n \"description\": \"Bad request\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"409\": {\n \"description\": \"Conflict\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"companion\": {\n \"limitation\": \"OpenAPI uses GenericObject or GenericObjectArray here and does not fully specify the HTTP contract. These are documentation placeholders, not permission to send arbitrary fields. SDK signatures describe normalized SDK inputs and outputs, not exact wire response envelopes. Source validators specify structural inputs; route authorization and semantic checks still apply.\",\n \"requestValidator\": {\n \"name\": \"gatewayTokenSchema\",\n \"source\": \"apps/core/src/validation/portal-schemas.ts#L124\",\n \"declaration\": \"export const gatewayTokenSchema = z.object({}).strict().default({});\"\n },\n \"responseEvidence\": {\n \"name\": \"GatewayContextToken\",\n \"source\": \"packages/farthershore-js/src/types.ts#L886\",\n \"declaration\": \"export interface GatewayContextToken {\\n /** Short-lived `fsc_` bearer accepted by the Gateway for this subscriber. */\\n token: string;\\n /** ISO timestamp when the token expires. */\\n expiresAt: string;\\n}\"\n },\n \"note\": \"The hosted SDK's client.route methods mint and cache this token automatically; there is no public manual mint method. The HTTP request body is empty and the response is { data: GatewayContextToken }. Identity comes from the authenticated session and organization context.\"\n }\n}\n", "guide": "backend/consume" }, { "id": "rest.createPortalServiceAccount", "name": "POST /portal/businesses/{businessId}/me/service-accounts", "kind": "rest", "collection": "frontend-sdk", "page": "generated/frontend-sdk/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1service-accounts/post", "description": "Create or request approval for a managed service account", "signature": "{\n \"operationId\": \"createPortalServiceAccount\",\n \"summary\": \"Create or request approval for a managed service account\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"name\": \"Idempotency-Key\",\n \"in\": \"header\",\n \"required\": false,\n \"description\": \"Stable replay key for this provisioning request.\",\n \"schema\": {\n \"type\": \"string\",\n \"minLength\": 1\n }\n }\n ],\n \"requestBody\": {\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"name\",\n \"requestedPermissions\"\n ],\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 100\n },\n \"requestedPermissions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 1,\n \"maxItems\": 100\n },\n \"scopes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"maxItems\": 50\n },\n \"usageLimit\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"quantity\",\n \"mode\"\n ],\n \"properties\": {\n \"quantity\": {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9_]{1,64}$\"\n },\n \"mode\": {\n \"type\": \"string\",\n \"enum\": [\n \"BLOCK\",\n \"NOTIFY\"\n ]\n },\n \"notifyAtPct\": {\n \"type\": \"number\",\n \"minimum\": 0.01,\n \"maximum\": 1,\n \"description\": \"Required for NOTIFY usage limits and forbidden for BLOCK.\"\n },\n \"limitUnits\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 2147483647\n },\n \"limitCents\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 2147483647\n }\n },\n \"oneOf\": [\n {\n \"required\": [\n \"quantity\",\n \"limitCents\"\n ],\n \"properties\": {\n \"quantity\": {\n \"type\": \"string\",\n \"const\": \"spend\"\n }\n },\n \"not\": {\n \"required\": [\n \"limitUnits\"\n ]\n }\n },\n {\n \"required\": [\n \"quantity\",\n \"limitUnits\"\n ],\n \"properties\": {\n \"quantity\": {\n \"type\": \"string\",\n \"not\": {\n \"const\": \"spend\"\n }\n }\n },\n \"not\": {\n \"required\": [\n \"limitCents\"\n ]\n }\n }\n ],\n \"allOf\": [\n {\n \"if\": {\n \"required\": [\n \"mode\"\n ],\n \"properties\": {\n \"mode\": {\n \"const\": \"NOTIFY\"\n }\n }\n },\n \"then\": {\n \"required\": [\n \"notifyAtPct\"\n ]\n }\n },\n {\n \"if\": {\n \"required\": [\n \"mode\"\n ],\n \"properties\": {\n \"mode\": {\n \"const\": \"BLOCK\"\n }\n }\n },\n \"then\": {\n \"not\": {\n \"required\": [\n \"notifyAtPct\"\n ]\n }\n }\n },\n {\n \"if\": {\n \"anyOf\": [\n {\n \"required\": [\n \"limitUnits\"\n ],\n \"properties\": {\n \"limitUnits\": {\n \"const\": 0\n }\n }\n },\n {\n \"required\": [\n \"limitCents\"\n ],\n \"properties\": {\n \"limitCents\": {\n \"const\": 0\n }\n }\n }\n ]\n },\n \"then\": {\n \"properties\": {\n \"mode\": {\n \"const\": \"BLOCK\"\n }\n }\n }\n }\n ]\n }\n }\n }\n }\n }\n },\n \"responses\": {\n \"201\": {\n \"description\": \"Service account created; secret returned once\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"status\",\n \"serviceAccountId\",\n \"apiKeyId\",\n \"keyPrefix\",\n \"plaintext\",\n \"requestedPermissions\",\n \"grantedPermissions\"\n ],\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"ACTIVE\"\n },\n \"serviceAccountId\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"grantedPermissions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 1,\n \"maxItems\": 100\n },\n \"apiKeyId\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"keyPrefix\": {\n \"type\": \"string\"\n },\n \"plaintext\": {\n \"type\": \"string\",\n \"writeOnly\": true\n },\n \"requestedPermissions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 1,\n \"maxItems\": 100\n }\n }\n }\n }\n }\n },\n \"202\": {\n \"description\": \"Service-account request pending approval; no secret exists\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"status\",\n \"serviceAccountId\",\n \"approvalId\",\n \"requestedPermissions\",\n \"grantedPermissions\",\n \"excessPermissions\",\n \"eligibleApproverIds\"\n ],\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"PENDING\"\n },\n \"serviceAccountId\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"approvalId\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"requestedPermissions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 1,\n \"maxItems\": 100\n },\n \"grantedPermissions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"maxItems\": 0\n },\n \"excessPermissions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"eligibleApproverIds\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n }\n },\n \"400\": {\n \"description\": \"Bad request\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"409\": {\n \"description\": \"Conflict\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"422\": {\n \"description\": \"Idempotency key was reused with a different request\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n}\n", "guide": "reference/frontend-sdk" }, { "id": "rest.createPortalUsageLimit", "name": "POST /portal/businesses/{businessId}/me/usage-limits", "kind": "rest", "collection": "frontend-sdk", "page": "generated/frontend-sdk/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1usage-limits/post", "description": "Create a subscriber-owned usage limit", "signature": "{\n \"operationId\": \"createPortalUsageLimit\",\n \"summary\": \"Create a subscriber-owned usage limit\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"requestBody\": {\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"quantity\",\n \"mode\",\n \"scope\"\n ],\n \"properties\": {\n \"quantity\": {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9_]{1,64}$\"\n },\n \"mode\": {\n \"type\": \"string\",\n \"enum\": [\n \"BLOCK\",\n \"NOTIFY\"\n ]\n },\n \"notifyAtPct\": {\n \"type\": \"number\",\n \"minimum\": 0.01,\n \"maximum\": 1,\n \"description\": \"Required for NOTIFY usage limits and forbidden for BLOCK.\"\n },\n \"limitUnits\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 2147483647\n },\n \"limitCents\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 2147483647\n },\n \"scope\": {\n \"type\": \"string\",\n \"enum\": [\n \"ORG\",\n \"MEMBER\",\n \"SERVICE_ACCOUNT\"\n ]\n },\n \"subjectId\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 128\n }\n },\n \"allOf\": [\n {\n \"oneOf\": [\n {\n \"required\": [\n \"quantity\",\n \"limitCents\"\n ],\n \"properties\": {\n \"quantity\": {\n \"type\": \"string\",\n \"const\": \"spend\"\n }\n },\n \"not\": {\n \"required\": [\n \"limitUnits\"\n ]\n }\n },\n {\n \"required\": [\n \"quantity\",\n \"limitUnits\"\n ],\n \"properties\": {\n \"quantity\": {\n \"type\": \"string\",\n \"not\": {\n \"const\": \"spend\"\n }\n }\n },\n \"not\": {\n \"required\": [\n \"limitCents\"\n ]\n }\n }\n ]\n },\n {\n \"oneOf\": [\n {\n \"required\": [\n \"scope\"\n ],\n \"properties\": {\n \"scope\": {\n \"type\": \"string\",\n \"const\": \"ORG\"\n }\n },\n \"not\": {\n \"required\": [\n \"subjectId\"\n ]\n }\n },\n {\n \"required\": [\n \"scope\",\n \"subjectId\"\n ],\n \"properties\": {\n \"scope\": {\n \"type\": \"string\",\n \"const\": \"MEMBER\"\n }\n }\n },\n {\n \"required\": [\n \"scope\",\n \"subjectId\"\n ],\n \"properties\": {\n \"scope\": {\n \"type\": \"string\",\n \"const\": \"SERVICE_ACCOUNT\"\n }\n }\n }\n ]\n },\n {\n \"if\": {\n \"required\": [\n \"mode\"\n ],\n \"properties\": {\n \"mode\": {\n \"const\": \"NOTIFY\"\n }\n }\n },\n \"then\": {\n \"required\": [\n \"notifyAtPct\"\n ]\n }\n },\n {\n \"if\": {\n \"required\": [\n \"mode\"\n ],\n \"properties\": {\n \"mode\": {\n \"const\": \"BLOCK\"\n }\n }\n },\n \"then\": {\n \"not\": {\n \"required\": [\n \"notifyAtPct\"\n ]\n }\n }\n },\n {\n \"if\": {\n \"anyOf\": [\n {\n \"required\": [\n \"limitUnits\"\n ],\n \"properties\": {\n \"limitUnits\": {\n \"const\": 0\n }\n }\n },\n {\n \"required\": [\n \"limitCents\"\n ],\n \"properties\": {\n \"limitCents\": {\n \"const\": 0\n }\n }\n }\n ]\n },\n \"then\": {\n \"properties\": {\n \"mode\": {\n \"const\": \"BLOCK\"\n }\n }\n }\n }\n ]\n }\n }\n }\n },\n \"responses\": {\n \"201\": {\n \"description\": \"Usage limit created\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"quantity\",\n \"mode\",\n \"period\",\n \"createdBy\",\n \"createdAt\",\n \"updatedAt\",\n \"scope\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"quantity\": {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9_]{1,64}$\"\n },\n \"mode\": {\n \"type\": \"string\",\n \"enum\": [\n \"BLOCK\",\n \"NOTIFY\"\n ]\n },\n \"notifyAtPct\": {\n \"type\": \"number\",\n \"minimum\": 0.01,\n \"maximum\": 1,\n \"description\": \"Required for NOTIFY usage limits and forbidden for BLOCK.\"\n },\n \"limitUnits\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 2147483647\n },\n \"limitCents\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 2147483647\n },\n \"scope\": {\n \"type\": \"string\",\n \"enum\": [\n \"ORG\",\n \"MEMBER\",\n \"SERVICE_ACCOUNT\"\n ]\n },\n \"subjectId\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 128\n },\n \"period\": {\n \"type\": \"string\",\n \"const\": \"BILLING_PERIOD\"\n },\n \"ceiling\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"limitUnits\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"limitCents\": {\n \"type\": \"integer\",\n \"minimum\": 0\n }\n },\n \"description\": \"The builder's own per-billing-period ceiling on this quantity, when the plan declares one. Read-only.\"\n },\n \"effectiveWindow\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"strategy\",\n \"periodSeconds\"\n ],\n \"properties\": {\n \"strategy\": {\n \"type\": \"string\",\n \"enum\": [\n \"fixed_window\",\n \"sliding_window\"\n ]\n },\n \"periodSeconds\": {\n \"type\": \"integer\",\n \"minimum\": 1\n }\n },\n \"description\": \"Read-only: how the limit is accounted at the edge. `sliding_window` means the ceiling is a rolling horizon of `periodSeconds` rather than one that resets at the billing-period boundary. Builder-owned; not writable.\"\n },\n \"createdBy\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"updatedAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n }\n },\n \"allOf\": [\n {\n \"oneOf\": [\n {\n \"required\": [\n \"quantity\",\n \"limitCents\"\n ],\n \"properties\": {\n \"quantity\": {\n \"type\": \"string\",\n \"const\": \"spend\"\n }\n },\n \"not\": {\n \"required\": [\n \"limitUnits\"\n ]\n }\n },\n {\n \"required\": [\n \"quantity\",\n \"limitUnits\"\n ],\n \"properties\": {\n \"quantity\": {\n \"type\": \"string\",\n \"not\": {\n \"const\": \"spend\"\n }\n }\n },\n \"not\": {\n \"required\": [\n \"limitCents\"\n ]\n }\n }\n ]\n },\n {\n \"oneOf\": [\n {\n \"required\": [\n \"scope\"\n ],\n \"properties\": {\n \"scope\": {\n \"type\": \"string\",\n \"const\": \"ORG\"\n }\n },\n \"not\": {\n \"required\": [\n \"subjectId\"\n ]\n }\n },\n {\n \"required\": [\n \"scope\",\n \"subjectId\"\n ],\n \"properties\": {\n \"scope\": {\n \"type\": \"string\",\n \"const\": \"MEMBER\"\n }\n }\n },\n {\n \"required\": [\n \"scope\",\n \"subjectId\"\n ],\n \"properties\": {\n \"scope\": {\n \"type\": \"string\",\n \"const\": \"SERVICE_ACCOUNT\"\n }\n }\n }\n ]\n },\n {\n \"if\": {\n \"required\": [\n \"mode\"\n ],\n \"properties\": {\n \"mode\": {\n \"const\": \"NOTIFY\"\n }\n }\n },\n \"then\": {\n \"required\": [\n \"notifyAtPct\"\n ]\n }\n },\n {\n \"if\": {\n \"required\": [\n \"mode\"\n ],\n \"properties\": {\n \"mode\": {\n \"const\": \"BLOCK\"\n }\n }\n },\n \"then\": {\n \"not\": {\n \"required\": [\n \"notifyAtPct\"\n ]\n }\n }\n },\n {\n \"if\": {\n \"anyOf\": [\n {\n \"required\": [\n \"limitUnits\"\n ],\n \"properties\": {\n \"limitUnits\": {\n \"const\": 0\n }\n }\n },\n {\n \"required\": [\n \"limitCents\"\n ],\n \"properties\": {\n \"limitCents\": {\n \"const\": 0\n }\n }\n }\n ]\n },\n \"then\": {\n \"properties\": {\n \"mode\": {\n \"const\": \"BLOCK\"\n }\n }\n }\n }\n ]\n }\n }\n }\n },\n \"400\": {\n \"description\": \"Bad request\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"409\": {\n \"description\": \"Conflict\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n}\n", "guide": "reference/frontend-sdk" }, { "id": "rest.deletePortalUsageLimit", "name": "DELETE /portal/businesses/{businessId}/me/usage-limits/{limitId}", "kind": "rest", "collection": "frontend-sdk", "page": "generated/frontend-sdk/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1usage-limits~1{limitId}/delete", "description": "Delete a subscriber-owned usage limit", "signature": "{\n \"operationId\": \"deletePortalUsageLimit\",\n \"summary\": \"Delete a subscriber-owned usage limit\",\n \"description\": \"Deletes a usage-limit row across the subscription. This is an all-mutation operation and requires subscription-wide usage_limit:delete authority, not just own-row read authority.\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"name\": \"limitId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Usage-limit identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Usage limit deleted\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"deleted\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"deleted\": {\n \"type\": \"boolean\",\n \"const\": true\n }\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n}\n", "guide": "reference/frontend-sdk" }, { "id": "rest.getPortalConsumerBillPreview", "name": "GET /portal/businesses/{businessId}/me/bill-preview", "kind": "rest", "collection": "commerce", "page": "generated/commerce/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1bill-preview/get", "description": "Return the signed-in consumer's current-window bill preview, computed through the same rating engine and ledger state as invoicing", "signature": "{\n \"openapi\": {\n \"operationId\": \"getPortalConsumerBillPreview\",\n \"summary\": \"Return the signed-in consumer's current-window bill preview, computed through the same rating engine and ledger state as invoicing\",\n \"description\": \"Requires `invoice:read` — the preview carries the plan fee and every rating window, so it is gated exactly like the invoice surface it previews. A caller with no subscription receives the constant empty preview (200), never a 403, so the status code does not disclose whether the organization has a subscription.\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Bill preview. `disclosure: \\\"transparent\\\"` → `{ currency, disclosure, recurringFeeCents, windows: [{ windowId, windowStart, windowEnd, chargeCount, ratedNanos }], totals: { ratedNanos, fundedNanos, receivableNanos }, allowances: [{ kind, state, remainingNanos, heldNanos, consumedNanos, expiresAt }], usageRating: { pendingEventCount, unratableEventCount, oldestUnratedServedAt } }`. `totals` sums POSTED charges only, so `usageRating` states the served usage those totals CANNOT include — usage still awaiting rating (`pendingEventCount`, drains on its own) that reached a TERMINAL quarantine and will never be priced (`unratableEventCount`; bookkeeping-only quarantine families such as a retry repair are excluded, so this is the same number the builder-plane `usage summary` reports for the same traffic). All-zero counts mean the totals are the whole bill; a client must not present a `$0` total as final while either count is non-zero. `disclosure: \\\"opaque\\\"` (authored opaque, or the served release's policy cannot be resolved — disclosure fails closed) → `{ currency, disclosure, recurringFeeCents, allowances: [{ kind, state, expiresAt, display }] }` where `display` is the plan-authored `{ kind: \\\"multiplier\\\", allowanceUnits, remainingUnits, consumedUnits }` or `{ kind: \\\"fraction\\\", consumedBasisPoints, remainingBasisPoints }` — never windows, totals, or nanodollar amounts.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"companion\": {\n \"limitation\": \"OpenAPI uses GenericObject or GenericObjectArray here and does not fully specify the HTTP contract. These are documentation placeholders, not permission to send arbitrary fields. SDK signatures describe normalized SDK inputs and outputs, not exact wire response envelopes. Source validators specify structural inputs; route authorization and semantic checks still apply.\",\n \"sdk\": {\n \"usage\": \"client.billing.getBillPreview(...)\",\n \"signature\": \"getBillPreview(opts?: {\\n signal?: AbortSignal;\\n }): Promise;\",\n \"source\": \"packages/farthershore-js/dist/resources/billing.d.ts#L13\",\n \"declarationName\": \"BillingResource\",\n \"page\": \"generated/frontend-sdk/root\",\n \"typeReferences\": [\n {\n \"name\": \"BillPreview\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1284\"\n },\n {\n \"name\": \"CancelSubscriptionResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1122\"\n },\n {\n \"name\": \"ChangePlanResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1144\"\n },\n {\n \"name\": \"RestoreSubscriptionResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1134\"\n },\n {\n \"name\": \"SpendCapResult\",\n \"source\": \"packages/farthershore-js/dist/resources/billing.d.ts#L5\"\n },\n {\n \"name\": \"Subscription\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L739\"\n }\n ]\n }\n }\n}\n", "guide": "commerce/overview" }, { "id": "rest.getPortalConsumerContext", "name": "GET /portal/businesses/{businessId}/me", "kind": "rest", "collection": "frontend-sdk", "page": "generated/frontend-sdk/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me/get", "description": "Return the signed-in consumer context for a product portal", "signature": "{\n \"openapi\": {\n \"operationId\": \"getPortalConsumerContext\",\n \"summary\": \"Return the signed-in consumer context for a product portal\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Consumer portal context. authSession is null except for a trusted site-shell cookie-authenticated test-persona session, where it contains only kind, personaId, userId, organizationId, displayName, and expiresAt (never a token, JWT ID, or raw claims).\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"allOf\": [\n {\n \"type\": \"object\",\n \"additionalProperties\": true\n },\n {\n \"type\": \"object\",\n \"required\": [\n \"authSession\"\n ],\n \"properties\": {\n \"authSession\": {\n \"oneOf\": [\n {\n \"type\": \"null\"\n },\n {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"kind\",\n \"personaId\",\n \"userId\",\n \"organizationId\",\n \"displayName\",\n \"expiresAt\"\n ],\n \"properties\": {\n \"kind\": {\n \"const\": \"test-persona\"\n },\n \"personaId\": {\n \"type\": \"string\"\n },\n \"userId\": {\n \"type\": \"string\"\n },\n \"organizationId\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"displayName\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"expiresAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n }\n }\n }\n ]\n }\n }\n }\n ]\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"companion\": {\n \"limitation\": \"OpenAPI uses GenericObject or GenericObjectArray here and does not fully specify the HTTP contract. These are documentation placeholders, not permission to send arbitrary fields. SDK signatures describe normalized SDK inputs and outputs, not exact wire response envelopes. Source validators specify structural inputs; route authorization and semantic checks still apply.\",\n \"sdk\": {\n \"usage\": \"client.me(...)\",\n \"signature\": \"me(opts?: {\\n signal?: AbortSignal;\\n /** `null` omits the organization header without changing the shared\\n * client selection; `undefined` uses that selection. */\\n organizationId?: string | null;\\n }): Promise;\",\n \"source\": \"packages/farthershore-js/dist/client.d.ts#L36\",\n \"declarationName\": \"FartherShoreClient\",\n \"page\": \"generated/frontend-sdk/root\",\n \"typeReferences\": [\n {\n \"name\": \"AuditLogsResource\",\n \"source\": \"packages/farthershore-js/dist/resources/account.d.ts#L142\"\n },\n {\n \"name\": \"AuthResource\",\n \"source\": \"packages/farthershore-js/dist/resources/auth.d.ts#L3\"\n },\n {\n \"name\": \"BillingResource\",\n \"source\": \"packages/farthershore-js/dist/resources/billing.d.ts#L13\"\n },\n {\n \"name\": \"Bootstrap\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L294\"\n },\n {\n \"name\": \"BusinessResource\",\n \"source\": \"packages/farthershore-js/dist/resources/business.d.ts#L2\"\n },\n {\n \"name\": \"ClientContext__d9dbf3313290\",\n \"source\": \"packages/farthershore-js/dist/config.d.ts#L183\"\n },\n {\n \"name\": \"CoreRequest\",\n \"source\": \"packages/farthershore-js/dist/http.d.ts#L3\"\n },\n {\n \"name\": \"EntitlementsResource\",\n \"source\": \"packages/farthershore-js/dist/resources/entitlements.d.ts#L16\"\n },\n {\n \"name\": \"FartherShoreApiError\",\n \"source\": \"packages/farthershore-js/dist/errors/index.d.ts#L49\"\n },\n {\n \"name\": \"KeysResource\",\n \"source\": \"packages/farthershore-js/dist/resources/keys.d.ts#L3\"\n },\n {\n \"name\": \"LegalAcceptance__cc2291cc0442\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L80\"\n },\n {\n \"name\": \"ManagedIntegration\",\n \"source\": \"packages/farthershore-js/dist/integrations.d.ts#L6\"\n },\n {\n \"name\": \"NotificationsResource\",\n \"source\": \"packages/farthershore-js/dist/resources/account.d.ts#L169\"\n },\n {\n \"name\": \"ObservedLimitDeny__ff379deca309\",\n \"source\": \"packages/farthershore-js/dist/errors/index.d.ts#L580\"\n },\n {\n \"name\": \"OrganizationsResource\",\n \"source\": \"packages/farthershore-js/dist/resources/account.d.ts#L3\"\n },\n {\n \"name\": \"PlansResource\",\n \"source\": \"packages/farthershore-js/dist/resources/plans.d.ts#L61\"\n },\n {\n \"name\": \"PrefetchSurface__2b22bd2b6c45\",\n \"source\": \"packages/farthershore-js/dist/client.d.ts#L24\"\n },\n {\n \"name\": \"RateLimitSnapshot__934527ed940b\",\n \"source\": \"packages/farthershore-js/dist/errors/index.d.ts#L8\"\n },\n {\n \"name\": \"RbacResource\",\n \"source\": \"packages/farthershore-js/dist/resources/account.d.ts#L65\"\n },\n {\n \"name\": \"ResourcesResource\",\n \"source\": \"packages/farthershore-js/dist/resources/resources.d.ts#L25\"\n },\n {\n \"name\": \"RouteResource\",\n \"source\": \"packages/farthershore-js/dist/resources/route.d.ts#L15\"\n },\n {\n \"name\": \"SubscriberContext\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L897\"\n },\n {\n \"name\": \"TeamResource\",\n \"source\": \"packages/farthershore-js/dist/resources/account.d.ts#L13\"\n },\n {\n \"name\": \"UsageLimitsResource\",\n \"source\": \"packages/farthershore-js/dist/resources/usage-limits.d.ts#L3\"\n },\n {\n \"name\": \"UsageResource\",\n \"source\": \"packages/farthershore-js/dist/resources/usage.d.ts#L7\"\n }\n ]\n }\n }\n}\n", "guide": "reference/frontend-sdk" }, { "id": "rest.getPortalConsumerResourceCount", "name": "GET /portal/businesses/{businessId}/me/resources/{resource}/count", "kind": "rest", "collection": "frontend-sdk", "page": "generated/frontend-sdk/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1resources~1{resource}~1count/get", "description": "Return the authoritative { count, cap } for one declared counted resource on the signed-in consumer's subscription", "signature": "{\n \"openapi\": {\n \"operationId\": \"getPortalConsumerResourceCount\",\n \"summary\": \"Return the authoritative { count, cap } for one declared counted resource on the signed-in consumer's subscription\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"name\": \"resource\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"The declared counted-resource name.\",\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"name\": \"subjectId\",\n \"in\": \"query\",\n \"required\": false,\n \"description\": \"For subject-scoped resources: the subject id the count keys on.\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Authoritative resource usage — `{ count, cap }`; `cap` is null when uncapped. Empty subscription → `{ count: 0, cap: null }`.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"companion\": {\n \"limitation\": \"OpenAPI uses GenericObject or GenericObjectArray here and does not fully specify the HTTP contract. These are documentation placeholders, not permission to send arbitrary fields. SDK signatures describe normalized SDK inputs and outputs, not exact wire response envelopes. Source validators specify structural inputs; route authorization and semantic checks still apply.\",\n \"responseEvidence\": {\n \"name\": \"ResourceUsage\",\n \"source\": \"apps/core/src/services/resource-counts/resource-usage-service.ts#L35\",\n \"declaration\": \"export type ResourceUsage = { count: number; cap: number | null };\"\n },\n \"note\": \"No typed SDK method for this HTTP read. Use the documented GET path and subjectId query parameter; there is no request body. ResourceUsage is the response body.\"\n }\n}\n", "guide": "reference/frontend-sdk" }, { "id": "rest.getPortalConsumerResourceLimitUsage", "name": "GET /portal/businesses/{businessId}/me/resource-limit-usage", "kind": "rest", "collection": "frontend-sdk", "page": "generated/frontend-sdk/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1resource-limit-usage/get", "description": "Return per-resource { limit, current } usage for the signed-in consumer's pinned plan", "signature": "{\n \"openapi\": {\n \"operationId\": \"getPortalConsumerResourceLimitUsage\",\n \"summary\": \"Return per-resource { limit, current } usage for the signed-in consumer's pinned plan\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Per-resource limit usage map — `{ [resourceKey]: { limit, current } }`; resources the plan doesn't declare are absent (= unlimited)\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"companion\": {\n \"limitation\": \"OpenAPI uses GenericObject or GenericObjectArray here and does not fully specify the HTTP contract. These are documentation placeholders, not permission to send arbitrary fields. SDK signatures describe normalized SDK inputs and outputs, not exact wire response envelopes. Source validators specify structural inputs; route authorization and semantic checks still apply.\",\n \"sdk\": {\n \"usage\": \"client.entitlements.resourceLimitUsage(...)\",\n \"signature\": \"resourceLimitUsage(): Promise;\",\n \"source\": \"packages/farthershore-js/dist/resources/entitlements.d.ts#L16\",\n \"declarationName\": \"EntitlementsResource\",\n \"page\": \"generated/frontend-sdk/root\",\n \"typeReferences\": [\n {\n \"name\": \"EntitlementSnapshot\",\n \"source\": \"packages/farthershore-js/dist/resources/entitlements.d.ts#L3\"\n },\n {\n \"name\": \"ResourceLimitUsageMap\",\n \"source\": \"packages/farthershore-js/dist/resources/entitlements.d.ts#L15\"\n }\n ]\n }\n }\n}\n", "guide": "reference/frontend-sdk" }, { "id": "rest.getPortalConsumerSubscription", "name": "GET /portal/businesses/{businessId}/me/subscription", "kind": "rest", "collection": "commerce", "page": "generated/commerce/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1subscription/get", "description": "Get subscription details for the signed-in consumer", "signature": "{\n \"openapi\": {\n \"operationId\": \"getPortalConsumerSubscription\",\n \"summary\": \"Get subscription details for the signed-in consumer\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Subscription details\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"companion\": {\n \"limitation\": \"OpenAPI uses GenericObject or GenericObjectArray here and does not fully specify the HTTP contract. These are documentation placeholders, not permission to send arbitrary fields. SDK signatures describe normalized SDK inputs and outputs, not exact wire response envelopes. Source validators specify structural inputs; route authorization and semantic checks still apply.\",\n \"sdk\": {\n \"usage\": \"client.billing.subscription(...)\",\n \"signature\": \"subscription(opts?: {\\n signal?: AbortSignal;\\n }): Promise;\",\n \"source\": \"packages/farthershore-js/dist/resources/billing.d.ts#L13\",\n \"declarationName\": \"BillingResource\",\n \"page\": \"generated/frontend-sdk/root\",\n \"typeReferences\": [\n {\n \"name\": \"BillPreview\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1284\"\n },\n {\n \"name\": \"CancelSubscriptionResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1122\"\n },\n {\n \"name\": \"ChangePlanResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1144\"\n },\n {\n \"name\": \"RestoreSubscriptionResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1134\"\n },\n {\n \"name\": \"SpendCapResult\",\n \"source\": \"packages/farthershore-js/dist/resources/billing.d.ts#L5\"\n },\n {\n \"name\": \"Subscription\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L739\"\n }\n ]\n }\n }\n}\n", "guide": "commerce/overview" }, { "id": "rest.getPortalConsumerUsage", "name": "GET /portal/businesses/{businessId}/me/usage", "kind": "rest", "collection": "frontend-sdk", "page": "generated/frontend-sdk/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1usage/get", "description": "Return usage for the signed-in consumer on a product portal", "signature": "{\n \"openapi\": {\n \"operationId\": \"getPortalConsumerUsage\",\n \"summary\": \"Return usage for the signed-in consumer on a product portal\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Customer usage summary\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"companion\": {\n \"limitation\": \"OpenAPI uses GenericObject or GenericObjectArray here and does not fully specify the HTTP contract. These are documentation placeholders, not permission to send arbitrary fields. SDK signatures describe normalized SDK inputs and outputs, not exact wire response envelopes. Source validators specify structural inputs; route authorization and semantic checks still apply.\",\n \"sdk\": {\n \"usage\": \"client.usage.snapshot(...)\",\n \"signature\": \"snapshot(range?: UsageRange, opts?: {\\n signal?: AbortSignal;\\n includeEvents?: boolean;\\n }): Promise;\",\n \"source\": \"packages/farthershore-js/dist/resources/usage.d.ts#L7\",\n \"declarationName\": \"UsageResource\",\n \"page\": \"generated/frontend-sdk/root\",\n \"typeReferences\": [\n {\n \"name\": \"UsageEvent\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L679\"\n },\n {\n \"name\": \"UsageRange\",\n \"source\": \"packages/farthershore-js/dist/resources/usage.d.ts#L3\"\n },\n {\n \"name\": \"UsageSnapshot\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L701\"\n },\n {\n \"name\": \"UsageSummary\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L645\"\n }\n ]\n }\n }\n}\n", "guide": "reference/frontend-sdk" }, { "id": "rest.getPortalUsageLimit", "name": "GET /portal/businesses/{businessId}/me/usage-limits/{limitId}", "kind": "rest", "collection": "frontend-sdk", "page": "generated/frontend-sdk/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1usage-limits~1{limitId}/get", "description": "Get one subscriber-owned usage limit", "signature": "{\n \"operationId\": \"getPortalUsageLimit\",\n \"summary\": \"Get one subscriber-owned usage limit\",\n \"description\": \"Requires usage_limit:read. Without subscription-wide mutation authority, members can fetch organization limits and their own member limit rows only; other members' rows return 404.\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"name\": \"limitId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Usage-limit identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Usage limit\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"quantity\",\n \"mode\",\n \"period\",\n \"createdBy\",\n \"createdAt\",\n \"updatedAt\",\n \"scope\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"quantity\": {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9_]{1,64}$\"\n },\n \"mode\": {\n \"type\": \"string\",\n \"enum\": [\n \"BLOCK\",\n \"NOTIFY\"\n ]\n },\n \"notifyAtPct\": {\n \"type\": \"number\",\n \"minimum\": 0.01,\n \"maximum\": 1,\n \"description\": \"Required for NOTIFY usage limits and forbidden for BLOCK.\"\n },\n \"limitUnits\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 2147483647\n },\n \"limitCents\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 2147483647\n },\n \"scope\": {\n \"type\": \"string\",\n \"enum\": [\n \"ORG\",\n \"MEMBER\",\n \"SERVICE_ACCOUNT\"\n ]\n },\n \"subjectId\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 128\n },\n \"period\": {\n \"type\": \"string\",\n \"const\": \"BILLING_PERIOD\"\n },\n \"ceiling\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"limitUnits\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"limitCents\": {\n \"type\": \"integer\",\n \"minimum\": 0\n }\n },\n \"description\": \"The builder's own per-billing-period ceiling on this quantity, when the plan declares one. Read-only.\"\n },\n \"effectiveWindow\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"strategy\",\n \"periodSeconds\"\n ],\n \"properties\": {\n \"strategy\": {\n \"type\": \"string\",\n \"enum\": [\n \"fixed_window\",\n \"sliding_window\"\n ]\n },\n \"periodSeconds\": {\n \"type\": \"integer\",\n \"minimum\": 1\n }\n },\n \"description\": \"Read-only: how the limit is accounted at the edge. `sliding_window` means the ceiling is a rolling horizon of `periodSeconds` rather than one that resets at the billing-period boundary. Builder-owned; not writable.\"\n },\n \"createdBy\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"updatedAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n }\n },\n \"allOf\": [\n {\n \"oneOf\": [\n {\n \"required\": [\n \"quantity\",\n \"limitCents\"\n ],\n \"properties\": {\n \"quantity\": {\n \"type\": \"string\",\n \"const\": \"spend\"\n }\n },\n \"not\": {\n \"required\": [\n \"limitUnits\"\n ]\n }\n },\n {\n \"required\": [\n \"quantity\",\n \"limitUnits\"\n ],\n \"properties\": {\n \"quantity\": {\n \"type\": \"string\",\n \"not\": {\n \"const\": \"spend\"\n }\n }\n },\n \"not\": {\n \"required\": [\n \"limitCents\"\n ]\n }\n }\n ]\n },\n {\n \"oneOf\": [\n {\n \"required\": [\n \"scope\"\n ],\n \"properties\": {\n \"scope\": {\n \"type\": \"string\",\n \"const\": \"ORG\"\n }\n },\n \"not\": {\n \"required\": [\n \"subjectId\"\n ]\n }\n },\n {\n \"required\": [\n \"scope\",\n \"subjectId\"\n ],\n \"properties\": {\n \"scope\": {\n \"type\": \"string\",\n \"const\": \"MEMBER\"\n }\n }\n },\n {\n \"required\": [\n \"scope\",\n \"subjectId\"\n ],\n \"properties\": {\n \"scope\": {\n \"type\": \"string\",\n \"const\": \"SERVICE_ACCOUNT\"\n }\n }\n }\n ]\n },\n {\n \"if\": {\n \"required\": [\n \"mode\"\n ],\n \"properties\": {\n \"mode\": {\n \"const\": \"NOTIFY\"\n }\n }\n },\n \"then\": {\n \"required\": [\n \"notifyAtPct\"\n ]\n }\n },\n {\n \"if\": {\n \"required\": [\n \"mode\"\n ],\n \"properties\": {\n \"mode\": {\n \"const\": \"BLOCK\"\n }\n }\n },\n \"then\": {\n \"not\": {\n \"required\": [\n \"notifyAtPct\"\n ]\n }\n }\n },\n {\n \"if\": {\n \"anyOf\": [\n {\n \"required\": [\n \"limitUnits\"\n ],\n \"properties\": {\n \"limitUnits\": {\n \"const\": 0\n }\n }\n },\n {\n \"required\": [\n \"limitCents\"\n ],\n \"properties\": {\n \"limitCents\": {\n \"const\": 0\n }\n }\n }\n ]\n },\n \"then\": {\n \"properties\": {\n \"mode\": {\n \"const\": \"BLOCK\"\n }\n }\n }\n }\n ]\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n}\n", "guide": "reference/frontend-sdk" }, { "id": "rest.listPortalConsumerApiKeys", "name": "GET /portal/businesses/{businessId}/me/api-keys", "kind": "rest", "collection": "frontend-sdk", "page": "generated/frontend-sdk/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1api-keys/get", "description": "List consumer-scoped API keys for the signed-in user on a product portal", "signature": "{\n \"openapi\": {\n \"operationId\": \"listPortalConsumerApiKeys\",\n \"summary\": \"List consumer-scoped API keys for the signed-in user on a product portal\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Customer API keys\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"companion\": {\n \"limitation\": \"OpenAPI uses GenericObject or GenericObjectArray here and does not fully specify the HTTP contract. These are documentation placeholders, not permission to send arbitrary fields. SDK signatures describe normalized SDK inputs and outputs, not exact wire response envelopes. Source validators specify structural inputs; route authorization and semantic checks still apply.\",\n \"sdk\": {\n \"usage\": \"client.keys.list(...)\",\n \"signature\": \"list(opts?: {\\n signal?: AbortSignal;\\n }): Promise;\",\n \"source\": \"packages/farthershore-js/dist/resources/keys.d.ts#L3\",\n \"declarationName\": \"KeysResource\",\n \"page\": \"generated/frontend-sdk/root\",\n \"typeReferences\": [\n {\n \"name\": \"ApiKey\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L347\"\n },\n {\n \"name\": \"CreatedApiKey\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L375\"\n },\n {\n \"name\": \"ServiceAccountsResource\",\n \"source\": \"packages/farthershore-js/dist/resources/keys.d.ts#L53\"\n }\n ]\n }\n }\n}\n", "guide": "reference/frontend-sdk" }, { "id": "rest.listPortalConsumerPlanOffers", "name": "GET /portal/businesses/{businessId}/me/plan-offers", "kind": "rest", "collection": "commerce", "page": "generated/commerce/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1plan-offers/get", "description": "List the purchasable plan offers (plan + offerFingerprint) for the signed-in consumer, including the current pinned plan version", "signature": "{\n \"openapi\": {\n \"operationId\": \"listPortalConsumerPlanOffers\",\n \"summary\": \"List the purchasable plan offers (plan + offerFingerprint) for the signed-in consumer, including the current pinned plan version\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Plan offers — `[{ compiledPlanId, plan, offerFingerprint }]`. `offerFingerprint` is the billing fingerprint of that CompiledPlan version; echo it back as `offerFingerprint` on checkout/onboarding to get a 409 PLAN_OFFER_CHANGED if the plan's economics changed since render.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"companion\": {\n \"limitation\": \"OpenAPI uses GenericObject or GenericObjectArray here and does not fully specify the HTTP contract. These are documentation placeholders, not permission to send arbitrary fields. SDK signatures describe normalized SDK inputs and outputs, not exact wire response envelopes. Source validators specify structural inputs; route authorization and semantic checks still apply.\",\n \"sdk\": {\n \"usage\": \"client.plans.getPlanOffers(...)\",\n \"signature\": \"getPlanOffers(): Promise;\",\n \"source\": \"packages/farthershore-js/dist/resources/plans.d.ts#L61\",\n \"declarationName\": \"PlansResource\",\n \"page\": \"generated/frontend-sdk/root\",\n \"typeReferences\": [\n {\n \"name\": \"OnboardingResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1104\"\n },\n {\n \"name\": \"Plan\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L127\"\n },\n {\n \"name\": \"PlanOffer__5ab47cb32b7d\",\n \"source\": \"packages/farthershore-js/dist/resources/plans.d.ts#L31\"\n },\n {\n \"name\": \"StartOnboardingInput\",\n \"source\": \"packages/farthershore-js/dist/resources/plans.d.ts#L27\"\n },\n {\n \"name\": \"SubscribeInput\",\n \"source\": \"packages/farthershore-js/dist/resources/plans.d.ts#L5\"\n },\n {\n \"name\": \"SubscribeResult\",\n \"source\": \"packages/farthershore-js/dist/resources/plans.d.ts#L44\"\n }\n ]\n }\n }\n}\n", "guide": "commerce/overview" }, { "id": "rest.listPortalServiceAccounts", "name": "GET /portal/businesses/{businessId}/me/service-accounts", "kind": "rest", "collection": "frontend-sdk", "page": "generated/frontend-sdk/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1service-accounts/get", "description": "List managed service accounts and their pending requests", "signature": "{\n \"operationId\": \"listPortalServiceAccounts\",\n \"summary\": \"List managed service accounts and their pending requests\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"name\": \"limit\",\n \"in\": \"query\",\n \"required\": false,\n \"description\": \"Maximum number of service accounts to return.\",\n \"schema\": {\n \"type\": \"integer\",\n \"minimum\": 1,\n \"maximum\": 100,\n \"default\": 100\n }\n },\n {\n \"name\": \"offset\",\n \"in\": \"query\",\n \"required\": false,\n \"description\": \"Number of service accounts to skip.\",\n \"schema\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"default\": 0\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Managed service accounts\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"data\",\n \"pagination\"\n ],\n \"properties\": {\n \"data\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"name\",\n \"state\",\n \"requestedPermissions\",\n \"grantedPermissions\",\n \"createdBy\",\n \"approvedBy\",\n \"createdAt\",\n \"activatedAt\",\n \"revokedAt\",\n \"credentialApprovals\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"state\": {\n \"type\": \"string\",\n \"enum\": [\n \"PENDING\",\n \"ACTIVE\"\n ]\n },\n \"requestedPermissions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 1,\n \"maxItems\": 100\n },\n \"grantedPermissions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"createdBy\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"approvedBy\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"activatedAt\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"format\": \"date-time\"\n },\n \"revokedAt\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"format\": \"date-time\"\n },\n \"credentialApprovals\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"operation\",\n \"requestedBy\",\n \"requestedPermissions\",\n \"excessPermissions\",\n \"createdAt\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"operation\": {\n \"type\": \"string\",\n \"enum\": [\n \"CREATE\",\n \"UPDATE\"\n ]\n },\n \"requestedBy\": {\n \"type\": \"string\"\n },\n \"requestedPermissions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 1,\n \"maxItems\": 100\n },\n \"excessPermissions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n }\n }\n }\n }\n }\n }\n },\n \"pagination\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"limit\",\n \"offset\",\n \"hasMore\"\n ],\n \"properties\": {\n \"limit\": {\n \"type\": \"integer\",\n \"minimum\": 1,\n \"maximum\": 100\n },\n \"offset\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"hasMore\": {\n \"type\": \"boolean\"\n }\n }\n }\n }\n }\n }\n }\n },\n \"400\": {\n \"description\": \"Bad request\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n}\n", "guide": "reference/frontend-sdk" }, { "id": "rest.listPortalUsageLimits", "name": "GET /portal/businesses/{businessId}/me/usage-limits", "kind": "rest", "collection": "frontend-sdk", "page": "generated/frontend-sdk/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1usage-limits/get", "description": "List subscriber-owned usage limits for the signed-in consumer", "signature": "{\n \"operationId\": \"listPortalUsageLimits\",\n \"summary\": \"List subscriber-owned usage limits for the signed-in consumer\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"name\": \"limit\",\n \"in\": \"query\",\n \"required\": false,\n \"description\": \"Maximum number of usage limits to return.\",\n \"schema\": {\n \"type\": \"integer\",\n \"minimum\": 1,\n \"maximum\": 100,\n \"default\": 100\n }\n },\n {\n \"name\": \"offset\",\n \"in\": \"query\",\n \"required\": false,\n \"description\": \"Number of usage limits to skip.\",\n \"schema\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"default\": 0\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Usage limits\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"data\",\n \"pagination\"\n ],\n \"properties\": {\n \"data\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"quantity\",\n \"mode\",\n \"period\",\n \"createdBy\",\n \"createdAt\",\n \"updatedAt\",\n \"scope\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"quantity\": {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9_]{1,64}$\"\n },\n \"mode\": {\n \"type\": \"string\",\n \"enum\": [\n \"BLOCK\",\n \"NOTIFY\"\n ]\n },\n \"notifyAtPct\": {\n \"type\": \"number\",\n \"minimum\": 0.01,\n \"maximum\": 1,\n \"description\": \"Required for NOTIFY usage limits and forbidden for BLOCK.\"\n },\n \"limitUnits\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 2147483647\n },\n \"limitCents\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 2147483647\n },\n \"scope\": {\n \"type\": \"string\",\n \"enum\": [\n \"ORG\",\n \"MEMBER\",\n \"SERVICE_ACCOUNT\"\n ]\n },\n \"subjectId\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 128\n },\n \"period\": {\n \"type\": \"string\",\n \"const\": \"BILLING_PERIOD\"\n },\n \"ceiling\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"limitUnits\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"limitCents\": {\n \"type\": \"integer\",\n \"minimum\": 0\n }\n },\n \"description\": \"The builder's own per-billing-period ceiling on this quantity, when the plan declares one. Read-only.\"\n },\n \"effectiveWindow\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"strategy\",\n \"periodSeconds\"\n ],\n \"properties\": {\n \"strategy\": {\n \"type\": \"string\",\n \"enum\": [\n \"fixed_window\",\n \"sliding_window\"\n ]\n },\n \"periodSeconds\": {\n \"type\": \"integer\",\n \"minimum\": 1\n }\n },\n \"description\": \"Read-only: how the limit is accounted at the edge. `sliding_window` means the ceiling is a rolling horizon of `periodSeconds` rather than one that resets at the billing-period boundary. Builder-owned; not writable.\"\n },\n \"createdBy\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"updatedAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n }\n },\n \"allOf\": [\n {\n \"oneOf\": [\n {\n \"required\": [\n \"quantity\",\n \"limitCents\"\n ],\n \"properties\": {\n \"quantity\": {\n \"type\": \"string\",\n \"const\": \"spend\"\n }\n },\n \"not\": {\n \"required\": [\n \"limitUnits\"\n ]\n }\n },\n {\n \"required\": [\n \"quantity\",\n \"limitUnits\"\n ],\n \"properties\": {\n \"quantity\": {\n \"type\": \"string\",\n \"not\": {\n \"const\": \"spend\"\n }\n }\n },\n \"not\": {\n \"required\": [\n \"limitCents\"\n ]\n }\n }\n ]\n },\n {\n \"oneOf\": [\n {\n \"required\": [\n \"scope\"\n ],\n \"properties\": {\n \"scope\": {\n \"type\": \"string\",\n \"const\": \"ORG\"\n }\n },\n \"not\": {\n \"required\": [\n \"subjectId\"\n ]\n }\n },\n {\n \"required\": [\n \"scope\",\n \"subjectId\"\n ],\n \"properties\": {\n \"scope\": {\n \"type\": \"string\",\n \"const\": \"MEMBER\"\n }\n }\n },\n {\n \"required\": [\n \"scope\",\n \"subjectId\"\n ],\n \"properties\": {\n \"scope\": {\n \"type\": \"string\",\n \"const\": \"SERVICE_ACCOUNT\"\n }\n }\n }\n ]\n },\n {\n \"if\": {\n \"required\": [\n \"mode\"\n ],\n \"properties\": {\n \"mode\": {\n \"const\": \"NOTIFY\"\n }\n }\n },\n \"then\": {\n \"required\": [\n \"notifyAtPct\"\n ]\n }\n },\n {\n \"if\": {\n \"required\": [\n \"mode\"\n ],\n \"properties\": {\n \"mode\": {\n \"const\": \"BLOCK\"\n }\n }\n },\n \"then\": {\n \"not\": {\n \"required\": [\n \"notifyAtPct\"\n ]\n }\n }\n },\n {\n \"if\": {\n \"anyOf\": [\n {\n \"required\": [\n \"limitUnits\"\n ],\n \"properties\": {\n \"limitUnits\": {\n \"const\": 0\n }\n }\n },\n {\n \"required\": [\n \"limitCents\"\n ],\n \"properties\": {\n \"limitCents\": {\n \"const\": 0\n }\n }\n }\n ]\n },\n \"then\": {\n \"properties\": {\n \"mode\": {\n \"const\": \"BLOCK\"\n }\n }\n }\n }\n ]\n }\n },\n \"pagination\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"limit\",\n \"offset\",\n \"hasMore\"\n ],\n \"properties\": {\n \"limit\": {\n \"type\": \"integer\",\n \"minimum\": 1,\n \"maximum\": 100\n },\n \"offset\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"hasMore\": {\n \"type\": \"boolean\"\n }\n }\n }\n }\n }\n }\n }\n },\n \"400\": {\n \"description\": \"Bad request\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n}\n", "guide": "reference/frontend-sdk" }, { "id": "rest.reportManagedBusinessResourceCount", "name": "PUT /management/businesses/{businessId}/resources/{resource}/count", "kind": "rest", "collection": "backend-sdk", "page": "generated/backend-sdk/http", "source": "apps/core/openapi.json#/paths/~1management~1businesses~1{businessId}~1resources~1{resource}~1count/put", "description": "Record a managed product resource count", "signature": "{\n \"openapi\": {\n \"operationId\": \"reportManagedBusinessResourceCount\",\n \"summary\": \"Record a managed product resource count\",\n \"tags\": [\n \"Management\"\n ],\n \"security\": [\n {\n \"cliUserSessionBearerAuth\": []\n },\n {\n \"makerTokenAccessBearerAuth\": []\n }\n ],\n \"x-farthershore-agent-operations\": [\n \"resource_count.report\"\n ],\n \"x-farthershore-agent-target\": {\n \"kind\": \"path\",\n \"targetKind\": \"business\",\n \"parameter\": \"businessId\"\n },\n \"x-farthershore-agent-retry\": [\n {\n \"operationKey\": \"resource_count.report\",\n \"kind\": \"convergent_write\",\n \"keyRequired\": false,\n \"enforcement\": \"resource_identity\",\n \"responseSemantics\": \"point_in_time_write_result\"\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"name\": \"resource\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Resource identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"requestBody\": {\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [\n \"subscriptionId\",\n \"count\"\n ],\n \"properties\": {\n \"subscriptionId\": {\n \"type\": \"string\",\n \"description\": \"Subscriber identifier\"\n },\n \"environmentId\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"description\": \"Environment id for preview environments, or null/omitted for production\"\n },\n \"count\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"subjectType\": {\n \"type\": \"string\",\n \"maxLength\": 64\n },\n \"subjectId\": {\n \"type\": \"string\",\n \"maxLength\": 160\n }\n },\n \"additionalProperties\": false\n }\n }\n }\n },\n \"responses\": {\n \"200\": {\n \"description\": \"Recorded resource count\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"400\": {\n \"description\": \"Bad request\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"companion\": {\n \"limitation\": \"OpenAPI uses GenericObject or GenericObjectArray here and does not fully specify the HTTP contract. These are documentation placeholders, not permission to send arbitrary fields. SDK signatures describe normalized SDK inputs and outputs, not exact wire response envelopes. Source validators specify structural inputs; route authorization and semantic checks still apply.\",\n \"requestValidator\": {\n \"name\": \"resourceCountBodySchema\",\n \"source\": \"apps/core/src/routes/management/resource-counts.ts#L27\",\n \"declaration\": \"const resourceCountBodySchema = z.object({\\n subscriptionId: z.string().min(1),\\n environmentId: z.string().min(1).nullable().optional(),\\n count: z.number().int().nonnegative(),\\n subjectType: z.string().min(1).max(64).optional(),\\n subjectId: z.string().min(1).max(160).optional(),\\n});\"\n },\n \"note\": \"No public SDK method for this management operation. PUT the validator's JSON fields using the documented management credential context. Success returns { resourceCount: row }; OpenAPI does not specify the row shape, so a complete response schema is still unavailable. Do not infer fields from GenericObject.\"\n }\n}\n", "guide": "define/resources" }, { "id": "rest.restorePortalConsumerSubscription", "name": "POST /portal/businesses/{businessId}/me/restore", "kind": "rest", "collection": "commerce", "page": "generated/commerce/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1restore/post", "description": "Restore a fully cancelled subscription by resubscribing to a plan", "signature": "{\n \"openapi\": {\n \"operationId\": \"restorePortalConsumerSubscription\",\n \"summary\": \"Restore a fully cancelled subscription by resubscribing to a plan\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"requestBody\": {\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"responses\": {\n \"200\": {\n \"description\": \"Restore result\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"400\": {\n \"description\": \"Bad request\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"companion\": {\n \"limitation\": \"OpenAPI uses GenericObject or GenericObjectArray here and does not fully specify the HTTP contract. These are documentation placeholders, not permission to send arbitrary fields. SDK signatures describe normalized SDK inputs and outputs, not exact wire response envelopes. Source validators specify structural inputs; route authorization and semantic checks still apply.\",\n \"sdk\": {\n \"usage\": \"client.billing.restoreSubscription(...)\",\n \"signature\": \"restoreSubscription(): Promise;\",\n \"source\": \"packages/farthershore-js/dist/resources/billing.d.ts#L13\",\n \"declarationName\": \"BillingResource\",\n \"page\": \"generated/frontend-sdk/root\",\n \"typeReferences\": [\n {\n \"name\": \"BillPreview\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1284\"\n },\n {\n \"name\": \"CancelSubscriptionResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1122\"\n },\n {\n \"name\": \"ChangePlanResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1144\"\n },\n {\n \"name\": \"RestoreSubscriptionResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1134\"\n },\n {\n \"name\": \"SpendCapResult\",\n \"source\": \"packages/farthershore-js/dist/resources/billing.d.ts#L5\"\n },\n {\n \"name\": \"Subscription\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L739\"\n }\n ]\n },\n \"requestValidator\": {\n \"name\": \"restoreSchema\",\n \"source\": \"apps/core/src/validation/portal-schemas.ts#L76\",\n \"declaration\": \"export const restoreSchema = z\\n .object({\\n compiledPlanId: z.string().min(1).optional(),\\n organizationId: z.string().uuid().optional(),\\n returnUrl: z.string().url().optional(),\\n })\\n .strict();\"\n },\n \"note\": \"SDK limitation: restoreSubscription takes no arguments and returns raw:unknown. Core's free-plan restore branch requires compiledPlanId; use the documented HTTP body when that branch applies. The exact successful wire response remains unspecified by OpenAPI.\"\n }\n}\n", "guide": "commerce/overview" }, { "id": "rest.revokePortalConsumerApiKey", "name": "DELETE /portal/businesses/{businessId}/me/api-keys/{keyId}", "kind": "rest", "collection": "frontend-sdk", "page": "generated/frontend-sdk/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1api-keys~1{keyId}/delete", "description": "Revoke a consumer-scoped API key for the signed-in user on a product portal", "signature": "{\n \"operationId\": \"revokePortalConsumerApiKey\",\n \"summary\": \"Revoke a consumer-scoped API key for the signed-in user on a product portal\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"name\": \"keyId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Consumer API key identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"responses\": {\n \"204\": {\n \"description\": \"No content\"\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n}\n", "guide": "reference/frontend-sdk" }, { "id": "rest.revokePortalServiceAccount", "name": "POST /portal/businesses/{businessId}/me/service-accounts/{serviceAccountId}/revoke", "kind": "rest", "collection": "frontend-sdk", "page": "generated/frontend-sdk/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1service-accounts~1{serviceAccountId}~1revoke/post", "description": "Revoke a managed service account and all of its active keys", "signature": "{\n \"operationId\": \"revokePortalServiceAccount\",\n \"summary\": \"Revoke a managed service account and all of its active keys\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"name\": \"serviceAccountId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Managed service-account identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"requestBody\": {\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {}\n }\n }\n }\n },\n \"responses\": {\n \"204\": {\n \"description\": \"No content\"\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n}\n", "guide": "reference/frontend-sdk" }, { "id": "rest.rotatePortalConsumerApiKey", "name": "POST /portal/businesses/{businessId}/me/api-keys/{keyId}/rotate", "kind": "rest", "collection": "frontend-sdk", "page": "generated/frontend-sdk/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1api-keys~1{keyId}~1rotate/post", "description": "Rotate a consumer-scoped API key — create a replacement then revoke the old one", "signature": "{\n \"openapi\": {\n \"operationId\": \"rotatePortalConsumerApiKey\",\n \"summary\": \"Rotate a consumer-scoped API key — create a replacement then revoke the old one\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"name\": \"keyId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Consumer API key identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"responses\": {\n \"201\": {\n \"description\": \"Rotated API key (new raw secret included)\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"400\": {\n \"description\": \"Bad request\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"companion\": {\n \"limitation\": \"OpenAPI uses GenericObject or GenericObjectArray here and does not fully specify the HTTP contract. These are documentation placeholders, not permission to send arbitrary fields. SDK signatures describe normalized SDK inputs and outputs, not exact wire response envelopes. Source validators specify structural inputs; route authorization and semantic checks still apply.\",\n \"sdk\": {\n \"usage\": \"client.keys.rotate(...)\",\n \"signature\": \"rotate(keyId: string): Promise;\",\n \"source\": \"packages/farthershore-js/dist/resources/keys.d.ts#L3\",\n \"declarationName\": \"KeysResource\",\n \"page\": \"generated/frontend-sdk/root\",\n \"typeReferences\": [\n {\n \"name\": \"ApiKey\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L347\"\n },\n {\n \"name\": \"CreatedApiKey\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L375\"\n },\n {\n \"name\": \"ServiceAccountsResource\",\n \"source\": \"packages/farthershore-js/dist/resources/keys.d.ts#L53\"\n }\n ]\n },\n \"note\": \"Pass keyId as the path argument; no request body is required.\"\n }\n}\n", "guide": "reference/frontend-sdk" }, { "id": "rest.rotatePortalServiceAccount", "name": "POST /portal/businesses/{businessId}/me/service-accounts/{serviceAccountId}/rotate", "kind": "rest", "collection": "frontend-sdk", "page": "generated/frontend-sdk/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1service-accounts~1{serviceAccountId}~1rotate/post", "description": "Rotate a managed service account and return its replacement secret once", "signature": "{\n \"operationId\": \"rotatePortalServiceAccount\",\n \"summary\": \"Rotate a managed service account and return its replacement secret once\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"name\": \"serviceAccountId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Managed service-account identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"requestBody\": {\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {}\n }\n }\n }\n },\n \"responses\": {\n \"201\": {\n \"description\": \"Service-account key rotated\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"status\",\n \"serviceAccountId\",\n \"revokedKeyId\",\n \"apiKeyId\",\n \"plaintext\",\n \"grantedPermissions\"\n ],\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"ACTIVE\"\n },\n \"serviceAccountId\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"grantedPermissions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 1,\n \"maxItems\": 100\n },\n \"revokedKeyId\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"apiKeyId\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"plaintext\": {\n \"type\": \"string\",\n \"writeOnly\": true\n }\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n}\n", "guide": "reference/frontend-sdk" }, { "id": "rest.updatePortalConsumerSpendCap", "name": "PATCH /portal/businesses/{businessId}/me/spend-cap", "kind": "rest", "collection": "commerce", "page": "generated/commerce/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1spend-cap/patch", "description": "Set or remove the monthly spend cap for the signed-in consumer on a product portal", "signature": "{\n \"openapi\": {\n \"operationId\": \"updatePortalConsumerSpendCap\",\n \"summary\": \"Set or remove the monthly spend cap for the signed-in consumer on a product portal\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Spend cap updated\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n },\n \"400\": {\n \"description\": \"Bad request\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"companion\": {\n \"limitation\": \"OpenAPI uses GenericObject or GenericObjectArray here and does not fully specify the HTTP contract. These are documentation placeholders, not permission to send arbitrary fields. SDK signatures describe normalized SDK inputs and outputs, not exact wire response envelopes. Source validators specify structural inputs; route authorization and semantic checks still apply.\",\n \"sdk\": {\n \"usage\": \"client.billing.setSpendCap(...)\",\n \"signature\": \"setSpendCap(input: {\\n maxMonthlySpendCents: number | null;\\n }): Promise;\",\n \"source\": \"packages/farthershore-js/dist/resources/billing.d.ts#L13\",\n \"declarationName\": \"BillingResource\",\n \"page\": \"generated/frontend-sdk/root\",\n \"typeReferences\": [\n {\n \"name\": \"BillPreview\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1284\"\n },\n {\n \"name\": \"CancelSubscriptionResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1122\"\n },\n {\n \"name\": \"ChangePlanResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1144\"\n },\n {\n \"name\": \"RestoreSubscriptionResult\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L1134\"\n },\n {\n \"name\": \"SpendCapResult\",\n \"source\": \"packages/farthershore-js/dist/resources/billing.d.ts#L5\"\n },\n {\n \"name\": \"Subscription\",\n \"source\": \"packages/farthershore-js/dist/types.d.ts#L739\"\n }\n ]\n },\n \"requestValidator\": {\n \"name\": \"updateSpendCapSchema\",\n \"source\": \"apps/core/src/validation/portal-schemas.ts#L97\",\n \"declaration\": \"export const updateSpendCapSchema = z.object({\\n maxMonthlySpendCents: z\\n .number()\\n .int()\\n .min(1, \\\"maxMonthlySpendCents must be a positive integer\\\")\\n .nullable(),\\n organizationId: z.string().uuid().optional(),\\n});\"\n }\n }\n}\n", "guide": "commerce/overview" }, { "id": "rest.updatePortalServiceAccount", "name": "PATCH /portal/businesses/{businessId}/me/service-accounts/{serviceAccountId}", "kind": "rest", "collection": "frontend-sdk", "page": "generated/frontend-sdk/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1service-accounts~1{serviceAccountId}/patch", "description": "Update or request approval for a service-account grant snapshot", "signature": "{\n \"operationId\": \"updatePortalServiceAccount\",\n \"summary\": \"Update or request approval for a service-account grant snapshot\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"name\": \"serviceAccountId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Managed service-account identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"name\": \"Idempotency-Key\",\n \"in\": \"header\",\n \"required\": false,\n \"description\": \"Stable replay key for this provisioning request.\",\n \"schema\": {\n \"type\": \"string\",\n \"minLength\": 1\n }\n }\n ],\n \"requestBody\": {\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"minProperties\": 1,\n \"properties\": {\n \"requestedPermissions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 1,\n \"maxItems\": 100\n },\n \"usageLimit\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"quantity\",\n \"mode\"\n ],\n \"properties\": {\n \"quantity\": {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9_]{1,64}$\"\n },\n \"mode\": {\n \"type\": \"string\",\n \"enum\": [\n \"BLOCK\",\n \"NOTIFY\"\n ]\n },\n \"notifyAtPct\": {\n \"type\": \"number\",\n \"minimum\": 0.01,\n \"maximum\": 1,\n \"description\": \"Required for NOTIFY usage limits and forbidden for BLOCK.\"\n },\n \"limitUnits\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 2147483647\n },\n \"limitCents\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 2147483647\n }\n },\n \"oneOf\": [\n {\n \"required\": [\n \"quantity\",\n \"limitCents\"\n ],\n \"properties\": {\n \"quantity\": {\n \"type\": \"string\",\n \"const\": \"spend\"\n }\n },\n \"not\": {\n \"required\": [\n \"limitUnits\"\n ]\n }\n },\n {\n \"required\": [\n \"quantity\",\n \"limitUnits\"\n ],\n \"properties\": {\n \"quantity\": {\n \"type\": \"string\",\n \"not\": {\n \"const\": \"spend\"\n }\n }\n },\n \"not\": {\n \"required\": [\n \"limitCents\"\n ]\n }\n }\n ],\n \"allOf\": [\n {\n \"if\": {\n \"required\": [\n \"mode\"\n ],\n \"properties\": {\n \"mode\": {\n \"const\": \"NOTIFY\"\n }\n }\n },\n \"then\": {\n \"required\": [\n \"notifyAtPct\"\n ]\n }\n },\n {\n \"if\": {\n \"required\": [\n \"mode\"\n ],\n \"properties\": {\n \"mode\": {\n \"const\": \"BLOCK\"\n }\n }\n },\n \"then\": {\n \"not\": {\n \"required\": [\n \"notifyAtPct\"\n ]\n }\n }\n },\n {\n \"if\": {\n \"anyOf\": [\n {\n \"required\": [\n \"limitUnits\"\n ],\n \"properties\": {\n \"limitUnits\": {\n \"const\": 0\n }\n }\n },\n {\n \"required\": [\n \"limitCents\"\n ],\n \"properties\": {\n \"limitCents\": {\n \"const\": 0\n }\n }\n }\n ]\n },\n \"then\": {\n \"properties\": {\n \"mode\": {\n \"const\": \"BLOCK\"\n }\n }\n }\n }\n ]\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n }\n }\n }\n }\n },\n \"responses\": {\n \"200\": {\n \"description\": \"Service-account snapshot updated\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"status\",\n \"serviceAccountId\",\n \"requestedPermissions\",\n \"grantedPermissions\"\n ],\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"ACTIVE\"\n },\n \"serviceAccountId\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"grantedPermissions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 1,\n \"maxItems\": 100\n },\n \"requestedPermissions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 1,\n \"maxItems\": 100\n }\n }\n }\n }\n }\n },\n \"202\": {\n \"description\": \"Update pending approval; active snapshot is unchanged\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"status\",\n \"serviceAccountId\",\n \"approvalId\",\n \"activePermissions\",\n \"requestedPermissions\",\n \"excessPermissions\",\n \"eligibleApproverIds\"\n ],\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"PENDING\"\n },\n \"serviceAccountId\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"approvalId\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"activePermissions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"requestedPermissions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 1,\n \"maxItems\": 100\n },\n \"excessPermissions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"eligibleApproverIds\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n }\n },\n \"400\": {\n \"description\": \"Bad request\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"409\": {\n \"description\": \"Conflict\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"422\": {\n \"description\": \"Idempotency key was reused with a different request\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n}\n", "guide": "reference/frontend-sdk" }, { "id": "rest.updatePortalUsageLimit", "name": "PUT /portal/businesses/{businessId}/me/usage-limits/{limitId}", "kind": "rest", "collection": "frontend-sdk", "page": "generated/frontend-sdk/http", "source": "apps/core/openapi.json#/paths/~1portal~1businesses~1{businessId}~1me~1usage-limits~1{limitId}/put", "description": "Update a subscriber-owned usage limit", "signature": "{\n \"operationId\": \"updatePortalUsageLimit\",\n \"summary\": \"Update a subscriber-owned usage limit\",\n \"description\": \"Updates a usage-limit row across the subscription. This is an all-mutation operation and requires subscription-wide usage_limit:update authority, not just own-row read authority.\",\n \"tags\": [\n \"portal-customer\"\n ],\n \"security\": [\n {\n \"consumerBearerAuth\": []\n },\n {\n \"siteShellServiceJwt\": [],\n \"personaSessionCookie\": []\n }\n ],\n \"parameters\": [\n {\n \"name\": \"businessId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Business identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"name\": \"limitId\",\n \"in\": \"path\",\n \"required\": true,\n \"description\": \"Usage-limit identifier\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"requestBody\": {\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"minProperties\": 1,\n \"properties\": {\n \"limitUnits\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 2147483647\n },\n \"limitCents\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 2147483647\n },\n \"mode\": {\n \"type\": \"string\",\n \"enum\": [\n \"BLOCK\",\n \"NOTIFY\"\n ]\n },\n \"notifyAtPct\": {\n \"anyOf\": [\n {\n \"type\": \"number\",\n \"minimum\": 0.01,\n \"maximum\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"Required for NOTIFY usage limits and forbidden for BLOCK.\"\n }\n },\n \"not\": {\n \"required\": [\n \"limitUnits\",\n \"limitCents\"\n ]\n },\n \"allOf\": [\n {\n \"if\": {\n \"required\": [\n \"mode\"\n ],\n \"properties\": {\n \"mode\": {\n \"const\": \"NOTIFY\"\n }\n }\n },\n \"then\": {\n \"required\": [\n \"notifyAtPct\"\n ],\n \"properties\": {\n \"notifyAtPct\": {\n \"type\": \"number\"\n }\n }\n }\n },\n {\n \"if\": {\n \"required\": [\n \"mode\"\n ],\n \"properties\": {\n \"mode\": {\n \"const\": \"BLOCK\"\n }\n }\n },\n \"then\": {\n \"properties\": {\n \"notifyAtPct\": {\n \"type\": \"null\"\n }\n }\n }\n },\n {\n \"if\": {\n \"allOf\": [\n {\n \"anyOf\": [\n {\n \"required\": [\n \"limitUnits\"\n ],\n \"properties\": {\n \"limitUnits\": {\n \"const\": 0\n }\n }\n },\n {\n \"required\": [\n \"limitCents\"\n ],\n \"properties\": {\n \"limitCents\": {\n \"const\": 0\n }\n }\n }\n ]\n },\n {\n \"required\": [\n \"mode\"\n ]\n }\n ]\n },\n \"then\": {\n \"properties\": {\n \"mode\": {\n \"const\": \"BLOCK\"\n }\n }\n }\n }\n ]\n }\n }\n }\n },\n \"responses\": {\n \"200\": {\n \"description\": \"Usage limit updated\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"quantity\",\n \"mode\",\n \"period\",\n \"createdBy\",\n \"createdAt\",\n \"updatedAt\",\n \"scope\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"quantity\": {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9_]{1,64}$\"\n },\n \"mode\": {\n \"type\": \"string\",\n \"enum\": [\n \"BLOCK\",\n \"NOTIFY\"\n ]\n },\n \"notifyAtPct\": {\n \"type\": \"number\",\n \"minimum\": 0.01,\n \"maximum\": 1,\n \"description\": \"Required for NOTIFY usage limits and forbidden for BLOCK.\"\n },\n \"limitUnits\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 2147483647\n },\n \"limitCents\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 2147483647\n },\n \"scope\": {\n \"type\": \"string\",\n \"enum\": [\n \"ORG\",\n \"MEMBER\",\n \"SERVICE_ACCOUNT\"\n ]\n },\n \"subjectId\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 128\n },\n \"period\": {\n \"type\": \"string\",\n \"const\": \"BILLING_PERIOD\"\n },\n \"ceiling\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"limitUnits\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"limitCents\": {\n \"type\": \"integer\",\n \"minimum\": 0\n }\n },\n \"description\": \"The builder's own per-billing-period ceiling on this quantity, when the plan declares one. Read-only.\"\n },\n \"effectiveWindow\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"strategy\",\n \"periodSeconds\"\n ],\n \"properties\": {\n \"strategy\": {\n \"type\": \"string\",\n \"enum\": [\n \"fixed_window\",\n \"sliding_window\"\n ]\n },\n \"periodSeconds\": {\n \"type\": \"integer\",\n \"minimum\": 1\n }\n },\n \"description\": \"Read-only: how the limit is accounted at the edge. `sliding_window` means the ceiling is a rolling horizon of `periodSeconds` rather than one that resets at the billing-period boundary. Builder-owned; not writable.\"\n },\n \"createdBy\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"updatedAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n }\n },\n \"allOf\": [\n {\n \"oneOf\": [\n {\n \"required\": [\n \"quantity\",\n \"limitCents\"\n ],\n \"properties\": {\n \"quantity\": {\n \"type\": \"string\",\n \"const\": \"spend\"\n }\n },\n \"not\": {\n \"required\": [\n \"limitUnits\"\n ]\n }\n },\n {\n \"required\": [\n \"quantity\",\n \"limitUnits\"\n ],\n \"properties\": {\n \"quantity\": {\n \"type\": \"string\",\n \"not\": {\n \"const\": \"spend\"\n }\n }\n },\n \"not\": {\n \"required\": [\n \"limitCents\"\n ]\n }\n }\n ]\n },\n {\n \"oneOf\": [\n {\n \"required\": [\n \"scope\"\n ],\n \"properties\": {\n \"scope\": {\n \"type\": \"string\",\n \"const\": \"ORG\"\n }\n },\n \"not\": {\n \"required\": [\n \"subjectId\"\n ]\n }\n },\n {\n \"required\": [\n \"scope\",\n \"subjectId\"\n ],\n \"properties\": {\n \"scope\": {\n \"type\": \"string\",\n \"const\": \"MEMBER\"\n }\n }\n },\n {\n \"required\": [\n \"scope\",\n \"subjectId\"\n ],\n \"properties\": {\n \"scope\": {\n \"type\": \"string\",\n \"const\": \"SERVICE_ACCOUNT\"\n }\n }\n }\n ]\n },\n {\n \"if\": {\n \"required\": [\n \"mode\"\n ],\n \"properties\": {\n \"mode\": {\n \"const\": \"NOTIFY\"\n }\n }\n },\n \"then\": {\n \"required\": [\n \"notifyAtPct\"\n ]\n }\n },\n {\n \"if\": {\n \"required\": [\n \"mode\"\n ],\n \"properties\": {\n \"mode\": {\n \"const\": \"BLOCK\"\n }\n }\n },\n \"then\": {\n \"not\": {\n \"required\": [\n \"notifyAtPct\"\n ]\n }\n }\n },\n {\n \"if\": {\n \"anyOf\": [\n {\n \"required\": [\n \"limitUnits\"\n ],\n \"properties\": {\n \"limitUnits\": {\n \"const\": 0\n }\n }\n },\n {\n \"required\": [\n \"limitCents\"\n ],\n \"properties\": {\n \"limitCents\": {\n \"const\": 0\n }\n }\n }\n ]\n },\n \"then\": {\n \"properties\": {\n \"mode\": {\n \"const\": \"BLOCK\"\n }\n }\n }\n }\n ]\n }\n }\n }\n },\n \"400\": {\n \"description\": \"Bad request\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"401\": {\n \"description\": \"Unauthorized\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"403\": {\n \"description\": \"Forbidden\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n },\n \"404\": {\n \"description\": \"Not found\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"error\"\n ],\n \"properties\": {\n \"error\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"additionalProperties\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n}\n", "guide": "reference/frontend-sdk" }, { "id": "schema.automation.create", "name": "Automation create body", "kind": "schema", "collection": "agents", "page": "generated/agents/automation", "source": "packages/contracts/src/automation/rule.ts", "description": "Closed automation create input, including trigger, condition and action variants.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 200\n },\n \"trigger\": {\n \"type\": \"object\",\n \"properties\": {\n \"eventType\": {\n \"type\": \"string\",\n \"enum\": [\n \"subscription.created\",\n \"subscription.updated\",\n \"subscription.canceled\",\n \"payment.succeeded\",\n \"payment.failed\",\n \"entitlement.changed\",\n \"usage.threshold_reached\",\n \"rate_limit.exceeded\",\n \"usage.recorded\",\n \"usage.archive_checkpoint\",\n \"gateway.request_denied\",\n \"change_set.created\",\n \"change_set.approved\",\n \"change_set.applied\",\n \"change_set.rolled_back\",\n \"change_set.cancelled\",\n \"billing.event_recorded\",\n \"authz.decision\",\n \"repo.changed\",\n \"automation.rule_fired\",\n \"automation.action_succeeded\",\n \"automation.action_failed\",\n \"automation.action_denied\",\n \"automation.notification\",\n \"access_request.created\",\n \"access_request.resolved\",\n \"build.failed\",\n \"product.published\",\n \"workflow.failed\",\n \"pr.review_posted\"\n ]\n },\n \"filter\": {\n \"type\": \"object\",\n \"properties\": {\n \"subjectType\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 128\n },\n \"subjectId\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 256\n }\n },\n \"additionalProperties\": false\n }\n },\n \"required\": [\n \"eventType\"\n ],\n \"additionalProperties\": false\n },\n \"conditions\": {\n \"default\": [],\n \"maxItems\": 20,\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 136\n },\n \"operator\": {\n \"type\": \"string\",\n \"enum\": [\n \"eq\",\n \"neq\",\n \"gt\",\n \"lt\",\n \"contains\",\n \"path_prefix\"\n ]\n },\n \"value\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"maxLength\": 1024\n },\n {\n \"type\": \"number\"\n },\n {\n \"type\": \"boolean\"\n }\n ]\n }\n },\n \"required\": [\n \"path\",\n \"operator\",\n \"value\"\n ],\n \"additionalProperties\": false\n }\n },\n \"actions\": {\n \"minItems\": 1,\n \"maxItems\": 10,\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"kind\": {\n \"type\": \"string\",\n \"const\": \"emit_webhook_event\"\n },\n \"event\": {\n \"type\": \"string\",\n \"enum\": [\n \"subscription.created\",\n \"subscription.updated\",\n \"subscription.canceled\",\n \"payment.succeeded\",\n \"payment.failed\",\n \"entitlement.changed\",\n \"usage.threshold_reached\"\n ]\n },\n \"payload\": {\n \"default\": {},\n \"type\": \"object\",\n \"propertyNames\": {\n \"type\": \"string\"\n },\n \"additionalProperties\": {}\n }\n },\n \"required\": [\n \"kind\",\n \"event\",\n \"payload\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"kind\": {\n \"type\": \"string\",\n \"const\": \"create_notification\"\n },\n \"level\": {\n \"default\": \"info\",\n \"type\": \"string\",\n \"enum\": [\n \"info\",\n \"warning\",\n \"critical\"\n ]\n },\n \"message\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 2000\n }\n },\n \"required\": [\n \"kind\",\n \"level\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"kind\": {\n \"type\": \"string\",\n \"const\": \"propose_change_set\"\n },\n \"intent\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 500\n },\n \"roleKey\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 200\n },\n \"permissions\": {\n \"maxItems\": 200,\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 200\n }\n }\n },\n \"required\": [\n \"kind\",\n \"intent\",\n \"roleKey\",\n \"permissions\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"kind\": {\n \"type\": \"string\",\n \"const\": \"notify_audience\"\n },\n \"audience\": {\n \"type\": \"object\",\n \"propertyNames\": {\n \"type\": \"string\"\n },\n \"additionalProperties\": {}\n },\n \"class\": {\n \"type\": \"string\",\n \"enum\": [\n \"product_update\",\n \"transactional\"\n ]\n },\n \"subject\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 200\n },\n \"body\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 20000\n }\n },\n \"required\": [\n \"kind\",\n \"audience\",\n \"class\",\n \"subject\",\n \"body\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"enabled\": {\n \"default\": true,\n \"type\": \"boolean\"\n },\n \"schemaVersion\": {\n \"default\": 1,\n \"type\": \"integer\",\n \"minimum\": 1,\n \"maximum\": 9007199254740991\n }\n },\n \"required\": [\n \"name\",\n \"trigger\",\n \"conditions\",\n \"actions\",\n \"enabled\",\n \"schemaVersion\"\n ],\n \"additionalProperties\": false\n}\n", "guide": "agents/automation" }, { "id": "schema.automation.update", "name": "Automation update body", "kind": "schema", "collection": "agents", "page": "generated/agents/automation", "source": "packages/contracts/src/automation/rule.ts", "description": "Closed automation update input, including trigger, condition and action variants.", "signature": "{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 200\n },\n \"trigger\": {\n \"type\": \"object\",\n \"properties\": {\n \"eventType\": {\n \"type\": \"string\",\n \"enum\": [\n \"subscription.created\",\n \"subscription.updated\",\n \"subscription.canceled\",\n \"payment.succeeded\",\n \"payment.failed\",\n \"entitlement.changed\",\n \"usage.threshold_reached\",\n \"rate_limit.exceeded\",\n \"usage.recorded\",\n \"usage.archive_checkpoint\",\n \"gateway.request_denied\",\n \"change_set.created\",\n \"change_set.approved\",\n \"change_set.applied\",\n \"change_set.rolled_back\",\n \"change_set.cancelled\",\n \"billing.event_recorded\",\n \"authz.decision\",\n \"repo.changed\",\n \"automation.rule_fired\",\n \"automation.action_succeeded\",\n \"automation.action_failed\",\n \"automation.action_denied\",\n \"automation.notification\",\n \"access_request.created\",\n \"access_request.resolved\",\n \"build.failed\",\n \"product.published\",\n \"workflow.failed\",\n \"pr.review_posted\"\n ]\n },\n \"filter\": {\n \"type\": \"object\",\n \"properties\": {\n \"subjectType\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 128\n },\n \"subjectId\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 256\n }\n },\n \"additionalProperties\": false\n }\n },\n \"required\": [\n \"eventType\"\n ],\n \"additionalProperties\": false\n },\n \"conditions\": {\n \"maxItems\": 20,\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 136\n },\n \"operator\": {\n \"type\": \"string\",\n \"enum\": [\n \"eq\",\n \"neq\",\n \"gt\",\n \"lt\",\n \"contains\",\n \"path_prefix\"\n ]\n },\n \"value\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"maxLength\": 1024\n },\n {\n \"type\": \"number\"\n },\n {\n \"type\": \"boolean\"\n }\n ]\n }\n },\n \"required\": [\n \"path\",\n \"operator\",\n \"value\"\n ],\n \"additionalProperties\": false\n }\n },\n \"actions\": {\n \"minItems\": 1,\n \"maxItems\": 10,\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"kind\": {\n \"type\": \"string\",\n \"const\": \"emit_webhook_event\"\n },\n \"event\": {\n \"type\": \"string\",\n \"enum\": [\n \"subscription.created\",\n \"subscription.updated\",\n \"subscription.canceled\",\n \"payment.succeeded\",\n \"payment.failed\",\n \"entitlement.changed\",\n \"usage.threshold_reached\"\n ]\n },\n \"payload\": {\n \"default\": {},\n \"type\": \"object\",\n \"propertyNames\": {\n \"type\": \"string\"\n },\n \"additionalProperties\": {}\n }\n },\n \"required\": [\n \"kind\",\n \"event\",\n \"payload\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"kind\": {\n \"type\": \"string\",\n \"const\": \"create_notification\"\n },\n \"level\": {\n \"default\": \"info\",\n \"type\": \"string\",\n \"enum\": [\n \"info\",\n \"warning\",\n \"critical\"\n ]\n },\n \"message\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 2000\n }\n },\n \"required\": [\n \"kind\",\n \"level\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"kind\": {\n \"type\": \"string\",\n \"const\": \"propose_change_set\"\n },\n \"intent\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 500\n },\n \"roleKey\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 200\n },\n \"permissions\": {\n \"maxItems\": 200,\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 200\n }\n }\n },\n \"required\": [\n \"kind\",\n \"intent\",\n \"roleKey\",\n \"permissions\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"kind\": {\n \"type\": \"string\",\n \"const\": \"notify_audience\"\n },\n \"audience\": {\n \"type\": \"object\",\n \"propertyNames\": {\n \"type\": \"string\"\n },\n \"additionalProperties\": {}\n },\n \"class\": {\n \"type\": \"string\",\n \"enum\": [\n \"product_update\",\n \"transactional\"\n ]\n },\n \"subject\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 200\n },\n \"body\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"maxLength\": 20000\n }\n },\n \"required\": [\n \"kind\",\n \"audience\",\n \"class\",\n \"subject\",\n \"body\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"additionalProperties\": false\n}\n", "guide": "agents/automation" }, { "id": "sdk.backend.express.createExpressHandler", "name": "@farthershore/backend/express.createExpressHandler", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/express", "source": "packages/backend/dist/types/adapters/express.d.ts#L129", "description": "Wrap a route handler so it runs only with a GUARANTEED verified PRINCIPAL. The\nstrict {@link createExpressMiddleware} already attaches `req.fartherShore`\nbefore any handler runs; this closes the type gap by handing the handler a\n{@link VerifiedPrincipalContext} whose `principal` is NON-OPTIONAL (no\noptional-chaining to read `ctx.principal`). It enforces that guarantee at\nruntime with two fail-closed 401s BEFORE the callback runs:\n - `context_unverified` when there is no verified context at all (handler\n mounted without the middleware);\n - `principal_required` when the context is verified but identity-less (a\n valid gateway request that carried no `X-Fs-Context`) — so the callback is\n never invoked with an absent `ctx.principal`.\nA thrown `FartherShoreError` / `FartherShorePermissionError` — e.g. from\n`requireMember(ctx)` — is mapped to its typed status; any other error is\nforwarded to `next` for the app's error pipeline.\n\nReturns the wide {@link ExpressMiddleware} so it drops straight into\n`app.post(path, fs.handler(...))`: a handler whose `req` is narrowed to a\n`{ fartherShore: ... }` request type is a SUBTYPE of Express's `Request` and\nwould fail Express's `RequestHandler` assignability — moving the verified\ncontext onto its own `ctx` argument (not the `req` type) is what keeps the\nnon-optional guarantee AND Express compatibility.\nOptions-first overload: `fs.handler({ permission: \"widgets:write\" }, cb)`\nasserts the verified principal holds `permission` (via the fail-closed\ncarrier gate — an absent permission set DENIES) BEFORE the callback runs,\nresponding `403 permission_denied` otherwise. The key is checked with the\nunified grammar (`*` / `:*` / exact); derive route-shaped keys with\n`routePermission(subject, method)`.", "signature": "export declare function createExpressHandler(handler: VerifiedExpressHandler): ExpressMiddleware;\nexport declare function createExpressHandler(options: HandlerOptions, handler: VerifiedExpressHandler): ExpressMiddleware;", "typeReferences": [ { "name": "ExpressMiddleware", "source": "packages/backend/dist/types/adapters/express.d.ts#L30" }, { "name": "ExpressRequestLike", "source": "packages/backend/dist/types/adapters/express.d.ts#L5" }, { "name": "ExpressResponseLike", "source": "packages/backend/dist/types/adapters/express.d.ts#L17" }, { "name": "HandlerOptions", "source": "packages/backend/dist/types/adapters/express.d.ts#L91" }, { "name": "VerifiedExpressHandler", "source": "packages/backend/dist/types/adapters/express.d.ts#L89" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.express.createExpressMiddleware", "name": "@farthershore/backend/express.createExpressMiddleware", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/express", "source": "packages/backend/dist/types/adapters/express.d.ts#L105", "description": "Build the Express middleware. Captures raw body bytes, calls verifyRequest,\nand fail-closes on any error.", "signature": "export declare function createExpressMiddleware(fs: FartherShore__b6398b2ddfc7, options?: MiddlewareOptions): ExpressMiddleware;", "typeReferences": [ { "name": "ExpressMiddleware", "source": "packages/backend/dist/types/adapters/express.d.ts#L30" }, { "name": "FartherShore__b6398b2ddfc7", "source": "packages/backend/dist/types/core/runtime.d.ts#L84" }, { "name": "MiddlewareOptions", "source": "packages/backend/dist/types/adapters/express.d.ts#L31" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.express.ExpressMiddleware", "name": "@farthershore/backend/express.ExpressMiddleware", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/express", "source": "packages/backend/dist/types/adapters/express.d.ts#L30", "description": "Public export ExpressMiddleware; see its declaration and owning guide.", "signature": "export type ExpressMiddleware = (req: ExpressRequestLike, res: ExpressResponseLike, next: ExpressNext) => void;", "typeReferences": [ { "name": "ExpressNext", "source": "packages/backend/dist/types/adapters/express.d.ts#L29" }, { "name": "ExpressRequestLike", "source": "packages/backend/dist/types/adapters/express.d.ts#L5" }, { "name": "ExpressResponseLike", "source": "packages/backend/dist/types/adapters/express.d.ts#L17" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.express.ExpressNext", "name": "@farthershore/backend/express.ExpressNext", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/express", "source": "packages/backend/dist/types/adapters/express.d.ts#L29", "description": "Public export ExpressNext; see its declaration and owning guide.", "signature": "export type ExpressNext = (err?: unknown) => void;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.express.ExpressRequestLike", "name": "@farthershore/backend/express.ExpressRequestLike", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/express", "source": "packages/backend/dist/types/adapters/express.d.ts#L5", "description": "Minimal Express-shaped types so we don't hard-depend on", "signature": "export type ExpressRequestLike = {\n method: string;\n /** Original URL incl. query, e.g. \"/v1/x?a=1\". */\n originalUrl?: string;\n url?: string;\n path?: string;\n headers: Record;\n /** Raw body bytes if captured by an upstream raw parser. */\n rawBody?: Buffer | Uint8Array;\n body?: unknown;\n fartherShore?: FartherShoreRequestContext__fee40dd450e8;\n};", "typeReferences": [ { "name": "FartherShoreRequestContext__fee40dd450e8", "source": "packages/backend/dist/types/core/verifyRequest.d.ts#L24" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.express.ExpressResponseLike", "name": "@farthershore/backend/express.ExpressResponseLike", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/express", "source": "packages/backend/dist/types/adapters/express.d.ts#L17", "description": "Public export ExpressResponseLike; see its declaration and owning guide.", "signature": "export type ExpressResponseLike = {\n status(code: number): ExpressResponseLike;\n json(body: unknown): unknown;\n setHeader(name: string, value: string): void;\n /**\n * Node's `ServerResponse.headersSent`. This is what makes the reporting verb's\n * transport choice AUTOMATIC: while it is false the measurement rides signed\n * response headers (no network call); once the response is on the wire\n * `ctx.report()` transparently switches to the post-stream channel.\n */\n headersSent?: boolean;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.express.HandlerOptions", "name": "@farthershore/backend/express.HandlerOptions", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/express", "source": "packages/backend/dist/types/adapters/express.d.ts#L91", "description": "Options for the `fs.handler(options, cb)` overload.", "signature": "export type HandlerOptions = {\n /**\n * Permission key the verified principal must hold (unified grammar:\n * `*` / `:*` / exact — custom strings work). Checked with the\n * FAIL-CLOSED carrier gate (`requirePermission`): an ABSENT permission set\n * denies. On failure the wrapper responds `403 { error: \"permission_denied\" }`\n * before the callback runs.\n */\n permission?: string;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.express.MiddlewareOptions", "name": "@farthershore/backend/express.MiddlewareOptions", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/express", "source": "packages/backend/dist/types/adapters/express.d.ts#L31", "description": "Public export MiddlewareOptions; see its declaration and owning guide.", "signature": "export type MiddlewareOptions = {\n /**\n * STRICT BY DEFAULT (`true`). Every request is verified FAIL-CLOSED and its\n * inbound `x-fs-*` headers are stripped before the handler runs — the verified\n * `req.fartherShore` context is the only identity source. The builder need not\n * pass this: the gateway signs every request, and a missing/invalid signature\n * or context is a `401`.\n *\n * Set `always: false` to instead DEFER to bootstrap's\n * `verification.required` flag — when the backend contract does not require\n * verification, the request passes through WITHOUT a context (and without\n * stripping). This is an advanced escape hatch for a backend that intentionally\n * consumes no identity; the secure default is strict.\n */\n always?: boolean;\n /**\n * Called when verification REJECTS a request, with the diagnostic detail that\n * is deliberately withheld from the response body.\n *\n * The wire response is only `{ error: }` (plus the error's `details`,\n * if any) — several distinct causes share one code (`route_mismatch` covers\n * both a business mismatch and a backend mismatch; an unserved route id is\n * the separate `route_unknown`), and the specifics must not leak to an\n * unauthenticated caller. But discarding them entirely leaves the operator\n * with no way to tell which cause fired, in their OWN logs, for their OWN\n * server. That is what this hook restores.\n *\n * Defaults to a one-line `console.warn`. Pass a function to route it into a\n * structured logger, or `() => {}` to silence it.\n */\n onVerificationError?: (detail: {\n code: string;\n message: string;\n status: number;\n method: string;\n path: string;\n }) => void;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.express.VerifiedExpressHandler", "name": "@farthershore/backend/express.VerifiedExpressHandler", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/express", "source": "packages/backend/dist/types/adapters/express.d.ts#L89", "description": "A route handler that runs only with a GUARANTEED verified PRINCIPAL. The first\nargument is the {@link VerifiedPrincipalContext} — read `ctx.principal` and\n`ctx.signedContext` (and narrow with `requireMember`/`requireService`)\nwithout any optional-chaining.\nSee {@link createExpressHandler}.", "signature": "export type VerifiedExpressHandler = (ctx: VerifiedPrincipalContext, req: Req, res: Res, next: ExpressNext) => void | Promise;", "typeReferences": [ { "name": "ExpressNext", "source": "packages/backend/dist/types/adapters/express.d.ts#L29" }, { "name": "ExpressRequestLike", "source": "packages/backend/dist/types/adapters/express.d.ts#L5" }, { "name": "ExpressResponseLike", "source": "packages/backend/dist/types/adapters/express.d.ts#L17" }, { "name": "VerifiedPrincipalContext", "source": "packages/backend/dist/types/adapters/express.d.ts#L78" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.express.VerifiedPrincipalContext", "name": "@farthershore/backend/express.VerifiedPrincipalContext", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/express", "source": "packages/backend/dist/types/adapters/express.d.ts#L78", "description": "A verified request context whose {@link ConsumerPrincipal} is GUARANTEED\npresent — the shape handed to a {@link VerifiedExpressHandler}. The raw\n`FartherShoreRequestContext.principal` is optional (an identity-less gateway\nrequest is legitimate on the `fs.middleware()` path); `fs.handler()` narrows to\nthis type only AFTER rejecting an absent principal with `401 principal_required`,\nso the callback can read `ctx.principal` (and narrow with\n`requireMember`/`requireService`) without any optional-chaining.", "signature": "export type VerifiedPrincipalContext = FartherShoreRequestContext__fee40dd450e8 & {\n principal: ConsumerPrincipal__16f951b9786d;\n signedContext: FartherShoreSignedContext__24c947c09583;\n};", "typeReferences": [ { "name": "ConsumerPrincipal__16f951b9786d", "source": "packages/backend/dist/types/core/verifyContext.d.ts#L8" }, { "name": "FartherShoreRequestContext__fee40dd450e8", "source": "packages/backend/dist/types/core/verifyRequest.d.ts#L24" }, { "name": "FartherShoreSignedContext__24c947c09583", "source": "packages/backend/dist/types/core/verifyContext.d.ts#L33" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.reflect.ReflectOptions", "name": "@farthershore/backend/reflect.ReflectOptions", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/reflect", "source": "packages/backend/dist/types/reflect/index.d.ts#L7", "description": "Public export ReflectOptions; see its declaration and owning guide.", "signature": "export interface ReflectOptions {\n framework?: \"express\";\n}", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.reflect.ReflectResult", "name": "@farthershore/backend/reflect.ReflectResult", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/reflect", "source": "packages/backend/dist/types/reflect/index.d.ts#L2", "description": "Public export ReflectResult; see its declaration and owning guide.", "signature": "export interface ReflectResult {\n routes: ReflectedRoute__a5f4bc3646ed[];\n /** Count of sub-mounted routes that couldn't be reflected (Express-5 mount). */\n unreflectable: number;\n}", "typeReferences": [ { "name": "ReflectedRoute__a5f4bc3646ed", "source": "packages/backend/dist/types/reflect/route-canon.d.ts#L2" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.reflect.reflectRoutes", "name": "@farthershore/backend/reflect.reflectRoutes", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/reflect", "source": "packages/backend/dist/types/reflect/index.d.ts#L16", "description": "Reflect the routes an Express app serves into the canonical `ReflectedRoute[]`.\nDeduped, HEAD-suppressed, canonical paths (`:id`→`{id}`).", "signature": "export declare function reflectRoutes(app: unknown, opts?: ReflectOptions): ReflectedRoute__a5f4bc3646ed[];", "typeReferences": [ { "name": "ReflectedRoute__a5f4bc3646ed", "source": "packages/backend/dist/types/reflect/route-canon.d.ts#L2" }, { "name": "ReflectOptions", "source": "packages/backend/dist/types/reflect/index.d.ts#L7" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.reflect.reflectRoutesDetailed", "name": "@farthershore/backend/reflect.reflectRoutesDetailed", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/reflect", "source": "packages/backend/dist/types/reflect/index.d.ts#L11", "description": "Reflect with diagnostics. Use `reflectRoutes` for just the canonical list.", "signature": "export declare function reflectRoutesDetailed(app: unknown, _opts?: ReflectOptions): ReflectResult;", "typeReferences": [ { "name": "ReflectOptions", "source": "packages/backend/dist/types/reflect/index.d.ts#L7" }, { "name": "ReflectResult", "source": "packages/backend/dist/types/reflect/index.d.ts#L2" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.BootstrapClient", "name": "@farthershore/backend.BootstrapClient", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/bootstrap.d.ts#L25", "description": "Caches the bootstrap response and refreshes it lazily. `get()` returns the\ncached value when fresh, otherwise refreshes (single-flight).", "signature": "export declare class BootstrapClient {\n private readonly runtimeToken;\n private readonly endpoint;\n private readonly request;\n private readonly fetchImpl;\n private readonly now;\n private readonly minRefreshSeconds;\n private readonly maxStaleMs;\n private cached;\n private fetchedAt;\n private refreshAfterMs;\n private inflight;\n constructor(options: BootstrapClientOptions);\n /** Cached config when fresh; otherwise refreshes. */\n get(): Promise;\n /** Force a network refresh (single-flight). */\n refresh(): Promise;\n /** Last cached value without triggering a refresh (null until bootstrapped). */\n peek(): RuntimeBootstrapResponse | null;\n /**\n * Seconds since the cached response was fetched; `null` before the first\n * successful bootstrap. Diagnostics only — a rejected route logs this so an\n * operator can tell \"cache is an hour old\" from \"core says it really is gone\".\n */\n ageSeconds(): number | null;\n private isStale;\n private isHardStale;\n private cachedOrThrowOnHardStale;\n private doBootstrap;\n}", "typeReferences": [ { "name": "BootstrapClientOptions", "source": "packages/backend/dist/types/core/bootstrap.d.ts#L3" }, { "name": "RuntimeBootstrapResponse", "source": "packages/backend/dist/types/runtime-types.d.ts#L228" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.BootstrapClientOptions", "name": "@farthershore/backend.BootstrapClientOptions", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/bootstrap.d.ts#L3", "description": "Where to reach core's bootstrap endpoint. Derived from the token's coreUrl.", "signature": "export type BootstrapClientOptions = {\n runtimeToken: string;\n /** Core base URL, e.g. https://core.farthershore.com. */\n coreUrl: string;\n /** Optional bootstrap request metadata. */\n request?: RuntimeBootstrapRequest__4b9c188578f3;\n /** Injectable fetch (tests). */\n fetchImpl?: typeof fetch;\n /** Injectable clock in ms (tests). */\n now?: () => number;\n /** Minimum seconds between refreshes regardless of server hint. */\n minRefreshSeconds?: number;\n /**\n * Maximum age for cached bootstrap authorization metadata during transient\n * refresh failures. Defaults to 5 minutes.\n */\n maxStaleSeconds?: number;\n};", "typeReferences": [ { "name": "RuntimeBootstrapRequest__4b9c188578f3", "source": "packages/backend/dist/types/runtime-types.d.ts#L183" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.buildCanonicalSigningString", "name": "@farthershore/backend.buildCanonicalSigningString", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-signing.d.ts#L16", "description": "Build the byte-exact canonical signing string. This is the cross-language\ngate: every SDK MUST produce identical output for identical inputs, with NO\ndependence on JSON key order or Node Buffer serialization.", "signature": "declare const buildCanonicalSigningString: (input: CanonicalSigningInput) => string;", "typeReferences": [ { "name": "CanonicalSigningInput", "source": "packages/backend/dist/types/runtime-types.d.ts#L153" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.buildHealthReport", "name": "@farthershore/backend.buildHealthReport", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/health.d.ts#L11", "description": "Build the fs.health() report from the current snapshot.", "signature": "export declare function buildHealthReport(snapshot: HealthSnapshot): RuntimeHealthReport;", "typeReferences": [ { "name": "HealthSnapshot", "source": "packages/backend/dist/types/core/health.d.ts#L3" }, { "name": "RuntimeHealthReport", "source": "packages/backend/dist/types/runtime-types.d.ts#L306" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.canonicalizeQuery", "name": "@farthershore/backend.canonicalizeQuery", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-signing.d.ts#L10", "description": "Normalize a query string into the canonical form: split into name=value\npairs on '&', sort by (name, then value) using byte (code-unit) order, and\nre-join with '&'. Pass-through (no re-encoding) so all SDKs agree on bytes.\nAn empty input yields an empty string.", "signature": "declare const canonicalizeQuery: (query: string) => string;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.CanonicalSigningInput", "name": "@farthershore/backend.CanonicalSigningInput", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-types.d.ts#L153", "description": "The signed claim set. Field VALUES are language-neutral strings/integers;\nthe canonical serialization (in runtime-signing.ts) pins the wire bytes.", "signature": "export type CanonicalSigningInput = {\n /** HTTP method; canonicalized to upper-case. */\n method: string;\n /** Request path (no host, no query). */\n path: string;\n /** Raw query string (without leading '?'), or \"\" when absent. */\n query: string;\n /** Lowercase-hex SHA-256 of the raw body, EMPTY_BODY_SHA256, or \"STREAM\". */\n bodyHash: string;\n /** Gateway-minted request id (also the replay nonce). */\n requestId: string;\n /** Unix epoch seconds at signing time. */\n timestamp: number;\n businessId: string;\n backendId: string;\n /** Resolved route id; \"\" when unresolved. */\n routeId: string;\n policyVersion: string;\n /**\n * Consumer-principal wave (D3) — SHA-256 hex of the presented `X-Fs-Context`\n * JWT string, or the SHA-256 of the EMPTY string when context signing is off.\n * Bound into the canonical string so one request-signature verification\n * covers both the request and the identity context. Compute via\n * {@link hashContextToken}.\n */\n contextHash: string;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.CloudflaredSupervisor", "name": "@farthershore/backend.CloudflaredSupervisor", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/tunnel.d.ts#L88", "description": "Supervises a single `cloudflared` child process. One supervisor ⇒ one tunnel\n(one backend). Restarts on unexpected exit; stays down after `shutdown()`.", "signature": "export declare class CloudflaredSupervisor {\n private readonly tunnelToken;\n private readonly spawn;\n private readonly binaryPath;\n private readonly locateBinary;\n private readonly logger;\n private readonly onError;\n private readonly failClosed;\n private readonly baseBackoffMs;\n private readonly maxBackoffMs;\n private readonly backoffJitter;\n private readonly random;\n private readonly setTimeoutFn;\n private readonly clearTimeoutFn;\n private readonly childEnv;\n private child;\n private state;\n private restarts;\n private consecutiveFailures;\n private lastError;\n private intentionalStop;\n private restartTimer;\n private signalsBound;\n private readonly signalHandler;\n constructor(options: CloudflaredSupervisorOptions);\n /**\n * Resolve the binary, spawn the child, wire log piping + exit handling, and\n * bind SIGTERM/SIGINT. Fail-open by default (resolves; error in `status()`);\n * fail-closed when configured (rejects).\n *\n * Async by contract: the public lifecycle API (and a future binary\n * download/health-probe step) is Promise-returning even when today's body is\n * synchronous, so callers can always `await fs.start()`.\n */\n start(): Promise;\n /**\n * Intentional graceful stop: cancel any pending restart, signal the child\n * (SIGTERM), unbind signals, and mark the supervisor stopped. Any exit that\n * the kill provokes will NOT trigger a restart. Async by lifecycle contract.\n */\n shutdown(): Promise;\n /** Token-free status snapshot for diagnostics / health. */\n status(): TunnelStatus;\n /** Compact health string for `fs.health().tunnel`. */\n healthString(): string;\n private spawnChild;\n /**\n * Resolve the cloudflared binary path. Order:\n * 1. an installed `@farthershore/cloudflared-` optional-dependency\n * matching process.platform+arch (the injected locator), then\n * 2. an explicit `binaryPath` supplied by the host, then\n * 3. the bare `cloudflared` name on PATH (resolved at spawn time).\n *\n * On an unsupported arch (no optional dep, no binaryPath) AND no usable PATH\n * fallback, this raises a clear, redacted error pointing at the sidecar — it\n * NEVER downloads a binary at runtime. (Cross-platform binary management is the\n * optional-dep packages' job, populated at publish time.)\n */\n private resolveBinary;\n /** Pipe stdout/stderr to the logger with the tunnel token redacted. */\n private pipeLogs;\n /**\n * Build a per-stream `data` handler that BUFFERS partial lines across chunks\n * before redacting. The OS can deliver a single log line in two `data` events\n * with the boundary mid-token; redacting each chunk independently would let\n * the two token halves slip through. Buffering until a newline reassembles\n * the full line (a token never contains a newline), so redaction always sees\n * the whole token. A trailing partial is held for the next chunk, or flushed\n * if it grows past a safety cap (cloudflared is line-oriented, so this is a\n * belt-and-suspenders guard against unbounded buffer growth).\n */\n private makeLineSink;\n private emitLogLine;\n /** Replace every occurrence of the tunnel token with the sentinel. */\n private redact;\n private handleExit;\n private scheduleRestart;\n private backoffDelay;\n private handleStartFailure;\n private recordError;\n private bindSignals;\n private unbindSignals;\n}", "typeReferences": [ { "name": "CloudflaredSupervisorOptions", "source": "packages/backend/dist/types/core/tunnel.d.ts#L32" }, { "name": "TunnelStatus", "source": "packages/backend/dist/types/core/tunnel.d.ts#L77" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.CloudflaredSupervisorOptions", "name": "@farthershore/backend.CloudflaredSupervisorOptions", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/tunnel.d.ts#L32", "description": "Public export CloudflaredSupervisorOptions; see its declaration and owning guide.", "signature": "export type CloudflaredSupervisorOptions = {\n /**\n * The Cloudflare tunnel token (transport identity for `cloudflared`). HIGHLY\n * sensitive: kept in memory, never logged, redacted everywhere. (Distinct from\n * the runtime token / app identity.)\n */\n tunnelToken: string;\n /** Injected spawner (required; tests pass a fake — never a real process). */\n spawn: SpawnFn;\n /**\n * Explicit binary path. When omitted, `locateBinary` resolves it (Linux-first\n * candidates). When neither resolves, start fails with a clear error.\n */\n binaryPath?: string;\n /** Injected binary locator. Returns an absolute path or null if not found. */\n locateBinary?: () => string | null;\n /** Log sink for redacted cloudflared output. Defaults to console.error. */\n logger?: (line: string) => void;\n /** Error-surface callback (fail-open path). Receives a token-redacted error. */\n onError?: (error: Error) => void;\n /**\n * When true, a spawn failure rejects `start()` (the host opted into letting a\n * tunnel failure stop the app). Default false: tunnel failure ≠ app crash.\n * (Request *verification* is always fail-closed regardless — different axis.)\n */\n failClosed?: boolean;\n /** Base backoff for the first restart (doubles each consecutive failure). */\n baseBackoffMs?: number;\n /** Backoff ceiling. */\n maxBackoffMs?: number;\n /** Jitter strategy for the restart backoff. Defaults to `equal` (the shared\n * backoff default) — half the capped exponential is fixed, half randomized,\n * so multiple supervisors don't re-collide in lockstep after a shared\n * outage. Pass `none` for a deterministic schedule. */\n backoffJitter?: JitterStrategy__d3dcffd979fd;\n /** Injectable uniform random in [0, 1) for the jitter (tests pin it). Defaults\n * to Math.random. */\n random?: () => number;\n /** Injectable timer (tests use fake timers / a custom scheduler). */\n setTimeoutFn?: (cb: () => void, ms: number) => unknown;\n clearTimeoutFn?: (handle: unknown) => void;\n /** Process env passed to the child (tunnel token is NOT injected via env). */\n childEnv?: NodeJS.ProcessEnv;\n};", "typeReferences": [ { "name": "JitterStrategy__d3dcffd979fd", "source": "packages/backend/dist/types/core/backoff.d.ts#L2" }, { "name": "SpawnFn", "source": "packages/backend/dist/types/core/tunnel.d.ts#L25" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.computeMeteringHeaders", "name": "@farthershore/backend.computeMeteringHeaders", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/response-metering.d.ts#L83", "description": "Compute the three response-metering headers for a payload as a plain\nname→value map, attachable to ANY response mechanism (Fetch `Response`,\nExpress `res.set`, a raw header object). This is the metering-availability\nprimitive: it NEVER throws at request time — if no token is resolvable (or\nsigning fails) it skips stamping, reports the reason (`onSkip` / dev hook /\na `console.warn`), and returns `{}` so the builder's endpoint is never broken.\n\nThis is the framework-neutral wire recipe: `ctx.report()` is the JS surface\nover it, and a Python/Go backend can stamp identical headers by building the\nsame payload (see `docs/response-metering-wire.md`).", "signature": "export declare function computeMeteringHeaders(payload: ResponseMeteringUsagePayload, options?: ComputeMeteringOptions): Promise;", "typeReferences": [ { "name": "ComputeMeteringOptions", "source": "packages/backend/dist/types/response-metering.d.ts#L44" }, { "name": "MeteringHeaders", "source": "packages/backend/dist/types/response-metering.d.ts#L43" }, { "name": "ResponseMeteringUsagePayload", "source": "packages/backend/dist/types/response-metering.d.ts#L20" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.ComputeMeteringOptions", "name": "@farthershore/backend.ComputeMeteringOptions", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/response-metering.d.ts#L44", "description": "Public export ComputeMeteringOptions; see its declaration and owning guide.", "signature": "export type ComputeMeteringOptions = {\n token?: string;\n env?: Record;\n /** Gateway request id, for dev-mode trace/usage association (never signed). */\n requestId?: string;\n /**\n * Called (instead of throwing) when headers cannot be stamped at request time\n * — e.g. no token. The endpoint is never broken; usage is simply not metered.\n */\n onSkip?: (reason: string) => void;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.ConsumerPrincipal", "name": "@farthershore/backend.ConsumerPrincipal", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/verifyContext.d.ts#L8", "description": "The verified consumer principal derived from the cv=2 signed context — a\ntenant (`org`) plus exactly one subject. Local copy of the contracts\n`ConsumerPrincipal` (the SDK never leaks `@farthershore/contracts` into a\npublic type signature; see runtime-signing.ts).", "signature": "export type ConsumerPrincipal = {\n org: {\n id: string;\n };\n subject: {\n kind: \"member\";\n /** The member's stable internal id (never an IdP subject/email). */\n memberId: string;\n /** How this request's identity was proven. */\n via: \"session\" | \"api_key\";\n /** The personal `fsk_` key id when `via === \"api_key\"` (audit). */\n keyId?: string;\n } | {\n kind: \"service\";\n /** The org-owned service account id — the stable service identity. */\n serviceAccountId: string;\n /** The specific service `fsk_` key id (rotates; audit). */\n keyId: string;\n };\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.createExpressHandler", "name": "@farthershore/backend.createExpressHandler", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/adapters/express.d.ts#L129", "description": "Wrap a route handler so it runs only with a GUARANTEED verified PRINCIPAL. The\nstrict {@link createExpressMiddleware} already attaches `req.fartherShore`\nbefore any handler runs; this closes the type gap by handing the handler a\n{@link VerifiedPrincipalContext} whose `principal` is NON-OPTIONAL (no\noptional-chaining to read `ctx.principal`). It enforces that guarantee at\nruntime with two fail-closed 401s BEFORE the callback runs:\n - `context_unverified` when there is no verified context at all (handler\n mounted without the middleware);\n - `principal_required` when the context is verified but identity-less (a\n valid gateway request that carried no `X-Fs-Context`) — so the callback is\n never invoked with an absent `ctx.principal`.\nA thrown `FartherShoreError` / `FartherShorePermissionError` — e.g. from\n`requireMember(ctx)` — is mapped to its typed status; any other error is\nforwarded to `next` for the app's error pipeline.\n\nReturns the wide {@link ExpressMiddleware} so it drops straight into\n`app.post(path, fs.handler(...))`: a handler whose `req` is narrowed to a\n`{ fartherShore: ... }` request type is a SUBTYPE of Express's `Request` and\nwould fail Express's `RequestHandler` assignability — moving the verified\ncontext onto its own `ctx` argument (not the `req` type) is what keeps the\nnon-optional guarantee AND Express compatibility.\nOptions-first overload: `fs.handler({ permission: \"widgets:write\" }, cb)`\nasserts the verified principal holds `permission` (via the fail-closed\ncarrier gate — an absent permission set DENIES) BEFORE the callback runs,\nresponding `403 permission_denied` otherwise. The key is checked with the\nunified grammar (`*` / `:*` / exact); derive route-shaped keys with\n`routePermission(subject, method)`.", "signature": "export declare function createExpressHandler(handler: VerifiedExpressHandler): ExpressMiddleware;\nexport declare function createExpressHandler(options: HandlerOptions, handler: VerifiedExpressHandler): ExpressMiddleware;", "typeReferences": [ { "name": "ExpressMiddleware", "source": "packages/backend/dist/types/adapters/express.d.ts#L30" }, { "name": "ExpressRequestLike", "source": "packages/backend/dist/types/adapters/express.d.ts#L5" }, { "name": "ExpressResponseLike", "source": "packages/backend/dist/types/adapters/express.d.ts#L17" }, { "name": "HandlerOptions", "source": "packages/backend/dist/types/adapters/express.d.ts#L91" }, { "name": "VerifiedExpressHandler", "source": "packages/backend/dist/types/adapters/express.d.ts#L89" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.createExpressMiddleware", "name": "@farthershore/backend.createExpressMiddleware", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/adapters/express.d.ts#L105", "description": "Build the Express middleware. Captures raw body bytes, calls verifyRequest,\nand fail-closes on any error.", "signature": "export declare function createExpressMiddleware(fs: FartherShore, options?: MiddlewareOptions): ExpressMiddleware;", "typeReferences": [ { "name": "ExpressMiddleware", "source": "packages/backend/dist/types/adapters/express.d.ts#L30" }, { "name": "FartherShore", "source": "packages/backend/dist/types/core/runtime.d.ts#L84" }, { "name": "MiddlewareOptions", "source": "packages/backend/dist/types/adapters/express.d.ts#L31" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.credentialKind", "name": "@farthershore/backend.credentialKind", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/subject.d.ts#L36", "description": "The credential SURFACE behind a verified request, DERIVED from the signed\nprincipal (route-surfaces wave) — no new claim, no spoofable header. A member\nsubject carries `via`; a service subject is always key-borne. Returns\n`undefined` when the request carried no verified principal (identity-less), so\na caller can distinguish \"not a portal session\" from \"unknown\".\n\n - `\"portal_session\"` ⟺ a member via a browser session (`fsc_`).\n - `\"api_key\"` ⟺ a member's personal key OR any service key (`fsk_`).", "signature": "export declare function credentialKind(ctx: PrincipalCarrier): \"portal_session\" | \"api_key\" | undefined;", "typeReferences": [ { "name": "PrincipalCarrier", "source": "packages/backend/dist/types/core/subject.d.ts#L11" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.decodeContextClaims", "name": "@farthershore/backend.decodeContextClaims", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/verifyContext.d.ts#L109", "description": "Decode + shape-check a cv=2 context token's PAYLOAD **without** verifying its\nHS256 signature. Safe to call ONLY after the token's authenticity has been\nestablished by another proof — in this SDK the presented `X-Fs-Context`'s\nSHA-256 (`contextHash`) is bound into the Ed25519-verified request signature,\nso once that request signature checks out the token bytes are byte-exact the\nones the gateway signed and its CONTENT is gateway-vouched (no HS256 secret\nrequired). This is the DEFAULT identity path: with request signing on, a\nverified request always yields the principal even when no HS256 context secret\nis distributed to the backend. Returns the typed cv=2 claims, or `null` when\nthe token is malformed or is not a cv=2 claim.", "signature": "export declare function decodeContextClaims(token: string): FartherShoreSignedContext | null;", "typeReferences": [ { "name": "FartherShoreSignedContext", "source": "packages/backend/dist/types/core/verifyContext.d.ts#L33" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.DEFAULT_TOKEN_ENV", "name": "@farthershore/backend.DEFAULT_TOKEN_ENV", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/response-metering.d.ts#L66", "description": "Public export DEFAULT_TOKEN_ENV; see its declaration and owning guide.", "signature": "declare const DEFAULT_TOKEN_ENV: \"FS_RUNTIME_TOKEN\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.EMPTY_BODY_SHA256", "name": "@farthershore/backend.EMPTY_BODY_SHA256", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-types.d.ts#L143", "description": "SHA-256 of zero bytes — the canonical empty-body hash.", "signature": "declare const EMPTY_BODY_SHA256 = \"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.ExpressMiddleware", "name": "@farthershore/backend.ExpressMiddleware", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/adapters/express.d.ts#L30", "description": "Public export ExpressMiddleware; see its declaration and owning guide.", "signature": "export type ExpressMiddleware = (req: ExpressRequestLike, res: ExpressResponseLike, next: ExpressNext) => void;", "typeReferences": [ { "name": "ExpressNext", "source": "packages/backend/dist/types/adapters/express.d.ts#L29" }, { "name": "ExpressRequestLike", "source": "packages/backend/dist/types/adapters/express.d.ts#L5" }, { "name": "ExpressResponseLike", "source": "packages/backend/dist/types/adapters/express.d.ts#L17" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.ExpressNext", "name": "@farthershore/backend.ExpressNext", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/adapters/express.d.ts#L29", "description": "Public export ExpressNext; see its declaration and owning guide.", "signature": "export type ExpressNext = (err?: unknown) => void;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.ExpressRequestLike", "name": "@farthershore/backend.ExpressRequestLike", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/adapters/express.d.ts#L5", "description": "Minimal Express-shaped types so we don't hard-depend on", "signature": "export type ExpressRequestLike = {\n method: string;\n /** Original URL incl. query, e.g. \"/v1/x?a=1\". */\n originalUrl?: string;\n url?: string;\n path?: string;\n headers: Record;\n /** Raw body bytes if captured by an upstream raw parser. */\n rawBody?: Buffer | Uint8Array;\n body?: unknown;\n fartherShore?: FartherShoreRequestContext;\n};", "typeReferences": [ { "name": "FartherShoreRequestContext", "source": "packages/backend/dist/types/core/verifyRequest.d.ts#L24" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.ExpressResponseLike", "name": "@farthershore/backend.ExpressResponseLike", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/adapters/express.d.ts#L17", "description": "Public export ExpressResponseLike; see its declaration and owning guide.", "signature": "export type ExpressResponseLike = {\n status(code: number): ExpressResponseLike;\n json(body: unknown): unknown;\n setHeader(name: string, value: string): void;\n /**\n * Node's `ServerResponse.headersSent`. This is what makes the reporting verb's\n * transport choice AUTOMATIC: while it is false the measurement rides signed\n * response headers (no network call); once the response is on the wire\n * `ctx.report()` transparently switches to the post-stream channel.\n */\n headersSent?: boolean;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.fartherShore", "name": "@farthershore/backend.fartherShore", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/index.d.ts#L64", "description": "Public export fartherShore; see its declaration and owning guide.", "signature": "declare const fartherShore: {\n /** Derive everything from FS_RUNTIME_TOKEN via bootstrap. */\n initFromEnv(options?: FartherShoreInitOptions): FartherShoreInstance;\n};", "typeReferences": [ { "name": "FartherShoreInitOptions", "source": "packages/backend/dist/types/core/runtime.d.ts#L21" }, { "name": "FartherShoreInstance", "source": "packages/backend/dist/types/index.d.ts#L32" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.FartherShore", "name": "@farthershore/backend.FartherShore", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/runtime.d.ts#L84", "description": "The runtime instance. Lazily bootstraps; holds the JWKS client, nonce cache,\nmetering buffer, and shutdown hooks.", "signature": "export declare class FartherShore {\n private readonly bootstrapClient;\n private readonly fetchImpl;\n private readonly verificationEnabled;\n private readonly meteringEnabledOverride;\n private readonly runtimeToken;\n private readonly coreUrl;\n private readonly instanceId?;\n private readonly tunnelOptions;\n /** OPTIONAL HS256 secret(s) — defense-in-depth over the cv=2 X-Fs-Context. */\n private readonly contextSecrets;\n private readonly nonceCache;\n private readonly replayProtectionDiagnostic;\n private readonly shutdownManager;\n /** Bounds the on-demand bootstrap refreshes an unknown route id can trigger. */\n private readonly routeRefreshLimiter;\n private jwks;\n private postStreamUsageClient;\n private tunnel;\n private bootstrapped;\n constructor(options?: FartherShoreInitOptions);\n /** Ensure bootstrap config is loaded; build the JWKS + metering clients. */\n ensureBootstrapped(): Promise;\n /**\n * Boot-time route reconciliation (call once, before `listen()`). Reflects the\n * app's real route surface, diffs it against the declared lock from bootstrap,\n * REPORTS drift to the platform, and CONFIRMS the declared `pending` routes\n * this replica serves. Fail-OPEN: never throws / never blocks boot.\n *\n * The reflection code is dynamically imported so it stays OFF the per-request\n * verification hot path (the runtime stays route-unaware there). The report is\n * an OUTBOUND backend→core call (same channel as bootstrap/metering), so it\n * works for every transport (direct / tunnel).\n *\n * Returns the reconcile result (or null if reflection is unavailable / boot\n * reporting failed). v1 reflects Express; `app` omitted → no-op.\n */\n ready(app?: unknown): Promise;\n /** Outbound report sink for `ready()` — runtime-token-authed POSTs to core. */\n private buildReportSink;\n /**\n * Framework-neutral verification primitive. Fail-closed: throws a typed\n * FartherShoreError on any verification failure. Returns the verified context.\n */\n verifyRequest(input: VerifyRequestInput, options?: VerifyRequestHostOptions__981e9466821d): Promise;\n /**\n * Bind the ONE reporting verb to a verified context. Identity comes from the\n * context (`signedContext.subscriptionId` + `requestId`) — never from the\n * caller — so a handler cannot forget it, and a background job that is handed\n * this context keeps reporting against the SAME served identity.\n */\n private buildReportFn;\n /** Whether verification is required (bootstrap × opt-out). */\n verificationRequired(): Promise;\n /**\n * Start the embedded runner. For a `tunnel` backend whose runner is\n * `embedded`, this supervises `cloudflared` as a child process\n * (spawned via the injected/default spawner) using the tunnel token from\n * bootstrap. For every other transport (`direct`, or the `sidecar` runner)\n * it is a no-op — there is no SDK-managed process to run.\n *\n * Fail-open by default: a tunnel that cannot start does NOT crash the host app\n * (request verification stays fail-closed regardless — a different axis).\n */\n start(): Promise;\n /**\n * PRIVATE transport for the post-stream lane of `ctx.report()`. Never rejects\n * — a metering hiccup must not break a builder's endpoint. This is machinery,\n * not surface: the ONE public reporting verb is `ctx.report()`.\n */\n private reportPostStreamUsage;\n /**\n * How far replay protection actually reaches — `\"shared\"` (enforced across\n * every replica) or `\"single-instance\"` (this process only). Deployment\n * diagnostic: log it at boot, or assert on it in a smoke test, so the mode is\n * never a surprise. See {@link FartherShoreInitOptions.nonceStore}.\n */\n replayProtection(): ReplayProtectionDiagnostic;\n /** Current local health report. */\n health(): RuntimeHealthReport;\n /** Graceful shutdown: flush metering + send a stopping heartbeat. */\n shutdown(): Promise;\n /** Register an additional shutdown hook (e.g. the cloudflared supervisor). */\n onShutdown(hook: () => Promise | void): void;\n}", "typeReferences": [ { "name": "FartherShoreInitOptions", "source": "packages/backend/dist/types/core/runtime.d.ts#L21" }, { "name": "FartherShoreRequestContext", "source": "packages/backend/dist/types/core/verifyRequest.d.ts#L24" }, { "name": "ReconcileResult__9286f3220e09", "source": "packages/backend/dist/types/reflect/reconcile.d.ts#L23" }, { "name": "ReplayProtectionDiagnostic", "source": "packages/backend/dist/types/core/replay-protection.d.ts#L4" }, { "name": "RuntimeBootstrapResponse", "source": "packages/backend/dist/types/runtime-types.d.ts#L228" }, { "name": "RuntimeHealthReport", "source": "packages/backend/dist/types/runtime-types.d.ts#L306" }, { "name": "VerifyRequestHostOptions__981e9466821d", "source": "packages/backend/dist/types/core/runtime.d.ts#L76" }, { "name": "VerifyRequestInput", "source": "packages/backend/dist/types/core/verifyRequest.d.ts#L6" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.FartherShoreContext", "name": "@farthershore/backend.FartherShoreContext", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/verifyRequest.d.ts#L85", "description": "The verified Farther Shore context — the identity + reporting handle a\nhandler (or a background job the handler hands it to) works with. Alias of\n{@link FartherShoreRequestContext}: a background job is simply given the\nalready-verified context, so there is no second context type to learn.", "signature": "export type FartherShoreContext = FartherShoreRequestContext;", "typeReferences": [ { "name": "FartherShoreRequestContext", "source": "packages/backend/dist/types/core/verifyRequest.d.ts#L24" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.FartherShoreError", "name": "@farthershore/backend.FartherShoreError", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/errors.d.ts#L33", "description": "A verification / runtime failure with a stable, cross-language `code` and the\nfail-closed HTTP status the adapter should emit.\n\nOptionally carries a {@link LimitDescriptor} (`limitDescriptor`) when the\nfailure is a plan-limit deny the backend chooses to surface itself, so SDKs\ncan render an upgrade affordance from a backend-minted error. This is OPT-IN\nplumbing — the backend normally RELAYS the gateway's deny (which already\ncarries the descriptor) rather than minting its own, so the field is absent on\nevery verification/runtime failure. Additive; no behavior change.", "signature": "export declare class FartherShoreError extends Error {\n readonly code: FartherShoreErrorCode;\n readonly status: number;\n /** Present only when this error is a self-minted plan-limit deny (rare; the\n * backend usually relays the gateway's descriptor-bearing deny instead). */\n readonly limitDescriptor?: LimitDescriptor;\n /**\n * Extra scalar fields the adapters merge into the `{ error: }` response\n * body. Kept to strings so the body stays a flat, machine-readable envelope —\n * `route_unknown` uses it to name the `routeId` that was not served, which is\n * the single fact an operator needs to tell a stale cache from a real deny.\n */\n readonly details?: Readonly>;\n constructor(code: FartherShoreErrorCode, message: string, status?: number, limitDescriptor?: LimitDescriptor, details?: Readonly>);\n}", "typeReferences": [ { "name": "FartherShoreErrorCode", "source": "packages/backend/dist/types/core/errors.d.ts#L21" }, { "name": "LimitDescriptor", "source": "packages/backend/dist/types/runtime-types.d.ts#L8" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.FartherShoreErrorCode", "name": "@farthershore/backend.FartherShoreErrorCode", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/errors.d.ts#L21", "description": "Every code a {@link FartherShoreError} can carry.", "signature": "export type FartherShoreErrorCode = RuntimeErrorCode | SdkLocalErrorCode;", "typeReferences": [ { "name": "RuntimeErrorCode", "source": "packages/backend/dist/types/generated/runtime-contract.d.ts#L21" }, { "name": "SdkLocalErrorCode", "source": "packages/backend/dist/types/core/errors.d.ts#L19" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.FartherShoreInitOptions", "name": "@farthershore/backend.FartherShoreInitOptions", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/runtime.d.ts#L21", "description": "Public export FartherShoreInitOptions; see its declaration and owning guide.", "signature": "export type FartherShoreInitOptions = {\n /** Explicit runtime token. Defaults to process.env.FS_RUNTIME_TOKEN. */\n runtimeToken?: string;\n /** Core base URL. Defaults to FS_CORE_URL or https://core.farthershore.com. */\n coreUrl?: string;\n /** Env map (tests). Defaults to process.env. */\n env?: Record;\n /** Injectable fetch (tests). */\n fetchImpl?: typeof fetch;\n /** Optional advanced opt-outs (default: everything on). */\n verification?: {\n enabled?: boolean;\n };\n metering?: {\n enabled?: boolean;\n };\n /** Embedded-cloudflared runner config (advanced opt-in; default DX is on). */\n tunnel?: FartherShoreTunnelOptions;\n /** SDK metadata forwarded to bootstrap. */\n instanceId?: string;\n /**\n * OPTIONAL HS256 secret(s) for the gateway's cv=2 `X-Fs-Context` claim — pure\n * DEFENSE-IN-DEPTH, NOT required to derive identity. The consumer principal is\n * always produced from the `X-Fs-Context` token whose bytes are vouched for by\n * the Ed25519 request signature (the token's SHA-256 is bound into the signed\n * canonical string). These secrets add a second, independent HS256 proof: when\n * configured, a presented token must ALSO pass HS256 or the request is\n * rejected. They are the GATEWAY CONTEXT-SIGNING keyring values\n * (`CONTEXT_SIGNING_KEYS_JSON`; supply every live key during rotation —\n * try-all), NOT the business's `contextTokenSecret` (which signs `fsc_`\n * INGRESS tokens verified BY the gateway — setting that here would reject every\n * valid gateway request). Defaults to `FS_CONTEXT_SECRETS` (comma-separated)\n * from the env. Leaving it unset is the common case.\n */\n contextSecrets?: readonly string[];\n /**\n * OPTIONAL shared replay-prevention store. Not required: the signature's\n * ~305s time window is the always-on defense, and the zero-config default is\n * an in-memory per-process cache. Inject a shared atomic store (Redis /\n * Memcached / Cloudflare KV / Durable Object) implementing {@link NonceStore}\n * only if you want one-time-use enforced ACROSS replicas rather than within\n * each one. `checkAndRemember` may be async, and should be TTL-bound to the\n * signature validity window.\n *\n * If you do inject one, an outage of that store fails requests CLOSED — it\n * never degrades to \"not a replay\".\n */\n nonceStore?: NonceStore;\n};", "typeReferences": [ { "name": "FartherShoreTunnelOptions", "source": "packages/backend/dist/types/core/runtime.d.ts#L9" }, { "name": "NonceStore", "source": "packages/backend/dist/types/core/nonceCache.d.ts#L13" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.FartherShoreInstance", "name": "@farthershore/backend.FartherShoreInstance", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/index.d.ts#L32", "description": "The conceptual public entrypoint. `fartherShore.initFromEnv()` mirrors the\nlanguage-neutral spec. The returned instance is augmented with `middleware()`\n(the Express adapter) bound to itself.", "signature": "export type FartherShoreInstance = FartherShore & {\n /** Express middleware: strict fail-closed verify → req.fartherShore (+ strip x-fs-*). */\n middleware(options?: MiddlewareOptions): ExpressMiddleware;\n /**\n * Wrap a route handler so it runs only with a GUARANTEED verified PRINCIPAL —\n * the handler's first argument is a {@link VerifiedPrincipalContext} whose\n * `principal` is NON-OPTIONAL. Fails closed (401 `context_unverified` when the\n * context is absent, `principal_required` when it is identity-less) before the\n * callback runs. Pairs with the strict `middleware()`.\n */\n handler: {\n (handler: VerifiedExpressHandler): ExpressMiddleware;\n /**\n * Options-first overload: `fs.handler({ permission: \"widgets:write\" }, cb)`\n * asserts the permission (fail-closed) before the callback runs,\n * responding `403 permission_denied` otherwise.\n */\n (options: HandlerOptions, handler: VerifiedExpressHandler): ExpressMiddleware;\n };\n /**\n * In-handler authorization helpers bound to the instance — the SAME shape as\n * the dev runtime's `rt.authz` (which additionally traces each decision), so\n * dev and prod code reads identically. Both key ONLY on `ctx.permissions`\n * with FAIL-CLOSED carrier semantics: an ABSENT permission set DENIES.\n */\n authz: {\n /** True when the acting user holds `key` (`*` / `:*` / exact). */\n hasPermission(ctx: PermissionCarrier, key: string): boolean;\n /** Assert `key` is held; throws `FartherShorePermissionError` (403). */\n requirePermission(ctx: PermissionCarrier, key: string): void;\n };\n};", "typeReferences": [ { "name": "ExpressMiddleware", "source": "packages/backend/dist/types/adapters/express.d.ts#L30" }, { "name": "ExpressRequestLike", "source": "packages/backend/dist/types/adapters/express.d.ts#L5" }, { "name": "ExpressResponseLike", "source": "packages/backend/dist/types/adapters/express.d.ts#L17" }, { "name": "FartherShore", "source": "packages/backend/dist/types/core/runtime.d.ts#L84" }, { "name": "HandlerOptions", "source": "packages/backend/dist/types/adapters/express.d.ts#L91" }, { "name": "MiddlewareOptions", "source": "packages/backend/dist/types/adapters/express.d.ts#L31" }, { "name": "PermissionCarrier", "source": "packages/backend/dist/types/core/permissions.d.ts#L61" }, { "name": "VerifiedExpressHandler", "source": "packages/backend/dist/types/adapters/express.d.ts#L89" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.FartherShorePermissionError", "name": "@farthershore/backend.FartherShorePermissionError", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/permissions.d.ts#L8", "description": "Thrown by {@link requirePermission} when the acting user lacks a permission.\nDistinct from {@link FartherShoreError } (which models signing/verification\nfailures) — authorization is a separate concern from request verification,\nand its 403 status is not part of the runtime verification contract.", "signature": "export declare class FartherShorePermissionError extends Error {\n readonly code = \"permission_denied\";\n readonly status = 403;\n /** The permission key that was required but not held. */\n readonly requiredPermission: string;\n constructor(requiredPermission: string, message?: string);\n}", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.FartherShoreRequestContext", "name": "@farthershore/backend.FartherShoreRequestContext", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/verifyRequest.d.ts#L24", "description": "The verified request context attached to req.fartherShore.", "signature": "export type FartherShoreRequestContext = {\n requestId: string;\n businessId: string;\n backendId: string;\n routeId: string;\n policyVersion: string;\n timestamp: number;\n bodyHash: string;\n /** Filled by the host bootstrap layer (tenant/customer), not by verify. */\n tenantId?: string;\n customerId?: string;\n meters?: string[];\n features?: Record;\n /**\n * The verified CONSUMER PRINCIPAL behind this request (consumer-principal\n * wave, D3) — derived from the cv=2 `X-Fs-Context` whose bytes are vouched for\n * by the Ed25519 request signature (the token hash is bound into the canonical\n * signing string). OPTIONAL on this raw `fs.middleware()` path: a valid gateway\n * request MAY be identity-less (no `X-Fs-Context` — the gateway signs an\n * empty context hash), in which case there is no principal to resolve. This\n * field is typed honestly here; the `fs.handler()` path (createExpressHandler)\n * is where the GUARANTEED non-optional principal lives — it rejects an\n * identity-less request with `401 principal_required` before the callback runs.\n * Use {@link requireMember} to narrow to the member arm on member-only routes.\n */\n principal?: ConsumerPrincipal;\n /**\n * Managed-RBAC permissions the gateway resolved for the acting subject —\n * sourced ONLY from the VERIFIED signed `X-Fs-Context` claim (the unsigned\n * `x-fs-permissions` fallback is GONE). `undefined` when the claim was absent\n * ⇒ FAR-723 carrier-level DENY; `[]` for an authenticated subject with no\n * grants. Read via {@link hasPermission} / {@link requirePermission}.\n */\n permissions?: string[];\n /** Exact current-G product permissions default-allowed for this request. */\n unassignedProductPermissions?: string[];\n /** The VERIFIED signed cv=2 context payload. Its permissions/roles populated\n * the fields above; its claims derived {@link principal}. */\n signedContext?: FartherShoreSignedContext;\n /** Managed-RBAC role keys the acting subject holds (display/audit only). */\n roles?: string[];\n /**\n * THE reporting verb. `report({ meter, values, dims?, quote? })` reports\n * MEASUREMENTS against the served identity this context already carries —\n * there is no subscription/release argument to forget. The SDK picks the\n * transport (signed in-band headers before the response is sent, the attested\n * post-stream channel after it, or from a background job), so the builder\n * never chooses one.\n *\n * Attached by the runtime facade. A context produced by the BARE\n * `verifyRequest()` primitive has no metering channel, so its `report()`\n * throws an error naming the fix rather than dropping the measurement.\n */\n report: ReportFn__89e79b33cabf;\n};", "typeReferences": [ { "name": "ConsumerPrincipal", "source": "packages/backend/dist/types/core/verifyContext.d.ts#L8" }, { "name": "FartherShoreSignedContext", "source": "packages/backend/dist/types/core/verifyContext.d.ts#L33" }, { "name": "ReportFn__89e79b33cabf", "source": "packages/backend/dist/types/core/report.d.ts#L115" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.FartherShoreSignedContext", "name": "@farthershore/backend.FartherShoreSignedContext", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/verifyContext.d.ts#L33", "description": "The cv=2 signed-context payload the gateway stamps into `X-Fs-Context`. Local\ncopy of the contracts `ConsumerContextClaims`. Identity rides the RFC 9068 /\nRFC 8693 claims (`sub`, `client_id`, `act`, `subjectKind`).", "signature": "export type FartherShoreSignedContext = {\n /** Claim-format version. This SDK understands ONLY cv=2 (consumer principal). */\n cv: 2;\n /** Resource owner: member id (member) or service account id (service). */\n sub: string;\n /** API key / service credential id, when the call is key-borne. */\n client_id?: string;\n /** Nested actor (on-behalf-of): personal-key traffic sets `{ sub: keyId }`. */\n act?: {\n sub: string;\n };\n /** The org (tenant) id. */\n org: string;\n businessId: string;\n compiledPlanId: string;\n subscriptionId: string;\n subscriberId: string;\n environmentId: string | null;\n subjectKey: string;\n /** Which subject arm this context resolves to. */\n subjectKind: \"member\" | \"service\";\n /** The org-owned service account id, for service subjects (mirror of `sub`). */\n serviceAccountId?: string;\n /** The bound role keys (absent when unminted). */\n roles?: string[];\n /** The unified-authz permission claim (absent when unminted). */\n permissions?: string[];\n /** Exact current-G product permissions default-allowed for this request. */\n unassignedProductPermissions?: string[];\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.FartherShoreTunnelOptions", "name": "@farthershore/backend.FartherShoreTunnelOptions", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/runtime.d.ts#L9", "description": "Advanced opt-in tunnel config. The embedded runner is the default DX.", "signature": "export type FartherShoreTunnelOptions = {\n /** Opt out of the embedded cloudflared runner (e.g. sidecar mode). */\n enabled?: boolean;\n /** Injected spawner (tests/non-default hosts). Defaults to node:child_process. */\n spawn?: SpawnFn;\n /** Explicit cloudflared binary path. */\n binaryPath?: string;\n /** Crash the host app if the tunnel cannot start. Default: fail-open. */\n failClosed?: boolean;\n /** Log sink for redacted cloudflared output. */\n logger?: (line: string) => void;\n};", "typeReferences": [ { "name": "SpawnFn", "source": "packages/backend/dist/types/core/tunnel.d.ts#L25" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.FS_RUNTIME_TOKEN_ENV", "name": "@farthershore/backend.FS_RUNTIME_TOKEN_ENV", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-types.d.ts#L118", "description": "Public export FS_RUNTIME_TOKEN_ENV; see its declaration and owning guide.", "signature": "declare const FS_RUNTIME_TOKEN_ENV: \"FS_RUNTIME_TOKEN\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.HandlerOptions", "name": "@farthershore/backend.HandlerOptions", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/adapters/express.d.ts#L91", "description": "Options for the `fs.handler(options, cb)` overload.", "signature": "export type HandlerOptions = {\n /**\n * Permission key the verified principal must hold (unified grammar:\n * `*` / `:*` / exact — custom strings work). Checked with the\n * FAIL-CLOSED carrier gate (`requirePermission`): an ABSENT permission set\n * denies. On failure the wrapper responds `403 { error: \"permission_denied\" }`\n * before the callback runs.\n */\n permission?: string;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.hashBody", "name": "@farthershore/backend.hashBody", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-signing.d.ts#L3", "description": "Lowercase-hex SHA-256 of the RAW request bytes. Never re-serialized JSON.", "signature": "declare const hashBody: (body: Uint8Array) => Promise;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.hasPermission", "name": "@farthershore/backend.hasPermission", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/permissions.d.ts#L88", "description": "True when the acting user holds `key`. Call only with a verified request\ncontext (the verified `X-Fs-Context` permissions claim lives on\n`context.permissions`).\nNOTE: this is a convenience for in-handler gating; the edge `permission`\nconstraint is the security boundary for route-level access.\n\nFAIL-CLOSED: an ABSENT permission set (`ctx.permissions === undefined`)\nDENIES — absence NEVER means grant-all, and the presence of a verified signed\ncontext does NOT change that (its presence is not consulted). A DEFINED array\nuses the unified {@link permissionSatisfies} rule (`*` / `:*` /\nexact), so an explicit `[\"*\"]` (org OWNER / RBAC-disabled) grants everything\nand `[]` denies. A builder that wants an ungated route simply does not call\nthis / {@link requirePermission}.", "signature": "export declare function hasPermission(ctx: PermissionCarrier, key: string): boolean;", "typeReferences": [ { "name": "PermissionCarrier", "source": "packages/backend/dist/types/core/permissions.d.ts#L61" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.HeadersLike", "name": "@farthershore/backend.HeadersLike", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/verifyRequest.d.ts#L22", "description": "Public export HeadersLike; see its declaration and owning guide.", "signature": "export type HeadersLike = Headers | Record;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.HealthSnapshot", "name": "@farthershore/backend.HealthSnapshot", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/health.d.ts#L3", "description": "Public export HealthSnapshot; see its declaration and owning guide.", "signature": "export type HealthSnapshot = {\n runtimeToken: boolean;\n bootstrap: boolean;\n tunnel: string | null;\n verification: boolean;\n metering: boolean;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.HealthStatus", "name": "@farthershore/backend.HealthStatus", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/health.d.ts#L2", "description": "Public export HealthStatus; see its declaration and owning guide.", "signature": "export type HealthStatus = \"starting\" | \"ready\" | \"degraded\" | \"stopping\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.HeartbeatOptions", "name": "@farthershore/backend.HeartbeatOptions", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/health.d.ts#L12", "description": "Public export HeartbeatOptions; see its declaration and owning guide.", "signature": "export type HeartbeatOptions = {\n runtimeToken: string;\n coreUrl: string;\n status: HealthStatus;\n instanceId?: string;\n fetchImpl?: typeof fetch;\n};", "typeReferences": [ { "name": "HealthStatus", "source": "packages/backend/dist/types/core/health.d.ts#L2" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.initFromEnv", "name": "@farthershore/backend.initFromEnv", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/index.d.ts#L69", "description": "Convenience: top-level initFromEnv mirroring fartherShore.initFromEnv().", "signature": "export declare function initFromEnv(options?: FartherShoreInitOptions): FartherShoreInstance;", "typeReferences": [ { "name": "FartherShoreInitOptions", "source": "packages/backend/dist/types/core/runtime.d.ts#L21" }, { "name": "FartherShoreInstance", "source": "packages/backend/dist/types/index.d.ts#L32" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.isPortalSession", "name": "@farthershore/backend.isPortalSession", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/subject.d.ts#L45", "description": "True when the verified request came from the managed portal UI (a member\nbrowser session), false when it came from an API key, and `undefined` when\nthere is no verified principal. Convenience over {@link credentialKind} for\nthe common portal-vs-API branch (e.g. richer UI payloads for portal callers).\nThe gateway's `enforce-surface` middleware is the SECURITY boundary; this is\nfor in-handler ergonomics.", "signature": "export declare function isPortalSession(ctx: PrincipalCarrier): boolean | undefined;", "typeReferences": [ { "name": "PrincipalCarrier", "source": "packages/backend/dist/types/core/subject.d.ts#L11" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.Jwk", "name": "@farthershore/backend.Jwk", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/jwks.d.ts#L1", "description": "Public export Jwk; see its declaration and owning guide.", "signature": "export type Jwk = JsonWebKey & {\n kid?: string;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.JwksClient", "name": "@farthershore/backend.JwksClient", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/jwks.d.ts#L43", "description": "Caching JWKS client. Serves the last successful key set as a warm fallback\nwhile a refresh is failing, but only until {@link JwksClientOptions.hardStaleMs};\nfails closed on a cold cache and past the hard-stale ceiling.", "signature": "export declare class JwksClient {\n private readonly jwksUrl;\n private readonly fetchImpl;\n private readonly cacheTtlMs;\n private readonly hardStaleMs;\n private readonly negativeCacheMs;\n private readonly now;\n private readonly onObservation;\n private keysByKid;\n private fetchedAt;\n private hasFetchedOnce;\n private inflight;\n private readonly negativeKids;\n constructor(options: JwksClientOptions);\n /**\n * Resolve a public JWK for `kid`, fail-closed. Throws FartherShoreError with\n * `jwks_unavailable` (cold cache, or a hard-stale cache whose refresh is\n * failing) or `unknown_key_id`.\n */\n getKey(kid: string): Promise;\n /** Record a confirmed-missing kid, evicting the oldest if at capacity. */\n private rememberMissingKid;\n private ageMs;\n private isStale;\n private isHardStale;\n /** Current freshness of the cached key set. */\n private cacheState;\n private observe;\n /** Fail closed when the cached key set is past the hard-stale ceiling. */\n private assertWithinHardStale;\n /** Single-flight refresh: concurrent callers share one fetch. */\n private refresh;\n private doFetch;\n /**\n * BOUNDED stale-while-revalidate. A COLD cache fails closed. A warm cache\n * inside the soft window swallows the failure and keeps serving. Past the\n * hard-stale ceiling it fails closed too — availability is worth a bounded\n * window of degraded trust, not an unbounded one.\n */\n private handleRefreshFailure;\n}", "typeReferences": [ { "name": "Jwk", "source": "packages/backend/dist/types/core/jwks.d.ts#L1" }, { "name": "JwksClientOptions", "source": "packages/backend/dist/types/core/jwks.d.ts#L19" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.JwksClientOptions", "name": "@farthershore/backend.JwksClientOptions", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/jwks.d.ts#L19", "description": "Public export JwksClientOptions; see its declaration and owning guide.", "signature": "export type JwksClientOptions = {\n jwksUrl: string;\n /** Injectable fetch (tests). Defaults to globalThis.fetch. */\n fetchImpl?: typeof fetch;\n /** How long a successful fetch stays fresh before a background refresh. */\n cacheTtlMs?: number;\n /**\n * Hard ceiling on serving a key set whose refresh is failing. Past this age\n * the client FAILS CLOSED rather than vouching for keys it can no longer\n * confirm. Must be ≥ cacheTtlMs.\n */\n hardStaleMs?: number;\n /** How long an unknown-kid result is negatively cached (avoids hammering). */\n negativeCacheMs?: number;\n /** Injectable clock (tests). */\n now?: () => number;\n /** Freshness//staleness observations for metrics. */\n onObservation?: JwksObserver__4d7082fe0d6b;\n};", "typeReferences": [ { "name": "JwksObserver__4d7082fe0d6b", "source": "packages/backend/dist/types/core/jwks.d.ts#L18" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.LimitDescriptor", "name": "@farthershore/backend.LimitDescriptor", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-types.d.ts#L8", "description": "C-1 — the machine-readable limit descriptor on a limit-deny body. A backend\nthat surfaces a plan-limit deny carries this so SDKs can render an upgrade\naffordance. Structurally identical to the contracts `LimitDescriptor`.", "signature": "export interface LimitDescriptor {\n /** Stable identifier for the limit hit — a `limitCode` VALUE\n * (`quota` | `rate_limit` | `credit` | `resource:`), NOT a wire code. */\n limitCode: string;\n /** Metered/resource dimension when known; null otherwise. */\n dimension: string | null;\n /** The cap the subscriber is at when known; null otherwise. */\n currentCapacity: number | null;\n}", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.MAX_BODY_BYTES", "name": "@farthershore/backend.MAX_BODY_BYTES", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-types.d.ts#L148", "description": "Max raw-body bytes the gateway/SDK will hash before returning 413.", "signature": "declare const MAX_BODY_BYTES: number;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.Measurement", "name": "@farthershore/backend.Measurement", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/report.d.ts#L70", "description": "The wire shape of one validated measurement.", "signature": "export type Measurement = {\n meter: string;\n values: MeasurementValues;\n dims?: MeasurementDimensions;\n};", "typeReferences": [ { "name": "MeasurementDimensions", "source": "packages/backend/dist/types/core/report.d.ts#L5" }, { "name": "MeasurementValues", "source": "packages/backend/dist/types/core/report.d.ts#L3" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.MeasurementDimensions", "name": "@farthershore/backend.MeasurementDimensions", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/report.d.ts#L5", "description": "Catalog selectors the measurement was produced under, keyed by dimension.", "signature": "export type MeasurementDimensions = Record;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.MEASUREMENTS_VERSION", "name": "@farthershore/backend.MEASUREMENTS_VERSION", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/report.d.ts#L76", "description": "Version of the `measurements` payload lane (additive over `rawDimsUnits`).", "signature": "declare const MEASUREMENTS_VERSION = 1;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.MeasurementValues", "name": "@farthershore/backend.MeasurementValues", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/report.d.ts#L3", "description": "Observed measurement values, keyed by measure key.", "signature": "export type MeasurementValues = Record;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.MemberSubject", "name": "@farthershore/backend.MemberSubject", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/subject.d.ts#L3", "description": "The member arm of {@link ConsumerPrincipal}'s subject.", "signature": "export type MemberSubject = Extract;", "typeReferences": [ { "name": "ConsumerPrincipal", "source": "packages/backend/dist/types/core/verifyContext.d.ts#L8" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.METERING_PAYLOAD_HEADER", "name": "@farthershore/backend.METERING_PAYLOAD_HEADER", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/response-metering.d.ts#L63", "description": "Public export METERING_PAYLOAD_HEADER; see its declaration and owning guide.", "signature": "declare const METERING_PAYLOAD_HEADER: \"x-fs-metering\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.METERING_SIGNATURE_HEADER", "name": "@farthershore/backend.METERING_SIGNATURE_HEADER", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/response-metering.d.ts#L64", "description": "Public export METERING_SIGNATURE_HEADER; see its declaration and owning guide.", "signature": "declare const METERING_SIGNATURE_HEADER: \"x-fs-metering-sig\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.METERING_TOKEN_HEADER", "name": "@farthershore/backend.METERING_TOKEN_HEADER", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/response-metering.d.ts#L65", "description": "Public export METERING_TOKEN_HEADER; see its declaration and owning guide.", "signature": "declare const METERING_TOKEN_HEADER: \"x-fs-metering-token\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.MeteringError", "name": "@farthershore/backend.MeteringError", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/response-metering.d.ts#L67", "description": "Public export MeteringError; see its declaration and owning guide.", "signature": "export declare class MeteringError extends Error {\n readonly code: ResponseMeteringErrorCode__bb4ee7cec8df;\n constructor(code: ResponseMeteringErrorCode__bb4ee7cec8df, message: string);\n}", "typeReferences": [ { "name": "ResponseMeteringErrorCode__bb4ee7cec8df", "source": "packages/backend/dist/types/response-metering.d.ts#L8" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.MeteringHeaders", "name": "@farthershore/backend.MeteringHeaders", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/response-metering.d.ts#L43", "description": "The three response-metering headers as a plain, attachable name→value map.", "signature": "export type MeteringHeaders = Record;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.MiddlewareOptions", "name": "@farthershore/backend.MiddlewareOptions", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/adapters/express.d.ts#L31", "description": "Public export MiddlewareOptions; see its declaration and owning guide.", "signature": "export type MiddlewareOptions = {\n /**\n * STRICT BY DEFAULT (`true`). Every request is verified FAIL-CLOSED and its\n * inbound `x-fs-*` headers are stripped before the handler runs — the verified\n * `req.fartherShore` context is the only identity source. The builder need not\n * pass this: the gateway signs every request, and a missing/invalid signature\n * or context is a `401`.\n *\n * Set `always: false` to instead DEFER to bootstrap's\n * `verification.required` flag — when the backend contract does not require\n * verification, the request passes through WITHOUT a context (and without\n * stripping). This is an advanced escape hatch for a backend that intentionally\n * consumes no identity; the secure default is strict.\n */\n always?: boolean;\n /**\n * Called when verification REJECTS a request, with the diagnostic detail that\n * is deliberately withheld from the response body.\n *\n * The wire response is only `{ error: }` (plus the error's `details`,\n * if any) — several distinct causes share one code (`route_mismatch` covers\n * both a business mismatch and a backend mismatch; an unserved route id is\n * the separate `route_unknown`), and the specifics must not leak to an\n * unauthenticated caller. But discarding them entirely leaves the operator\n * with no way to tell which cause fired, in their OWN logs, for their OWN\n * server. That is what this hook restores.\n *\n * Defaults to a one-line `console.warn`. Pass a function to route it into a\n * structured logger, or `() => {}` to silence it.\n */\n onVerificationError?: (detail: {\n code: string;\n message: string;\n status: number;\n method: string;\n path: string;\n }) => void;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.nodeSpawn", "name": "@farthershore/backend.nodeSpawn", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/tunnel.d.ts#L177", "description": "The default production spawner: a thin wrapper over Node's\n`child_process.spawn`. Stdio is piped (so logs flow through the redactor); the\ntunnel token is passed as an argv item, never via the environment. Tests\nalways inject their own spawner instead of this.", "signature": "export declare function nodeSpawn(): SpawnFn;", "typeReferences": [ { "name": "SpawnFn", "source": "packages/backend/dist/types/core/tunnel.d.ts#L25" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.NonceCache", "name": "@farthershore/backend.NonceCache", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/nonceCache.d.ts#L36", "description": "Bounded nonce cache. `checkAndRemember(id)` returns false (and records the id)\nthe first time it sees an id, and true (replay) on any subsequent sighting\nwhile the id is still retained.", "signature": "export declare class NonceCache implements NonceStore {\n private readonly maxEntries;\n private readonly ttlMs;\n private readonly now;\n private readonly seen;\n constructor(options?: NonceCacheOptions);\n /**\n * @returns true if `id` was already seen (a REPLAY); false on first sight\n * (the id is then remembered).\n */\n checkAndRemember(id: string): boolean;\n /** Number of retained nonces (test/observability hook). */\n get size(): number;\n private evictExpired;\n}", "typeReferences": [ { "name": "NonceCacheOptions", "source": "packages/backend/dist/types/core/nonceCache.d.ts#L16" }, { "name": "NonceStore", "source": "packages/backend/dist/types/core/nonceCache.d.ts#L13" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.NonceCacheOptions", "name": "@farthershore/backend.NonceCacheOptions", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/nonceCache.d.ts#L16", "description": "Public export NonceCacheOptions; see its declaration and owning guide.", "signature": "export type NonceCacheOptions = {\n /**\n * Max distinct nonces retained. At capacity (after expired nonces are\n * removed) the cache FAILS CLOSED — new nonces are rejected as replays rather\n * than evicting an unexpired one. Raise this for high single-instance\n * throughput, or inject a shared {@link NonceStore}.\n */\n maxEntries?: number;\n /** TTL after which a nonce is forgotten. Defaults to the signature validity\n * window (replay window + clock skew); a nonce older than that is rejected by\n * the timestamp check anyway. Must be ≥ that window. */\n ttlMs?: number;\n /** Injectable clock (tests). */\n now?: () => number;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.NonceStore", "name": "@farthershore/backend.NonceStore", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/nonceCache.d.ts#L13", "description": "Replay-prevention store contract. `checkAndRemember(id)` returns `true` if\n`id` was already seen (a REPLAY) and `false` on first sight (recording it).\n\nThe default {@link NonceCache} is IN-MEMORY and PER-PROCESS: it prevents\nreplay against a single instance only. A multi-replica backend where a\ncaptured, still-valid signed request is replayed to a DIFFERENT replica needs\na SHARED store (Redis/Memcached/Cloudflare KV/Durable Object) — inject one via\n`FartherShoreInitOptions.nonceStore`. `checkAndRemember` may be async so a\nnetwork-backed store can be awaited. (Time-bounding still caps the exposure\nto the signature's ~300s validity window regardless of the store.)", "signature": "export interface NonceStore {\n checkAndRemember(id: string): boolean | Promise;\n}", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.PermissionCarrier", "name": "@farthershore/backend.PermissionCarrier", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/permissions.d.ts#L61", "description": "The subset of a verified context these helpers read.", "signature": "export interface PermissionCarrier {\n permissions?: readonly string[];\n /** Exact product permissions default-allowed by the current G+A decision. */\n unassignedProductPermissions?: readonly string[];\n /**\n * The verified X-Fs-Context claims, when the request carried a valid token.\n * NOT consulted for permission decisions — its presence NEVER grants (an\n * absent `permissions` set always denies). Retained only as part of the\n * verified-context shape a carrier is built from.\n */\n signedContext?: FartherShoreSignedContext;\n}", "typeReferences": [ { "name": "FartherShoreSignedContext", "source": "packages/backend/dist/types/core/verifyContext.d.ts#L33" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.permissionSatisfies", "name": "@farthershore/backend.permissionSatisfies", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/permissions.d.ts#L59", "description": "Whether the granted `permissions` satisfy the required `key` under the\nunified grammar: `\"*\"` (global), `\":*\"` (subject wildcard), or the\nEXACT key. NO verb-class widening (class forms are expanded to concrete verbs\nserver-side at save time). Superset of {@link permissionGrants } — it adds the\n`:*` rung. NOTE: the `granted === undefined → true` codomain here is\nthe PRIMITIVE's contract (kept byte-identical to contracts for parity); it is\nNOT the SDK's carrier policy. Callers gate through {@link hasPermission},\nwhich under FAR-723 DENIES an absent permission set before ever reaching this\nprimitive — so absence never grants at the carrier level.\n\nFAITHFUL COPY of the canonical `permissionSatisfies` in\n`@farthershore/contracts` (`authz/verbs.ts`); the published bundle is\ncontracts-free, so `permissions-parity.test.ts` asserts agreement over a\nshared golden table (with the backend's grace rule tested separately).", "signature": "export declare function permissionSatisfies(required: string, granted: readonly string[] | undefined): boolean;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.PrincipalCarrier", "name": "@farthershore/backend.PrincipalCarrier", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/subject.d.ts#L11", "description": "Anything carrying a verified {@link ConsumerPrincipal} (the request context).", "signature": "export type PrincipalCarrier = {\n principal?: ConsumerPrincipal;\n};", "typeReferences": [ { "name": "ConsumerPrincipal", "source": "packages/backend/dist/types/core/verifyContext.d.ts#L8" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.principalFromContextClaims", "name": "@farthershore/backend.principalFromContextClaims", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/verifyContext.d.ts#L88", "description": "Derive the {@link ConsumerPrincipal} from a verified cv=2 payload, FAIL-CLOSED.\n\nThis is a thin, contracts-free-typed re-export of the SINGLE canonical\nderivation in `@farthershore/contracts` (`authz/principal.ts`). The SDK keeps\nits own local {@link ConsumerPrincipal} / {@link FartherShoreSignedContext}\n*types* (so the published `.d.ts` never leaks the private contracts package),\nbut the derivation LOGIC lives in exactly one place — no drift is possible.\n\nReturns `null` — never a partially-populated principal — when any identity /\nauthz field is invalid: an empty/whitespace `sub`/`org`/`businessId`, a\nmissing/unknown `subjectKind`, a `service` subject with no `serviceAccountId`\nor `keyId`, a delegated `member` with an empty `act.sub`, a `permissions` /\n`roles` claim that is not an array of non-empty strings, or CONTRADICTORY\nidentity evidence (a `serviceAccountId` that disagrees with `sub`, or a\n`client_id` that disagrees with `act.sub`). The caller (`verifyRequest`) treats\n`null` as tamper evidence and fails closed (`context_unverified`).\n\n - service: `serviceAccountId = serviceAccountId ?? sub` (the two must agree),\n `keyId = client_id ?? act.sub ?? sub`.\n - member: `memberId = sub`; `via = \"api_key\"` with `keyId = act.sub` when\n the delegation claim is present, else `via = \"session\"`.\n\nEvery derived id is the TRIMMED (canonical) value.", "signature": "export declare function principalFromContextClaims(claims: FartherShoreSignedContext): ConsumerPrincipal | null;", "typeReferences": [ { "name": "ConsumerPrincipal", "source": "packages/backend/dist/types/core/verifyContext.d.ts#L8" }, { "name": "FartherShoreSignedContext", "source": "packages/backend/dist/types/core/verifyContext.d.ts#L33" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.QuoteInput", "name": "@farthershore/backend.QuoteInput", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/report.d.ts#L23", "description": "Authoring shape of {@link QuoteProposal}. `amountNanos` (nanodollars PER\nUNIT of the entry's measure) accepts a number, bigint, or decimal integer\nstring; anything else is rejected.", "signature": "export type QuoteInput = {\n currency: string;\n amountNanos: number | bigint | string;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.QuoteProposal", "name": "@farthershore/backend.QuoteProposal", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/report.d.ts#L14", "description": "The validated, transmitted quote — a PROPOSED rate input, never a charge.\n`amountNanos` is a decimal integer string of nanodollars **per unit of the\nentry's measure** (the platform's money unit is the nanodollar); core\nmultiplies it by the measured quantity, clamps it into the pricing policy's\ndeclared per-unit `{min,max}`, and flags out-of-range proposals for dispute.\nNever send a total.", "signature": "export type QuoteProposal = {\n currency: string;\n amountNanos: string;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.READ_METHODS", "name": "@farthershore/backend.READ_METHODS", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/permissions.d.ts#L25", "description": "HTTP verbs that classify as `:read`. Everything else — including the\nroute-catalog wildcard `*` — classifies as `:write`.\n\nFAITHFUL COPY of the canonical `READ_METHODS` in the permissions kernel\n(`@farthershore/authz/grammar/route`, re-exported by\n`@farthershore/contracts/rbac`); the published bundle is contracts-free, so\n`permissions-parity.test.ts` asserts agreement and the full corpus replay\nlives in packages/authz/test-node/sdk-copy-parity.test.ts.", "signature": "declare const READ_METHODS: ReadonlySet;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.REDACTED_TOKEN", "name": "@farthershore/backend.REDACTED_TOKEN", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/tunnel.d.ts#L31", "description": "The sentinel substituted for the tunnel token in any logged/serialized text.", "signature": "declare const REDACTED_TOKEN = \"***REDACTED***\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.ReplayProtectionDiagnostic", "name": "@farthershore/backend.ReplayProtectionDiagnostic", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/replay-protection.d.ts#L4", "description": "Public export ReplayProtectionDiagnostic; see its declaration and owning guide.", "signature": "export type ReplayProtectionDiagnostic = {\n mode: ReplayProtectionMode;\n /** True when replay is enforced across every replica, not just this process. */\n crossReplica: boolean;\n};", "typeReferences": [ { "name": "ReplayProtectionMode", "source": "packages/backend/dist/types/core/replay-protection.d.ts#L3" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.ReplayProtectionMode", "name": "@farthershore/backend.ReplayProtectionMode", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/replay-protection.d.ts#L3", "description": "How far one-time-use enforcement actually reaches.", "signature": "export type ReplayProtectionMode = \"shared\" | \"single-instance\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.reportHealth", "name": "@farthershore/backend.reportHealth", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/health.d.ts#L23", "description": "POST a heartbeat to core. Best-effort: resolves false on any failure rather\nthan throwing (tunnel/health failure ≠ verification — must not crash the app).", "signature": "export declare function reportHealth(options: HeartbeatOptions): Promise;", "typeReferences": [ { "name": "HeartbeatOptions", "source": "packages/backend/dist/types/core/health.d.ts#L12" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.ReportInput", "name": "@farthershore/backend.ReportInput", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/report.d.ts#L28", "description": "One measurement report. The complete argument surface of the verb.", "signature": "export type ReportInput = {\n /** Meter key as declared in the business release (plain string at the wire). */\n meter: string;\n /** Observed values keyed by measure key, e.g. `{ input_tokens: 1200 }`. */\n values: MeasurementValues;\n /** Catalog selectors, e.g. `{ model: \"acme-4\", cache_status: \"hit\" }`. */\n dims?: MeasurementDimensions;\n /**\n * OPTIONAL money proposal for a `backendQuoted` pricing rule: a PER-UNIT\n * rate in nanodollars (multiplied by the measured quantity — never a\n * total). Opaque at the authoring boundary (a job result carries it through\n * untyped); validated against {@link QuoteInput} here and transmitted as a\n * {@link QuoteProposal}. Applies to every backend-quoted component of this\n * report; ignored by rules that are not backend-quoted.\n */\n quote?: unknown;\n};", "typeReferences": [ { "name": "MeasurementDimensions", "source": "packages/backend/dist/types/core/report.d.ts#L5" }, { "name": "MeasurementValues", "source": "packages/backend/dist/types/core/report.d.ts#L3" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.ReportResult", "name": "@farthershore/backend.ReportResult", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/report.d.ts#L53", "description": "Delivery outcome. Validation faults THROW (a malformed report is a builder\nbug worth surfacing); delivery faults resolve `ok: false` so a metering\nhiccup never breaks the builder's endpoint. A served request may own only\none post-stream callback identity, so later calls fail explicitly.", "signature": "export type ReportResult = {\n ok: true;\n transport: ReportTransport;\n} | {\n ok: false;\n transport: ReportTransport;\n reason: string;\n /** The PLATFORM's error code, when the failure came back in a response\n * body (e.g. `post_stream_request_not_found`). Absent for local faults.\n * Surfaced so a builder can act on the cause without wrapping fetch. */\n code?: string;\n /** The platform's own error message, verbatim. */\n message?: string;\n /** HTTP status of the final delivery attempt, when there was one. */\n status?: number;\n};", "typeReferences": [ { "name": "ReportTransport", "source": "packages/backend/dist/types/core/report.d.ts#L46" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.ReportTransport", "name": "@farthershore/backend.ReportTransport", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/report.d.ts#L46", "description": "Which channel actually carried the measurement.", "signature": "export type ReportTransport = \"in_band\" | \"post_stream\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.requireMember", "name": "@farthershore/backend.requireMember", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/subject.d.ts#L20", "description": "Assert the request resolved to a MEMBER subject and return it narrowed. On a\ngateway-enforced `subject: 'member'` route this never throws; call it in\nhandler code to read `memberId` without a manual discriminant check. Throws\n`member_subject_required` when the subject is a service (or absent).", "signature": "export declare function requireMember(ctx: PrincipalCarrier): MemberSubject;", "typeReferences": [ { "name": "MemberSubject", "source": "packages/backend/dist/types/core/subject.d.ts#L3" }, { "name": "PrincipalCarrier", "source": "packages/backend/dist/types/core/subject.d.ts#L11" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.requirePermission", "name": "@farthershore/backend.requirePermission", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/permissions.d.ts#L93", "description": "Assert the acting user holds `key`, throwing {@link FartherShorePermissionError}\n(403) otherwise. Same trust model as {@link hasPermission}.", "signature": "export declare function requirePermission(ctx: PermissionCarrier, key: string): void;", "typeReferences": [ { "name": "PermissionCarrier", "source": "packages/backend/dist/types/core/permissions.d.ts#L61" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.requireService", "name": "@farthershore/backend.requireService", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/subject.d.ts#L25", "description": "Assert the request resolved to a SERVICE subject and return it narrowed.\nThrows `service_subject_required` when the subject is a member (or absent).", "signature": "export declare function requireService(ctx: PrincipalCarrier): ServiceSubject;", "typeReferences": [ { "name": "PrincipalCarrier", "source": "packages/backend/dist/types/core/subject.d.ts#L11" }, { "name": "ServiceSubject", "source": "packages/backend/dist/types/core/subject.d.ts#L7" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.ResponseMeteringUsagePayload", "name": "@farthershore/backend.ResponseMeteringUsagePayload", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/response-metering.d.ts#L20", "description": "The signed response-metering payload. `computeMeteringHeaders` accepts one of\nthese directly, so a non-Express / non-Fetch handler (or a Python/Go backend\nfollowing the wire recipe) can stamp valid headers with no JS SDK at all.\n`ctx.report()` is the JS surface that builds it.\n\n`measurements` (with its `measurementsVersion`) is the measurement lane the\none reporting verb emits: `{ meter, values, dims }` as declared in the\nbusiness release. `rawDimsUnits` remains as the flat projection the gateway's\nexisting settlement lane reads.", "signature": "export type ResponseMeteringUsagePayload = {\n method: string;\n path: string;\n rawDimsUnits?: Record;\n /** Schema version of {@link measurements}; currently `1`. */\n measurementsVersion?: number;\n /** Reported measurements — the authoritative rating input. */\n measurements?: {\n meter: string;\n values: Record;\n dims?: Record;\n }[];\n /** Proposed rate input for a `backendQuoted` pricing rule (core clamps it). */\n quote?: {\n currency: string;\n amountNanos: string;\n };\n measureContext?: Record;\n creditUnitsConsumed?: Record;\n operationKey?: string;\n usagePolicyId?: string;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.routePermission", "name": "@farthershore/backend.routePermission", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/permissions.d.ts#L42", "description": "Derive the permission string a credential must hold to call a route:\n`:read` for safe verbs (GET / HEAD / OPTIONS, any casing),\n`:write` for every other method INCLUDING the route-catalog\nwildcard `*`. Use it to build in-handler permission keys from the same\ngrammar the edge `permission` constraint enforces — never re-spell the\n`:read`/`:write` suffix locally.\n\nFAITHFUL COPY of the canonical `routePermission` in the permissions kernel\n(`@farthershore/authz/grammar/route`, re-exported by\n`@farthershore/contracts/rbac`); parity asserted as for {@link READ_METHODS}.", "signature": "export declare function routePermission(subject: string, method: string): string;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.RUNTIME_CLOCK_SKEW_SECONDS", "name": "@farthershore/backend.RUNTIME_CLOCK_SKEW_SECONDS", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-types.d.ts#L140", "description": "Mirrors SERVICE_JWT_CLOCK_SKEW_SECONDS — the per-request signer reuses the\nsame Ed25519/JWKS infra so the skew allowance is kept identical.", "signature": "declare const RUNTIME_CLOCK_SKEW_SECONDS = 5;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.RUNTIME_ERROR_CODE_TO_ERROR_CODE", "name": "@farthershore/backend.RUNTIME_ERROR_CODE_TO_ERROR_CODE", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-types.d.ts#L111", "description": "C-2 — map every canonical {@link RuntimeErrorCode} (wire snake_case value) to\nthe core `ErrorCode` it belongs to. Total over `RuntimeErrorCode` (the\n`Record` type makes a missing key a compile error). A\nfaithful copy of contracts' `RUNTIME_ERROR_CODE_TO_ERROR_CODE`.", "signature": "declare const RUNTIME_ERROR_CODE_TO_ERROR_CODE: Record;", "typeReferences": [ { "name": "RuntimeErrorCode", "source": "packages/backend/dist/types/generated/runtime-contract.d.ts#L21" }, { "name": "RuntimeMappedErrorCode", "source": "packages/backend/dist/types/runtime-types.d.ts#L104" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.RUNTIME_ERROR_CODES", "name": "@farthershore/backend.RUNTIME_ERROR_CODES", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/generated/runtime-contract.d.ts#L1", "description": "Public export RUNTIME_ERROR_CODES; see its declaration and owning guide.", "signature": "declare const RUNTIME_ERROR_CODES: {\n readonly missingSignature: \"missing_signature\";\n readonly malformedSignature: \"malformed_signature\";\n readonly unknownKeyId: \"unknown_key_id\";\n readonly jwksUnavailable: \"jwks_unavailable\";\n readonly badSignature: \"bad_signature\";\n readonly bodyHashMismatch: \"body_hash_mismatch\";\n readonly routeMismatch: \"route_mismatch\";\n readonly clockSkew: \"clock_skew\";\n readonly expiredSignature: \"expired_signature\";\n readonly replayedNonce: \"replayed_nonce\";\n readonly bodyTooLarge: \"body_too_large\";\n readonly environmentMismatch: \"environment_mismatch\";\n readonly missingToken: \"missing_token\";\n readonly invalidToken: \"invalid_token\";\n readonly contextUnverified: \"context_unverified\";\n readonly memberSubjectRequired: \"member_subject_required\";\n readonly serviceSubjectRequired: \"service_subject_required\";\n readonly surfaceNotAllowed: \"surface_not_allowed\";\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.RUNTIME_HEADER_NAMES", "name": "@farthershore/backend.RUNTIME_HEADER_NAMES", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-types.d.ts#L126", "description": "Public export RUNTIME_HEADER_NAMES; see its declaration and owning guide.", "signature": "declare const RUNTIME_HEADER_NAMES: {\n readonly signature: \"x-fs-signature\";\n readonly keyId: \"x-fs-key-id\";\n readonly requestId: \"x-fs-request-id\";\n readonly timestamp: \"x-fs-timestamp\";\n readonly businessId: \"x-fs-business-id\";\n readonly backendId: \"x-fs-backend-id\";\n readonly routeId: \"x-fs-route-id\";\n readonly policyVersion: \"x-fs-policy-version\";\n readonly bodyHash: \"x-fs-body-hash\";\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.RUNTIME_REPLAY_WINDOW_SECONDS", "name": "@farthershore/backend.RUNTIME_REPLAY_WINDOW_SECONDS", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-types.d.ts#L141", "description": "Public export RUNTIME_REPLAY_WINDOW_SECONDS; see its declaration and owning guide.", "signature": "declare const RUNTIME_REPLAY_WINDOW_SECONDS = 300;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.RUNTIME_TOKEN_OPERATIONS", "name": "@farthershore/backend.RUNTIME_TOKEN_OPERATIONS", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-types.d.ts#L124", "description": "Public export RUNTIME_TOKEN_OPERATIONS; see its declaration and owning guide.", "signature": "declare const RUNTIME_TOKEN_OPERATIONS: readonly [\"gateway_verification\", \"metering\", \"health\", \"tunnel\", \"drift_report\"];", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.RUNTIME_TOKEN_PREFIXES", "name": "@farthershore/backend.RUNTIME_TOKEN_PREFIXES", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-types.d.ts#L119", "description": "Public export RUNTIME_TOKEN_PREFIXES; see its declaration and owning guide.", "signature": "declare const RUNTIME_TOKEN_PREFIXES: {\n readonly live: \"fsrt_live_\";\n readonly test: \"fsrt_test_\";\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.RuntimeBootstrapResponse", "name": "@farthershore/backend.RuntimeBootstrapResponse", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-types.d.ts#L228", "description": "Public export RuntimeBootstrapResponse; see its declaration and owning guide.", "signature": "export type RuntimeBootstrapResponse = {\n business: {\n id: string;\n slug: string;\n };\n backend: {\n id: string;\n slug: string;\n name: string;\n };\n /**\n * Every backend id this token may serve, across ALL of the business's\n * environments — `backend.id` is always a member.\n *\n * One deployment holds exactly one `FS_RUNTIME_TOKEN`, so an\n * environment-scoped token forced a SEPARATE deployment per environment:\n * serving a preview env meant repointing (and breaking) production. A\n * business-scoped token serves every environment from one deployment, and the\n * SDK checks the gateway's signed backend id for MEMBERSHIP of this set\n * rather than equality with a single id.\n *\n * Optional and additive: an older core omits it and the SDK falls back to the\n * single-id equality check.\n */\n backendIds?: string[];\n environment: {\n id: string | null;\n kind: RuntimeEnvironmentKind__ac9ea026fbe7;\n };\n operations: RuntimeTokenOperation[];\n verification: RuntimeVerificationConfig__5494b13a9008;\n metering: RuntimeMeteringConfig__3d27722db6c2;\n transport: RuntimeTransportConfig__7254e971c589;\n routes: RuntimeRouteDescriptor__48a862559af0[];\n /** Reflected route-surface lock (surfaceHash + version). Present once core\n * serves it; `fs.ready()` diffs the reflected surface against it. */\n lock?: RuntimeLockDescriptor__0d22ecd0bb58;\n policyVersion: string;\n refreshAfterSeconds: number;\n};", "typeReferences": [ { "name": "RuntimeEnvironmentKind__ac9ea026fbe7", "source": "packages/backend/dist/types/runtime-types.d.ts#L180" }, { "name": "RuntimeLockDescriptor__0d22ecd0bb58", "source": "packages/backend/dist/types/runtime-types.d.ts#L224" }, { "name": "RuntimeMeteringConfig__3d27722db6c2", "source": "packages/backend/dist/types/runtime-types.d.ts#L195" }, { "name": "RuntimeRouteDescriptor__48a862559af0", "source": "packages/backend/dist/types/runtime-types.d.ts#L214" }, { "name": "RuntimeTokenOperation", "source": "packages/backend/dist/types/runtime-types.d.ts#L125" }, { "name": "RuntimeTransportConfig__7254e971c589", "source": "packages/backend/dist/types/runtime-types.d.ts#L203" }, { "name": "RuntimeVerificationConfig__5494b13a9008", "source": "packages/backend/dist/types/runtime-types.d.ts#L188" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.RuntimeErrorCode", "name": "@farthershore/backend.RuntimeErrorCode", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/generated/runtime-contract.d.ts#L21", "description": "Public export RuntimeErrorCode; see its declaration and owning guide.", "signature": "export type RuntimeErrorCode = (typeof RUNTIME_ERROR_CODES)[keyof typeof RUNTIME_ERROR_CODES];", "typeReferences": [ { "name": "RUNTIME_ERROR_CODES", "source": "packages/backend/dist/types/generated/runtime-contract.d.ts#L1" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.runtimeErrorToErrorCode", "name": "@farthershore/backend.runtimeErrorToErrorCode", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-types.d.ts#L117", "description": "C-2 — translate a runtime code into the canonical core `ErrorCode`. Returns\n`INTERNAL_ERROR` for an unrecognized value (defensive; the map is total over\nknown codes). Mirrors contracts' `runtimeErrorToErrorCode`.", "signature": "export declare function runtimeErrorToErrorCode(code: string): RuntimeMappedErrorCode;", "typeReferences": [ { "name": "RuntimeMappedErrorCode", "source": "packages/backend/dist/types/runtime-types.d.ts#L104" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.RuntimeHealthReport", "name": "@farthershore/backend.RuntimeHealthReport", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-types.d.ts#L306", "description": "Public export RuntimeHealthReport; see its declaration and owning guide.", "signature": "export type RuntimeHealthReport = {\n runtimeToken: boolean;\n bootstrap: boolean;\n tunnel: string | null;\n verification: boolean;\n metering: boolean;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.RuntimeMappedErrorCode", "name": "@farthershore/backend.RuntimeMappedErrorCode", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-types.d.ts#L104", "description": "C-2 — the canonical core `ErrorCode` VALUES this backend can map a\n`RuntimeErrorCode` onto (the codomain of {@link RUNTIME_ERROR_CODE_TO_ERROR_CODE}).\nThe full core enum lives in the shared platform contracts; the SDK only needs\nthe subset its bridge produces. Each is a verbatim core `ErrorCode` string —\nthe drift guard asserts membership in the canonical enum.", "signature": "export type RuntimeMappedErrorCode = \"UNAUTHORIZED\" | \"FORBIDDEN\" | \"SERVICE_UNAVAILABLE\" | \"VALIDATION_ERROR\" | \"INTERNAL_ERROR\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.RuntimeMeteringEvent", "name": "@farthershore/backend.RuntimeMeteringEvent", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-types.d.ts#L268", "description": "Public export RuntimeMeteringEvent; see its declaration and owning guide.", "signature": "export type RuntimeMeteringEvent = {\n event_id: string;\n business_id: string;\n backend_id: string;\n route_id?: string;\n request_id?: string;\n /** Subscription the usage belongs to (billing attribution). Optional and\n * additive: legacy emitters omit it; core then falls back to resolving the\n * served gateway request via `request_id`, and rows that resolve neither\n * way are persisted unbilled + flagged unattributable. */\n subscription_id?: string;\n meter: string;\n qty: number;\n timestamp: string;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.runtimeTokenKind", "name": "@farthershore/backend.runtimeTokenKind", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-signing.d.ts#L32", "description": "Classify a presented runtime token by prefix without trusting its body.\nReturns the environment kind, or `null` when the prefix is not recognized.", "signature": "declare const runtimeTokenKind: (token: string) => RuntimeTokenKind__821c369e851d | null;", "typeReferences": [ { "name": "RuntimeTokenKind__821c369e851d", "source": "packages/backend/dist/types/runtime-types.d.ts#L123" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.RuntimeTokenOperation", "name": "@farthershore/backend.RuntimeTokenOperation", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-types.d.ts#L125", "description": "Public export RuntimeTokenOperation; see its declaration and owning guide.", "signature": "export type RuntimeTokenOperation = (typeof RUNTIME_TOKEN_OPERATIONS)[number];", "typeReferences": [ { "name": "RUNTIME_TOKEN_OPERATIONS", "source": "packages/backend/dist/types/runtime-types.d.ts#L124" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.SDK_LOCAL_ERROR_CODES", "name": "@farthershore/backend.SDK_LOCAL_ERROR_CODES", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/errors.d.ts#L15", "description": "Codes this SDK mints on its own, which no gateway ever puts on the wire.\n\nThey deliberately do NOT live in `RUNTIME_ERROR_CODES` (the language-neutral\ngateway↔backend contract mirrored from `@farthershore/contracts/runtime` and\npinned by `runtime-contract-parity.test.ts`): that set describes the protocol\nthe gateway speaks, and a backend→CALLER response code is not part of it.\n\n`route_unknown` is the honest answer to \"your signature is valid, this process\nsimply does not serve that route id\" — previously indistinguishable from an\nauth failure because it shared `route_mismatch`'s 401.", "signature": "declare const SDK_LOCAL_ERROR_CODES: {\n /** Valid signature, unknown route id even after a forced bootstrap refresh. */\n readonly routeUnknown: \"route_unknown\";\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.SdkLocalErrorCode", "name": "@farthershore/backend.SdkLocalErrorCode", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/errors.d.ts#L19", "description": "Public export SdkLocalErrorCode; see its declaration and owning guide.", "signature": "export type SdkLocalErrorCode = (typeof SDK_LOCAL_ERROR_CODES)[keyof typeof SDK_LOCAL_ERROR_CODES];", "typeReferences": [ { "name": "SDK_LOCAL_ERROR_CODES", "source": "packages/backend/dist/types/core/errors.d.ts#L15" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.ServiceSubject", "name": "@farthershore/backend.ServiceSubject", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/subject.d.ts#L7", "description": "The service arm of {@link ConsumerPrincipal}'s subject.", "signature": "export type ServiceSubject = Extract;", "typeReferences": [ { "name": "ConsumerPrincipal", "source": "packages/backend/dist/types/core/verifyContext.d.ts#L8" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.ShutdownHook", "name": "@farthershore/backend.ShutdownHook", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/shutdown.d.ts#L1", "description": "Public export ShutdownHook; see its declaration and owning guide.", "signature": "export type ShutdownHook = () => Promise | void;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.ShutdownManager", "name": "@farthershore/backend.ShutdownManager", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/shutdown.d.ts#L3", "description": "LIFO registry of shutdown hooks, each isolated from sibling failures.", "signature": "export declare class ShutdownManager {\n private readonly hooks;\n private done;\n register(hook: ShutdownHook): void;\n get isShutDown(): boolean;\n /** Run all hooks in reverse order, isolating failures. Idempotent. */\n shutdown(): Promise;\n}", "typeReferences": [ { "name": "ShutdownHook", "source": "packages/backend/dist/types/core/shutdown.d.ts#L1" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.signCanonicalString", "name": "@farthershore/backend.signCanonicalString", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-signing.d.ts#L25", "description": "Sign the canonical string with an Ed25519 private JWK → base64url signature.", "signature": "declare const signCanonicalString: (canonical: string, privateJwk: JsonWebKey) => Promise;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.SpawnedTunnelProcess", "name": "@farthershore/backend.SpawnedTunnelProcess", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/tunnel.d.ts#L11", "description": "The minimal child-process surface the supervisor needs. A real\n`child_process.ChildProcess` satisfies this; tests pass a fake. We deliberately\ndo NOT depend on the full ChildProcess type so the spawner stays injectable and\nthe SDK does not pull a Node-only process model into the language-neutral core.", "signature": "export interface SpawnedTunnelProcess {\n readonly stdout: StdioStream__d26eea00aaf1 | null;\n readonly stderr: StdioStream__d26eea00aaf1 | null;\n readonly pid?: number;\n /** Register the process-exit handler. */\n on(event: \"exit\", listener: (code: number | null, signal: NodeJS.Signals | null) => void): unknown;\n /** Signal the child to stop. */\n kill(signal?: NodeJS.Signals | number): boolean;\n}", "typeReferences": [ { "name": "StdioStream__d26eea00aaf1", "source": "packages/backend/dist/types/core/tunnel.d.ts#L4" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.SpawnFn", "name": "@farthershore/backend.SpawnFn", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/tunnel.d.ts#L25", "description": "The injected spawner port. In production this is a thin wrapper over\n`child_process.spawn`; in tests it is a fake that records argv. It MUST NOT be\npassed `local_target` — routing is owned by Cloudflare.", "signature": "export type SpawnFn = (command: string, args: string[], options?: {\n env?: NodeJS.ProcessEnv;\n}) => SpawnedTunnelProcess;", "typeReferences": [ { "name": "SpawnedTunnelProcess", "source": "packages/backend/dist/types/core/tunnel.d.ts#L11" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.statusForCode", "name": "@farthershore/backend.statusForCode", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/errors.d.ts#L55", "description": "Map a runtime error code to its fail-closed HTTP status. Oversized bodies are\n413; a wrong-credential-surface denial is 403 (the caller IS authenticated,\njust not on a surface this route admits — mirrors the canonical\n`surface_not_allowed → FORBIDDEN` mapping in contracts/error-codes.ts);\nall other verification failures are 401.", "signature": "export declare function statusForCode(code: FartherShoreErrorCode): number;", "typeReferences": [ { "name": "FartherShoreErrorCode", "source": "packages/backend/dist/types/core/errors.d.ts#L21" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.STREAMING_EXEMPT_BODY_HASH", "name": "@farthershore/backend.STREAMING_EXEMPT_BODY_HASH", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-types.d.ts#L146", "description": "Sentinel emitted into the canonical string when a request is body-hash\nexempt (streaming). Raw-byte hashing is otherwise mandatory.", "signature": "declare const STREAMING_EXEMPT_BODY_HASH = \"STREAM\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.TransportMode", "name": "@farthershore/backend.TransportMode", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-types.d.ts#L181", "description": "Public export TransportMode; see its declaration and owning guide.", "signature": "export type TransportMode = \"direct\" | \"tunnel\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.TunnelState", "name": "@farthershore/backend.TunnelState", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/tunnel.d.ts#L29", "description": "Supervisor lifecycle states, surfaced through `status()` / `healthString()`.", "signature": "export type TunnelState = \"stopped\" | \"starting\" | \"running\" | \"restarting\" | \"error\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.TunnelStatus", "name": "@farthershore/backend.TunnelStatus", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/tunnel.d.ts#L77", "description": "A read-only snapshot of the supervisor — safe to serialize (token-free).", "signature": "export type TunnelStatus = {\n state: TunnelState;\n pid: number | null;\n restarts: number;\n /** Token-redacted last error message, if any. */\n lastError: string | null;\n};", "typeReferences": [ { "name": "TunnelState", "source": "packages/backend/dist/types/core/tunnel.d.ts#L29" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.VerifiedExpressHandler", "name": "@farthershore/backend.VerifiedExpressHandler", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/adapters/express.d.ts#L89", "description": "A route handler that runs only with a GUARANTEED verified PRINCIPAL. The first\nargument is the {@link VerifiedPrincipalContext} — read `ctx.principal` and\n`ctx.signedContext` (and narrow with `requireMember`/`requireService`)\nwithout any optional-chaining.\nSee {@link createExpressHandler}.", "signature": "export type VerifiedExpressHandler = (ctx: VerifiedPrincipalContext, req: Req, res: Res, next: ExpressNext) => void | Promise;", "typeReferences": [ { "name": "ExpressNext", "source": "packages/backend/dist/types/adapters/express.d.ts#L29" }, { "name": "ExpressRequestLike", "source": "packages/backend/dist/types/adapters/express.d.ts#L5" }, { "name": "ExpressResponseLike", "source": "packages/backend/dist/types/adapters/express.d.ts#L17" }, { "name": "VerifiedPrincipalContext", "source": "packages/backend/dist/types/adapters/express.d.ts#L78" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.VerifiedPrincipalContext", "name": "@farthershore/backend.VerifiedPrincipalContext", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/adapters/express.d.ts#L78", "description": "A verified request context whose {@link ConsumerPrincipal} is GUARANTEED\npresent — the shape handed to a {@link VerifiedExpressHandler}. The raw\n`FartherShoreRequestContext.principal` is optional (an identity-less gateway\nrequest is legitimate on the `fs.middleware()` path); `fs.handler()` narrows to\nthis type only AFTER rejecting an absent principal with `401 principal_required`,\nso the callback can read `ctx.principal` (and narrow with\n`requireMember`/`requireService`) without any optional-chaining.", "signature": "export type VerifiedPrincipalContext = FartherShoreRequestContext & {\n principal: ConsumerPrincipal;\n signedContext: FartherShoreSignedContext;\n};", "typeReferences": [ { "name": "ConsumerPrincipal", "source": "packages/backend/dist/types/core/verifyContext.d.ts#L8" }, { "name": "FartherShoreRequestContext", "source": "packages/backend/dist/types/core/verifyRequest.d.ts#L24" }, { "name": "FartherShoreSignedContext", "source": "packages/backend/dist/types/core/verifyContext.d.ts#L33" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.verifyCanonicalSignature", "name": "@farthershore/backend.verifyCanonicalSignature", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/runtime-signing.d.ts#L27", "description": "Verify a base64url Ed25519 signature over the canonical string.", "signature": "declare const verifyCanonicalSignature: (canonical: string, signatureB64Url: string, publicJwk: JsonWebKey) => Promise;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.verifyContext", "name": "@farthershore/backend.verifyContext", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/verifyContext.d.ts#L96", "description": "Verify an `X-Fs-Context` token against one or more HS256 secrets (try-all for\nkeyring rotation). Returns the typed cv=2 payload on success, `null` on any\nfailure (malformed, wrong alg, bad signature, unparseable payload, OR a\n`cv !== 2` claim-format the SDK does not understand). The caller treats a\n`null` as fatal (fail-closed).", "signature": "export declare function verifyContext(token: string, secrets: readonly string[]): Promise;", "typeReferences": [ { "name": "FartherShoreSignedContext", "source": "packages/backend/dist/types/core/verifyContext.d.ts#L33" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.verifyRequest", "name": "@farthershore/backend.verifyRequest", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/verifyRequest.d.ts#L167", "description": "Public export verifyRequest; see its declaration and owning guide.", "signature": "export declare function verifyRequest(input: VerifyRequestInput, deps: VerifyRequestDeps): Promise;", "typeReferences": [ { "name": "FartherShoreRequestContext", "source": "packages/backend/dist/types/core/verifyRequest.d.ts#L24" }, { "name": "VerifyRequestDeps", "source": "packages/backend/dist/types/core/verifyRequest.d.ts#L86" }, { "name": "VerifyRequestInput", "source": "packages/backend/dist/types/core/verifyRequest.d.ts#L6" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.VerifyRequestDeps", "name": "@farthershore/backend.VerifyRequestDeps", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/verifyRequest.d.ts#L86", "description": "Public export VerifyRequestDeps; see its declaration and owning guide.", "signature": "export type VerifyRequestDeps = {\n jwks: JwksClient;\n nonceCache: NonceStore;\n /** Expected business id (from bootstrap). When set, must match the signed claim. */\n businessId?: string;\n /** Expected backend id (from bootstrap). When set, must match — unless\n * `backendIds` is provided, which supersedes it with a membership check. */\n backendId?: string;\n /**\n * Every backend id this deployment may serve (from bootstrap), across all of\n * the business's environments. When provided, the signed backend id must be a\n * MEMBER of this set — superseding the single-id equality check above.\n *\n * A process holds exactly one `FS_RUNTIME_TOKEN`, so pinning to one backend id\n * forced a separate deployment per environment: serving a preview env meant\n * repointing (and breaking) production. A business-scoped token serves them\n * all from one deployment. Still fail-closed, still bound to this business —\n * just no longer bound to a single environment.\n */\n backendIds?: ReadonlySet;\n /**\n * Set of route ids this backend serves (from bootstrap). When provided AND\n * the signed route-id is non-empty, the signed route must be a member —\n * otherwise `route_unknown` (403), after one forced {@link refreshRouteSet}.\n */\n knownRouteIds?: ReadonlySet;\n clockSkewSeconds?: number;\n replayWindowSeconds?: number;\n /** Injectable clock (seconds since epoch). */\n nowSeconds?: () => number;\n /**\n * OPTIONAL HS256 secret(s) for the gateway's cv=2 `X-Fs-Context` claim\n * (multiple = keyring rotation, try-all). Consumer-principal wave (D3): these\n * are NOT required to produce the principal. The context token's authenticity\n * comes from the Ed25519 REQUEST signature — the token's SHA-256 is bound into\n * the canonical signing string, so a verified request already vouches for the\n * token's content. Principal derivation therefore happens whenever a token is\n * presented, with or without a configured secret. When these secrets ARE\n * configured they add DEFENSE-IN-DEPTH: a presented token must ALSO pass HS256\n * (a second, independent proof) or the request is rejected. Leaving this empty\n * is the common case (the request-signature binding is sufficient).\n */\n contextSecrets?: readonly string[];\n /**\n * The `policyVersion` of the bootstrap that produced {@link knownRouteIds}.\n * When the gateway's SIGNED policy version disagrees with it, this process is\n * demonstrably behind the edge — an exact, cheap refresh trigger that does not\n * wait for a route id to be missed.\n */\n cachedPolicyVersion?: string;\n /**\n * Force ONE bootstrap refresh and return the fresh route set. Called ONLY\n * after the Ed25519 signature has verified, and only through\n * {@link routeRefreshLimiter}. Returning `null` (or throwing) leaves the\n * cached set in force — a refresh failure must never turn a KNOWN route into\n * a rejection.\n */\n refreshRouteSet?: RouteSetRefresher__8966fd1442e8;\n /**\n * Rate limiter guarding {@link refreshRouteSet}. Omitting it admits every\n * refresh, which is acceptable only in tests — the runtime facade always\n * supplies one so a flood of bogus route ids cannot fan out to core.\n */\n routeRefreshLimiter?: RouteRefreshGate__ebb28e3c71bf;\n /** Age of the cached bootstrap in seconds (diagnostics only). */\n bootstrapAgeSeconds?: () => number;\n /** WARN sink for route-propagation diagnostics. Defaults to `console.warn`. */\n onWarn?: (message: string) => void;\n};", "typeReferences": [ { "name": "JwksClient", "source": "packages/backend/dist/types/core/jwks.d.ts#L43" }, { "name": "NonceStore", "source": "packages/backend/dist/types/core/nonceCache.d.ts#L13" }, { "name": "RouteRefreshGate__ebb28e3c71bf", "source": "packages/backend/dist/types/core/verifyRequest.d.ts#L164" }, { "name": "RouteSetRefresher__8966fd1442e8", "source": "packages/backend/dist/types/core/verifyRequest.d.ts#L159" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.root.VerifyRequestInput", "name": "@farthershore/backend.VerifyRequestInput", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/root", "source": "packages/backend/dist/types/core/verifyRequest.d.ts#L6", "description": "Per-request input. `headers` keys are matched case-insensitively.", "signature": "export type VerifyRequestInput = {\n method: string;\n /** Path only (no host, no query). */\n path: string;\n /** Raw query string (with or without leading '?'); \"\" when absent. */\n query?: string;\n headers: HeadersLike;\n /** Raw request bytes captured pre-parser; null/undefined for empty body. */\n body?: Uint8Array | null;\n /**\n * True when the request is body-hash-exempt (streaming). The signed hash must\n * then be the STREAM sentinel and the body is not hashed (size cap still\n * applies upstream).\n */\n streamingExempt?: boolean;\n};", "typeReferences": [ { "name": "HeadersLike", "source": "packages/backend/dist/types/core/verifyRequest.d.ts#L22" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.runtime.isStreamingExemptContentType", "name": "@farthershore/backend/runtime.isStreamingExemptContentType", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/runtime", "source": "packages/backend/dist/types/generated/runtime-contract.d.ts#L42", "description": "THE content-type half of the shared body-hash rule — a faithful copy of\n`isStreamingExemptContentType` in `@farthershore/contracts/runtime`, pinned\nbehaviourally by `runtime-contract-parity.test.ts`.\n\nMatching is on the content type's BASE (the part before any `;` parameters,\ne.g. a multipart boundary), case-insensitively. An exempt content type signs\nand verifies the STREAM sentinel REGARDLESS OF SIZE — the gateway signer\napplies the identical rule, so a small multipart upload agrees on both sides.", "signature": "export declare function isStreamingExemptContentType(contentType: string | null | undefined): boolean;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.runtime.RUNTIME_BODY_HASH_CONTRACT", "name": "@farthershore/backend/runtime.RUNTIME_BODY_HASH_CONTRACT", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/runtime", "source": "packages/backend/dist/types/generated/runtime-contract.d.ts#L22", "description": "Public export RUNTIME_BODY_HASH_CONTRACT; see its declaration and owning guide.", "signature": "declare const RUNTIME_BODY_HASH_CONTRACT: {\n readonly algorithm: \"SHA-256\";\n readonly encoding: \"hex-lower\";\n readonly source: \"raw-request-bytes\";\n readonly emptyBodyHash: \"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855\";\n readonly maxBodyBytes: 10485760;\n readonly streamingExemptToken: \"STREAM\";\n readonly streamingExemptContentTypes: readonly [\"text/event-stream\", \"application/octet-stream\", \"multipart/form-data\"];\n readonly overMaxStatus: 413;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.runtime.RUNTIME_ERROR_CODES", "name": "@farthershore/backend/runtime.RUNTIME_ERROR_CODES", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/runtime", "source": "packages/backend/dist/types/generated/runtime-contract.d.ts#L1", "description": "Public export RUNTIME_ERROR_CODES; see its declaration and owning guide.", "signature": "declare const RUNTIME_ERROR_CODES: {\n readonly missingSignature: \"missing_signature\";\n readonly malformedSignature: \"malformed_signature\";\n readonly unknownKeyId: \"unknown_key_id\";\n readonly jwksUnavailable: \"jwks_unavailable\";\n readonly badSignature: \"bad_signature\";\n readonly bodyHashMismatch: \"body_hash_mismatch\";\n readonly routeMismatch: \"route_mismatch\";\n readonly clockSkew: \"clock_skew\";\n readonly expiredSignature: \"expired_signature\";\n readonly replayedNonce: \"replayed_nonce\";\n readonly bodyTooLarge: \"body_too_large\";\n readonly environmentMismatch: \"environment_mismatch\";\n readonly missingToken: \"missing_token\";\n readonly invalidToken: \"invalid_token\";\n readonly contextUnverified: \"context_unverified\";\n readonly memberSubjectRequired: \"member_subject_required\";\n readonly serviceSubjectRequired: \"service_subject_required\";\n readonly surfaceNotAllowed: \"surface_not_allowed\";\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.runtime.RUNTIME_RESPONSE_METERING_CONTRACT", "name": "@farthershore/backend/runtime.RUNTIME_RESPONSE_METERING_CONTRACT", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/runtime", "source": "packages/backend/dist/types/generated/runtime-contract.d.ts#L43", "description": "Public export RUNTIME_RESPONSE_METERING_CONTRACT; see its declaration and owning guide.", "signature": "declare const RUNTIME_RESPONSE_METERING_CONTRACT: {\n readonly headers: {\n readonly payload: \"x-fs-metering\";\n readonly signature: \"x-fs-metering-sig\";\n readonly token: \"x-fs-metering-token\";\n };\n readonly token: {\n readonly environmentVariable: \"FS_RUNTIME_TOKEN\";\n readonly presentation: \"x-fs-metering-token\";\n readonly storage: \"sha256-hash-only\";\n };\n readonly signature: {\n readonly algorithm: \"HMAC-SHA256\";\n readonly encoding: \"base64url\";\n readonly input: \"payload-json\";\n readonly secret: \"presented-runtime-token\";\n };\n readonly payload: {\n readonly method: \"string\";\n readonly path: \"string\";\n readonly rawDimsUnits: \"Record?\";\n readonly measureContext: \"Record?\";\n readonly creditUnitsConsumed: \"Record?\";\n readonly measurementsVersion: \"1?\";\n readonly measurements: \"Array<{ meter: string; values: Record; dims?: Record }>?\";\n readonly quote: \"{ currency: string; amountNanos: string }?\";\n };\n readonly errors: {\n readonly missingToken: \"missing_token\";\n readonly invalidMeterKey: \"invalid_meter_key\";\n readonly invalidMeterValue: \"invalid_meter_value\";\n readonly invalidQuote: \"invalid_quote\";\n };\n readonly httpAdapter: {\n readonly input: \"Request\";\n readonly output: \"Response\";\n readonly networkCalls: false;\n readonly preserves: readonly [\"body\", \"headers\", \"status\", \"statusText\"];\n readonly gatewayStripsInternalHeaders: true;\n };\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.runtime.RuntimeErrorCode", "name": "@farthershore/backend/runtime.RuntimeErrorCode", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/runtime", "source": "packages/backend/dist/types/generated/runtime-contract.d.ts#L21", "description": "Public export RuntimeErrorCode; see its declaration and owning guide.", "signature": "export type RuntimeErrorCode = (typeof RUNTIME_ERROR_CODES)[keyof typeof RUNTIME_ERROR_CODES];", "typeReferences": [ { "name": "RUNTIME_ERROR_CODES", "source": "packages/backend/dist/types/generated/runtime-contract.d.ts#L1" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.assertNotProduction", "name": "@farthershore/backend/testing.assertNotProduction", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/prodGuard.d.ts#L12", "description": "Throw {@link DevModeInProductionError} when `NODE_ENV=production`. Call at the\nTOP of every dev-runtime constructor. `context` names the entry point for the\nerror message (e.g. \"createDevRuntime\", \"FS_DEV_MODE\").", "signature": "export declare function assertNotProduction(context: string, env?: Record): void;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.AuthzDecisionEntry", "name": "@farthershore/backend/testing.AuthzDecisionEntry", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L3", "description": "Public export AuthzDecisionEntry; see its declaration and owning guide.", "signature": "export type AuthzDecisionEntry = {\n permission: string;\n decision: \"allow\" | \"deny\";\n reason?: string;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.buildPersonaMap", "name": "@farthershore/backend/testing.buildPersonaMap", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/personas.d.ts#L90", "description": "Merge caller personas over the built-in defaults into a name→def map.", "signature": "export declare function buildPersonaMap(overrides?: Record | PersonaDefinition[]): Map;", "typeReferences": [ { "name": "PersonaDefinition", "source": "packages/backend/dist/types/testing/personas.d.ts#L4" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.CONTEXT_HEADER_NAME", "name": "@farthershore/backend/testing.CONTEXT_HEADER_NAME", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/personas.d.ts#L92", "description": "The header name for the signed context (exported for assertions).", "signature": "declare const CONTEXT_HEADER_NAME = \"x-fs-context\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.createDevGateway", "name": "@farthershore/backend/testing.createDevGateway", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/devGateway.d.ts#L40", "description": "Build the in-process dev gateway. `mode` drives `verification.required`:\n`passthrough` → false (the adapter passes requests through unverified, matching\nthe pre-keystone deploy order), `simulated` → true (fail-closed verification is\nexercised end-to-end).", "signature": "export declare function createDevGateway(options: DevGatewayOptions): DevGateway;", "typeReferences": [ { "name": "DevGateway", "source": "packages/backend/dist/types/testing/devGateway.d.ts#L21" }, { "name": "DevGatewayOptions", "source": "packages/backend/dist/types/testing/devGateway.d.ts#L7" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.createDevRuntime", "name": "@farthershore/backend/testing.createDevRuntime", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/devRuntime.d.ts#L71", "description": "Build a dev runtime: a real `FartherShore` wired to the in-process gateway and\nsigned personas, plus assertable usage/trace side channels.", "signature": "export declare function createDevRuntime(options: CreateDevRuntimeOptions): DevRuntime;", "typeReferences": [ { "name": "CreateDevRuntimeOptions", "source": "packages/backend/dist/types/testing/devRuntime.d.ts#L30" }, { "name": "DevRuntime", "source": "packages/backend/dist/types/testing/devRuntime.d.ts#L46" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.createDevRuntimeFromEnv", "name": "@farthershore/backend/testing.createDevRuntimeFromEnv", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/devRuntime.d.ts#L79", "description": "Self-construct the dev simulator from the environment. Called by `initFromEnv`\nwhen `FS_DEV_MODE` is set. Prints a LOUD banner, wires JSONL usage/trace sinks\n+ a mode-600 dev-keys file, and returns the augmented runtime.", "signature": "export declare function createDevRuntimeFromEnv(env?: Record): FartherShoreDevInstance;", "typeReferences": [ { "name": "FartherShoreDevInstance", "source": "packages/backend/dist/types/testing/devRuntime.d.ts#L14" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.CreateDevRuntimeOptions", "name": "@farthershore/backend/testing.CreateDevRuntimeOptions", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/devRuntime.d.ts#L30", "description": "Public export CreateDevRuntimeOptions; see its declaration and owning guide.", "signature": "export type CreateDevRuntimeOptions = {\n mode: DevMode;\n /** Persona overrides merged over the built-in owner/admin/member/anonymous. */\n personas?: Record | PersonaDefinition[];\n /** Route ids to expose in bootstrap (for route-binding tests). */\n routes?: string[];\n /** Meter keys (informational — the dev gateway accepts any meter). */\n meters?: string[];\n businessId?: string;\n backendId?: string;\n /** Optional app transport for persona `.fetch()`; defaults to global fetch. */\n appFetch?: typeof fetch;\n /** Reuse a fixed key set (cross-process). Defaults to a fresh ephemeral set. */\n keys?: DevSignerKeys;\n};", "typeReferences": [ { "name": "DevMode", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L1" }, { "name": "DevSignerKeys", "source": "packages/backend/dist/types/testing/signers.d.ts#L80" }, { "name": "PersonaDefinition", "source": "packages/backend/dist/types/testing/personas.d.ts#L4" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.createPersonaClient", "name": "@farthershore/backend/testing.createPersonaClient", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/personas.d.ts#L85", "description": "Build a persona client bound to a set of dev keys + bootstrap ids. Returns an\n`asPersona(name)` factory. Constructed by the dev runtime; also constructible\nstandalone from a dev-keys file (see `personaClientFromKeysFile`).", "signature": "export declare function createPersonaClient(ctx: PersonaClientContext): {\n asPersona(name: string): PersonaRequest;\n personas: Map;\n};", "typeReferences": [ { "name": "PersonaClientContext", "source": "packages/backend/dist/types/testing/personas.d.ts#L54" }, { "name": "PersonaDefinition", "source": "packages/backend/dist/types/testing/personas.d.ts#L4" }, { "name": "PersonaRequest", "source": "packages/backend/dist/types/testing/personas.d.ts#L66" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.DEFAULT_KEYS_FILE", "name": "@farthershore/backend/testing.DEFAULT_KEYS_FILE", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/keysFile.d.ts#L4", "description": "Public export DEFAULT_KEYS_FILE; see its declaration and owning guide.", "signature": "declare const DEFAULT_KEYS_FILE = \".farthershore/dev-keys.json\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.DEFAULT_PERSONAS", "name": "@farthershore/backend/testing.DEFAULT_PERSONAS", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/personas.d.ts#L34", "description": "The four built-in personas: owner / admin / member / anonymous.", "signature": "declare const DEFAULT_PERSONAS: Record;", "typeReferences": [ { "name": "PersonaDefinition", "source": "packages/backend/dist/types/testing/personas.d.ts#L4" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.definePersona", "name": "@farthershore/backend/testing.definePersona", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/personas.d.ts#L32", "description": "Identity-neutral pass-through of a persona definition (readability sugar).", "signature": "export declare function definePersona(def: PersonaDefinition): PersonaDefinition;", "typeReferences": [ { "name": "PersonaDefinition", "source": "packages/backend/dist/types/testing/personas.d.ts#L4" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.DEV_CORE_URL", "name": "@farthershore/backend/testing.DEV_CORE_URL", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/devGateway.d.ts#L4", "description": "Public export DEV_CORE_URL; see its declaration and owning guide.", "signature": "declare const DEV_CORE_URL = \"https://dev-gateway.farthershore.local\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.DEV_JWKS_URL", "name": "@farthershore/backend/testing.DEV_JWKS_URL", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/devGateway.d.ts#L5", "description": "Public export DEV_JWKS_URL; see its declaration and owning guide.", "signature": "declare const DEV_JWKS_URL = \"https://dev-gateway.farthershore.local/.well-known/jwks.json\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.DEV_METERING_ENDPOINT", "name": "@farthershore/backend/testing.DEV_METERING_ENDPOINT", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/devGateway.d.ts#L6", "description": "Public export DEV_METERING_ENDPOINT; see its declaration and owning guide.", "signature": "declare const DEV_METERING_ENDPOINT = \"https://dev-gateway.farthershore.local/v1/metering/events\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.DevGateway", "name": "@farthershore/backend/testing.DevGateway", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/devGateway.d.ts#L21", "description": "Public export DevGateway; see its declaration and owning guide.", "signature": "export type DevGateway = {\n /** Inject this as `fetchImpl` when constructing the FartherShore runtime. */\n fetchImpl: typeof fetch;\n /** The bootstrap response this fixture serves. */\n bootstrap: RuntimeBootstrapResponse__aecc7a0d671f;\n /** Every captured background metering event (a capture == an ACK). */\n meterEvents: RuntimeMeteringEvent__418138753c49[];\n /** Every captured attested post-stream usage report. */\n reportUsageEvents: RuntimePostStreamUsageEvent__1827aaa16965[];\n businessId: string;\n backendId: string;\n jwksUrl: string;\n};", "typeReferences": [ { "name": "RuntimeBootstrapResponse__aecc7a0d671f", "source": "packages/backend/dist/types/runtime-types.d.ts#L228" }, { "name": "RuntimeMeteringEvent__418138753c49", "source": "packages/backend/dist/types/runtime-types.d.ts#L268" }, { "name": "RuntimePostStreamUsageEvent__1827aaa16965", "source": "packages/backend/dist/types/runtime-types.d.ts#L284" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.DevGatewayOptions", "name": "@farthershore/backend/testing.DevGatewayOptions", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/devGateway.d.ts#L7", "description": "Public export DevGatewayOptions; see its declaration and owning guide.", "signature": "export type DevGatewayOptions = {\n mode: DevMode;\n keys: DevSignerKeys;\n businessId?: string;\n backendId?: string;\n businessSlug?: string;\n backendSlug?: string;\n /** Extra route ids to expose in bootstrap for route-binding tests. */\n routeIds?: string[];\n /** Called for each captured metering event (at-least-once ACK). */\n onMeterEvent?: (event: RuntimeMeteringEvent__418138753c49) => void;\n /** Called for each captured attested post-stream report. */\n onReportUsage?: (event: RuntimePostStreamUsageEvent__1827aaa16965) => void;\n};", "typeReferences": [ { "name": "DevMode", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L1" }, { "name": "DevSignerKeys", "source": "packages/backend/dist/types/testing/signers.d.ts#L80" }, { "name": "RuntimeMeteringEvent__418138753c49", "source": "packages/backend/dist/types/runtime-types.d.ts#L268" }, { "name": "RuntimePostStreamUsageEvent__1827aaa16965", "source": "packages/backend/dist/types/runtime-types.d.ts#L284" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.DevKeysFile", "name": "@farthershore/backend/testing.DevKeysFile", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/keysFile.d.ts#L6", "description": "The on-disk shape of the dev-keys handoff file.", "signature": "export type DevKeysFile = {\n version: 1;\n mode: DevMode;\n keys: DevSignerKeys;\n businessId: string;\n backendId: string;\n /** Persona definitions in effect for this dev session. */\n personas: Record;\n};", "typeReferences": [ { "name": "DevMode", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L1" }, { "name": "DevSignerKeys", "source": "packages/backend/dist/types/testing/signers.d.ts#L80" }, { "name": "PersonaDefinition", "source": "packages/backend/dist/types/testing/personas.d.ts#L4" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.DevMode", "name": "@farthershore/backend/testing.DevMode", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L1", "description": "Public export DevMode; see its declaration and owning guide.", "signature": "export type DevMode = \"passthrough\" | \"simulated\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.devModeFromEnv", "name": "@farthershore/backend/testing.devModeFromEnv", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/devRuntime.d.ts#L73", "description": "Whether `FS_DEV_MODE` selects a dev mode. Returns the mode or null.", "signature": "export declare function devModeFromEnv(env: Record): DevMode | null;", "typeReferences": [ { "name": "DevMode", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L1" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.DevModeInProductionError", "name": "@farthershore/backend/testing.DevModeInProductionError", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/prodGuard.d.ts#L4", "description": "Thrown when a dev runtime is constructed in a production process.", "signature": "export declare class DevModeInProductionError extends Error {\n constructor(context: string);\n}", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.DevRuntime", "name": "@farthershore/backend/testing.DevRuntime", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/devRuntime.d.ts#L46", "description": "The dev harness returned by `createDevRuntime` and attached as `fs.dev`.", "signature": "export type DevRuntime = {\n fs: FartherShoreDevInstance;\n asPersona(name: string): PersonaRequest;\n usage: DevUsageSink;\n trace: DevTraceSink;\n gateway: DevGateway;\n keys: DevSignerKeys;\n personas: Map;\n mode: DevMode;\n bootstrap: DevGateway[\"bootstrap\"];\n /** Traced authz helpers — delegate to the REAL permission functions and\n * record each decision into the trace (keyed by ctx.requestId). */\n authz: {\n hasPermission(ctx: TracedCarrier, key: string): boolean;\n requirePermission(ctx: TracedCarrier, key: string): void;\n };\n /** A trace-aware Express middleware (wraps the real fail-closed middleware). */\n middleware(options?: MiddlewareOptions__b16fbb0c44c2): ExpressMiddleware__416c4ad228c7;\n /** Clear usage + trace + captured meter events. */\n reset(): void;\n};", "typeReferences": [ { "name": "DevGateway", "source": "packages/backend/dist/types/testing/devGateway.d.ts#L21" }, { "name": "DevMode", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L1" }, { "name": "DevSignerKeys", "source": "packages/backend/dist/types/testing/signers.d.ts#L80" }, { "name": "DevTraceSink", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L34" }, { "name": "DevUsageSink", "source": "packages/backend/dist/types/testing/usageSink.d.ts#L27" }, { "name": "ExpressMiddleware__416c4ad228c7", "source": "packages/backend/dist/types/adapters/express.d.ts#L30" }, { "name": "FartherShoreDevInstance", "source": "packages/backend/dist/types/testing/devRuntime.d.ts#L14" }, { "name": "MiddlewareOptions__b16fbb0c44c2", "source": "packages/backend/dist/types/adapters/express.d.ts#L31" }, { "name": "PersonaDefinition", "source": "packages/backend/dist/types/testing/personas.d.ts#L4" }, { "name": "PersonaRequest", "source": "packages/backend/dist/types/testing/personas.d.ts#L66" }, { "name": "TracedCarrier", "source": "packages/backend/dist/types/testing/devRuntime.d.ts#L10" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.DevSignerKeys", "name": "@farthershore/backend/testing.DevSignerKeys", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/signers.d.ts#L80", "description": "Public export DevSignerKeys; see its declaration and owning guide.", "signature": "export type DevSignerKeys = {\n /** Ed25519 signing keypair as JWKs (request-signature keys). */\n kid: string;\n privateJwk: JsonWebKey;\n publicJwk: JsonWebKey;\n /** HS256 context-signing secret + its kid (X-Fs-Context keys). */\n contextKid: string;\n contextSecret: string;\n /** Ephemeral fsrt_test_ runtime token (bootstrap bearer + metering HMAC). */\n runtimeToken: string;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.DevTrace", "name": "@farthershore/backend/testing.DevTrace", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L12", "description": "Public export DevTrace; see its declaration and owning guide.", "signature": "export type DevTrace = {\n requestId: string;\n method?: string;\n path?: string;\n persona?: string;\n mode: DevMode;\n verification?: {\n outcome: VerificationOutcome;\n reason?: string;\n };\n authz: AuthzDecisionEntry[];\n metering: MeteringTraceEntry[];\n response?: {\n status: number;\n };\n};", "typeReferences": [ { "name": "AuthzDecisionEntry", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L3" }, { "name": "DevMode", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L1" }, { "name": "MeteringTraceEntry", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L8" }, { "name": "VerificationOutcome", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L2" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.DevTraceSink", "name": "@farthershore/backend/testing.DevTraceSink", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L34", "description": "Accumulates one `DevTrace` per request id and (optionally) appends each\ncompleted trace as a single JSONL line via the injected `appendLine` sink.", "signature": "export declare class DevTraceSink {\n private readonly traces;\n private readonly flushed;\n private readonly appendLine?;\n constructor(options?: {\n appendLine?: (line: string) => void;\n });\n private ensure;\n /** Record how a request's signature/context verification resolved. */\n recordVerification(requestId: string, mode: DevMode, outcome: VerificationOutcome, fields?: {\n method?: string;\n path?: string;\n persona?: string;\n reason?: string;\n }): void;\n /** Record a single hasPermission / requirePermission decision. */\n recordAuthz(requestId: string, mode: DevMode, entry: AuthzDecisionEntry): void;\n /** Record usage reported for this request. */\n recordMetering(requestId: string, mode: DevMode, entry: MeteringTraceEntry): void;\n /** Record the final response status and flush the trace as one JSONL line. */\n recordResponse(requestId: string, mode: DevMode, status: number): void;\n /**\n * Append a trace's current state as one JSONL line (if a sink is wired).\n * Flushes at most ONCE per request id, so wrapping several response methods\n * (status/json/end) never produces duplicate JSONL lines.\n */\n flush(requestId: string): void;\n /** The accumulated trace for a request id, or `undefined`. */\n forRequest(requestId: string): DevTrace | undefined;\n /** Every accumulated trace (insertion order). */\n all(): DevTrace[];\n /** Clear all traces. */\n reset(): void;\n}", "typeReferences": [ { "name": "AuthzDecisionEntry", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L3" }, { "name": "DevMode", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L1" }, { "name": "DevTrace", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L12" }, { "name": "MeteringTraceEntry", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L8" }, { "name": "VerificationOutcome", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L2" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.DevUsageEvent", "name": "@farthershore/backend/testing.DevUsageEvent", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/usageSink.d.ts#L3", "description": "One recorded usage observation. `source` distinguishes the two channels.", "signature": "export type DevUsageEvent = {\n source: \"response\";\n /** rawDimsUnits from the signed response-metering payload. */\n meters: Record;\n /** The full response-metering payload (method/path/rawDimsUnits/…). */\n payload: Record;\n /** The gateway request id this usage was reported against, when known. */\n requestId?: string;\n at: number;\n} | {\n source: \"meter\";\n /** `{ [meter]: qty }` for a single background metering event. */\n meters: Record;\n event: RuntimeMeteringEvent__418138753c49;\n requestId?: string;\n at: number;\n} | {\n source: \"reportUsage\";\n meters: Record;\n event: RuntimePostStreamUsageEvent__1827aaa16965;\n requestId: string;\n at: number;\n};", "typeReferences": [ { "name": "RuntimeMeteringEvent__418138753c49", "source": "packages/backend/dist/types/runtime-types.d.ts#L268" }, { "name": "RuntimePostStreamUsageEvent__1827aaa16965", "source": "packages/backend/dist/types/runtime-types.d.ts#L284" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.DevUsageSink", "name": "@farthershore/backend/testing.DevUsageSink", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/usageSink.d.ts#L27", "description": "In-memory, assertable sink for all dev usage.", "signature": "export declare class DevUsageSink {\n readonly events: DevUsageEvent[];\n /** Record a signed response-metering payload (report() in-band / computeMeteringHeaders). */\n recordResponse(payload: Record, requestId?: string): void;\n /** Record a background `fs.meter()` event captured by the dev gateway. */\n recordMeterEvent(event: RuntimeMeteringEvent__418138753c49): void;\n /** Record an attested post-stream report captured by the dev gateway. */\n recordReportUsage(event: RuntimePostStreamUsageEvent__1827aaa16965): void;\n /** Total quantity per meter key across every recorded event. */\n byMeter(): Record;\n /** Clear all recorded usage. */\n reset(): void;\n}", "typeReferences": [ { "name": "DevUsageEvent", "source": "packages/backend/dist/types/testing/usageSink.d.ts#L3" }, { "name": "RuntimeMeteringEvent__418138753c49", "source": "packages/backend/dist/types/runtime-types.d.ts#L268" }, { "name": "RuntimePostStreamUsageEvent__1827aaa16965", "source": "packages/backend/dist/types/runtime-types.d.ts#L284" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.FartherShoreDevInstance", "name": "@farthershore/backend/testing.FartherShoreDevInstance", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/devRuntime.d.ts#L14", "description": "The FartherShore instance augmented with a bound Express middleware.", "signature": "export type FartherShoreDevInstance = FartherShore__b6398b2ddfc7 & {\n middleware(options?: MiddlewareOptions__b16fbb0c44c2): ExpressMiddleware__416c4ad228c7;\n /** Strict-context handler wrapper (guaranteed non-optional ctx). */\n handler: {\n (handler: VerifiedExpressHandler__ca6f4e2c232b): ExpressMiddleware__416c4ad228c7;\n /** Options-first overload — declarative `permission` gate. */\n (options: HandlerOptions__89c221f2c3e0, handler: VerifiedExpressHandler__ca6f4e2c232b): ExpressMiddleware__416c4ad228c7;\n };\n /** Traced authz helpers — the SAME shape as the prod facade's `fs.authz`. */\n authz: {\n hasPermission(ctx: TracedCarrier, key: string): boolean;\n requirePermission(ctx: TracedCarrier, key: string): void;\n };\n /** The dev harness attached to this runtime. */\n dev: DevRuntime;\n};", "typeReferences": [ { "name": "DevRuntime", "source": "packages/backend/dist/types/testing/devRuntime.d.ts#L46" }, { "name": "ExpressMiddleware__416c4ad228c7", "source": "packages/backend/dist/types/adapters/express.d.ts#L30" }, { "name": "ExpressRequestLike__f93080abdbb9", "source": "packages/backend/dist/types/adapters/express.d.ts#L5" }, { "name": "ExpressResponseLike__7a6dd95793e1", "source": "packages/backend/dist/types/adapters/express.d.ts#L17" }, { "name": "FartherShore__b6398b2ddfc7", "source": "packages/backend/dist/types/core/runtime.d.ts#L84" }, { "name": "HandlerOptions__89c221f2c3e0", "source": "packages/backend/dist/types/adapters/express.d.ts#L91" }, { "name": "MiddlewareOptions__b16fbb0c44c2", "source": "packages/backend/dist/types/adapters/express.d.ts#L31" }, { "name": "TracedCarrier", "source": "packages/backend/dist/types/testing/devRuntime.d.ts#L10" }, { "name": "VerifiedExpressHandler__ca6f4e2c232b", "source": "packages/backend/dist/types/adapters/express.d.ts#L89" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.generateDevSignerKeys", "name": "@farthershore/backend/testing.generateDevSignerKeys", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/signers.d.ts#L97", "description": "Generate a fresh, ephemeral set of dev signer keys: an Ed25519 request-signing\nkeypair, an HS256 context secret, and a `fsrt_test_` runtime token. Fully\nsynchronous (uses `node:crypto`) so a dev simulator can be built without\nawaiting. NEVER call this in production (guarded upstream).", "signature": "export declare function generateDevSignerKeys(): DevSignerKeys;", "typeReferences": [ { "name": "DevSignerKeys", "source": "packages/backend/dist/types/testing/signers.d.ts#L80" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.isProductionEnv", "name": "@farthershore/backend/testing.isProductionEnv", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/prodGuard.d.ts#L2", "description": "Case-insensitive `NODE_ENV=production` check (matches core's `isProductionEnv`).", "signature": "export declare function isProductionEnv(env?: Record): boolean;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.makeSignedRequest", "name": "@farthershore/backend/testing.makeSignedRequest", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/signers.d.ts#L53", "description": "Produce a valid signed claim + the X-FS-* header bag. Returns both the verify\ninput shape and a mutable header record you can corrupt for negative tests.", "signature": "export declare function makeSignedRequest(spec?: SignedRequestSpec): Promise<{\n input: {\n method: string;\n path: string;\n query: string;\n body: Uint8Array | null;\n streamingExempt: boolean;\n };\n claim: CanonicalSigningInput__d7cf4cea4ad9;\n headers: Record;\n}>;", "typeReferences": [ { "name": "CanonicalSigningInput__d7cf4cea4ad9", "source": "packages/backend/dist/types/runtime-types.d.ts#L153" }, { "name": "SignedRequestSpec", "source": "packages/backend/dist/types/testing/signers.d.ts#L22" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.memoryJwks", "name": "@farthershore/backend/testing.memoryJwks", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/signers.d.ts#L65", "description": "A JwksClient backed by an in-memory key set (no network).", "signature": "export declare function memoryJwks(keys?: Array): JwksClient__3bf9d241c5e2;", "typeReferences": [ { "name": "JwksClient__3bf9d241c5e2", "source": "packages/backend/dist/types/core/jwks.d.ts#L43" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.MeteringTraceEntry", "name": "@farthershore/backend/testing.MeteringTraceEntry", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L8", "description": "Public export MeteringTraceEntry; see its declaration and owning guide.", "signature": "export type MeteringTraceEntry = {\n meters: Record;\n source: \"response\" | \"meter\";\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.PersonaClientContext", "name": "@farthershore/backend/testing.PersonaClientContext", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/personas.d.ts#L54", "description": "The context a persona client signs against (bootstrap ids + dev keys).", "signature": "export type PersonaClientContext = {\n keys: DevSignerKeys;\n businessId: string;\n backendId: string;\n contextSecret: string;\n contextKid: string;\n personas: Map;\n mode: DevMode;\n /** fetch used by `.fetch()`; defaults to global fetch for real app listeners. */\n fetchImpl?: typeof fetch;\n};", "typeReferences": [ { "name": "DevMode", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L1" }, { "name": "DevSignerKeys", "source": "packages/backend/dist/types/testing/signers.d.ts#L80" }, { "name": "PersonaDefinition", "source": "packages/backend/dist/types/testing/personas.d.ts#L4" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.personaClientFromKeysFile", "name": "@farthershore/backend/testing.personaClientFromKeysFile", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/keysFile.d.ts#L24", "description": "Construct a persona client from a dev-keys file — the cross-process entry\npoint. A test runner in a separate process reads the file the running service\nwrote and can immediately `asPersona(\"member\").fetch(url)` against it.", "signature": "export declare function personaClientFromKeysFile(path?: string, options?: {\n fetchImpl?: typeof fetch;\n}): {\n asPersona(name: string): PersonaRequest;\n personas: Map;\n file: DevKeysFile;\n};", "typeReferences": [ { "name": "DevKeysFile", "source": "packages/backend/dist/types/testing/keysFile.d.ts#L6" }, { "name": "PersonaDefinition", "source": "packages/backend/dist/types/testing/personas.d.ts#L4" }, { "name": "PersonaRequest", "source": "packages/backend/dist/types/testing/personas.d.ts#L66" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.PersonaDefinition", "name": "@farthershore/backend/testing.PersonaDefinition", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/personas.d.ts#L4", "description": "A named identity in the platform's test-persona claim vocabulary.", "signature": "export type PersonaDefinition = {\n name: string;\n orgId?: string;\n actor?: {\n type: string;\n id: string | null;\n };\n productId?: string;\n environmentId?: string | null;\n compiledPlanId?: string;\n subscriptionId?: string;\n subscriberId?: string;\n /**\n * The unified-authz permission grant. `[\"*\"]` = full access (org OWNER /\n * RBAC-disabled). `[]` = authenticated with no grants (fail-closed on every\n * check). Omit to mint a verified-but-claimless context (RBAC N/A ⇒ grant).\n */\n permissions?: string[];\n roles?: string[];\n subjectKey?: string;\n /**\n * When true, `asPersona` emits NO `X-Fs-Context` — an unidentified caller.\n * Under `simulated` mode the request still verifies (valid signature) but\n * carrier-level permission checks fail closed. Used by the `anonymous` default.\n */\n anonymous?: boolean;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.PersonaRequest", "name": "@farthershore/backend/testing.PersonaRequest", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/personas.d.ts#L66", "description": "The request-builder returned by `asPersona(name)`.", "signature": "export type PersonaRequest = {\n /** The persona name. */\n readonly persona: string;\n /**\n * The 9 signed `x-fs-*` headers + `X-Fs-Context` (unless anonymous).\n * Defaults to GET; pass `method` for non-GET requests so the signature\n * matches the request the caller sends.\n */\n headers(spec?: PersonaRequestSpec): Promise>;\n /** Real HTTP with signed headers (uses the wired fetch). */\n fetch(url: string, init?: RequestInit): Promise;\n /** Set the signed headers on any `.set()`-carrying request (supertest, etc.). */\n inject(req: SettableRequest, spec?: PersonaRequestSpec): Promise;\n};", "typeReferences": [ { "name": "PersonaRequestSpec", "source": "packages/backend/dist/types/testing/personas.d.ts#L43" }, { "name": "SettableRequest", "source": "packages/backend/dist/types/testing/personas.d.ts#L36" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.PersonaRequestSpec", "name": "@farthershore/backend/testing.PersonaRequestSpec", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/personas.d.ts#L43", "description": "A single request spec for `.headers()`.", "signature": "export type PersonaRequestSpec = {\n method?: string;\n path?: string;\n query?: string;\n body?: Uint8Array | null;\n streamingExempt?: boolean;\n routeId?: string;\n requestId?: string;\n timestamp?: number;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.readDevKeysFile", "name": "@farthershore/backend/testing.readDevKeysFile", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/keysFile.d.ts#L18", "description": "Read + parse a dev-keys file.", "signature": "export declare function readDevKeysFile(path?: string): DevKeysFile;", "typeReferences": [ { "name": "DevKeysFile", "source": "packages/backend/dist/types/testing/keysFile.d.ts#L6" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.redactValue", "name": "@farthershore/backend/testing.redactValue", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L29", "description": "Redact anything that smells like a credential from a free-form string.", "signature": "export declare function redactValue(input: string): string;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.SettableRequest", "name": "@farthershore/backend/testing.SettableRequest", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/personas.d.ts#L36", "description": "A minimal `.set(name, value)`-carrying request (supertest `Test`, etc.).", "signature": "export type SettableRequest = {\n method?: string;\n url?: string;\n path?: string;\n set(field: string, value: string): unknown;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.signContextToken", "name": "@farthershore/backend/testing.signContextToken", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/signers.d.ts#L79", "description": "Mint an HS256-signed `X-Fs-Context` token — the exact INVERSE of\n`verifyContext.ts`. The header is `{alg:\"HS256\",typ:\"JWT\",kid}` and the\npayload is the cv=2 `ConsumerContextClaims` shape (sub / client_id? / act? /\nsubjectKind / org / businessId / compiledPlanId / subscriptionId /\nsubscriberId / environmentId / subjectKey plus optional permissions / roles).\nSigns with the same secret the SDK would verify against (`contextSecrets` /\n`FS_CONTEXT_SECRETS`).", "signature": "export declare function signContextToken(claim: FartherShoreSignedContext__24c947c09583, secret?: string, kid?: string): Promise;", "typeReferences": [ { "name": "FartherShoreSignedContext__24c947c09583", "source": "packages/backend/dist/types/core/verifyContext.d.ts#L33" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.SIGNED_HEADER_NAMES", "name": "@farthershore/backend/testing.SIGNED_HEADER_NAMES", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/personas.d.ts#L94", "description": "The signed request header names (exported for assertions).", "signature": "declare const SIGNED_HEADER_NAMES: {\n readonly signature: \"x-fs-signature\";\n readonly keyId: \"x-fs-key-id\";\n readonly requestId: \"x-fs-request-id\";\n readonly timestamp: \"x-fs-timestamp\";\n readonly businessId: \"x-fs-business-id\";\n readonly backendId: \"x-fs-backend-id\";\n readonly routeId: \"x-fs-route-id\";\n readonly policyVersion: \"x-fs-policy-version\";\n readonly bodyHash: \"x-fs-body-hash\";\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.SignedHeaderOverrides", "name": "@farthershore/backend/testing.SignedHeaderOverrides", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/signers.d.ts#L11", "description": "Public export SignedHeaderOverrides; see its declaration and owning guide.", "signature": "export type SignedHeaderOverrides = Partial<{\n signature: string;\n kid: string;\n requestId: string;\n timestamp: number;\n businessId: string;\n backendId: string;\n routeId: string;\n policyVersion: string;\n bodyHash: string;\n}>;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.SignedRequestSpec", "name": "@farthershore/backend/testing.SignedRequestSpec", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/signers.d.ts#L22", "description": "Public export SignedRequestSpec; see its declaration and owning guide.", "signature": "export type SignedRequestSpec = {\n method?: string;\n path?: string;\n query?: string;\n body?: Uint8Array | null;\n streamingExempt?: boolean;\n businessId?: string;\n backendId?: string;\n routeId?: string;\n policyVersion?: string;\n requestId?: string;\n timestamp?: number;\n /**\n * Ed25519 private JWK to sign with. Defaults to {@link TEST_PRIVATE_JWK}. A\n * dev simulator passes its ephemeral signer here.\n */\n privateJwk?: JsonWebKey;\n /** Key id stamped into `x-fs-key-id`. Defaults to {@link TEST_KID}. */\n kid?: string;\n /**\n * Consumer-principal wave (D3) — the signed `X-Fs-Context` JWT to bind into\n * the request signature (and stamp as the `x-fs-context` header). Its SHA-256\n * is appended to the canonical string, exactly as the gateway signer does. A\n * missing token binds the empty-string hash (identity-less request).\n */\n contextToken?: string;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.SignedTestWebhook", "name": "@farthershore/backend/testing.SignedTestWebhook", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/webhooks.d.ts#L16", "description": "Public export SignedTestWebhook; see its declaration and owning guide.", "signature": "export interface SignedTestWebhook {\n envelope: WebhookEnvelope__f1da89296e6d;\n /** The exact bytes to POST. */\n body: string;\n /** `webhook-id` / `webhook-timestamp` / `webhook-signature` / event / content-type. */\n headers: Record;\n /** Convenience: a `Request` you can hand straight to `handler.fetch`. */\n request(url?: string): Request;\n}", "typeReferences": [ { "name": "WebhookEnvelope__f1da89296e6d", "source": "packages/backend/dist/types/webhooks/types.d.ts#L68" }, { "name": "WebhookEnvelopeType__22116d242a71", "source": "packages/backend/dist/types/webhooks/types.d.ts#L10" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.signWebhookForTesting", "name": "@farthershore/backend/testing.signWebhookForTesting", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/webhooks.d.ts#L30", "description": "Build + sign one delivery the way the platform does (Standard Webhooks\nover `${id}.${timestamp}.${body}`). Pass several secrets to emulate the\n24 h dual-signing rotation window.", "signature": "export declare function signWebhookForTesting(input: SignWebhookForTestingInput): SignedTestWebhook;", "typeReferences": [ { "name": "SignedTestWebhook", "source": "packages/backend/dist/types/testing/webhooks.d.ts#L16" }, { "name": "SignWebhookForTestingInput", "source": "packages/backend/dist/types/testing/webhooks.d.ts#L2" }, { "name": "WebhookEnvelopeType__22116d242a71", "source": "packages/backend/dist/types/webhooks/types.d.ts#L10" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.SignWebhookForTestingInput", "name": "@farthershore/backend/testing.SignWebhookForTestingInput", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/webhooks.d.ts#L2", "description": "Public export SignWebhookForTestingInput; see its declaration and owning guide.", "signature": "export interface SignWebhookForTestingInput {\n /** The endpoint secret(s) the receiver is configured with (current first). */\n secret: string | readonly string[];\n type: T;\n data: WebhookEventData__3ab81689f0bb[T];\n /** Defaults to a random delivery id. */\n id?: string;\n businessId?: string;\n environmentId?: string | null;\n /** Defaults to now (ISO). */\n createdAt?: string;\n /** Signing timestamp (unix seconds); defaults to now. */\n timestamp?: number;\n}", "typeReferences": [ { "name": "WebhookEnvelopeType__22116d242a71", "source": "packages/backend/dist/types/webhooks/types.d.ts#L10" }, { "name": "WebhookEventData__3ab81689f0bb", "source": "packages/backend/dist/types/webhooks/types.d.ts#L16" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.TEST_CONTEXT_KID", "name": "@farthershore/backend/testing.TEST_CONTEXT_KID", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/signers.d.ts#L10", "description": "The default context-signing kid stamped into the JWT header.", "signature": "declare const TEST_CONTEXT_KID = \"fs-context-test-2026\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.TEST_CONTEXT_SECRET", "name": "@farthershore/backend/testing.TEST_CONTEXT_SECRET", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/signers.d.ts#L8", "description": "The default HS256 context-signing secret for dev fixtures (NEVER production).", "signature": "declare const TEST_CONTEXT_SECRET = \"fs-dev-context-secret-2026\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.TEST_KID", "name": "@farthershore/backend/testing.TEST_KID", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/signers.d.ts#L4", "description": "Public export TEST_KID; see its declaration and owning guide.", "signature": "declare const TEST_KID = \"fs-runtime-test-2026\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.TEST_PRIVATE_JWK", "name": "@farthershore/backend/testing.TEST_PRIVATE_JWK", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/signers.d.ts#L5", "description": "Public export TEST_PRIVATE_JWK; see its declaration and owning guide.", "signature": "declare const TEST_PRIVATE_JWK: JsonWebKey;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.TEST_PUBLIC_JWK", "name": "@farthershore/backend/testing.TEST_PUBLIC_JWK", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/signers.d.ts#L6", "description": "Public export TEST_PUBLIC_JWK; see its declaration and owning guide.", "signature": "declare const TEST_PUBLIC_JWK: JsonWebKey;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.TracedCarrier", "name": "@farthershore/backend/testing.TracedCarrier", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/devRuntime.d.ts#L10", "description": "A permission carrier that also knows its request id (for trace keying).", "signature": "export type TracedCarrier = PermissionCarrier__227d98a75a82 & {\n requestId?: string;\n};", "typeReferences": [ { "name": "PermissionCarrier__227d98a75a82", "source": "packages/backend/dist/types/core/permissions.d.ts#L61" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.unreachableJwks", "name": "@farthershore/backend/testing.unreachableJwks", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/signers.d.ts#L69", "description": "A JwksClient whose fetch always throws (cold-cache failure).", "signature": "export declare function unreachableJwks(): JwksClient__3bf9d241c5e2;", "typeReferences": [ { "name": "JwksClient__3bf9d241c5e2", "source": "packages/backend/dist/types/core/jwks.d.ts#L43" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.VerificationOutcome", "name": "@farthershore/backend/testing.VerificationOutcome", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/traceSink.d.ts#L2", "description": "Public export VerificationOutcome; see its declaration and owning guide.", "signature": "export type VerificationOutcome = \"verified\" | \"passthrough\" | \"rejected\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.testing.writeDevKeysFile", "name": "@farthershore/backend/testing.writeDevKeysFile", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/testing", "source": "packages/backend/dist/types/testing/keysFile.d.ts#L16", "description": "Write the dev-keys file with 0600 permissions (owner read/write only).", "signature": "export declare function writeDevKeysFile(path: string, contents: DevKeysFile): void;", "typeReferences": [ { "name": "DevKeysFile", "source": "packages/backend/dist/types/testing/keysFile.d.ts#L6" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.createWebhookHandler", "name": "@farthershore/backend/webhooks.createWebhookHandler", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L237", "description": "Public export createWebhookHandler; see its declaration and owning guide.", "signature": "export declare function createWebhookHandler(options: CreateWebhookHandlerOptions): WebhookHandler;", "typeReferences": [ { "name": "CreateWebhookHandlerOptions", "source": "packages/backend/dist/types/webhooks/index.d.ts#L116" }, { "name": "WebhookHandler", "source": "packages/backend/dist/types/webhooks/index.d.ts#L218" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.CreateWebhookHandlerOptions", "name": "@farthershore/backend/webhooks.CreateWebhookHandlerOptions", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L116", "description": "Public export CreateWebhookHandlerOptions; see its declaration and owning guide.", "signature": "export interface CreateWebhookHandlerOptions {\n /** The endpoint's signing secret (`fswh_…`). */\n secret?: string;\n /** Several accepted secrets (current first) — use while rolling a rotation. */\n secrets?: readonly string[];\n /** Typed per-event handlers. Missing types are acknowledged and ignored. */\n on: WebhookHandlers;\n /**\n * Called for an event `type` this SDK does not know (a newer platform).\n * Always acknowledged 2xx; use this to log or forward.\n */\n onUnknown?: (event: {\n id: string;\n type: string;\n body: unknown;\n }) => void | Promise;\n /** Called for every rejected delivery (never throws the request). */\n onRejected?: (rejection: WebhookRejection) => void;\n /** Called when a duplicate `webhook-id` is acknowledged without running. */\n onDuplicate?: (event: {\n id: string;\n type: string;\n }) => void;\n /**\n * Delivery-id store for deduplication. Defaults to a bounded in-memory\n * cache (single instance, `WEBHOOK_DEDUPE_TTL_MS`). Provide a shared store\n * (Redis, DB) with an atomic `claim`/`settle` lease when the receiver runs on\n * more than one instance (see {@link WebhookNonceStore}).\n */\n nonceStore?: WebhookNonceStore;\n /**\n * Largest request body the adapters will buffer (default 1 MiB). Checked\n * against `Content-Length` and enforced on the stream BEFORE the signature\n * is verified, so an unauthenticated caller cannot exhaust memory.\n */\n maxBodyBytes?: number;\n /** Override for tests; defaults to `Date.now`. */\n now?: () => number;\n}", "typeReferences": [ { "name": "WebhookHandlers", "source": "packages/backend/dist/types/webhooks/index.d.ts#L11" }, { "name": "WebhookNonceStore", "source": "packages/backend/dist/types/webhooks/index.d.ts#L76" }, { "name": "WebhookRejection", "source": "packages/backend/dist/types/webhooks/index.d.ts#L15" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.DATA_FIELD_TYPES", "name": "@farthershore/backend/webhooks.DATA_FIELD_TYPES", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L247", "description": "Runtime mirror of the typed keys in `WebhookEventData` (types.ts). Kept\nSDK-local (no zod in the published bundle) and pinned field-by-field to the\ncontracts schemas (`WEBHOOK_EVENT_DATA_SCHEMAS`) by `contracts-drift.test.ts`\n— a wrong `kind` here (e.g. dropping the `|null` from `amount`) would reject\na legitimately-signed delivery, so the pin proves each kind matches the zod\nfield's null/type behavior. Exported solely so that pin can read it.", "signature": "declare const DATA_FIELD_TYPES: Record, Record>;", "typeReferences": [ { "name": "DataFieldKind", "source": "packages/backend/dist/types/webhooks/index.d.ts#L238" }, { "name": "WebhookEnvelopeType", "source": "packages/backend/dist/types/webhooks/types.d.ts#L10" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.DataFieldKind", "name": "@farthershore/backend/webhooks.DataFieldKind", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L238", "description": "Public export DataFieldKind; see its declaration and owning guide.", "signature": "export type DataFieldKind = \"string\" | \"number\" | \"string|null\" | \"number|null\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.isWebhookEnvelopeType", "name": "@farthershore/backend/webhooks.isWebhookEnvelopeType", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L9", "description": "Public export isWebhookEnvelopeType; see its declaration and owning guide.", "signature": "export declare function isWebhookEnvelopeType(value: unknown): value is WebhookEnvelopeType;", "typeReferences": [ { "name": "WebhookEnvelopeType", "source": "packages/backend/dist/types/webhooks/types.d.ts#L10" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.MemoryWebhookNonceStore", "name": "@farthershore/backend/webhooks.MemoryWebhookNonceStore", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L94", "description": "Default single-instance delivery-id store: an atomic claim/settle lease,\nTTL-bounded, capacity-bounded, and honest about saturation (returns\n`\"saturated\"` rather than lying when it cannot lease a fresh id).", "signature": "export declare class MemoryWebhookNonceStore implements WebhookNonceStore {\n private readonly options;\n private readonly seen;\n private tokenSeq;\n constructor(options?: {\n ttlMs?: number;\n leaseMs?: number;\n maxEntries?: number;\n now?: () => number;\n });\n private horizonFor;\n claim(id: string): WebhookClaim;\n settle(id: string, token: string, outcome: \"processed\" | \"release\"): void;\n get size(): number;\n}", "typeReferences": [ { "name": "WebhookClaim", "source": "packages/backend/dist/types/webhooks/index.d.ts#L38" }, { "name": "WebhookNonceStore", "source": "packages/backend/dist/types/webhooks/index.d.ts#L76" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.readBoundedRequestBody", "name": "@farthershore/backend/webhooks.readBoundedRequestBody", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L236", "description": "Read a Fetch request body without ever buffering more than `limit` bytes:\na declared `Content-Length` over the cap is refused before any allocation,\nand a stream that exceeds it mid-flight is abandoned. Returns `null` when\nthe cap is exceeded.", "signature": "export declare function readBoundedRequestBody(request: Request, limit: number): Promise;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.verifyWebhook", "name": "@farthershore/backend/webhooks.verifyWebhook", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L8", "description": "Verify one delivery's Standard Webhooks signature + timestamp window. The\nlow-level primitive; `createWebhookHandler` adds dedupe, parsing and routing.", "signature": "export declare function verifyWebhook(input: VerifyWebhookInput): WebhookVerifyResult;", "typeReferences": [ { "name": "VerifyWebhookInput", "source": "packages/backend/dist/types/webhooks/types.d.ts#L96" }, { "name": "WebhookVerifyResult", "source": "packages/backend/dist/types/webhooks/types.d.ts#L88" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.VerifyWebhookInput", "name": "@farthershore/backend/webhooks.VerifyWebhookInput", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/types.d.ts#L96", "description": "Public export VerifyWebhookInput; see its declaration and owning guide.", "signature": "export interface VerifyWebhookInput {\n /** Raw request body, exactly as received. */\n body: string | Uint8Array;\n /** Request headers (any case). */\n headers: Record | Headers;\n /**\n * Accepted signing secrets. Pass `[current, previous]` while you roll a\n * rotated secret on your side; the platform already dual-signs for 24 h.\n */\n secrets: readonly string[];\n /** Override for tests; defaults to `Date.now()`. */\n now?: () => number;\n /** Override for tests; defaults to ±300 s. */\n toleranceSeconds?: number;\n}", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WEBHOOK_DEDUPE_MAX_ENTRIES", "name": "@farthershore/backend/webhooks.WEBHOOK_DEDUPE_MAX_ENTRIES", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L81", "description": "Capacity of the default in-memory store (ids retained per TTL window).", "signature": "declare const WEBHOOK_DEDUPE_MAX_ENTRIES = 250000;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WEBHOOK_DEDUPE_TTL_MS", "name": "@farthershore/backend/webhooks.WEBHOOK_DEDUPE_TTL_MS", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L115", "description": "How long a delivery id is remembered. The platform retries a delivery at\n30 s, 5 min and 30 min after the first attempt (≈ 35.5 min horizon), so the\nwindow must outlast the LAST retry plus clock tolerance — a shorter window\nwould let the final retry re-run a handler whose 2xx the platform never saw.", "signature": "declare const WEBHOOK_DEDUPE_TTL_MS: number;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WEBHOOK_EVENT_HEADER", "name": "@farthershore/backend/webhooks.WEBHOOK_EVENT_HEADER", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/types.d.ts#L82", "description": "Public export WEBHOOK_EVENT_HEADER; see its declaration and owning guide.", "signature": "declare const WEBHOOK_EVENT_HEADER = \"x-fs-webhook-event\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WEBHOOK_EVENT_NAMES", "name": "@farthershore/backend/webhooks.WEBHOOK_EVENT_NAMES", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/types.d.ts#L5", "description": "Event names a webhook endpoint can subscribe to (the platform events\ncatalog's webhook-deliverable subset), in catalog order.", "signature": "declare const WEBHOOK_EVENT_NAMES: readonly [\"subscription.created\", \"subscription.updated\", \"subscription.canceled\", \"payment.succeeded\", \"payment.failed\", \"entitlement.changed\", \"usage.threshold_reached\"];", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WEBHOOK_ID_HEADER", "name": "@farthershore/backend/webhooks.WEBHOOK_ID_HEADER", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/types.d.ts#L79", "description": "Header names on the wire (Standard Webhooks + our convenience header).", "signature": "declare const WEBHOOK_ID_HEADER = \"webhook-id\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WEBHOOK_INFLIGHT_LEASE_MS", "name": "@farthershore/backend/webhooks.WEBHOOK_INFLIGHT_LEASE_MS", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L88", "description": "How long an in-flight lease is held before a crashed / hung handler's id\nbecomes reclaimable. Longer than any reasonable handler, shorter than the\nretry horizon, so a genuinely stuck delivery is retried rather than wedged\nas a permanent \"in_flight\".", "signature": "declare const WEBHOOK_INFLIGHT_LEASE_MS: number;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WEBHOOK_MAX_BODY_BYTES", "name": "@farthershore/backend/webhooks.WEBHOOK_MAX_BODY_BYTES", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L156", "description": "Default cap on a delivery body. Platform envelopes are a few KiB.", "signature": "declare const WEBHOOK_MAX_BODY_BYTES: number;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WEBHOOK_SECRET_PREFIX", "name": "@farthershore/backend/webhooks.WEBHOOK_SECRET_PREFIX", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/types.d.ts#L86", "description": "Prefix every platform-minted signing secret carries.", "signature": "declare const WEBHOOK_SECRET_PREFIX = \"fswh_\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WEBHOOK_SIGNATURE_HEADER", "name": "@farthershore/backend/webhooks.WEBHOOK_SIGNATURE_HEADER", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/types.d.ts#L81", "description": "Public export WEBHOOK_SIGNATURE_HEADER; see its declaration and owning guide.", "signature": "declare const WEBHOOK_SIGNATURE_HEADER = \"webhook-signature\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WEBHOOK_TEST_EVENT", "name": "@farthershore/backend/webhooks.WEBHOOK_TEST_EVENT", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/types.d.ts#L8", "description": "The synthetic event a dashboard / CLI \"Send test\" produces.", "signature": "declare const WEBHOOK_TEST_EVENT: \"webhook.test\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WEBHOOK_TIMESTAMP_HEADER", "name": "@farthershore/backend/webhooks.WEBHOOK_TIMESTAMP_HEADER", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/types.d.ts#L80", "description": "Public export WEBHOOK_TIMESTAMP_HEADER; see its declaration and owning guide.", "signature": "declare const WEBHOOK_TIMESTAMP_HEADER = \"webhook-timestamp\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WEBHOOK_TIMESTAMP_TOLERANCE_SECONDS", "name": "@farthershore/backend/webhooks.WEBHOOK_TIMESTAMP_TOLERANCE_SECONDS", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/types.d.ts#L84", "description": "Accept deliveries within ±this many seconds of the receiver's clock.", "signature": "declare const WEBHOOK_TIMESTAMP_TOLERANCE_SECONDS = 300;", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WebhookClaim", "name": "@farthershore/backend/webhooks.WebhookClaim", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L38", "description": "The result of `claim`. A `token` is present ONLY for a \"fresh\" claim — it\nidentifies THIS lease so `settle` cannot act on a lease that has since been\nreclaimed by another delivery (see {@link WebhookNonceStore}).", "signature": "export interface WebhookClaim {\n outcome: WebhookClaimOutcome;\n token?: string;\n}", "typeReferences": [ { "name": "WebhookClaimOutcome", "source": "packages/backend/dist/types/webhooks/index.d.ts#L34" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WebhookClaimOutcome", "name": "@farthershore/backend/webhooks.WebhookClaimOutcome", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L34", "description": "Delivery-id store for deduplication. Unlike the request verifier's\n`NonceStore`, a webhook store leases an id: `claim` before the handler and\n`settle` after, so a thrown handler releases the id and the platform's retry\n(same `webhook-id`) re-runs it instead of being acknowledged as a duplicate,\nwhile a concurrent retry of an in-flight id never double-runs the handler.\nSee {@link WebhookNonceStore}.", "signature": "export type WebhookClaimOutcome = \"fresh\" | \"in_flight\" | \"processed\" | \"saturated\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WebhookEnvelope", "name": "@farthershore/backend/webhooks.WebhookEnvelope", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/types.d.ts#L68", "description": "The JSON body of every delivery. `id` equals the `webhook-id` header.", "signature": "export type WebhookEnvelope = T extends WebhookEnvelopeType ? {\n id: string;\n type: T;\n /** ISO 8601 — when the event was recorded (stable across retries). */\n createdAt: string;\n businessId: string;\n /** `null` = production. */\n environmentId: string | null;\n data: WebhookEventData[T];\n} : never;", "typeReferences": [ { "name": "WebhookEnvelopeType", "source": "packages/backend/dist/types/webhooks/types.d.ts#L10" }, { "name": "WebhookEventData", "source": "packages/backend/dist/types/webhooks/types.d.ts#L16" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WebhookEnvelopeType", "name": "@farthershore/backend/webhooks.WebhookEnvelopeType", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/types.d.ts#L10", "description": "Every `type` a delivery envelope can carry.", "signature": "export type WebhookEnvelopeType = WebhookEventName | typeof WEBHOOK_TEST_EVENT;", "typeReferences": [ { "name": "WEBHOOK_TEST_EVENT", "source": "packages/backend/dist/types/webhooks/types.d.ts#L8" }, { "name": "WebhookEventName", "source": "packages/backend/dist/types/webhooks/types.d.ts#L6" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WebhookEventData", "name": "@farthershore/backend/webhooks.WebhookEventData", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/types.d.ts#L16", "description": "Per-event `data`. The keys listed are what the platform's producers carry\ntoday; extra keys pass through untouched (automation rules may attach\nbuilder-authored fields), so every shape is open.", "signature": "export interface WebhookEventData {\n \"subscription.created\": {\n subscriptionId?: string;\n compiledPlanId?: string;\n [key: string]: unknown;\n };\n \"subscription.updated\": {\n subscriptionId?: string;\n /** Producer-specific change reason, e.g. `plan_changed`, `trial_ending`. */\n reason?: string;\n lifecycle?: string;\n compiledPlanId?: string;\n [key: string]: unknown;\n };\n \"subscription.canceled\": {\n subscriptionId?: string;\n reason?: string;\n lifecycle?: string;\n [key: string]: unknown;\n };\n \"payment.succeeded\": WebhookPaymentData__dc4de7029bac;\n \"payment.failed\": WebhookPaymentData__dc4de7029bac;\n \"entitlement.changed\": {\n compiledPlanId?: string;\n lineageId?: string;\n status?: string;\n [key: string]: unknown;\n };\n \"usage.threshold_reached\": {\n subscriptionId?: string;\n subscriberId?: string;\n limitId?: string;\n threshold?: number;\n windowStartMs?: number;\n windowEndMs?: number;\n [key: string]: unknown;\n };\n \"webhook.test\": {\n businessId: string;\n sentAt: string;\n [key: string]: unknown;\n };\n}", "typeReferences": [ { "name": "WebhookPaymentData__dc4de7029bac", "source": "packages/backend/dist/types/webhooks/types.d.ts#L59" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WebhookEventHandler", "name": "@farthershore/backend/webhooks.WebhookEventHandler", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L10", "description": "Public export WebhookEventHandler; see its declaration and owning guide.", "signature": "export type WebhookEventHandler = (event: WebhookEnvelope) => void | Promise;", "typeReferences": [ { "name": "WebhookEnvelope", "source": "packages/backend/dist/types/webhooks/types.d.ts#L68" }, { "name": "WebhookEnvelopeType", "source": "packages/backend/dist/types/webhooks/types.d.ts#L10" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WebhookEventName", "name": "@farthershore/backend/webhooks.WebhookEventName", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/types.d.ts#L6", "description": "Public export WebhookEventName; see its declaration and owning guide.", "signature": "export type WebhookEventName = (typeof WEBHOOK_EVENT_NAMES)[number];", "typeReferences": [ { "name": "WEBHOOK_EVENT_NAMES", "source": "packages/backend/dist/types/webhooks/types.d.ts#L5" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WebhookExpressRequestLike", "name": "@farthershore/backend/webhooks.WebhookExpressRequestLike", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L208", "description": "Minimal Express-shaped types so we don't hard-depend on", "signature": "export type WebhookExpressRequestLike = {\n headers: Record;\n /** Raw body bytes when captured by a raw parser (`express.raw()`). */\n body?: unknown;\n rawBody?: Buffer | Uint8Array;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WebhookExpressResponseLike", "name": "@farthershore/backend/webhooks.WebhookExpressResponseLike", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L214", "description": "Public export WebhookExpressResponseLike; see its declaration and owning guide.", "signature": "export type WebhookExpressResponseLike = {\n status(code: number): WebhookExpressResponseLike;\n json(body: unknown): unknown;\n};", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WebhookHandleInput", "name": "@farthershore/backend/webhooks.WebhookHandleInput", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L202", "description": "Public export WebhookHandleInput; see its declaration and owning guide.", "signature": "export interface WebhookHandleInput {\n /** Raw request body, exactly as received. */\n body: string | Uint8Array;\n headers: Record | Headers;\n}", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WebhookHandleOutcome", "name": "@farthershore/backend/webhooks.WebhookHandleOutcome", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L157", "description": "Public export WebhookHandleOutcome; see its declaration and owning guide.", "signature": "export type WebhookHandleOutcome = {\n status: 200;\n kind: \"handled\";\n id: string;\n type: WebhookEnvelopeType;\n} | {\n status: 200;\n kind: \"ignored\";\n id: string;\n type: WebhookEnvelopeType;\n} | {\n status: 200;\n kind: \"unknown_type\";\n id: string;\n type: string;\n} | {\n status: 200;\n kind: \"duplicate\";\n id: string;\n type: string;\n} | {\n status: 400 | 401;\n kind: \"rejected\";\n rejection: WebhookRejection;\n} | {\n status: 413;\n kind: \"rejected\";\n rejection: WebhookRejection;\n} | {\n status: 503;\n kind: \"store_unavailable\";\n id: string;\n type: string;\n} | {\n status: 503;\n kind: \"in_flight\";\n id: string;\n type: string;\n} | {\n status: 500;\n kind: \"handler_error\";\n id: string;\n type: string;\n error: unknown;\n};", "typeReferences": [ { "name": "WebhookEnvelopeType", "source": "packages/backend/dist/types/webhooks/types.d.ts#L10" }, { "name": "WebhookRejection", "source": "packages/backend/dist/types/webhooks/index.d.ts#L15" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WebhookHandler", "name": "@farthershore/backend/webhooks.WebhookHandler", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L218", "description": "Public export WebhookHandler; see its declaration and owning guide.", "signature": "export interface WebhookHandler {\n /** Framework-neutral: verify, dedupe, parse, route. Never throws. */\n handle(input: WebhookHandleInput): Promise;\n /** Fetch-API handler (Next.js route handlers, Hono, Bun, Workers…). */\n fetch(request: Request): Promise;\n /**\n * Express handler. Mount AFTER a raw-body parser\n * (`express.raw({ type: \"application/json\" })`) or set `req.rawBody`; a pre-parsed\n * JSON body cannot be verified and is rejected 400.\n */\n express(): (req: WebhookExpressRequestLike, res: WebhookExpressResponseLike) => Promise;\n}", "typeReferences": [ { "name": "WebhookExpressRequestLike", "source": "packages/backend/dist/types/webhooks/index.d.ts#L208" }, { "name": "WebhookExpressResponseLike", "source": "packages/backend/dist/types/webhooks/index.d.ts#L214" }, { "name": "WebhookHandleInput", "source": "packages/backend/dist/types/webhooks/index.d.ts#L202" }, { "name": "WebhookHandleOutcome", "source": "packages/backend/dist/types/webhooks/index.d.ts#L157" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WebhookHandlers", "name": "@farthershore/backend/webhooks.WebhookHandlers", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L11", "description": "Public export WebhookHandlers; see its declaration and owning guide.", "signature": "export type WebhookHandlers = {\n [T in WebhookEnvelopeType]?: WebhookEventHandler;\n};", "typeReferences": [ { "name": "WebhookEnvelopeType", "source": "packages/backend/dist/types/webhooks/types.d.ts#L10" }, { "name": "WebhookEventHandler", "source": "packages/backend/dist/types/webhooks/index.d.ts#L10" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WebhookNonceStore", "name": "@farthershore/backend/webhooks.WebhookNonceStore", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L76", "description": "Delivery-id store protocol — an ATOMIC, OWNERSHIP-FENCED claim/settle lease.\n\nThe earlier split `has(id)` … handler … `remember(id)` had a check-then-act\nrace: two concurrent deliveries of the SAME `webhook-id` could BOTH observe\n`has(id) === false` and both run a payment / lifecycle handler. An atomic\nclaim closes that window.\n\n `claim(id)` is taken BEFORE the handler:\n - \"fresh\" → unseen; the caller HOLDS the lease (identified by the\n returned `token`) and must settle() with that token.\n - \"in_flight\" → another delivery of this id is mid-handler; the caller\n answers 503 and NEVER runs the handler. The platform\n retries; that retry sees \"processed\" once the first wins.\n - \"processed\" → already handled to success; answer 200 without re-running.\n - \"saturated\" → the store cannot retain the id; the caller runs the\n handler best-effort WITHOUT a lease (at-least-once holds).\n\n `settle(id, token, outcome)` resolves a \"fresh\" claim, and is a NO-OP unless\n `token` still identifies the live lease:\n - \"processed\" → keep the id so future retries dedupe.\n - \"release\" → drop the lease so the platform's retry re-runs the handler.\n\nThe token fences the case where a handler outlives the in-flight lease TTL:\nthe id becomes reclaimable, a retry re-leases it with a NEW token, and the\noriginal handler's late `settle` (with the OLD token) is ignored rather than\ndeleting or overwriting the replacement's lease. (A handler that exceeds the\nlease TTL still degrades to at-least-once — the receiver dedupes on\nwebhook-id — but never corrupts another delivery's lease.)\n\nA shared store (Redis, DB) implements `claim` as an atomic upsert stamping a\nunique token, a short in-flight lease TTL (so a crashed handler's id becomes\nreclaimable) and a longer processed TTL of at least `WEBHOOK_DEDUPE_TTL_MS`.", "signature": "export interface WebhookNonceStore {\n claim(id: string): WebhookClaim | Promise;\n settle(id: string, token: string, outcome: \"processed\" | \"release\"): void | Promise;\n}", "typeReferences": [ { "name": "WebhookClaim", "source": "packages/backend/dist/types/webhooks/index.d.ts#L38" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WebhookRejection", "name": "@farthershore/backend/webhooks.WebhookRejection", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/index.d.ts#L15", "description": "Why a delivery was rejected (401 / 400) — surfaced through `onRejected`.", "signature": "export type WebhookRejection = {\n reason: WebhookVerifyFailure;\n} | {\n reason: \"invalid_json\";\n} | {\n reason: \"invalid_envelope\";\n detail: string;\n} | {\n reason: \"payload_too_large\";\n limitBytes: number;\n};", "typeReferences": [ { "name": "WebhookVerifyFailure", "source": "packages/backend/dist/types/webhooks/types.d.ts#L87" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WebhookVerifyFailure", "name": "@farthershore/backend/webhooks.WebhookVerifyFailure", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/types.d.ts#L87", "description": "Public export WebhookVerifyFailure; see its declaration and owning guide.", "signature": "export type WebhookVerifyFailure = \"missing_headers\" | \"invalid_timestamp\" | \"timestamp_out_of_tolerance\" | \"no_matching_signature\";", "typeReferences": [], "guide": "reference/backend-sdk" }, { "id": "sdk.backend.webhooks.WebhookVerifyResult", "name": "@farthershore/backend/webhooks.WebhookVerifyResult", "kind": "sdk", "collection": "backend-sdk", "page": "generated/backend-sdk/webhooks", "source": "packages/backend/dist/types/webhooks/types.d.ts#L88", "description": "Public export WebhookVerifyResult; see its declaration and owning guide.", "signature": "export type WebhookVerifyResult = {\n ok: true;\n id: string;\n timestamp: number;\n} | {\n ok: false;\n reason: WebhookVerifyFailure;\n};", "typeReferences": [ { "name": "WebhookVerifyFailure", "source": "packages/backend/dist/types/webhooks/types.d.ts#L87" } ], "guide": "reference/backend-sdk" }, { "id": "sdk.business.codegen.irToValueModelSource", "name": "@farthershore/business/codegen.irToValueModelSource", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/codegen", "source": "packages/business/dist/types/codegen/index.d.ts#L7", "description": "Generate the canonical functional Business SDK program for a value-model IR.\nEvery declaration is assigned one stable identifier and all relationships\nreuse those branded refs; no stringly-typed cross-reference is emitted.", "signature": "export declare function irToValueModelSource(ir: ManifestIrDocument__3d04599c0d50): string;", "typeReferences": [ { "name": "ManifestIrDocument__3d04599c0d50", "source": "packages/business/dist/types/ir-types.d.ts#L425" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.AuthoredMoneyAmount", "name": "@farthershore/business.AuthoredMoneyAmount", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L230", "description": "Public export AuthoredMoneyAmount; see its declaration and owning guide.", "signature": "export type AuthoredMoneyAmount = Readonly>;", "typeReferences": [ { "name": "CommerceBrand__7b1b990b7c90", "source": "packages/business/dist/types/commerce/types.d.ts#L8" }, { "name": "MoneyAmount__51964157493a", "source": "packages/business/dist/types/value-model/money.d.ts#L11" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.backend", "name": "@farthershore/business.backend", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/declarations.d.ts#L66", "description": "Public export backend; see its declaration and owning guide.", "signature": "export declare function backend(id: string, options?: FunctionalBackendOptions): BackendRef;", "typeReferences": [ { "name": "BackendRef", "source": "packages/business/dist/types/value-model/refs.d.ts#L42" }, { "name": "FunctionalBackendOptions", "source": "packages/business/dist/types/value-model/declarations.d.ts#L12" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.BackendDefinitionJson", "name": "@farthershore/business.BackendDefinitionJson", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L304", "description": "Public export BackendDefinitionJson; see its declaration and owning guide.", "signature": "export type BackendDefinitionJson = {\n name?: string;\n slug?: string;\n transport?: {\n mode?: BackendTransportModeJson;\n runner?: BackendRunnerJson;\n };\n /**\n * Gateway->backend request signing. Emitted for every declared backend; the\n * builder helper defaults omission to `{ required: true }` (HARD default).\n */\n verification?: {\n required?: boolean;\n };\n /** Meter allow-list. Omitted = all business meters allowed. */\n meters?: string[];\n /** Marks the default backend when a business declares more than one. */\n default?: boolean;\n};", "typeReferences": [ { "name": "BackendRunnerJson", "source": "packages/business/dist/types/ir-types.d.ts#L303" }, { "name": "BackendTransportModeJson", "source": "packages/business/dist/types/ir-types.d.ts#L302" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.BackendRef", "name": "@farthershore/business.BackendRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/refs.d.ts#L42", "description": "Public export BackendRef; see its declaration and owning guide.", "signature": "export type BackendRef = DeclarationRef__2a230f417174<\"backend\">;", "typeReferences": [ { "name": "DeclarationRef__2a230f417174", "source": "packages/business/dist/types/value-model/refs.d.ts#L5" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.BackendRunnerJson", "name": "@farthershore/business.BackendRunnerJson", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L303", "description": "Public export BackendRunnerJson; see its declaration and owning guide.", "signature": "export type BackendRunnerJson = \"embedded\" | \"sidecar\";", "typeReferences": [], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.BackendTransportModeJson", "name": "@farthershore/business.BackendTransportModeJson", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L302", "description": "Public export BackendTransportModeJson; see its declaration and owning guide.", "signature": "export type BackendTransportModeJson = \"direct\" | \"tunnel\";", "typeReferences": [], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.BoundRateRef", "name": "@farthershore/business.BoundRateRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L63", "description": "Public export BoundRateRef; see its declaration and owning guide.", "signature": "export type BoundRateRef = Readonly<{\n kind: \"bound_catalog_rate\";\n rate?: ExactRate;\n tiers?: ExactCatalogTiers;\n quote?: ExactQuoteBounds__e9cf817917c1;\n measure: MeasureRef;\n item?: ModelRef;\n where: readonly DimensionValueRef[];\n} & CommerceBrand__7b1b990b7c90<\"bound_catalog_rate\">>;", "typeReferences": [ { "name": "CommerceBrand__7b1b990b7c90", "source": "packages/business/dist/types/commerce/types.d.ts#L8" }, { "name": "DimensionValueRef", "source": "packages/business/dist/types/commerce/types.d.ts#L26" }, { "name": "ExactCatalogTiers", "source": "packages/business/dist/types/commerce/lowered-types.d.ts#L5" }, { "name": "ExactQuoteBounds__e9cf817917c1", "source": "packages/business/dist/types/commerce/lowered-types.d.ts#L13" }, { "name": "ExactRate", "source": "packages/business/dist/types/commerce/lowered-types.d.ts#L1" }, { "name": "MeasureRef", "source": "packages/business/dist/types/commerce/types.d.ts#L16" }, { "name": "ModelRef", "source": "packages/business/dist/types/commerce/types.d.ts#L42" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.business", "name": "@farthershore/business.business", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/authoring.d.ts#L21", "description": "Public export business; see its declaration and owning guide.", "signature": "declare const business: BusinessFunction__7e4f3d5c2657;", "typeReferences": [ { "name": "BusinessFunction__7e4f3d5c2657", "source": "packages/business/dist/types/commerce/types.d.ts#L229" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.BusinessSpecJson", "name": "@farthershore/business.BusinessSpecJson", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L395", "description": "Public export BusinessSpecJson; see its declaration and owning guide.", "signature": "export type BusinessSpecJson = {\n business: BusinessBlockJson__a04690090fc8;\n gateway?: {\n authHeader?: string;\n upstreamAuth?: {\n type: \"none\" | \"static_bearer\";\n token?: string;\n };\n };\n metering?: {\n meters?: MeterDefinitionJson[];\n billOn4xx?: boolean;\n };\n /** BYO-Backend V1 — first-class backend declarations keyed by backend id.\n * Emitted only when at least one backend is declared (so single-backend /\n * no-backend products keep their pre-BYOB irHash). */\n backend?: Record;\n resources?: CountedResourceJson__90d0b7f16d08[];\n /** Repo-owned custom permission subjects. Emitted (sorted by subject) only\n * when at least one permission-carrying group is declared, so businesses\n * without permission groups keep their pre-cutover irHash. */\n permissions?: PermissionSubjectJson__d124b4a2259d[];\n policies?: BusinessPoliciesJson__0d51efe66230;\n customer_context?: BusinessCustomerContextJson__e5b9539124a5;\n plans?: PlanSpecJson[];\n /** Advanced/internal platform-schema blocks (usage, billing,\n * environments, lifecycle, ephemeral, …) are validated by the platform\n * schema but are not authorable through the functional SDK. */\n [key: string]: unknown;\n};", "typeReferences": [ { "name": "BackendDefinitionJson", "source": "packages/business/dist/types/ir-types.d.ts#L304" }, { "name": "BusinessBlockJson__a04690090fc8", "source": "packages/business/dist/types/ir-types.d.ts#L383" }, { "name": "BusinessCustomerContextJson__e5b9539124a5", "source": "packages/business/dist/types/ir-types.d.ts#L375" }, { "name": "BusinessPoliciesJson__0d51efe66230", "source": "packages/business/dist/types/ir-types.d.ts#L364" }, { "name": "CountedResourceJson__90d0b7f16d08", "source": "packages/business/dist/types/ir-types.d.ts#L355" }, { "name": "MeterDefinitionJson", "source": "packages/business/dist/types/ir-types.d.ts#L4" }, { "name": "PermissionSubjectJson__d124b4a2259d", "source": "packages/business/dist/types/ir-types.d.ts#L389" }, { "name": "PlanSpecJson", "source": "packages/business/dist/types/ir-types.d.ts#L113" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.CacheProfile", "name": "@farthershore/business.CacheProfile", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L3", "description": "Public export CacheProfile; see its declaration and owning guide.", "signature": "export type CacheProfile = \"long\" | \"short\" | \"blocking\";", "typeReferences": [], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.canonicalIrJson", "name": "@farthershore/business.canonicalIrJson", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/validate.d.ts#L68", "description": "Public export canonicalIrJson; see its declaration and owning guide.", "signature": "export declare function canonicalIrJson(ir: unknown): string;", "typeReferences": [], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.CatalogSelectorRef", "name": "@farthershore/business.CatalogSelectorRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L52", "description": "Public export CatalogSelectorRef; see its declaration and owning guide.", "signature": "export type CatalogSelectorRef = ModelRef | DimensionValueRef;", "typeReferences": [ { "name": "DimensionValueRef", "source": "packages/business/dist/types/commerce/types.d.ts#L26" }, { "name": "ModelRef", "source": "packages/business/dist/types/commerce/types.d.ts#L42" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.CatalogTierInput", "name": "@farthershore/business.CatalogTierInput", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L12", "description": "One authored tier bracket: `upTo` is the inclusive cumulative upper bound; `null` = open-ended final tier.", "signature": "export type CatalogTierInput = Readonly<{\n upTo: number | null;\n rate: UnboundRateRef;\n}>;", "typeReferences": [ { "name": "UnboundRateRef", "source": "packages/business/dist/types/commerce/types.d.ts#L53" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.commerceSnapshotOf", "name": "@farthershore/business.commerceSnapshotOf", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/authoring.d.ts#L22", "description": "Public export commerceSnapshotOf; see its declaration and owning guide.", "signature": "export declare function commerceSnapshotOf(businessValue: CompiledBusiness__671c1daa22b7): CommerceAuthoringSnapshot__60159f2d0d70 | null;", "typeReferences": [ { "name": "CommerceAuthoringSnapshot__60159f2d0d70", "source": "packages/business/dist/types/commerce/lowered-types.d.ts#L92" }, { "name": "CompiledBusiness__671c1daa22b7", "source": "packages/business/dist/types/business.d.ts#L7" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.dimension", "name": "@farthershore/business.dimension", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/authoring.d.ts#L4", "description": "Public export dimension; see its declaration and owning guide.", "signature": "export declare function dimension(key: string, options?: Readonly<{\n values?: readonly string[];\n}>): DimensionRef;", "typeReferences": [ { "name": "DimensionRef", "source": "packages/business/dist/types/commerce/types.d.ts#L36" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.DimensionConditionRef", "name": "@farthershore/business.DimensionConditionRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L31", "description": "Public export DimensionConditionRef; see its declaration and owning guide.", "signature": "export type DimensionConditionRef = Readonly<{\n kind: \"dimension_condition\";\n dimension: DimensionRef;\n value: string;\n} & CommerceBrand__7b1b990b7c90<\"dimension_condition\">>;", "typeReferences": [ { "name": "CommerceBrand__7b1b990b7c90", "source": "packages/business/dist/types/commerce/types.d.ts#L8" }, { "name": "DimensionRef", "source": "packages/business/dist/types/commerce/types.d.ts#L36" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.DimensionRef", "name": "@farthershore/business.DimensionRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L36", "description": "Public export DimensionRef; see its declaration and owning guide.", "signature": "export type DimensionRef = Readonly<{\n kind: \"dimension\";\n key: string;\n value(value: string): DimensionValueRef;\n is(value: string): DimensionConditionRef;\n} & CommerceBrand__7b1b990b7c90<\"dimension\">>;", "typeReferences": [ { "name": "CommerceBrand__7b1b990b7c90", "source": "packages/business/dist/types/commerce/types.d.ts#L8" }, { "name": "DimensionConditionRef", "source": "packages/business/dist/types/commerce/types.d.ts#L31" }, { "name": "DimensionValueRef", "source": "packages/business/dist/types/commerce/types.d.ts#L26" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.DimensionValueRef", "name": "@farthershore/business.DimensionValueRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L26", "description": "Public export DimensionValueRef; see its declaration and owning guide.", "signature": "export type DimensionValueRef = Readonly<{\n kind: \"dimension_value\";\n dimension: DimensionRef;\n value: string;\n} & CommerceBrand__7b1b990b7c90<\"dimension_value\">>;", "typeReferences": [ { "name": "CommerceBrand__7b1b990b7c90", "source": "packages/business/dist/types/commerce/types.d.ts#L8" }, { "name": "DimensionRef", "source": "packages/business/dist/types/commerce/types.d.ts#L36" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.disclosure", "name": "@farthershore/business.disclosure", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/authoring.d.ts#L59", "description": "Public export disclosure; see its declaration and owning guide.", "signature": "declare const disclosure: Readonly<{\n opaque: DisclosureRef;\n transparent: DisclosureRef;\n}>;", "typeReferences": [ { "name": "DisclosureRef", "source": "packages/business/dist/types/commerce/types.d.ts#L118" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.DisclosureRef", "name": "@farthershore/business.DisclosureRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L118", "description": "Public export DisclosureRef; see its declaration and owning guide.", "signature": "export type DisclosureRef = Readonly<{\n kind: \"disclosure\";\n disclosure: \"opaque\" | \"transparent\";\n} & CommerceBrand__7b1b990b7c90<\"disclosure\">>;", "typeReferences": [ { "name": "CommerceBrand__7b1b990b7c90", "source": "packages/business/dist/types/commerce/types.d.ts#L8" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.display", "name": "@farthershore/business.display", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/authoring.d.ts#L54", "description": "Public export display; see its declaration and owning guide.", "signature": "declare const display: Readonly<{\n multiplier(options: Readonly<{\n factor: number;\n }>): MultiplierDisplayRef;\n}>;", "typeReferences": [ { "name": "MultiplierDisplayRef", "source": "packages/business/dist/types/commerce/types.d.ts#L110" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.ExactCatalogTiers", "name": "@farthershore/business.ExactCatalogTiers", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/lowered-types.d.ts#L5", "description": "Public export ExactCatalogTiers; see its declaration and owning guide.", "signature": "export type ExactCatalogTiers = Readonly<{\n strategy: \"graduated\" | \"volume_retroactive\";\n tiers: readonly Readonly<{\n upTo: string | null;\n rate: ExactRate;\n }>[];\n}>;", "typeReferences": [ { "name": "ExactRate", "source": "packages/business/dist/types/commerce/lowered-types.d.ts#L1" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.ExactRate", "name": "@farthershore/business.ExactRate", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/lowered-types.d.ts#L1", "description": "Public export ExactRate; see its declaration and owning guide.", "signature": "export type ExactRate = Readonly<{\n num: string;\n den: string;\n}>;", "typeReferences": [], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.exhaustion", "name": "@farthershore/business.exhaustion", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/authoring.d.ts#L67", "description": "Public export exhaustion; see its declaration and owning guide.", "signature": "declare const exhaustion: Readonly<{\n block: ExhaustionRef;\n overage(binding: PricingBindingRef): ExhaustionRef;\n}>;", "typeReferences": [ { "name": "ExhaustionRef", "source": "packages/business/dist/types/commerce/types.d.ts#L122" }, { "name": "PricingBindingRef", "source": "packages/business/dist/types/commerce/types.d.ts#L97" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.ExhaustionRef", "name": "@farthershore/business.ExhaustionRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L122", "description": "Public export ExhaustionRef; see its declaration and owning guide.", "signature": "export type ExhaustionRef = Readonly<{\n kind: \"exhaustion\";\n behavior: \"block\" | \"overage\";\n} & CommerceBrand__7b1b990b7c90<\"exhaustion\">>;", "typeReferences": [ { "name": "CommerceBrand__7b1b990b7c90", "source": "packages/business/dist/types/commerce/types.d.ts#L8" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.free", "name": "@farthershore/business.free", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/money.d.ts#L31", "description": "The zero recurring price. Only meaningful on a `plan.kind.free` plan,\nwhere it is optional (a free plan needs no price control at all); every\nother kind states its price with `money.usd(...)`.", "signature": "export declare function free(): AuthoredPrice__fa4522a263d6;", "typeReferences": [ { "name": "AuthoredPrice__fa4522a263d6", "source": "packages/business/dist/types/value-model/money.d.ts#L4" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.frontendIntegration", "name": "@farthershore/business.frontendIntegration", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/declarations.d.ts#L67", "description": "Public export frontendIntegration; see its declaration and owning guide.", "signature": "export declare function frontendIntegration(id: string, options: FrontendIntegrationOptions): FrontendIntegrationRef;", "typeReferences": [ { "name": "FrontendIntegrationOptions", "source": "packages/business/dist/types/value-model/declarations.d.ts#L43" }, { "name": "FrontendIntegrationRef", "source": "packages/business/dist/types/value-model/refs.d.ts#L43" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.FrontendIntegrationInjectionJson", "name": "@farthershore/business.FrontendIntegrationInjectionJson", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L159", "description": "Public export FrontendIntegrationInjectionJson; see its declaration and owning guide.", "signature": "export type FrontendIntegrationInjectionJson = {\n secretRef: string;\n location: \"header\";\n name: string;\n template: \"{value}\" | \"Bearer {value}\";\n} | {\n secretRef: string;\n location: \"query\";\n name: string;\n};", "typeReferences": [], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.FrontendIntegrationOperationJson", "name": "@farthershore/business.FrontendIntegrationOperationJson", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L152", "description": "Public export FrontendIntegrationOperationJson; see its declaration and owning guide.", "signature": "export type FrontendIntegrationOperationJson = {\n method: FrontendIntegrationMethodJson__404791a522ea;\n path: string;\n headers: string[];\n query: string[];\n body: FrontendIntegrationBodyJson__412664c4c97a;\n};", "typeReferences": [ { "name": "FrontendIntegrationBodyJson__412664c4c97a", "source": "packages/business/dist/types/ir-types.d.ts#L142" }, { "name": "FrontendIntegrationMethodJson__404791a522ea", "source": "packages/business/dist/types/ir-types.d.ts#L141" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.FrontendIntegrationOptions", "name": "@farthershore/business.FrontendIntegrationOptions", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/declarations.d.ts#L43", "description": "Public export FrontendIntegrationOptions; see its declaration and owning guide.", "signature": "export type FrontendIntegrationOptions = Omit & {\n request: {\n operations: ReadonlyArray & {\n headers?: readonly string[];\n query?: readonly string[];\n body: FrontendIntegrationBodyOptions__69124a73fbef;\n }>;\n };\n response: Omit & {\n contentTypes: readonly string[];\n jsonPointers: readonly string[];\n responseHeaders?: readonly string[];\n };\n /** Integration calls are always platform-only and cannot carry customer economics. */\n costs?: never;\n reports?: never;\n usagePolicy?: never;\n creates?: never;\n deletes?: never;\n};", "typeReferences": [ { "name": "FrontendIntegrationBodyOptions__69124a73fbef", "source": "packages/business/dist/types/value-model/declarations.d.ts#L36" }, { "name": "FrontendIntegrationSpecJson", "source": "packages/business/dist/types/ir-types.d.ts#L170" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.FrontendIntegrationRef", "name": "@farthershore/business.FrontendIntegrationRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/refs.d.ts#L43", "description": "Public export FrontendIntegrationRef; see its declaration and owning guide.", "signature": "export type FrontendIntegrationRef = DeclarationRef__2a230f417174<\"frontend_integration\">;", "typeReferences": [ { "name": "DeclarationRef__2a230f417174", "source": "packages/business/dist/types/value-model/refs.d.ts#L5" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.FrontendIntegrationSpecJson", "name": "@farthershore/business.FrontendIntegrationSpecJson", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L170", "description": "Secret-value-free mirror of contracts' FrontendIntegrationSpec.", "signature": "export type FrontendIntegrationSpecJson = {\n id: string;\n upstream: string;\n request: {\n operations: FrontendIntegrationOperationJson[];\n };\n injection: FrontendIntegrationInjectionJson;\n response: {\n kind: \"json\";\n contentTypes: string[];\n maxBytes: number;\n jsonPointers: string[];\n responseHeaders: string[];\n };\n};", "typeReferences": [ { "name": "FrontendIntegrationInjectionJson", "source": "packages/business/dist/types/ir-types.d.ts#L159" }, { "name": "FrontendIntegrationOperationJson", "source": "packages/business/dist/types/ir-types.d.ts#L152" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.FunctionalBackendOptions", "name": "@farthershore/business.FunctionalBackendOptions", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/declarations.d.ts#L12", "description": "Public export FunctionalBackendOptions; see its declaration and owning guide.", "signature": "export type FunctionalBackendOptions = Omit & {\n meters?: MeterRef[];\n};", "typeReferences": [ { "name": "BackendOptions__63ffee6039bc", "source": "packages/business/dist/types/backend.d.ts#L8" }, { "name": "MeterRef", "source": "packages/business/dist/types/value-model/refs.d.ts#L26" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.FunctionalBusinessOptions", "name": "@farthershore/business.FunctionalBusinessOptions", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/declarations.d.ts#L8", "description": "Public export FunctionalBusinessOptions; see its declaration and owning guide.", "signature": "export type FunctionalBusinessOptions = BusinessOptions__bbd5a4a3592b;", "typeReferences": [ { "name": "BusinessOptions__bbd5a4a3592b", "source": "packages/business/dist/types/business.d.ts#L35" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.FunctionalGroupOptions", "name": "@farthershore/business.FunctionalGroupOptions", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/declarations.d.ts#L89", "description": "Public export FunctionalGroupOptions; see its declaration and owning guide.", "signature": "export type FunctionalGroupOptions = {\n permission?: FunctionalGroupPermissionOptions;\n};", "typeReferences": [ { "name": "FunctionalGroupPermissionOptions", "source": "packages/business/dist/types/value-model/declarations.d.ts#L84" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.FunctionalGroupPermissionOptions", "name": "@farthershore/business.FunctionalGroupPermissionOptions", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/declarations.d.ts#L84", "description": "Repo-owned raw permission vocabulary — the `permission` option of\n`fs.group`. This declaration never creates a role, chooses a default role,\nor assigns a user. Each subscribing organization composes these permissions\ninto its own CUSTOM roles at runtime.\n\nDeclaring it makes the group id a custom permission subject: member routes\nare gated at the gateway by `:read|write`, and `verbs` are the EXTRA\ngrant-by-exact-name domain verbs the builder's own backend checks\n(`read`/`write` are implied and may not be re-declared). Collisions with\nthe managed / platform permission vocabularies are rejected by the\nplatform compiler's validate pass.", "signature": "export type FunctionalGroupPermissionOptions = {\n verbs?: readonly string[];\n escalatory?: readonly string[];\n description?: string;\n};", "typeReferences": [], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.FunctionalMeterOptions", "name": "@farthershore/business.FunctionalMeterOptions", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/declarations.d.ts#L15", "description": "Public export FunctionalMeterOptions; see its declaration and owning guide.", "signature": "export type FunctionalMeterOptions = Omit & {\n pairsWith?: MeterRef;\n};", "typeReferences": [ { "name": "MeterOptions__b9495f4ba34f", "source": "packages/business/dist/types/business.d.ts#L63" }, { "name": "MeterRef", "source": "packages/business/dist/types/value-model/refs.d.ts#L26" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.FunctionalMeterRoutesOptions", "name": "@farthershore/business.FunctionalMeterRoutesOptions", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/registry.d.ts#L28", "description": "Public export FunctionalMeterRoutesOptions; see its declaration and owning guide.", "signature": "export type FunctionalMeterRoutesOptions = Pick;", "typeReferences": [ { "name": "FunctionalRouteOptions", "source": "packages/business/dist/types/value-model/registry.d.ts#L7" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.FunctionalRequestMeterOptions", "name": "@farthershore/business.FunctionalRequestMeterOptions", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/declarations.d.ts#L18", "description": "Public export FunctionalRequestMeterOptions; see its declaration and owning guide.", "signature": "export type FunctionalRequestMeterOptions = Omit;", "typeReferences": [ { "name": "RequestMeterOptions__7ec5d6047951", "source": "packages/business/dist/types/business.d.ts#L66" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.FunctionalResourceOptions", "name": "@farthershore/business.FunctionalResourceOptions", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/declarations.d.ts#L9", "description": "Public export FunctionalResourceOptions; see its declaration and owning guide.", "signature": "export type FunctionalResourceOptions = ResourceOptions__04a2cc1fd6ee & {\n cap?: ResourceOptions__04a2cc1fd6ee[\"scope\"];\n};", "typeReferences": [ { "name": "ResourceOptions__04a2cc1fd6ee", "source": "packages/business/dist/types/business.d.ts#L74" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.FunctionalRouteLimitAuthoring", "name": "@farthershore/business.FunctionalRouteLimitAuthoring", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/registry.d.ts#L26", "description": "Public export FunctionalRouteLimitAuthoring; see its declaration and owning guide.", "signature": "export type FunctionalRouteLimitAuthoring = Extract | FunctionalRouteLimitInput;", "typeReferences": [ { "name": "FunctionalRouteLimitInput", "source": "packages/business/dist/types/value-model/registry.d.ts#L23" }, { "name": "RouteLimitAuthoring__ae39586db789", "source": "packages/business/dist/types/route-metering.d.ts#L34" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.FunctionalRouteLimitInput", "name": "@farthershore/business.FunctionalRouteLimitInput", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/registry.d.ts#L23", "description": "Public export FunctionalRouteLimitInput; see its declaration and owning guide.", "signature": "export type FunctionalRouteLimitInput = Omit & {\n dimension?: MeterRef;\n};", "typeReferences": [ { "name": "MeterRef", "source": "packages/business/dist/types/value-model/refs.d.ts#L26" }, { "name": "RouteLimitInput__250d9325480a", "source": "packages/business/dist/types/route-metering.d.ts#L22" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.FunctionalRouteOptions", "name": "@farthershore/business.FunctionalRouteOptions", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/registry.d.ts#L7", "description": "Public export FunctionalRouteOptions; see its declaration and owning guide.", "signature": "export type FunctionalRouteOptions = Omit & {\n action?: string;\n /** Repo-owned custom permissions — require ONE of the route's permission\n * group's declared verbs at the gateway for this operation, instead of the\n * method-derived read/write default. Only valid on a route that is a\n * member of a permission-carrying group declaring the verb. */\n permission?: string;\n backend?: BackendRef;\n reports?: MeterRef | readonly MeterRef[];\n costs?: MeterCost | readonly MeterCost[];\n rateLimit?: FunctionalRouteLimitAuthoring;\n quota?: FunctionalRouteLimitAuthoring;\n creates?: ResourceRef;\n deletes?: ResourceRef;\n surfaces?: RouteOptions__8ba341feca83[\"surfaces\"];\n};", "typeReferences": [ { "name": "BackendRef", "source": "packages/business/dist/types/value-model/refs.d.ts#L42" }, { "name": "FunctionalRouteLimitAuthoring", "source": "packages/business/dist/types/value-model/registry.d.ts#L26" }, { "name": "MeterCost", "source": "packages/business/dist/types/value-model/refs.d.ts#L16" }, { "name": "MeterRef", "source": "packages/business/dist/types/value-model/refs.d.ts#L26" }, { "name": "ResourceRef", "source": "packages/business/dist/types/value-model/refs.d.ts#L38" }, { "name": "RouteOptions__8ba341feca83", "source": "packages/business/dist/types/business.d.ts#L67" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.FundingBucketRef", "name": "@farthershore/business.FundingBucketRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L114", "description": "Public export FundingBucketRef; see its declaration and owning guide.", "signature": "export type FundingBucketRef = Readonly<{\n kind: \"funding_bucket\";\n bucketKind: FundingBucketKind__eced6b195b95;\n} & CommerceBrand__7b1b990b7c90<\"funding_bucket\">>;", "typeReferences": [ { "name": "CommerceBrand__7b1b990b7c90", "source": "packages/business/dist/types/commerce/types.d.ts#L8" }, { "name": "FundingBucketKind__eced6b195b95", "source": "packages/business/dist/types/commerce/lowered-types.d.ts#L19" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.group", "name": "@farthershore/business.group", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/declarations.d.ts#L92", "description": "Public export group; see its declaration and owning guide.", "signature": "export declare function group(id: string, members: readonly (RouteRef | GroupRef)[], options?: FunctionalGroupOptions): GroupRef;", "typeReferences": [ { "name": "FunctionalGroupOptions", "source": "packages/business/dist/types/value-model/declarations.d.ts#L89" }, { "name": "GroupRef", "source": "packages/business/dist/types/value-model/refs.d.ts#L36" }, { "name": "RouteRef", "source": "packages/business/dist/types/value-model/refs.d.ts#L35" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.GroupRef", "name": "@farthershore/business.GroupRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/refs.d.ts#L36", "description": "Public export GroupRef; see its declaration and owning guide.", "signature": "export type GroupRef = DeclarationRef__2a230f417174<\"group\">;", "typeReferences": [ { "name": "DeclarationRef__2a230f417174", "source": "packages/business/dist/types/value-model/refs.d.ts#L5" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.hashIr", "name": "@farthershore/business.hashIr", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/validate.d.ts#L67", "description": "Public export hashIr; see its declaration and owning guide.", "signature": "export declare function hashIr(ir: unknown): string;", "typeReferences": [], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.HttpMethod", "name": "@farthershore/business.HttpMethod", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L1", "description": "Public export HttpMethod; see its declaration and owning guide.", "signature": "export type HttpMethod = \"GET\" | \"POST\" | \"PUT\" | \"PATCH\" | \"DELETE\" | \"HEAD\" | \"OPTIONS\";", "typeReferences": [], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.included", "name": "@farthershore/business.included", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/authoring.d.ts#L46", "description": "Public export included; see its declaration and owning guide.", "signature": "export declare function included(amount: AuthoredMoneyAmount, options?: Readonly<{\n display?: MultiplierDisplayRef;\n}>): FundingBucketRef;", "typeReferences": [ { "name": "AuthoredMoneyAmount", "source": "packages/business/dist/types/commerce/types.d.ts#L230" }, { "name": "FundingBucketRef", "source": "packages/business/dist/types/commerce/types.d.ts#L114" }, { "name": "MultiplierDisplayRef", "source": "packages/business/dist/types/commerce/types.d.ts#L110" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.LimitStrategy", "name": "@farthershore/business.LimitStrategy", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/limit-strategy.d.ts#L1", "description": "Public export LimitStrategy; see its declaration and owning guide.", "signature": "export type LimitStrategy = \"fixed_window\" | \"sliding_window\" | \"token_bucket\";", "typeReferences": [], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.ManifestBuilderError", "name": "@farthershore/business.ManifestBuilderError", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/errors.d.ts#L19", "description": "Thrown on builder misuse (duplicate keys, unknown refs) at call time.", "signature": "export declare class ManifestBuilderError extends Error {\n readonly code: string;\n constructor(message: string, code?: string);\n}", "typeReferences": [], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.ManifestBuildResult", "name": "@farthershore/business.ManifestBuildResult", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L434", "description": "Platform compiler result: the validated envelope plus its canonical hash.", "signature": "export type ManifestBuildResult = {\n ir: ManifestIrDocument;\n irHash: string;\n};", "typeReferences": [ { "name": "ManifestIrDocument", "source": "packages/business/dist/types/ir-types.d.ts#L425" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.ManifestIrDocument", "name": "@farthershore/business.ManifestIrDocument", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L425", "description": "Public export ManifestIrDocument; see its declaration and owning guide.", "signature": "export type ManifestIrDocument = {\n irVersion: 1;\n sdkVersion: string;\n business: BusinessSpecJson;\n routes: RouteLayerJson[];\n frontendIntegrations: FrontendIntegrationSpecJson[];\n commerce: CommerceAuthoringSnapshot__60159f2d0d70;\n};", "typeReferences": [ { "name": "BusinessSpecJson", "source": "packages/business/dist/types/ir-types.d.ts#L395" }, { "name": "CommerceAuthoringSnapshot__60159f2d0d70", "source": "packages/business/dist/types/commerce/lowered-types.d.ts#L92" }, { "name": "FrontendIntegrationSpecJson", "source": "packages/business/dist/types/ir-types.d.ts#L170" }, { "name": "RouteLayerJson", "source": "packages/business/dist/types/ir-types.d.ts#L340" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.ManifestIssue", "name": "@farthershore/business.ManifestIssue", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/errors.d.ts#L2", "description": "One validation problem, in the platform's diagnostic envelope shape.", "signature": "export type ManifestIssue = {\n code: string;\n path: string;\n message: string;\n /** Builder source that owns the invalid business definition, when known. */\n source?: string;\n};", "typeReferences": [], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.ManifestResourceGraphSnapshot", "name": "@farthershore/business.ManifestResourceGraphSnapshot", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/resource-graph.d.ts#L11", "description": "Public export ManifestResourceGraphSnapshot; see its declaration and owning guide.", "signature": "export type ManifestResourceGraphSnapshot = {\n readonly nodes: readonly Omit[];\n};", "typeReferences": [ { "name": "ManifestResourceNode__c5816bda01cb", "source": "packages/business/dist/types/resource-graph.d.ts#L3" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.ManifestResourceKind", "name": "@farthershore/business.ManifestResourceKind", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/resource-graph.d.ts#L1", "description": "Public export ManifestResourceKind; see its declaration and owning guide.", "signature": "export type ManifestResourceKind = \"business\" | \"meter\" | \"counted_resource\" | \"surface\" | \"route_layer\" | \"action\" | \"plan\" | \"backend\" | \"frontend_integration\" | \"permission_subject\";", "typeReferences": [], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.ManifestResourceUrn", "name": "@farthershore/business.ManifestResourceUrn", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/resource-graph.d.ts#L2", "description": "Public export ManifestResourceUrn; see its declaration and owning guide.", "signature": "export type ManifestResourceUrn = `urn:farthershore:business:${ManifestResourceKind}:${string}`;", "typeReferences": [ { "name": "ManifestResourceKind", "source": "packages/business/dist/types/resource-graph.d.ts#L1" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.ManifestValidationError", "name": "@farthershore/business.ManifestValidationError", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/errors.d.ts#L14", "description": "Thrown by the platform manifest compiler when the assembled manifest fails\nschema validation. Plain-data `issues` so the error survives serialization\nacross the runner callback boundary.", "signature": "export declare class ManifestValidationError extends Error {\n readonly issues: ManifestIssue[];\n constructor(issues: ManifestIssue[]);\n}", "typeReferences": [ { "name": "ManifestIssue", "source": "packages/business/dist/types/errors.d.ts#L2" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.measure", "name": "@farthershore/business.measure", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/authoring.d.ts#L3", "description": "Public export measure; see its declaration and owning guide.", "signature": "export declare function measure(key: string): MeasureRef;", "typeReferences": [ { "name": "MeasureRef", "source": "packages/business/dist/types/commerce/types.d.ts#L16" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.MeasureMaximumRef", "name": "@farthershore/business.MeasureMaximumRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L21", "description": "Public export MeasureMaximumRef; see its declaration and owning guide.", "signature": "export type MeasureMaximumRef = Readonly<{\n kind: \"measure_maximum\";\n measure: MeasureRef;\n maximum: number;\n} & CommerceBrand__7b1b990b7c90<\"measure_maximum\">>;", "typeReferences": [ { "name": "CommerceBrand__7b1b990b7c90", "source": "packages/business/dist/types/commerce/types.d.ts#L8" }, { "name": "MeasureRef", "source": "packages/business/dist/types/commerce/types.d.ts#L16" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.MeasureRef", "name": "@farthershore/business.MeasureRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L16", "description": "Public export MeasureRef; see its declaration and owning guide.", "signature": "export type MeasureRef = Readonly<{\n kind: \"measure\";\n key: string;\n atMost(maximum: number): MeasureMaximumRef;\n} & CommerceBrand__7b1b990b7c90<\"measure\">>;", "typeReferences": [ { "name": "CommerceBrand__7b1b990b7c90", "source": "packages/business/dist/types/commerce/types.d.ts#L8" }, { "name": "MeasureMaximumRef", "source": "packages/business/dist/types/commerce/types.d.ts#L21" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.meter", "name": "@farthershore/business.meter", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/authoring.d.ts#L8", "description": "Public export meter; see its declaration and owning guide.", "signature": "declare const meter: MeterFunction__02c80dd4d01e;", "typeReferences": [ { "name": "MeterFunction__02c80dd4d01e", "source": "packages/business/dist/types/commerce/types.d.ts#L220" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.MeterCost", "name": "@farthershore/business.MeterCost", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/refs.d.ts#L16", "description": "Public export MeterCost; see its declaration and owning guide.", "signature": "export type MeterCost = {\n readonly kind: \"meter_cost\";\n readonly meter: MeterRef;\n readonly value: number;\n};", "typeReferences": [ { "name": "MeterRef", "source": "packages/business/dist/types/value-model/refs.d.ts#L26" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.MeterDefinitionJson", "name": "@farthershore/business.MeterDefinitionJson", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L4", "description": "Public export MeterDefinitionJson; see its declaration and owning guide.", "signature": "export type MeterDefinitionJson = {\n key: string;\n display: string;\n unit?: string;\n routeDefault?: number;\n enforcementType?: \"exact_pre_request\" | \"estimated_then_settled\" | \"postpaid\" | \"strict_concurrency\";\n aggregation?: \"SUM\" | \"COUNT\" | \"MAX\" | \"UNIQUE_COUNT\" | \"LATEST\";\n window?: \"minute\" | \"hour\" | \"day\" | \"month\" | \"billing_period\";\n valueProperty?: string;\n uniqueProperty?: string;\n groupBy?: string[];\n eventCode?: string;\n /** Token category this meter measures, when it is a token meter. T5 covers\n * the full token-accounting vocabulary: the input/output/total axes, the\n * cache axes (`cached_read_input` / `cache_creation_input`), `context`, the\n * output-budget axes (`max_output` / `estimated_output` / `actual_output`),\n * and `streaming_output`. Mirrors `TOKEN_CATEGORIES` in contracts. */\n tokenCategory?: \"input\" | \"output\" | \"total\" | \"cached_read_input\" | \"cache_creation_input\" | \"context\" | \"max_output\" | \"estimated_output\" | \"actual_output\" | \"streaming_output\";\n /** How the gateway RESERVES units for this meter on an estimate-then-settle\n * path: `reserve_max` (conservative worst-case) / `estimate` (heuristic) /\n * `count_actual` (no reserve). T5 — authored per token category to its\n * use-case: hard quota → `reserve_max` (optionally capped by\n * `reserveCeiling`); soft billing → `estimate`; spend → `reserve_max`. */\n reserveStrategy?: \"reserve_max\" | \"estimate\" | \"count_actual\";\n /** T5 — optional configured reservation CEILING (meter's native unit) for a\n * conservative `reserve_max` strategy that must not hold the full theoretical\n * worst case. Positive integer. Omit ⇒ unbounded worst-case reserve. */\n reserveCeiling?: number;\n /** Key of a meter this one is paired with (e.g. an `input` token meter pairs\n * with its `output` meter) so settlement / observability correlate the pair. */\n pairsWith?: string;\n};", "typeReferences": [], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.MeterLimit", "name": "@farthershore/business.MeterLimit", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/refs.d.ts#L11", "description": "Public export MeterLimit; see its declaration and owning guide.", "signature": "export type MeterLimit = {\n readonly kind: \"meter_limit\";\n readonly meter: MeterRef;\n readonly value: PlanLimitJson;\n};", "typeReferences": [ { "name": "MeterRef", "source": "packages/business/dist/types/value-model/refs.d.ts#L26" }, { "name": "PlanLimitJson", "source": "packages/business/dist/types/ir-types.d.ts#L75" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.MeterOptions", "name": "@farthershore/business.MeterOptions", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L87", "description": "`meter()` options. Every meter is structural (aggregation / window /\nenforcement / unit — what routes report and limits ration). Declaring\n`measures` (and optionally `dimensions`) additionally makes it a PRICEABLE\nmeasurement meter that `pricing()` catalogs rate and\n`meterRoutes(key, route, { reports })` binds.", "signature": "export type MeterOptions = FunctionalMeterOptions & Readonly<{\n measures?: readonly MeasureRef[];\n dimensions?: readonly DimensionRef[];\n}>;", "typeReferences": [ { "name": "DimensionRef", "source": "packages/business/dist/types/commerce/types.d.ts#L36" }, { "name": "FunctionalMeterOptions", "source": "packages/business/dist/types/value-model/declarations.d.ts#L15" }, { "name": "MeasureRef", "source": "packages/business/dist/types/commerce/types.d.ts#L16" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.MeterRef", "name": "@farthershore/business.MeterRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/refs.d.ts#L26", "description": "Public export MeterRef; see its declaration and owning guide.", "signature": "export type MeterRef = DeclarationRef__2a230f417174<\"meter\"> & {\n fixed(value: number): MeterCost;\n perSecond(value: number, options?: TemporalLimitOptions): MeterLimit;\n perMinute(value: number, options?: TemporalLimitOptions): MeterLimit;\n perHour(value: number, options?: TemporalLimitOptions): MeterLimit;\n perDay(value: number, options?: TemporalLimitOptions): MeterLimit;\n perWeek(value: number, options?: TemporalLimitOptions): MeterLimit;\n perMonth(value: number, options?: TemporalLimitOptions): MeterLimit;\n};", "typeReferences": [ { "name": "DeclarationRef__2a230f417174", "source": "packages/business/dist/types/value-model/refs.d.ts#L5" }, { "name": "MeterCost", "source": "packages/business/dist/types/value-model/refs.d.ts#L16" }, { "name": "MeterLimit", "source": "packages/business/dist/types/value-model/refs.d.ts#L11" }, { "name": "TemporalLimitOptions", "source": "packages/business/dist/types/limit-strategy.d.ts#L2" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.MeterRouteBindingOptions", "name": "@farthershore/business.MeterRouteBindingOptions", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L163", "description": "`meterRoutes(key, routeRef, options)` — a concrete route's commerce\nmetering binding.", "signature": "export type MeterRouteBindingOptions = Readonly<{\n /** Priceable meters (declared with `measures`) this route reports. */\n reports: readonly MeterRef[];\n maxOutputUnits?: MeasureMaximumRef;\n /** FAR-909 — finite route_cap admission bounds for measures the client cannot declare. */\n caps?: readonly MeasureMaximumRef[];\n /**\n * FAR-911 (H5) — the request-side clamp binding for `maxOutputUnits`: names\n * the compiled admission knob `max_output_units` and the ONE gateway\n * parser/mutator that reads and rewrites the request body's output-unit\n * limit (`json_body_max_output_units_v1`: the JSON body's canonical\n * output-unit field — for LLM chat/stream routes the `max_tokens` /\n * `max_output_tokens` protocol aliases — parsed as a non-negative integer,\n * clamped DOWN to the declared bound, and rewritten before upstream\n * signing; a missing knob is set to the bound). Builders never name a raw\n * JSON path: the route adapter owns protocol aliases. Compile-time only on\n * this branch — the gateway consumer is FAR-905\n * (`far905-requires-clamp-consumer.pending-gate.test.ts`); until it lands,\n * a client that exceeds a declared bound is TERMINAL-QUARANTINED at\n * ingestion (`ADMISSION_BOUND_BREACHED`, fail-closed, unbilled), never\n * over-debited.\n */\n maxOutputUnitsAdapter?: Readonly<{\n knob: \"max_output_units\";\n parser: \"json_body_max_output_units_v1\";\n mutator: \"json_body_max_output_units_v1\";\n }>;\n /**\n * FAR-911 (H3) — chunked top-up instead of a declared `maxOutputUnits`:\n * `bound` is the cumulative per-operation ceiling (`out.atMost(65536)`),\n * `chunkUnits` the initial reservation; the cumulative ceiling is funded\n * before the first response byte. Exclusive with `maxOutputUnits`.\n */\n chunkPolicy?: Readonly<{\n bound: MeasureMaximumRef;\n chunkUnits: number;\n }>;\n /**\n * FAR-911 (H3) — post-stream measurement timing. `settlementMax` declares\n * the finite per-measure settlement maxima prepaid/x402 plans require.\n */\n postStream?: Readonly<{\n settlementMax?: readonly MeasureMaximumRef[];\n }>;\n}>;", "typeReferences": [ { "name": "MeasureMaximumRef", "source": "packages/business/dist/types/commerce/types.d.ts#L21" }, { "name": "MeterRef", "source": "packages/business/dist/types/value-model/refs.d.ts#L26" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.meterRoutes", "name": "@farthershore/business.meterRoutes", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/authoring.d.ts#L20", "description": "THE meterRoutes verb — always `(key, target, options)` with an\nauthor-supplied stable key. A concrete `route()` ref target is a COMMERCE\nMETERING BINDING (`reports` name priceable meters; admission bounds via\n`maxOutputUnits` / `caps` / `chunkPolicy` / `postStream`). A wildcard path,\ngroup ref, or array target is a STRUCTURAL OVERLAY on the matched routes\n(`reports` / `costs` / `onStatusCodes` / `postStreamBilling`) — the\nroute-layer overlay under `key`.", "signature": "declare const meterRoutes: MeterRoutesFunction__799abcbb8f6e;", "typeReferences": [ { "name": "MeterRoutesFunction__799abcbb8f6e", "source": "packages/business/dist/types/commerce/types.d.ts#L225" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.MeterRoutesOverlayTarget", "name": "@farthershore/business.MeterRoutesOverlayTarget", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L224", "description": "Structural overlay targets: a wildcard path, a group ref, or an array of\npaths / route refs / group refs. A single `route()` ref is a commerce\nmetering binding instead (see {@link MeterRouteBindingOptions}).", "signature": "export type MeterRoutesOverlayTarget = Exclude;", "typeReferences": [ { "name": "MeterRoutesTarget", "source": "packages/business/dist/types/value-model/registry.d.ts#L27" }, { "name": "RouteRef", "source": "packages/business/dist/types/value-model/refs.d.ts#L35" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.MeterRoutesTarget", "name": "@farthershore/business.MeterRoutesTarget", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/registry.d.ts#L27", "description": "Public export MeterRoutesTarget; see its declaration and owning guide.", "signature": "export type MeterRoutesTarget = string | RouteRef | GroupRef | readonly (string | RouteRef | GroupRef)[];", "typeReferences": [ { "name": "GroupRef", "source": "packages/business/dist/types/value-model/refs.d.ts#L36" }, { "name": "RouteRef", "source": "packages/business/dist/types/value-model/refs.d.ts#L35" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.ModelRef", "name": "@farthershore/business.ModelRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L42", "description": "Public export ModelRef; see its declaration and owning guide.", "signature": "export type ModelRef = Readonly<{\n kind: \"model\";\n provider: ProviderRef;\n key: string;\n} & CommerceBrand__7b1b990b7c90<\"model\">>;", "typeReferences": [ { "name": "CommerceBrand__7b1b990b7c90", "source": "packages/business/dist/types/commerce/types.d.ts#L8" }, { "name": "ProviderRef", "source": "packages/business/dist/types/commerce/types.d.ts#L47" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.modifier", "name": "@farthershore/business.modifier", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/authoring.d.ts#L43", "description": "Public export modifier; see its declaration and owning guide.", "signature": "declare const modifier: Readonly<{\n multiplier(numerator: number, denominator: number): ModifierBuilder__ae4a0e208869;\n}>;", "typeReferences": [ { "name": "ModifierBuilder__ae4a0e208869", "source": "packages/business/dist/types/commerce/types.d.ts#L77" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.ModifierRef", "name": "@farthershore/business.ModifierRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L72", "description": "Public export ModifierRef; see its declaration and owning guide.", "signature": "export type ModifierRef = Readonly<{\n kind: \"pricing_modifier\";\n multiplier: ExactRate;\n when: DimensionConditionRef;\n} & CommerceBrand__7b1b990b7c90<\"pricing_modifier\">>;", "typeReferences": [ { "name": "CommerceBrand__7b1b990b7c90", "source": "packages/business/dist/types/commerce/types.d.ts#L8" }, { "name": "DimensionConditionRef", "source": "packages/business/dist/types/commerce/types.d.ts#L31" }, { "name": "ExactRate", "source": "packages/business/dist/types/commerce/lowered-types.d.ts#L1" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.money", "name": "@farthershore/business.money", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/authoring.d.ts#L23", "description": "Public export money; see its declaration and owning guide.", "signature": "declare const money: MoneyFunction__dc62d2738f6d;", "typeReferences": [ { "name": "MoneyFunction__dc62d2738f6d", "source": "packages/business/dist/types/commerce/types.d.ts#L231" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.MultiplierDisplayRef", "name": "@farthershore/business.MultiplierDisplayRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L110", "description": "Public export MultiplierDisplayRef; see its declaration and owning guide.", "signature": "export type MultiplierDisplayRef = Readonly<{\n kind: \"multiplier_display\";\n factor: number;\n} & CommerceBrand__7b1b990b7c90<\"multiplier_display\">>;", "typeReferences": [ { "name": "CommerceBrand__7b1b990b7c90", "source": "packages/business/dist/types/commerce/types.d.ts#L8" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.MutationClass", "name": "@farthershore/business.MutationClass", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L2", "description": "Public export MutationClass; see its declaration and owning guide.", "signature": "export type MutationClass = \"runtime\" | \"contractual\";", "typeReferences": [], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.normalizeTemporalLimitOptions", "name": "@farthershore/business.normalizeTemporalLimitOptions", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/limit-strategy.d.ts#L31", "description": "Validate and presence-preservingly copy the temporal limit fields. A\nresolved quota-length window rejects `token_bucket` up front (mirrors Core\n`requireQuotaWindowStrategy`), including custom windows. `cell` carries the\nsurrounding limit's `capacity` + the dimension's `aggregation` so the\ncoherence rules Core enforces at publish also fail the local build.", "signature": "export declare function normalizeTemporalLimitOptions(options: TemporalLimitOptions, context: string, windowSeconds?: number, cell?: {\n capacity?: number;\n aggregation?: string;\n}): TemporalLimitOptions;", "typeReferences": [ { "name": "TemporalLimitOptions", "source": "packages/business/dist/types/limit-strategy.d.ts#L2" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.plan", "name": "@farthershore/business.plan", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/authoring.d.ts#L10", "description": "Public export plan; see its declaration and owning guide.", "signature": "declare const plan: PlanFunction__9b23957fc098;", "typeReferences": [ { "name": "PlanFunction__9b23957fc098", "source": "packages/business/dist/types/commerce/types.d.ts#L208" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.PlanCapacityJson", "name": "@farthershore/business.PlanCapacityJson", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L52", "description": "A3 — per-request capacity ceiling authored on a plan. Mirrors the contracts\n`planCapacitySchema` (ceilings + enforce/track + failMode + T9\n`tokenCountSource` + T12 `scope`) WITHOUT the compiler-owned `kind` /\n`provenance` discriminators. The core compiler turns it into a\n`{ kind: \"capacity\", …, provenance: \"plan\" }` ConstraintSpec. At least one\nceiling must be present.", "signature": "export type PlanCapacityJson = {\n maxInputTokens?: number;\n maxOutputTokens?: number;\n maxContextTokens?: number;\n maxPayloadBytes?: number;\n enforcement?: \"enforce\" | \"track\";\n failMode?: \"open\" | \"closed\";\n /** T9 — confidence input: `declared` (exact) vs `estimated` (tokenizer). */\n tokenCountSource?: \"declared\" | \"estimated\";\n /** T12 — FORWARD-COMPAT scope hint. */\n scope?: LimitScopeJson__215e4eb2041c;\n};", "typeReferences": [ { "name": "LimitScopeJson__215e4eb2041c", "source": "packages/business/dist/types/ir-types.d.ts#L40" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.PlanKindJson", "name": "@farthershore/business.PlanKindJson", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L66", "description": "The DECLARED plan kind (`plan.kind.*`). Carried on the Manifest IR plan\nand on the commerce manifest; surfaces read it, nothing infers it.", "signature": "export type PlanKindJson = \"free\" | \"flat\" | \"usage\" | \"prepaid\" | \"hybrid\" | \"trial\" | \"custom\";", "typeReferences": [], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.PlanKindRef", "name": "@farthershore/business.PlanKindRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L131", "description": "Public export PlanKindRef; see its declaration and owning guide.", "signature": "export type PlanKindRef = Readonly<{\n kind: \"plan_kind\";\n name: Name;\n} & CommerceBrand__7b1b990b7c90<`plan_kind:${Name}`>>;", "typeReferences": [ { "name": "CommerceBrand__7b1b990b7c90", "source": "packages/business/dist/types/commerce/types.d.ts#L8" }, { "name": "PlanKindName__d0fd9bcc38b8", "source": "packages/business/dist/types/commerce/lowered-types.d.ts#L20" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.PlanLimitJson", "name": "@farthershore/business.PlanLimitJson", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L75", "description": "Public export PlanLimitJson; see its declaration and owning guide.", "signature": "export type PlanLimitJson = {\n dimension: string;\n window: PlanLimitWindowJson__34c3ba9c4506;\n capacity: number;\n enforcement?: \"enforce\" | \"track\";\n /** A3 — optional WARN threshold as a fraction of `capacity` in [0, 1]. The\n * core compiler threads it onto the emitted rate_limit / quota constraint's\n * `warnAt`. Advisory only; never denies. Optional + additive. */\n warnAt?: number;\n strategy?: \"fixed_window\" | \"sliding_window\" | \"token_bucket\";\n bucketCapacity?: number;\n refillRatePerSecond?: number;\n /** T12 — optional FORWARD-COMPAT scope hint. The core compiler threads it onto\n * the emitted rate_limit / quota constraint's `scope`. v1 enforcement is\n * unchanged. Optional + additive. */\n scope?: LimitScopeJson__215e4eb2041c;\n reset_trigger?: \"billing_period\" | \"subscription_start\";\n};", "typeReferences": [ { "name": "LimitScopeJson__215e4eb2041c", "source": "packages/business/dist/types/ir-types.d.ts#L40" }, { "name": "PlanLimitWindowJson__34c3ba9c4506", "source": "packages/business/dist/types/ir-types.d.ts#L67" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.PlanOptions", "name": "@farthershore/business.PlanOptions", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L158", "description": "`plan()` options — the DECLARED `kind` (required), the five economics\ncontrols, and the structural (entitlement) half: what the plan grants and\nhow it rations. Usage money is only ever `usagePricing` / `funding` /\n`spendPolicy`; there is no per-meter rate on a plan.", "signature": "export type PlanOptions = PlanEconomicsControls__792c3ab4d885 & Readonly<{\n kind: PlanKindRef;\n}> & Readonly>;", "typeReferences": [ { "name": "PlanEconomicsControls__792c3ab4d885", "source": "packages/business/dist/types/commerce/types.d.ts#L135" }, { "name": "PlanKindRef", "source": "packages/business/dist/types/commerce/types.d.ts#L131" }, { "name": "StructuralPlanOptions__f7824ff3bdd0", "source": "packages/business/dist/types/value-model/declarations.d.ts#L26" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.PlanRef", "name": "@farthershore/business.PlanRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/refs.d.ts#L37", "description": "Public export PlanRef; see its declaration and owning guide.", "signature": "export type PlanRef = DeclarationRef__2a230f417174<\"plan\">;", "typeReferences": [ { "name": "DeclarationRef__2a230f417174", "source": "packages/business/dist/types/value-model/refs.d.ts#L5" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.PlanSpecJson", "name": "@farthershore/business.PlanSpecJson", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L113", "description": "Public export PlanSpecJson; see its declaration and owning guide.", "signature": "export type PlanSpecJson = {\n key: string;\n /** The DECLARED plan kind. Required: a plan is free / flat / usage / …\n * because the builder said so, never because of its shape. Usage money\n * never lives on the plan; it is commerce-manifest owned. */\n kind: PlanKindJson;\n description?: string;\n details?: string[];\n recurring_fee_cents?: number;\n billing_interval?: \"month\" | \"year\";\n trial_days?: number;\n max_monthly_spend_cents?: number;\n min_monthly_spend_cents?: number;\n limits?: PlanLimitJson[];\n /** Additive v2 direct grants using stable route ids. */\n routeGrants?: string[];\n /** Named managed-frontend integrations this plan permits. */\n frontendIntegrationGrants?: string[];\n resource_limits?: Record;\n /** A3 — per-request capacity ceiling. Compiles to a `{ kind: \"capacity\" }`\n * ConstraintSpec the gateway enforces (413 `request_too_large`). */\n capacity?: PlanCapacityJson;\n overageBehavior?: \"block\" | \"allow_and_bill\";\n selfServeEnabled?: boolean;\n archive?: PlanArchiveJson__452830f6517f;\n /** Escape hatch: future fields ride through here. `variants` was removed and is rejected at validation. */\n [key: string]: unknown;\n};", "typeReferences": [ { "name": "PlanArchiveJson__452830f6517f", "source": "packages/business/dist/types/ir-types.d.ts#L108" }, { "name": "PlanCapacityJson", "source": "packages/business/dist/types/ir-types.d.ts#L52" }, { "name": "PlanKindJson", "source": "packages/business/dist/types/ir-types.d.ts#L66" }, { "name": "PlanLimitJson", "source": "packages/business/dist/types/ir-types.d.ts#L75" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.prepaid", "name": "@farthershore/business.prepaid", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/authoring.d.ts#L49", "description": "Public export prepaid; see its declaration and owning guide.", "signature": "export declare function prepaid(amount: AuthoredMoneyAmount, options?: Readonly<{\n topUp?: boolean;\n}>): FundingBucketRef;", "typeReferences": [ { "name": "AuthoredMoneyAmount", "source": "packages/business/dist/types/commerce/types.d.ts#L230" }, { "name": "FundingBucketRef", "source": "packages/business/dist/types/commerce/types.d.ts#L114" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.pricing", "name": "@farthershore/business.pricing", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/authoring.d.ts#L9", "description": "Public export pricing; see its declaration and owning guide.", "signature": "export declare function pricing(key: string, options: PricingOptions): PricingRef;", "typeReferences": [ { "name": "PricingOptions", "source": "packages/business/dist/types/commerce/types.d.ts#L92" }, { "name": "PricingRef", "source": "packages/business/dist/types/commerce/types.d.ts#L103" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.PricingBindingRef", "name": "@farthershore/business.PricingBindingRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L97", "description": "Public export PricingBindingRef; see its declaration and owning guide.", "signature": "export type PricingBindingRef = Readonly<{\n kind: \"pricing_binding\";\n binding: PricingBindingKind__ff438801f484;\n pricing: PricingRef;\n version?: number;\n} & CommerceBrand__7b1b990b7c90<\"pricing_binding\">>;", "typeReferences": [ { "name": "CommerceBrand__7b1b990b7c90", "source": "packages/business/dist/types/commerce/types.d.ts#L8" }, { "name": "PricingBindingKind__ff438801f484", "source": "packages/business/dist/types/commerce/lowered-types.d.ts#L18" }, { "name": "PricingRef", "source": "packages/business/dist/types/commerce/types.d.ts#L103" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.PricingOptions", "name": "@farthershore/business.PricingOptions", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L92", "description": "Public export PricingOptions; see its declaration and owning guide.", "signature": "export type PricingOptions = Readonly<{\n /** A meter declared with `measures` (priceable). */\n meter: MeterRef;\n catalog: readonly PricingCatalogAuthoringEntry__8ad295725f7a[];\n}>;", "typeReferences": [ { "name": "MeterRef", "source": "packages/business/dist/types/value-model/refs.d.ts#L26" }, { "name": "PricingCatalogAuthoringEntry__8ad295725f7a", "source": "packages/business/dist/types/commerce/types.d.ts#L91" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.PricingRef", "name": "@farthershore/business.PricingRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L103", "description": "Public export PricingRef; see its declaration and owning guide.", "signature": "export type PricingRef = Readonly<{\n kind: \"pricing\";\n key: string;\n current(): PricingBindingRef;\n withContractTerms(): PricingBindingRef;\n fixedVersion(version: number): PricingBindingRef;\n} & CommerceBrand__7b1b990b7c90<\"pricing\">>;", "typeReferences": [ { "name": "CommerceBrand__7b1b990b7c90", "source": "packages/business/dist/types/commerce/types.d.ts#L8" }, { "name": "PricingBindingRef", "source": "packages/business/dist/types/commerce/types.d.ts#L97" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.promo", "name": "@farthershore/business.promo", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/authoring.d.ts#L52", "description": "Public export promo; see its declaration and owning guide.", "signature": "export declare function promo(amount: AuthoredMoneyAmount): FundingBucketRef;", "typeReferences": [ { "name": "AuthoredMoneyAmount", "source": "packages/business/dist/types/commerce/types.d.ts#L230" }, { "name": "FundingBucketRef", "source": "packages/business/dist/types/commerce/types.d.ts#L114" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.provider", "name": "@farthershore/business.provider", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/authoring.d.ts#L7", "description": "Public export provider; see its declaration and owning guide.", "signature": "export declare function provider(key: string): ProviderRef;", "typeReferences": [ { "name": "ProviderRef", "source": "packages/business/dist/types/commerce/types.d.ts#L47" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.ProviderRef", "name": "@farthershore/business.ProviderRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L47", "description": "Public export ProviderRef; see its declaration and owning guide.", "signature": "export type ProviderRef = Readonly<{\n kind: \"provider\";\n key: string;\n model(key: string): ModelRef;\n} & CommerceBrand__7b1b990b7c90<\"provider\">>;", "typeReferences": [ { "name": "CommerceBrand__7b1b990b7c90", "source": "packages/business/dist/types/commerce/types.d.ts#L8" }, { "name": "ModelRef", "source": "packages/business/dist/types/commerce/types.d.ts#L42" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.rail", "name": "@farthershore/business.rail", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/authoring.d.ts#L64", "description": "FAR-911 — admission-rail constants for `spendPolicy.rail`.", "signature": "declare const rail: Readonly<{\n x402: RailRef;\n}>;", "typeReferences": [ { "name": "RailRef", "source": "packages/business/dist/types/commerce/types.d.ts#L127" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.RailRef", "name": "@farthershore/business.RailRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L127", "description": "FAR-911 — admission rail constant (`rail.x402`): every op is funded before it runs.", "signature": "export type RailRef = Readonly<{\n kind: \"admission_rail\";\n rail: \"x402\";\n} & CommerceBrand__7b1b990b7c90<\"admission_rail\">>;", "typeReferences": [ { "name": "CommerceBrand__7b1b990b7c90", "source": "packages/business/dist/types/commerce/types.d.ts#L8" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.rate", "name": "@farthershore/business.rate", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/authoring.d.ts#L24", "description": "Public export rate; see its declaration and owning guide.", "signature": "declare const rate: Readonly<{\n perUnit(amount: AuthoredMoneyAmount): UnboundRateRef;\n perMillion(amount: AuthoredMoneyAmount): UnboundRateRef;\n per(unitCount: number, amount: AuthoredMoneyAmount): UnboundRateRef;\n rational(numerator: number, denominator: number, amount: AuthoredMoneyAmount): UnboundRateRef;\n /** FAR-909 — graduated tiers: each unit rated by the tier its cumulative window position falls in. */\n graduated(tiers: readonly CatalogTierInput[]): UnboundRateRef;\n /** FAR-909 — volume (retroactive) tiers: every unit rated at the tier the window total selects at close. */\n volume(tiers: readonly CatalogTierInput[]): UnboundRateRef;\n /**\n * FAR-911 / M5 — bounded backend quote: the backend proposes a per-unit\n * rate per report; Core clamps it into `[min, max]` (SDK-created flat\n * rates, USD per unit) and dispute-flags out-of-range proposals.\n */\n backendQuoted(bounds: Readonly<{\n min: UnboundRateRef;\n max: UnboundRateRef;\n }>): UnboundRateRef;\n}>;", "typeReferences": [ { "name": "AuthoredMoneyAmount", "source": "packages/business/dist/types/commerce/types.d.ts#L230" }, { "name": "CatalogTierInput", "source": "packages/business/dist/types/commerce/types.d.ts#L12" }, { "name": "UnboundRateRef", "source": "packages/business/dist/types/commerce/types.d.ts#L53" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.referral", "name": "@farthershore/business.referral", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/authoring.d.ts#L53", "description": "Public export referral; see its declaration and owning guide.", "signature": "export declare function referral(amount: AuthoredMoneyAmount): FundingBucketRef;", "typeReferences": [ { "name": "AuthoredMoneyAmount", "source": "packages/business/dist/types/commerce/types.d.ts#L230" }, { "name": "FundingBucketRef", "source": "packages/business/dist/types/commerce/types.d.ts#L114" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.requests", "name": "@farthershore/business.requests", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/declarations.d.ts#L64", "description": "Public export requests; see its declaration and owning guide.", "signature": "export declare function requests(options?: FunctionalRequestMeterOptions): MeterRef;", "typeReferences": [ { "name": "FunctionalRequestMeterOptions", "source": "packages/business/dist/types/value-model/declarations.d.ts#L18" }, { "name": "MeterRef", "source": "packages/business/dist/types/value-model/refs.d.ts#L26" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.resource", "name": "@farthershore/business.resource", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/declarations.d.ts#L65", "description": "Public export resource; see its declaration and owning guide.", "signature": "export declare function resource(id: string, options?: FunctionalResourceOptions): ResourceRef;", "typeReferences": [ { "name": "FunctionalResourceOptions", "source": "packages/business/dist/types/value-model/declarations.d.ts#L9" }, { "name": "ResourceRef", "source": "packages/business/dist/types/value-model/refs.d.ts#L38" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.resourceGraphOf", "name": "@farthershore/business.resourceGraphOf", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/business.d.ts#L133", "description": "The declaration graph behind a compiled business — every node's URN, kind,\nkey, `dependsOn` edges, and declaration order.\n\nThis is the SDK's internal representation, exposed for inspection: tooling and\nagents can reason about what a business declares and how its pieces reference\neach other without re-parsing the Manifest IR (where branded refs have already\ncollapsed to plain strings, and `group()` / `meterRoutes()` have been erased\nentirely).\n\nNode payloads are NOT included — `snapshot()` strips `value`, so this is\nstructure only. The Manifest IR remains the wire format and the only thing\nCore consumes.\n\nReturns `null` for a value that is not an authentic `fs.business()` result.\nFor a deferred (folder-discovered) program the graph is captured when the\nmanifest materializes, so call `compileBusinessToManifest` first if you need\nit before anything else has forced materialization.", "signature": "export declare function resourceGraphOf(business: CompiledBusiness__671c1daa22b7): ManifestResourceGraphSnapshot | null;", "typeReferences": [ { "name": "CompiledBusiness__671c1daa22b7", "source": "packages/business/dist/types/business.d.ts#L7" }, { "name": "ManifestResourceGraphSnapshot", "source": "packages/business/dist/types/resource-graph.d.ts#L11" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.ResourceLimit", "name": "@farthershore/business.ResourceLimit", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/refs.d.ts#L21", "description": "Public export ResourceLimit; see its declaration and owning guide.", "signature": "export type ResourceLimit = {\n readonly kind: \"resource_limit\";\n readonly resource: ResourceRef;\n readonly count: number;\n};", "typeReferences": [ { "name": "ResourceRef", "source": "packages/business/dist/types/value-model/refs.d.ts#L38" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.ResourceRef", "name": "@farthershore/business.ResourceRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/refs.d.ts#L38", "description": "Public export ResourceRef; see its declaration and owning guide.", "signature": "export type ResourceRef = DeclarationRef__2a230f417174<\"resource\"> & {\n /** Maximum number of this persistent resource a subscription may own. */\n max(count: number): ResourceLimit;\n};", "typeReferences": [ { "name": "DeclarationRef__2a230f417174", "source": "packages/business/dist/types/value-model/refs.d.ts#L5" }, { "name": "ResourceLimit", "source": "packages/business/dist/types/value-model/refs.d.ts#L21" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.route", "name": "@farthershore/business.route", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/declarations.d.ts#L68", "description": "Public export route; see its declaration and owning guide.", "signature": "export declare function route(path: string, operations: RouteOperations): RouteRef;", "typeReferences": [ { "name": "RouteOperations", "source": "packages/business/dist/types/value-model/registry.d.ts#L30" }, { "name": "RouteRef", "source": "packages/business/dist/types/value-model/refs.d.ts#L35" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.RouteDefinitionJson", "name": "@farthershore/business.RouteDefinitionJson", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L225", "description": "Public export RouteDefinitionJson; see its declaration and owning guide.", "signature": "export type RouteDefinitionJson = {\n match: {\n method: HttpMethod;\n path: string;\n };\n metering?: {\n defaults?: Record;\n reports?: string[];\n onStatusCodes?: string | number[];\n /** The authoritative billable units arrive through the attested\n * post-stream reporter. The in-band gateway event remains reserve-only. */\n postStreamBilling?: boolean;\n };\n /** Explicit billing semantics belong to the route, not the metering block;\n * contracts reparses route layers strictly enough to strip unknown nested\n * keys, which would silently turn authored free operations into inferred\n * billable metered operations. */\n usagePolicy?: RouteUsagePolicyJson__bd930ebf5713;\n unmetered?: boolean;\n inheritDefaultMeters?: boolean;\n action?: string;\n /** Repo-owned custom permissions — stamped by lowering when this route is a\n * member of a permission-carrying `fs.group`. The gateway gates the route\n * on `:read|write`; metering/grant identity (`action` /\n * canonical method+path) is untouched. Never authored directly on a route. */\n permissionSubject?: string;\n /** Repo-owned custom permissions — gateway-required verb override for this\n * operation (`:` instead of the\n * method-derived read/write). Present only with `permissionSubject`. */\n permissionVerb?: string;\n /** BYO-Backend V1 — route→backend binding id. Omitted = the sole / default\n * backend (single-backend businesses stay zero-config). */\n backend?: string;\n /** Canonical per-route auth/timeout/retry policy (FAR-680). Omitted when no\n * policy intent was authored — keeps the IR (and irHash) byte-identical. */\n policy?: RoutePolicyJson;\n /** FAR-684 — canonical per-route rate/quota overrides, normalized from\n * `rateLimit` / `quota` sugar. Omitted when the route authored none — keeps\n * the IR (and irHash) byte-identical. */\n limits?: RouteLimitJson__077809c9f639[];\n};", "typeReferences": [ { "name": "HttpMethod", "source": "packages/business/dist/types/ir-types.d.ts#L1" }, { "name": "RouteLimitJson__077809c9f639", "source": "packages/business/dist/types/ir-types.d.ts#L99" }, { "name": "RoutePolicyJson", "source": "packages/business/dist/types/ir-types.d.ts#L206" }, { "name": "RouteUsagePolicyJson__bd930ebf5713", "source": "packages/business/dist/types/ir-types.d.ts#L281" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.RouteLayerJson", "name": "@farthershore/business.RouteLayerJson", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L340", "description": "Public export RouteLayerJson; see its declaration and owning guide.", "signature": "export type RouteLayerJson = {\n description?: string;\n mutation_class?: MutationClass;\n cacheProfile?: CacheProfile;\n routes: RouteDefinitionJson[];\n runtime?: {\n rollout_key?: string;\n required_flags?: string[];\n };\n actions?: ActionSpecJson__e01b08e9d184[];\n /** Layer-level default backend binding; exact routes may override it. */\n backend?: string;\n};", "typeReferences": [ { "name": "ActionSpecJson__e01b08e9d184", "source": "packages/business/dist/types/ir-types.d.ts#L323" }, { "name": "CacheProfile", "source": "packages/business/dist/types/ir-types.d.ts#L3" }, { "name": "MutationClass", "source": "packages/business/dist/types/ir-types.d.ts#L2" }, { "name": "RouteDefinitionJson", "source": "packages/business/dist/types/ir-types.d.ts#L225" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.RouteOperations", "name": "@farthershore/business.RouteOperations", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/registry.d.ts#L30", "description": "Public export RouteOperations; see its declaration and owning guide.", "signature": "export type RouteOperations = Partial>;", "typeReferences": [ { "name": "RouteOperationOptions__902951868956", "source": "packages/business/dist/types/value-model/registry.d.ts#L29" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.RoutePolicyJson", "name": "@farthershore/business.RoutePolicyJson", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L206", "description": "Public export RoutePolicyJson; see its declaration and owning guide.", "signature": "export type RoutePolicyJson = {\n authMode?: \"public\" | \"required\";\n timeoutMs?: number;\n idleTimeoutMs?: number;\n retry?: RouteRetryPolicyJson;\n /** Consumer-principal subject requirement the gateway enforces (403\n * `member_subject_required` / `service_subject_required`). OMITTED when the\n * route imposes no requirement (\"any\") — absence-vs-presence is the only\n * irHash signal, so a route with no subject requirement stays byte-identical. */\n subject?: \"member\" | \"service\";\n /** CALLABILITY axis — allowlist of credential surfaces the gateway admits.\n * OMITTED = all admitted (the implicit \"hybrid\" state). Emitted as a\n * non-empty, deduped, canonically-sorted array so the irHash is stable. */\n surfaces?: RouteSurface__b5c8a54b503c[];\n /** VISIBILITY axis — true excludes the route from generated docs + grantable\n * API-key scopes, and makes a callability deny return 404 (not 403). OMITTED\n * when the route is visible, so a listed route stays byte-identical. */\n hidden?: boolean;\n};", "typeReferences": [ { "name": "RouteRetryPolicyJson", "source": "packages/business/dist/types/ir-types.d.ts#L189" }, { "name": "RouteSurface__b5c8a54b503c", "source": "packages/business/dist/types/ir-types.d.ts#L205" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.RouteRef", "name": "@farthershore/business.RouteRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/refs.d.ts#L35", "description": "Public export RouteRef; see its declaration and owning guide.", "signature": "export type RouteRef = DeclarationRef__2a230f417174<\"route\">;", "typeReferences": [ { "name": "DeclarationRef__2a230f417174", "source": "packages/business/dist/types/value-model/refs.d.ts#L5" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.RouteRetryOnJson", "name": "@farthershore/business.RouteRetryOnJson", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L186", "description": "Retry conditions the canonical retry policy fires on (FAR-680).", "signature": "export type RouteRetryOnJson = \"network\" | \"5xx\";", "typeReferences": [], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.RouteRetryPolicyJson", "name": "@farthershore/business.RouteRetryPolicyJson", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/ir-types.d.ts#L189", "description": "CANONICAL retry policy — the explicit IR shape SDK sugar normalizes into\nand FAR-689 consumes. Never hand-authored; `retry: true` expands to it.", "signature": "export type RouteRetryPolicyJson = {\n maxAttempts: number;\n retryOn: RouteRetryOnJson[];\n backoff: {\n base: number;\n max: number;\n jitter: number;\n };\n budgetRatio: number;\n};", "typeReferences": [ { "name": "RouteRetryOnJson", "source": "packages/business/dist/types/ir-types.d.ts#L186" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.scope", "name": "@farthershore/business.scope", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/constants.d.ts#L5", "description": "Public export scope; see its declaration and owning guide.", "signature": "declare const scope: Readonly<{\n subscription: \"subscription\";\n subject: \"subject\";\n}>;", "typeReferences": [], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.SDK_VERSION", "name": "@farthershore/business.SDK_VERSION", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/version.d.ts#L1", "description": "Public export SDK_VERSION; see its declaration and owning guide.", "signature": "declare const SDK_VERSION: string;", "typeReferences": [], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.surfaces", "name": "@farthershore/business.surfaces", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/value-model/constants.d.ts#L1", "description": "Public export surfaces; see its declaration and owning guide.", "signature": "declare const surfaces: Readonly<{\n ui: \"ui\";\n api: \"api\";\n}>;", "typeReferences": [], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.TemporalLimitOptions", "name": "@farthershore/business.TemporalLimitOptions", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/limit-strategy.d.ts#L2", "description": "Public export TemporalLimitOptions; see its declaration and owning guide.", "signature": "export type TemporalLimitOptions = {\n /** Temporal accounting strategy. Omitted preserves fixed-window IR. */\n strategy?: LimitStrategy;\n /** Token-bucket burst capacity. Valid only with `token_bucket`. */\n bucketCapacity?: number;\n /** Token-bucket steady-state refill rate in units per second. */\n refillRatePerSecond?: number;\n};", "typeReferences": [ { "name": "LimitStrategy", "source": "packages/business/dist/types/limit-strategy.d.ts#L1" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.UnboundRateRef", "name": "@farthershore/business.UnboundRateRef", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/commerce/types.d.ts#L53", "description": "Public export UnboundRateRef; see its declaration and owning guide.", "signature": "export type UnboundRateRef = Readonly<{\n kind: \"catalog_rate\";\n /** Flat per-unit rate; absent when `tiers` is present. */\n rate?: ExactRate;\n /** Tiered pricing model (FAR-909); absent when `rate` is present. */\n tiers?: ExactCatalogTiers;\n /** Bounded backend-quoted rule (FAR-911); absent when `rate`/`tiers` is present. */\n quote?: ExactQuoteBounds__e9cf817917c1;\n for(measure: MeasureRef, ...selectors: readonly CatalogSelectorRef[]): BoundRateRef;\n} & CommerceBrand__7b1b990b7c90<\"catalog_rate\">>;", "typeReferences": [ { "name": "BoundRateRef", "source": "packages/business/dist/types/commerce/types.d.ts#L63" }, { "name": "CatalogSelectorRef", "source": "packages/business/dist/types/commerce/types.d.ts#L52" }, { "name": "CommerceBrand__7b1b990b7c90", "source": "packages/business/dist/types/commerce/types.d.ts#L8" }, { "name": "ExactCatalogTiers", "source": "packages/business/dist/types/commerce/lowered-types.d.ts#L5" }, { "name": "ExactQuoteBounds__e9cf817917c1", "source": "packages/business/dist/types/commerce/lowered-types.d.ts#L13" }, { "name": "ExactRate", "source": "packages/business/dist/types/commerce/lowered-types.d.ts#L1" }, { "name": "MeasureRef", "source": "packages/business/dist/types/commerce/types.d.ts#L16" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.validateManifestIr", "name": "@farthershore/business.validateManifestIr", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/validate.d.ts#L18", "description": "Validate a candidate envelope against the platform schemas. On success\nthe returned `ir` is the JSON-normalized ORIGINAL candidate — NOT the\nzod-parsed value. The platform treats the business spec as a raw document\nbecause the YAML path never zod-transformed it before storing/compiling.\nValidation proves the document is acceptable; the bytes stay the author's.", "signature": "export declare function validateManifestIr(candidate: unknown): ValidationResult;", "typeReferences": [ { "name": "ValidationResult", "source": "packages/business/dist/types/validate.d.ts#L3" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.validatePlanRateLimitCompleteness", "name": "@farthershore/business.validatePlanRateLimitCompleteness", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/validate.d.ts#L37", "description": "BUILD-completeness check (distinct from the structural `validateManifestIr`\nabove): emit an `error` issue for every plan missing a `limits[]` rule, using\nthe shared `isCompletePlanRateLimit` predicate so the LOCAL build matches the\nPUBLISH gate exactly (`isCompletePlanRateLimit`, apps/core\n`services/plan-rate-limit.ts`). A limitless plan thus fails at author/build\ntime instead of passing locally and only failing at push. The predicate is\nthe single source of truth in `@farthershore/contracts/plans`, so local ==\npublish by construction.\n\nIt is run by the build entry (`farthershore build` → src/bin.ts) AFTER a\nclean `compileBusinessToManifest`, NOT folded into the platform compiler's\nstructural validation: the compiler's direct callers (and the golden\nIR-equivalence fixtures) compile minimal, intentionally-limitless products\nto assert IR byte-identity, and must stay free of the completeness gate.\n\nThe hint names the plan + shows the minimal structured `limits` shape.", "signature": "export declare function validatePlanRateLimitCompleteness(ir: ManifestIrDocument): ManifestIssue[];", "typeReferences": [ { "name": "ManifestIrDocument", "source": "packages/business/dist/types/ir-types.d.ts#L425" }, { "name": "ManifestIssue", "source": "packages/business/dist/types/errors.d.ts#L2" } ], "guide": "reference/business-sdk" }, { "id": "sdk.business.root.ValidationResult", "name": "@farthershore/business.ValidationResult", "kind": "sdk", "collection": "business-sdk", "page": "generated/business-sdk/root", "source": "packages/business/dist/types/validate.d.ts#L3", "description": "Public export ValidationResult; see its declaration and owning guide.", "signature": "export type ValidationResult = {\n ok: true;\n ir: ManifestIrDocument;\n irHash: string;\n} | {\n ok: false;\n issues: ManifestIssue[];\n};", "typeReferences": [ { "name": "ManifestIrDocument", "source": "packages/business/dist/types/ir-types.d.ts#L425" }, { "name": "ManifestIssue", "source": "packages/business/dist/types/errors.d.ts#L2" } ], "guide": "reference/business-sdk" }, { "id": "sdk.farthershore-js.components-docs-chrome.classifyTabLanguage", "name": "@farthershore/farthershore-js/components/docs-chrome.classifyTabLanguage", "kind": "sdk", "collection": "frontend-sdk", "page": "generated/frontend-sdk/components-docs-chrome", "source": "packages/farthershore-js/dist/components/docs-chrome/language.d.ts#L27", "description": "Normalize an arbitrary tab label/prop to a canonical language id, or `null`\nwhen the tab is auxiliary (a response/rotate/json strip — NOT a language\nvariant). Matching is case-insensitive and alias-aware.\n\nWhen `languages` is provided the info-string is matched against the declared\nset first: a match on `id` or any of a language's `aliases` (case-insensitive)\nwins and returns that language's `id`. Auxiliary labels always return `null`\nregardless. When no declared set is provided the built-in alias table is used\nas a fallback (js→node, py→python, golang→go) so existing callers are\nunaffected.", "signature": "export declare function classifyTabLanguage(labelOrProp: string, languages?: ReadonlyArray): string | null;", "typeReferences": [ { "name": "DocsLanguage", "source": "packages/farthershore-js/dist/components/docs-chrome/language.d.ts#L2" } ], "guide": "reference/frontend-sdk" }, { "id": "sdk.farthershore-js.components-docs-chrome.DocsCollection", "name": "@farthershore/farthershore-js/components/docs-chrome.DocsCollection", "kind": "sdk", "collection": "frontend-sdk", "page": "generated/frontend-sdk/components-docs-chrome", "source": "packages/farthershore-js/dist/components/docs-chrome/collections.d.ts#L2", "description": "A selectable documentation collection (a self-contained docs bundle).", "signature": "export type DocsCollection = {\n /** Stable id: URL segment, R2 key prefix, storage key, and matching (e.g. \"api\"). */\n id: string;\n /** Human label for the selector/tab (e.g. \"API reference\"). */\n label: string;\n /** Optional tab image URL. The default selector renders it as an ``,\n * so it must be an absolute/root-relative URL or data: URI. */\n icon?: string;\n};", "typeReferences": [], "guide": "reference/frontend-sdk" }, { "id": "sdk.farthershore-js.components-docs-chrome.DocsCollectionsContextValue", "name": "@farthershore/farthershore-js/components/docs-chrome.DocsCollectionsContextValue", "kind": "sdk", "collection": "frontend-sdk", "page": "generated/frontend-sdk/components-docs-chrome", "source": "packages/farthershore-js/dist/components/docs-chrome/collections-context.d.ts#L2", "description": "Public export DocsCollectionsContextValue; see its declaration and owning guide.", "signature": "export type DocsCollectionsContextValue = {\n /** The resolved active collection id, or null when there are no collections. */\n activeCollection: string | null;\n /** The full collection list (empty when unprovided / single bundle). */\n collections: ReadonlyArray;\n /** Switch the active collection (persists + lets the host navigate to it). */\n setCollection: (id: string) => void;\n};", "typeReferences": [ { "name": "DocsCollection", "source": "packages/farthershore-js/dist/components/docs-chrome/collections.d.ts#L2" } ], "guide": "reference/frontend-sdk" }, { "id": "sdk.farthershore-js.components-docs-chrome.DocsCollectionSelector", "name": "@farthershore/farthershore-js/components/docs-chrome.DocsCollectionSelector", "kind": "sdk", "collection": "frontend-sdk", "page": "generated/frontend-sdk/components-docs-chrome", "source": "packages/farthershore-js/dist/components/docs-chrome/collections-context.d.ts#L51", "description": "Unstyled collection switcher — a `