@farthershore/client 0.1.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +172 -0
- package/README.md +9 -8
- package/dist/index.js +105 -54
- package/dist/types/api.generated.d.ts +21 -7
- package/dist/types/generated/schemas.d.ts +3683 -0
- package/dist/types/helpers/wait-for-frontend-build.d.ts +12 -4
- package/dist/types/index.d.ts +2 -2
- package/dist/types/operations/agents.d.ts +204 -12
- package/dist/types/operations/agreements.d.ts +139 -9
- package/dist/types/operations/analytics.d.ts +27 -5
- package/dist/types/operations/audit-notifications.d.ts +64 -7
- package/dist/types/operations/auth.d.ts +12 -4
- package/dist/types/operations/backends.d.ts +211 -9
- package/dist/types/operations/billing.d.ts +60 -4
- package/dist/types/operations/businesses.d.ts +744 -27
- package/dist/types/operations/change-sets.d.ts +426 -7
- package/dist/types/operations/consumers.d.ts +133 -14
- package/dist/types/operations/define.d.ts +16 -5
- package/dist/types/operations/environments.d.ts +40 -4
- package/dist/types/operations/frontend.d.ts +20 -2
- package/dist/types/operations/index.d.ts +3941 -193
- package/dist/types/operations/maker-tokens.d.ts +175 -11
- package/dist/types/operations/organizations.d.ts +321 -19
- package/dist/types/operations/personas.d.ts +98 -8
- package/dist/types/operations/plans-usage.d.ts +69 -3
- package/dist/types/operations/platform.d.ts +420 -12
- package/dist/types/operations/portal.d.ts +409 -16
- package/dist/types/operations/promo-codes.d.ts +126 -6
- package/dist/types/operations/variables.d.ts +170 -7
- package/dist/types/operations/webhooks.d.ts +77 -14
- package/dist/types/surface-types.d.ts +25 -3
- package/dist/types/transport.d.ts +5 -10
- package/dist/types/types.d.ts +385 -411
- package/dist/types/version.d.ts +2 -2
- package/package.json +1 -1
package/dist/types/types.d.ts
CHANGED
|
@@ -1,35 +1,67 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
export type
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
1
|
+
import type { components } from "./generated/schemas.js";
|
|
2
|
+
type Schemas = components["schemas"];
|
|
3
|
+
/**
|
|
4
|
+
* A business as the business reads and writes return it (`GET /businesses`,
|
|
5
|
+
* `PATCH /businesses/:id`, the management reads). Closed: only these fields.
|
|
6
|
+
*/
|
|
7
|
+
export type BusinessSummary = Schemas["Business"];
|
|
8
|
+
/** `GET /businesses/:id`: the business plus its active environments. */
|
|
9
|
+
export type BusinessDetail = Schemas["BusinessDetail"];
|
|
10
|
+
/** `POST /businesses`: the draft business, its repository, and next steps. */
|
|
11
|
+
export type BusinessCreateResult = Schemas["BusinessCreateResponse"];
|
|
12
|
+
/** `POST /businesses/:id/publish`: the business plus the computed release. */
|
|
13
|
+
export type PublishBusinessResult = Schemas["PublishBusinessResponse"];
|
|
14
|
+
/**
|
|
15
|
+
* `POST /businesses/:id/publish` with `{ dryRun: true }`: the server's
|
|
16
|
+
* `{ dryRun, wouldHave }` envelope. The surface types a preview call as
|
|
17
|
+
* `DryRunPreview<PublishBusinessResult>`; this is the same shape, generated.
|
|
18
|
+
*/
|
|
19
|
+
export type PublishBusinessPreview = Schemas["PublishBusinessPreview"];
|
|
20
|
+
/**
|
|
21
|
+
* A preview environment, as `GET /businesses/:id/environments` lists it and
|
|
22
|
+
* `GET /businesses/:id` nests it. Closed: only these fields.
|
|
23
|
+
*/
|
|
24
|
+
export type EnvironmentSummary = Schemas["BusinessEnvironment"];
|
|
25
|
+
/**
|
|
26
|
+
* `POST /businesses/:id/environments`: the environment, plus whether this call
|
|
27
|
+
* created it (`created`) and its git branch (`branchCreated`).
|
|
28
|
+
*/
|
|
29
|
+
export type EnvironmentCreateResult = Schemas["BusinessEnvironmentCreateResponse"];
|
|
30
|
+
/** One Apply Timeline entry: a repository-triggered apply and its phases. */
|
|
31
|
+
export type ApplyTimelineEntry = Schemas["ApplyTimelineEntry"];
|
|
32
|
+
/** `GET /businesses/:id/apply-timeline`: newest first, plus the env filtered on. */
|
|
33
|
+
export type ApplyTimelineEntryList = Schemas["ApplyTimelineList"];
|
|
34
|
+
/** A governed ChangeSet (proposal) against one subscriber. Closed. */
|
|
35
|
+
export type ChangeSet = Schemas["ChangeSet"];
|
|
36
|
+
/** One page of ChangeSets, newest first; `nextCursor` is null on the last. */
|
|
37
|
+
export type ChangeSetList = Schemas["ChangeSetList"];
|
|
38
|
+
/**
|
|
39
|
+
* What a propose would record: the `wouldHave` of a
|
|
40
|
+
* `changeSets.propose(…, { dryRun: true })` preview. Nothing is written.
|
|
41
|
+
*/
|
|
42
|
+
export type ChangeSetProposePreview = Schemas["ChangeSetProposePreview"];
|
|
43
|
+
/** `analytics.timeseries`: one bucket per interval. */
|
|
44
|
+
export type AnalyticsTimeseriesResult = Schemas["AnalyticsTimeseriesResponse"];
|
|
45
|
+
/** `analytics.top`: ranked keys with their counts. */
|
|
46
|
+
export type AnalyticsTopKResult = Schemas["AnalyticsTopKResponse"];
|
|
47
|
+
/** `analytics.latency`: one row per requested percentile. */
|
|
48
|
+
export type AnalyticsPercentilesResult = Schemas["AnalyticsPercentilesResponse"];
|
|
49
|
+
/** `analytics.log`: archived events newest first, with their request detail. */
|
|
50
|
+
export type AnalyticsEventFeedResult = Schemas["AnalyticsEventFeedResponse"];
|
|
51
|
+
/** `analytics.query`: any verb's answer; the verb sent decides which. */
|
|
52
|
+
export type AnalyticsQueryResult = Schemas["AnalyticsQueryResponse"];
|
|
53
|
+
/** `GET /management/businesses/:id/usage`: the trailing-30-day summary. */
|
|
54
|
+
export type UsageSummary = Schemas["UsageSummary"];
|
|
55
|
+
/** `GET /management/businesses/:id/usage-limits`: subscriber limits, paged. */
|
|
56
|
+
export type ManagementUsageLimitList = Schemas["ManagementUsageLimitListResponse"];
|
|
57
|
+
/** `GET /management/businesses/:id/plans`: plans in one scope, paged. */
|
|
58
|
+
export type PlanList = Schemas["PlanList"];
|
|
59
|
+
/** `GET /businesses/:id/stripe/status`. No account ids. */
|
|
60
|
+
export type StripeConnectionStatus = Schemas["StripeConnectionStatus"];
|
|
61
|
+
/** `POST /businesses/:id/stripe/disconnect`. */
|
|
62
|
+
export type StripeDisconnectResult = Schemas["StripeDisconnectResponse"];
|
|
63
|
+
/** `GET`/`POST /management/businesses/:id/tax-settings`. */
|
|
64
|
+
export type TaxSettings = Schemas["TaxSettings"];
|
|
33
65
|
/** Offset pagination block. */
|
|
34
66
|
export type OffsetPagination = {
|
|
35
67
|
total: number;
|
|
@@ -38,10 +70,7 @@ export type OffsetPagination = {
|
|
|
38
70
|
hasMore: boolean;
|
|
39
71
|
};
|
|
40
72
|
/** `GET /businesses/:id/environments` response. */
|
|
41
|
-
export type EnvironmentListResult =
|
|
42
|
-
data: EnvironmentSummary[];
|
|
43
|
-
pagination: OffsetPagination;
|
|
44
|
-
};
|
|
73
|
+
export type EnvironmentListResult = Schemas["BusinessEnvironmentList"];
|
|
45
74
|
/** WS-C semver bump kinds. */
|
|
46
75
|
export type SemverBump = "major" | "minor" | "patch";
|
|
47
76
|
/** Release overrides a publish MAY carry (all optional). */
|
|
@@ -51,159 +80,124 @@ export type PublishBusinessBody = {
|
|
|
51
80
|
acceptBreaking?: boolean;
|
|
52
81
|
};
|
|
53
82
|
/** The `_release` block the publish route returns. */
|
|
54
|
-
export type PublishRelease =
|
|
55
|
-
compilationRecordId: string | null;
|
|
56
|
-
previousVersion: string | null;
|
|
57
|
-
computedBump: SemverBump;
|
|
58
|
-
version: string;
|
|
59
|
-
tagCreated: boolean;
|
|
60
|
-
changeSummary: string;
|
|
61
|
-
reasons: string[];
|
|
62
|
-
status: "PENDING" | "PREVIEW";
|
|
63
|
-
};
|
|
83
|
+
export type PublishRelease = Schemas["PublishRelease"];
|
|
64
84
|
/** `GET /management/businesses/subdomain-availability` response. */
|
|
65
|
-
export type ManagedSubdomainAvailability =
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
/**
|
|
79
|
-
export type
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
/**
|
|
85
|
-
export type
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
export type
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
export type
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
export type
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
export type
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
export type
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
export type
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
export type
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
changeSetId: string | null;
|
|
182
|
-
createdAt: string;
|
|
183
|
-
updatedAt: string;
|
|
184
|
-
[key: string]: unknown;
|
|
185
|
-
};
|
|
186
|
-
export type PromoCodeKind = "percent_off" | "amount_off" | "free_months";
|
|
187
|
-
export type PromoCodeStatus = "ACTIVE" | "ARCHIVED";
|
|
188
|
-
export type PromoCode = {
|
|
189
|
-
id: string;
|
|
190
|
-
businessId: string | null;
|
|
191
|
-
code: string;
|
|
192
|
-
kind: PromoCodeKind;
|
|
193
|
-
amount: number | null;
|
|
194
|
-
durationMonths: number;
|
|
195
|
-
applicablePlanIds: string[];
|
|
196
|
-
maxRedemptions: number | null;
|
|
197
|
-
redemptionCount: number;
|
|
198
|
-
activeFrom?: string | null;
|
|
199
|
-
activeUntil?: string | null;
|
|
200
|
-
status: PromoCodeStatus;
|
|
201
|
-
stripeCouponId?: string | null;
|
|
202
|
-
stripePromotionCodeId?: string | null;
|
|
203
|
-
createdAt?: string;
|
|
204
|
-
updatedAt?: string;
|
|
205
|
-
[key: string]: unknown;
|
|
206
|
-
};
|
|
85
|
+
export type ManagedSubdomainAvailability = Schemas["ManagedSubdomainAvailability"];
|
|
86
|
+
/** `businesses.routes.read`: the routes the current contract serves. */
|
|
87
|
+
export type BusinessRouteList = Schemas["BusinessRouteList"];
|
|
88
|
+
/**
|
|
89
|
+
* `businesses.contract.read`: plans with their limits and meters, and the
|
|
90
|
+
* metered / unmetered route partitions.
|
|
91
|
+
*/
|
|
92
|
+
export type BusinessContract = Schemas["BusinessContract"];
|
|
93
|
+
/**
|
|
94
|
+
* The accepted business contract (the authored `BusinessSpec`). An upstream
|
|
95
|
+
* credential's token is never returned.
|
|
96
|
+
*/
|
|
97
|
+
export type AcceptedBusinessContract = Schemas["AcceptedBusinessContract"];
|
|
98
|
+
/** `businesses.config.read`: the accepted contract for one scope. */
|
|
99
|
+
export type BusinessConfig = Schemas["BusinessConfig"];
|
|
100
|
+
/** `businesses.configAttempts.read`: rejected configuration attempts. */
|
|
101
|
+
export type BusinessConfigAttemptList = Schemas["BusinessConfigAttemptList"];
|
|
102
|
+
/** One deployment run from `businesses.status`. */
|
|
103
|
+
export type DeploymentRunSummary = Schemas["DeploymentRun"];
|
|
104
|
+
/** One recent apply from `businesses.status`. */
|
|
105
|
+
export type DeploymentApply = Schemas["DeploymentApply"];
|
|
106
|
+
/**
|
|
107
|
+
* `businesses.status`: recent runs and applies, the business's lifecycle and
|
|
108
|
+
* release, whether the scope is live, and whether the gateway serves it.
|
|
109
|
+
*/
|
|
110
|
+
export type BusinessStatusResult = Schemas["BusinessStatus"];
|
|
111
|
+
/** A diagnostic from a validate: what was wrong, and where. */
|
|
112
|
+
export type BusinessDiagnostic = Schemas["BusinessDiagnostic"];
|
|
113
|
+
/** `businesses.compile`: the dry-run validate verdict. Nothing is applied. */
|
|
114
|
+
export type BusinessValidateResult = Schemas["BusinessValidateResponse"];
|
|
115
|
+
/** `businesses.rbac.subjects.read`: builder-defined permission subjects. */
|
|
116
|
+
export type CustomPermissionSubjectList = Schemas["CustomPermissionSubjectListResponse"];
|
|
117
|
+
/** `businesses.rbac.enable` / `disable`: the resulting flag. */
|
|
118
|
+
export type BusinessRbacUpdateResult = Schemas["BusinessRbacUpdateResponse"];
|
|
119
|
+
/** `businesses.brand.uploadAsset`: the uploaded icon's or logo's URL. */
|
|
120
|
+
export type BrandAssetUploadResult = Schemas["BusinessIconUploadResponse"] | Schemas["BusinessLogoUploadResponse"];
|
|
121
|
+
/** A webhook endpoint as list and update return it: never the signing secret. */
|
|
122
|
+
export type WebhookEndpoint = Schemas["WebhookEndpoint"];
|
|
123
|
+
/** `GET /management/businesses/:id/webhooks`: one page of endpoints. */
|
|
124
|
+
export type WebhookEndpointList = Schemas["WebhookEndpointList"];
|
|
125
|
+
/**
|
|
126
|
+
* `POST /management/businesses/:id/webhooks`: the endpoint plus its signing
|
|
127
|
+
* `secret`, returned exactly once. Store it in the receiver's secret store.
|
|
128
|
+
*/
|
|
129
|
+
export type WebhookEndpointCreateResult = Schemas["WebhookEndpointCreateResponse"];
|
|
130
|
+
/** `PATCH /management/businesses/:id/webhooks/:webhookId`. */
|
|
131
|
+
export type WebhookEndpointUpdateResult = Schemas["WebhookEndpointUpdateResponse"];
|
|
132
|
+
/**
|
|
133
|
+
* `POST /management/businesses/:id/webhooks/:webhookId/rotate-secret`: the
|
|
134
|
+
* endpoint plus its NEW signing `secret`, returned exactly once; the previous
|
|
135
|
+
* secret keeps signing until `previousSecretExpiresAt`.
|
|
136
|
+
*/
|
|
137
|
+
export type WebhookEndpointRotateSecretResult = Schemas["WebhookEndpointRotateSecretResponse"];
|
|
138
|
+
/** `DELETE /management/businesses/:id/webhooks/:webhookId`. */
|
|
139
|
+
export type WebhookEndpointDeleteResult = Schemas["WebhookEndpointDeleteResponse"];
|
|
140
|
+
/** `POST /management/businesses/:id/webhooks/:webhookId/test` (`data.success` is the headline). */
|
|
141
|
+
export type WebhookTestResult = Schemas["WebhookTestResponse"];
|
|
142
|
+
/** One delivery of an event to an endpoint. */
|
|
143
|
+
export type WebhookDelivery = Schemas["WebhookDelivery"];
|
|
144
|
+
/** `GET /management/businesses/:id/webhooks/:webhookId/deliveries`: one page, newest first. */
|
|
145
|
+
export type WebhookDeliveryList = Schemas["WebhookDeliveryList"];
|
|
146
|
+
/**
|
|
147
|
+
* `GET /management/businesses/:id/webhooks/:webhookId/deliveries/:deliveryId`:
|
|
148
|
+
* one delivery's metadata. Not its payload nor the endpoint's response body
|
|
149
|
+
* (both can carry subscriber PII; no permission gates them yet).
|
|
150
|
+
*/
|
|
151
|
+
export type WebhookDeliveryResult = Schemas["WebhookDeliveryResponse"];
|
|
152
|
+
/** `GET /management/businesses/:id/webhook-event-types`: the subscribable events. */
|
|
153
|
+
export type WebhookEventTypeList = Schemas["WebhookEventTypeList"];
|
|
154
|
+
/** An operating agent of a business. Closed: only these fields. */
|
|
155
|
+
export type AgentSummary = Schemas["Agent"];
|
|
156
|
+
/** The closed config surface of an agent. */
|
|
157
|
+
export type AgentConfig = Schemas["AgentConfig"];
|
|
158
|
+
/** `agents.list`: the roster plus the roles that can still be enabled. */
|
|
159
|
+
export type AgentList = Schemas["AgentList"];
|
|
160
|
+
/** One run as an agent's status lists it. Failures carry a fixed message. */
|
|
161
|
+
export type AgentRunSummary = Schemas["AgentRun"];
|
|
162
|
+
/** `agents.status`: the agent, its recent runs, usage totals and catalog. */
|
|
163
|
+
export type AgentStatus = Schemas["AgentStatus"];
|
|
164
|
+
/** `agents.runs.show`: one run's trace, launch ledger and action receipts. */
|
|
165
|
+
export type AgentRunDetail = Schemas["AgentRunDetail"];
|
|
166
|
+
/** A post on a business's agent bulletin. */
|
|
167
|
+
export type BulletinPost = Schemas["BulletinPost"];
|
|
168
|
+
/** `bulletin.list`: one page, newest first; `nextCursor` is null on the last. */
|
|
169
|
+
export type BulletinPostList = Schemas["BulletinPostList"];
|
|
170
|
+
/** An automation rule: trigger, conditions and actions, as data. */
|
|
171
|
+
export type AutomationRule = Schemas["AutomationRule"];
|
|
172
|
+
/** `automationRules.read`: one page, newest first. */
|
|
173
|
+
export type AutomationRuleList = Schemas["AutomationRuleList"];
|
|
174
|
+
/** `business.docs.validate`: the issues a pull request's Docs comment
|
|
175
|
+
* would show for the files sent (errors first, then notes). */
|
|
176
|
+
export type DocsValidateResponse = Schemas["DocsValidateResponse"];
|
|
177
|
+
/** `knowledge.*.read`: one page of the Knowledge Registry index. */
|
|
178
|
+
export type KnowledgeIndex = Schemas["KnowledgeIndex"];
|
|
179
|
+
/** `platform.resourceCounts.report`: the recorded count. */
|
|
180
|
+
export type ResourceCountReport = Schemas["ResourceCountReport"];
|
|
181
|
+
/** `platform.denials.read`: why a gateway request was denied. */
|
|
182
|
+
export type DenialExplanation = Schemas["DenialExplanation"];
|
|
183
|
+
/** `platform.dependents.read`: subscribers active on a route. */
|
|
184
|
+
export type BusinessDependents = Schemas["BusinessDependents"];
|
|
185
|
+
/**
|
|
186
|
+
* `platform.workflowControl.replay`: a period scope preview
|
|
187
|
+
* (`status: "preview_only"`) or an invoice recompute (`status: "computed"`).
|
|
188
|
+
*/
|
|
189
|
+
export type ReplayResult = Schemas["ReplayResult"];
|
|
190
|
+
/** `platform.workflowControl.rollback`: what a config rollback would target. */
|
|
191
|
+
export type ConfigRollbackPreview = Schemas["ConfigRollbackPreview"];
|
|
192
|
+
export type PromoCodeKind = NonNullable<Schemas["PromoCode"]["kind"]>;
|
|
193
|
+
export type PromoCodeStatus = Schemas["PromoCode"]["status"];
|
|
194
|
+
/**
|
|
195
|
+
* A promo code as every promo-code route returns it. Closed: only these
|
|
196
|
+
* fields. `id` is an opaque handle for update, archive and reactivate.
|
|
197
|
+
*/
|
|
198
|
+
export type PromoCode = Schemas["PromoCode"];
|
|
199
|
+
/** `GET /businesses/:id/promo-codes`: every promo code of the business. */
|
|
200
|
+
export type PromoCodeList = Schemas["PromoCodeList"];
|
|
207
201
|
export type CreatePromoCodeInput = {
|
|
208
202
|
code: string;
|
|
209
203
|
kind: PromoCodeKind;
|
|
@@ -217,249 +211,228 @@ export type CreatePromoCodeInput = {
|
|
|
217
211
|
export type UpdatePromoCodeInput = Partial<CreatePromoCodeInput> & {
|
|
218
212
|
status?: PromoCodeStatus;
|
|
219
213
|
};
|
|
220
|
-
/**
|
|
221
|
-
* The lowercase account-tier vocabulary every agent surface speaks. The
|
|
222
|
-
* stored membership enum (`OWNER|ADMIN|VIEWER`) is projected alongside it as
|
|
223
|
-
* `role`; `VIEWER` maps to `member`.
|
|
224
|
-
*/
|
|
214
|
+
/** The lowercase account-tier vocabulary every agent surface speaks. */
|
|
225
215
|
export declare const ACCOUNT_ROLES: readonly ["owner", "admin", "member"];
|
|
226
216
|
export type AccountRole = (typeof ACCOUNT_ROLES)[number];
|
|
227
|
-
/** One member of a
|
|
228
|
-
export type BusinessConsumerMember =
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
export type BusinessConsumer = {
|
|
239
|
-
id: string;
|
|
240
|
-
businessId: string;
|
|
241
|
-
status: string;
|
|
242
|
-
ownerType?: string | null;
|
|
243
|
-
ownerOrganizationId?: string | null;
|
|
244
|
-
ownerName?: string | null;
|
|
245
|
-
planId?: string | null;
|
|
246
|
-
planName?: string | null;
|
|
247
|
-
createdAt?: string;
|
|
248
|
-
rbac?: {
|
|
249
|
-
enabled: boolean;
|
|
250
|
-
roles: unknown[];
|
|
251
|
-
};
|
|
252
|
-
members?: BusinessConsumerMember[];
|
|
253
|
-
[key: string]: unknown;
|
|
254
|
-
};
|
|
255
|
-
/** The per-subscriber Managed-RBAC enablement flag. */
|
|
256
|
-
export type ConsumerRbacSettingsResult = {
|
|
257
|
-
enabled: boolean;
|
|
258
|
-
defaultRoleKey?: string;
|
|
259
|
-
[key: string]: unknown;
|
|
260
|
-
};
|
|
217
|
+
/** One member of a consumer organization, as the consumers list returns it. */
|
|
218
|
+
export type BusinessConsumerMember = Schemas["ConsumerMember"];
|
|
219
|
+
/**
|
|
220
|
+
* A consumer (a subscribing organization) as `GET /businesses/:id/consumers`
|
|
221
|
+
* lists it. Closed: only these fields.
|
|
222
|
+
*/
|
|
223
|
+
export type BusinessConsumer = Schemas["Consumer"];
|
|
224
|
+
/** `GET /businesses/:id/consumers` (newest first, at most 500). */
|
|
225
|
+
export type BusinessConsumerList = Schemas["ConsumerList"];
|
|
226
|
+
/** The per-subscriber Managed-RBAC enablement flag and default role. */
|
|
227
|
+
export type ConsumerRbacSettingsResult = Schemas["ConsumerRbacSettings"];
|
|
261
228
|
/** One subscriber-owned role row (ACCOUNT or CUSTOM). */
|
|
262
|
-
export type ConsumerRbacRole =
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
permissions: string[];
|
|
266
|
-
kind: string;
|
|
267
|
-
createdAt: string;
|
|
268
|
-
[key: string]: unknown;
|
|
269
|
-
};
|
|
229
|
+
export type ConsumerRbacRole = Schemas["ConsumerRbacRole"];
|
|
230
|
+
/** `GET …/consumers/:subscriberId/rbac/roles`. */
|
|
231
|
+
export type ConsumerRbacRoleList = Schemas["ConsumerRbacRoleList"];
|
|
270
232
|
/**
|
|
271
233
|
* One consumer API key as the builder plane sees it: metadata only. No hash,
|
|
272
234
|
* no lookup prefix, no raw key; `displayPrefix` is already redacted.
|
|
273
235
|
*/
|
|
274
|
-
export type ConsumerApiKey =
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
lastUsedAt: string | null;
|
|
282
|
-
expiresAt: string | null;
|
|
283
|
-
revokedAt: string | null;
|
|
284
|
-
[key: string]: unknown;
|
|
285
|
-
};
|
|
286
|
-
export type BlockConsumerResult = {
|
|
287
|
-
blocked: true;
|
|
288
|
-
subscriberId: string;
|
|
289
|
-
apiKeysRevoked: number;
|
|
290
|
-
alreadyBlocked: boolean;
|
|
291
|
-
[key: string]: unknown;
|
|
292
|
-
};
|
|
293
|
-
export type RemoveConsumerResult = {
|
|
294
|
-
removed: true;
|
|
295
|
-
subscriberId: string;
|
|
296
|
-
subscriptionsRemoved: number;
|
|
297
|
-
apiKeysRevoked: number;
|
|
298
|
-
[key: string]: unknown;
|
|
299
|
-
};
|
|
300
|
-
/** The membership after a set-replace business-role assignment. */
|
|
301
|
-
export type ConsumerMemberRolesResult = {
|
|
302
|
-
id: string;
|
|
303
|
-
userExternalId: string;
|
|
304
|
-
role: string;
|
|
305
|
-
businessRoleKeys: string[];
|
|
306
|
-
[key: string]: unknown;
|
|
307
|
-
};
|
|
236
|
+
export type ConsumerApiKey = Schemas["ConsumerApiKey"];
|
|
237
|
+
/** `GET …/consumers/:subscriberId/api-keys`. */
|
|
238
|
+
export type ConsumerApiKeyList = Schemas["ConsumerApiKeyList"];
|
|
239
|
+
/** `POST …/consumers/:subscriberId/block`. */
|
|
240
|
+
export type BlockConsumerResult = Schemas["ConsumerBlockResponse"];
|
|
241
|
+
/** `POST …/consumers/:subscriberId/remove`. */
|
|
242
|
+
export type RemoveConsumerResult = Schemas["ConsumerRemoveResponse"];
|
|
308
243
|
/**
|
|
309
|
-
*
|
|
310
|
-
*
|
|
244
|
+
* `POST …/consumers/:subscriberId/migrate-latest`: moved, or not and why
|
|
245
|
+
* (`reason`).
|
|
311
246
|
*/
|
|
312
|
-
export type
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
/**
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
/**
|
|
344
|
-
export type
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
export type
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
/**
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
kind: "live" | "test";
|
|
394
|
-
lastFour: string;
|
|
395
|
-
lastUsedAt: string | null;
|
|
396
|
-
operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report")[];
|
|
397
|
-
revokedAt: string | null;
|
|
398
|
-
rotatedFromId: string | null;
|
|
399
|
-
status: "active" | "revoked";
|
|
400
|
-
};
|
|
247
|
+
export type ConsumerMigrateLatestResult = Schemas["ConsumerMigrateLatestResponse"];
|
|
248
|
+
/** A member's business-role assignment after a builder override. */
|
|
249
|
+
export type ConsumerMemberRolesResult = Schemas["ConsumerMemberRoles"];
|
|
250
|
+
/**
|
|
251
|
+
* A variable as `GET /businesses/:id/variables` lists it. `value` is set ONLY
|
|
252
|
+
* for an active public (`FS_PUBLIC_*`) variable; a secret's value is never
|
|
253
|
+
* returned by any call. Closed: only these fields.
|
|
254
|
+
*/
|
|
255
|
+
export type BusinessVariableRow = Schemas["BusinessVariable"];
|
|
256
|
+
/** `GET /businesses/:id/variables`. */
|
|
257
|
+
export type BusinessVariableList = Schemas["BusinessVariableList"];
|
|
258
|
+
/**
|
|
259
|
+
* A durable variable create / rotate / revoke / delete and its progress.
|
|
260
|
+
* `lastError.message` is fixed copy per code; `impact` names who the change
|
|
261
|
+
* affects. Never carries a value.
|
|
262
|
+
*/
|
|
263
|
+
export type SecretMutationOperation = Schemas["SecretMutationOperation"];
|
|
264
|
+
/**
|
|
265
|
+
* `error.details` of the 409 a revoke / delete answers while plans with live
|
|
266
|
+
* subscribers still use the secret: re-send with `acknowledgeImpact`.
|
|
267
|
+
*/
|
|
268
|
+
export type SecretReferencedByActiveCohortsDetails = Schemas["SecretReferencedByActiveCohortsDetails"];
|
|
269
|
+
/**
|
|
270
|
+
* `GET /businesses/:id/frontend/status`: what the scope serves, its recent
|
|
271
|
+
* releases (rollback targets) and its recent builds.
|
|
272
|
+
*/
|
|
273
|
+
export type FrontendStatusResult = Schemas["FrontendStatus"];
|
|
274
|
+
/** A recent frontend build, any status. */
|
|
275
|
+
export type FrontendBuildRow = Schemas["FrontendBuild"];
|
|
276
|
+
/** A prior frontend release; `releaseId` is what a rollback takes. */
|
|
277
|
+
export type FrontendReleaseRow = Schemas["FrontendRelease"];
|
|
278
|
+
/** `POST /businesses/:id/frontend/rollback`: the release now serving, pinned. */
|
|
279
|
+
export type FrontendRollbackResult = Schemas["FrontendRollbackResponse"];
|
|
280
|
+
/** What a rollback would re-activate (a dry run's `wouldHave`). */
|
|
281
|
+
export type FrontendRollbackPreview = Schemas["FrontendRollbackPreview"];
|
|
282
|
+
/** One page of builder audit-log entries; payloads arrive redacted. */
|
|
283
|
+
export type AuditLogPage = Schemas["AuditLogList"];
|
|
284
|
+
/** One builder audit-log entry. */
|
|
285
|
+
export type AuditLogEntry = Schemas["AuditLogEntry"];
|
|
286
|
+
/** The caller's email opt-outs for a business (`true` = opted out). */
|
|
287
|
+
export type NotificationPreferences = Schemas["NotificationPreferences"];
|
|
288
|
+
/** An economic agreement (builder surface). Closed: only these fields. */
|
|
289
|
+
export type EconomicAgreement = Schemas["EconomicAgreement"];
|
|
290
|
+
/** `GET /businesses/:id/agreements`: one page of agreements. */
|
|
291
|
+
export type EconomicAgreementList = Schemas["EconomicAgreementList"];
|
|
292
|
+
/**
|
|
293
|
+
* What creating an agreement would do, plus the `confirmationToken` that
|
|
294
|
+
* commits exactly that effect. Nothing is written.
|
|
295
|
+
*/
|
|
296
|
+
export type AgreementCreatePreview = Schemas["AgreementCreatePreview"];
|
|
297
|
+
/** What amending an agreement would do, plus its `confirmationToken`. */
|
|
298
|
+
export type AgreementAmendPreview = Schemas["AgreementAmendPreview"];
|
|
299
|
+
/** Either agreement preview. */
|
|
300
|
+
export type AgreementPreview = AgreementCreatePreview | AgreementAmendPreview;
|
|
301
|
+
/** What one subject's prices are pinned to (read-only). */
|
|
302
|
+
export type SubjectPins = Schemas["SubjectPins"];
|
|
303
|
+
/** A runtime token as list and revoke return it: never the secret. */
|
|
304
|
+
export type RuntimeTokenSummary = Schemas["RuntimeToken"];
|
|
305
|
+
/**
|
|
306
|
+
* A runtime token plus its plaintext `token`, returned by mint and rotate
|
|
307
|
+
* exactly once. Never log or persist it anywhere but the backend's secret store.
|
|
308
|
+
*/
|
|
309
|
+
export type RuntimeTokenIssuance = Schemas["RuntimeTokenIssuance"];
|
|
310
|
+
/** `GET /businesses/:id/runtime-tokens`: one page, plus the scope it describes. */
|
|
311
|
+
export type RuntimeTokenList = Schemas["RuntimeTokenList"];
|
|
312
|
+
/** A backend as every backend route returns it. */
|
|
313
|
+
export type BackendSummary = Schemas["Backend"];
|
|
314
|
+
/**
|
|
315
|
+
* `POST /businesses/:id/backends`: the backend. Create is an upsert keyed by
|
|
316
|
+
* (environment, slug); `updated: true` marks an existing backend updated in place.
|
|
317
|
+
*/
|
|
318
|
+
export type BackendCreateResult = Schemas["BackendCreateResponse"];
|
|
319
|
+
/**
|
|
320
|
+
* What a backend create would do: the `wouldHave` of a
|
|
321
|
+
* `backends.create(…, { dryRun: true })` preview. Nothing is written.
|
|
322
|
+
*/
|
|
323
|
+
export type BackendCreatePreview = Schemas["BackendCreatePreview"];
|
|
324
|
+
/** `GET /businesses/:id/backends`: one page, plus the scope it describes. */
|
|
325
|
+
export type BackendList = Schemas["BackendList"];
|
|
326
|
+
/** `DELETE /businesses/:id/backends/:backendId`. */
|
|
327
|
+
export type BackendDeleteResult = Schemas["BackendDeleteResponse"];
|
|
401
328
|
/** The delegable-permission vocabulary, grouped by subject. */
|
|
402
|
-
export type MakerTokenPermissionCatalog =
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
329
|
+
export type MakerTokenPermissionCatalog = Schemas["MakerTokenPermissionCatalog"];
|
|
330
|
+
/**
|
|
331
|
+
* A maker token as a listing returns it: metadata only. No plaintext, no hash;
|
|
332
|
+
* `lastFour` is the only secret-derived field.
|
|
333
|
+
*/
|
|
334
|
+
export type MakerTokenSummary = Schemas["MakerTokenSummary"];
|
|
335
|
+
/** `GET /maker-tokens/org` (one page). */
|
|
336
|
+
export type MakerTokenList = Schemas["MakerTokenListResponse"];
|
|
337
|
+
/** A minted maker token: the summary plus its plaintext, returned once. */
|
|
338
|
+
export type MakerTokenIssuance = Schemas["MakerTokenIssuanceResponse"];
|
|
339
|
+
/** A rotate: the replacement plaintext, returned once. */
|
|
340
|
+
export type MakerTokenRotation = Schemas["MakerTokenRotationResponse"];
|
|
341
|
+
/**
|
|
342
|
+
* `makerTokens.create`: ACTIVE (minted; `token` is the plaintext, once) or
|
|
343
|
+
* PENDING approval (no credential exists yet).
|
|
344
|
+
*/
|
|
345
|
+
export type OrgMakerTokenCreateResult = Schemas["OrgMakerTokenCreateResponse"];
|
|
346
|
+
/** `makerTokens.update`: ACTIVE (grants live) or PENDING approval. */
|
|
347
|
+
export type OrgMakerTokenUpdateResult = Schemas["OrgMakerTokenUpdateResponse"];
|
|
348
|
+
/** `makerTokens.approvalList`: pending requests, oldest first. */
|
|
349
|
+
export type OrgMakerTokenApprovalList = Schemas["OrgMakerTokenPendingApprovalListResponse"];
|
|
350
|
+
/** `makerTokens.approve`: approving a CREATE returns the plaintext once. */
|
|
351
|
+
export type OrgMakerTokenApprovalResult = Schemas["OrgMakerTokenApprovalResponse"];
|
|
352
|
+
/** `makerTokens.deny`. */
|
|
353
|
+
export type OrgMakerTokenDenyResult = Schemas["OrgMakerTokenDenyResponse"];
|
|
354
|
+
/** `organizations.list`: the organizations the caller can act in. */
|
|
355
|
+
export type OrganizationList = Schemas["OrganizationList"];
|
|
356
|
+
/** `organizations.create`: the new organization; the creator is its owner. */
|
|
357
|
+
export type OrganizationCreateResult = Schemas["OrganizationCreateResponse"];
|
|
358
|
+
/** An organization role and its exact permission grants. */
|
|
359
|
+
export type OrganizationRole = Schemas["OrganizationRole"];
|
|
360
|
+
/** `organizations.role.list`: roles plus what the viewer may grant. */
|
|
361
|
+
export type OrganizationRoleList = Schemas["OrganizationRoleList"];
|
|
362
|
+
/** `organizations.member.list`: one page of members plus viewer capabilities. */
|
|
363
|
+
export type OrganizationMembers = Schemas["OrganizationMembers"];
|
|
364
|
+
/** `organizations.member.update`. */
|
|
365
|
+
export type OrganizationMemberUpdateResult = Schemas["OrganizationMemberUpdateResponse"];
|
|
366
|
+
/** `organizations.ownership.transfer`. */
|
|
367
|
+
export type OrganizationOwnershipTransferResult = Schemas["OrganizationOwnershipTransferResponse"];
|
|
368
|
+
/** `organizations.invitation.create`. The accept token goes by email only. */
|
|
369
|
+
export type OrganizationInvitationCreateResult = Schemas["OrganizationInvitationCreateResponse"];
|
|
370
|
+
/** `organizations.invitation.listSent`: the organization's pending invitations. */
|
|
371
|
+
export type OrganizationSentInvitationList = Schemas["OrganizationSentInvitationList"];
|
|
372
|
+
/** `organizations.invitation.list`: pending invitations addressed to the caller. */
|
|
373
|
+
export type OrganizationReceivedInvitationList = Schemas["OrganizationReceivedInvitationList"];
|
|
374
|
+
/** `organizations.invitation.accept`. */
|
|
375
|
+
export type OrganizationInvitationAcceptResult = Schemas["OrganizationInvitationAcceptResponse"];
|
|
376
|
+
/** `organizations.overview.read`. Null means unknown, never zero. */
|
|
377
|
+
export type OrganizationOverview = Schemas["OrganizationOverview"];
|
|
378
|
+
/** `organizations.bulletin.read`: one page of the consolidated bulletin. */
|
|
379
|
+
export type OrganizationBulletin = Schemas["OrganizationBulletin"];
|
|
409
380
|
/** A CLI login's view of itself (`fscli_` session). */
|
|
410
381
|
export type CliSessionContext = {
|
|
411
382
|
kind: "cli_user";
|
|
412
|
-
|
|
413
|
-
sessionId: string;
|
|
414
|
-
userId: string;
|
|
415
|
-
organizationId: string;
|
|
416
|
-
role: string;
|
|
417
|
-
};
|
|
383
|
+
} & Schemas["ManagementWhoamiCliSession"];
|
|
418
384
|
/** A maker token's view of itself, including its granted permissions. */
|
|
419
385
|
export type MakerTokenContext = {
|
|
420
386
|
kind: "maker";
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
387
|
+
} & Schemas["ManagementWhoamiMakerToken"];
|
|
388
|
+
/** A builder (dashboard) session's view of itself. Closed: no provider ids. */
|
|
389
|
+
export type BuilderBootstrapContext = Schemas["BuilderContext"];
|
|
390
|
+
/** `auth.context.issue`: a short-lived member context token. Never log it. */
|
|
391
|
+
export type ContextTokenIssuance = Schemas["ContextTokenResponse"]["data"];
|
|
392
|
+
/** A subscriber-plane service account. Never key material. */
|
|
393
|
+
export type PortalServiceAccount = Schemas["PortalServiceAccountListResponse"]["data"][number];
|
|
394
|
+
/** `portal.serviceAccounts.list`: one offset page. */
|
|
395
|
+
export type PortalServiceAccountList = Schemas["PortalServiceAccountListResponse"];
|
|
396
|
+
/**
|
|
397
|
+
* `portal.serviceAccounts.create`: ACTIVE (minted; `plaintext` shown once) or
|
|
398
|
+
* PENDING approval (no credential exists yet).
|
|
399
|
+
*/
|
|
400
|
+
export type PortalServiceAccountCreateResult = Schemas["PortalServiceAccountCreateResponse"];
|
|
401
|
+
/** `portal.serviceAccounts.update`: ACTIVE (applied) or PENDING approval. */
|
|
402
|
+
export type PortalServiceAccountUpdateResult = Schemas["PortalServiceAccountUpdateResponse"];
|
|
403
|
+
/** `portal.serviceAccounts.approve`: an approved CREATE returns `plaintext` once. */
|
|
404
|
+
export type PortalServiceAccountApprovalResult = Schemas["PortalServiceAccountApprovalResponse"];
|
|
405
|
+
/** `portal.serviceAccounts.rotate`: the new `plaintext`, shown once. */
|
|
406
|
+
export type PortalServiceAccountRotateResult = Schemas["PortalServiceAccountRotateResponse"];
|
|
407
|
+
/** `portal.serviceAccounts.deny`. */
|
|
408
|
+
export type PortalServiceAccountDenyResult = Schemas["PortalServiceAccountDenyResponse"];
|
|
409
|
+
/** `portal.serviceAccounts.approvals`: pending changes, oldest first. */
|
|
410
|
+
export type PortalServiceAccountApprovalList = Schemas["PortalServiceAccountPendingApprovalListResponse"];
|
|
411
|
+
/** A subscriber usage limit: one subject and one value lane. */
|
|
412
|
+
export type PortalUsageLimit = Schemas["PortalUsageLimitDto"];
|
|
413
|
+
/** `portal.usageLimits.list`: one offset page. */
|
|
414
|
+
export type PortalUsageLimitList = Schemas["PortalUsageLimitListResponse"];
|
|
415
|
+
/** `portal.usageLimits.remove`. */
|
|
416
|
+
export type PortalUsageLimitDeleteResult = Schemas["PortalUsageLimitDeleteResponse"];
|
|
449
417
|
/** Who the credential is (`fs.auth.context.read()`). */
|
|
450
418
|
export type CallerContext = CliSessionContext | MakerTokenContext | ({
|
|
451
419
|
kind: "builder";
|
|
452
420
|
} & BuilderBootstrapContext);
|
|
453
|
-
/** A persona browser handoff
|
|
454
|
-
export type PersonaHandoff =
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
421
|
+
/** A persona browser handoff: a single-use, 60-second `handoffToken`. */
|
|
422
|
+
export type PersonaHandoff = Schemas["TestPersonaLoginResponse"];
|
|
423
|
+
/** A test persona as the persona list returns it: never key material. */
|
|
424
|
+
export type TestPersona = Schemas["TestPersona"];
|
|
425
|
+
/** `GET …/test/personas`. */
|
|
426
|
+
export type TestPersonaList = Schemas["TestPersonaList"];
|
|
427
|
+
/**
|
|
428
|
+
* `POST …/test/bootstrap-key`: a new persona with its plaintext `apiKey` and
|
|
429
|
+
* `sessionToken`, shown exactly once. Never log them.
|
|
430
|
+
*/
|
|
431
|
+
export type TestPersonaBootstrapResult = Schemas["TestPersonaBootstrapResponse"];
|
|
432
|
+
/** `POST …/test/personas/:id/rotate`: the new plaintext `apiKey`, shown once. */
|
|
433
|
+
export type TestPersonaRotateResult = Schemas["TestPersonaRotateResponse"];
|
|
434
|
+
/** `DELETE …/test/personas/:id`: the deletion receipt. */
|
|
435
|
+
export type TestPersonaDeleteResult = Schemas["TestPersonaDeleteResponse"];
|
|
463
436
|
/** A persona handoff plus the CLI-process-only local-preview proxy lease. */
|
|
464
437
|
export type PersonaLocalPreviewLease = {
|
|
465
438
|
data: PersonaHandoff["data"] & {
|
|
@@ -467,3 +440,4 @@ export type PersonaLocalPreviewLease = {
|
|
|
467
440
|
localProxyLeaseExpiresAt: string;
|
|
468
441
|
};
|
|
469
442
|
};
|
|
443
|
+
export {};
|