@farthershore/client 0.7.0 → 0.9.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 +35 -0
- package/README.md +10 -10
- package/dist/index.js +158 -61
- package/dist/types/api.generated.d.ts +61 -25
- package/dist/types/generated/schemas.d.ts +129 -37
- package/dist/types/operations/auth.d.ts +26 -8
- package/dist/types/operations/backends.d.ts +76 -21
- package/dist/types/operations/businesses.d.ts +199 -91
- package/dist/types/operations/consumers.d.ts +2 -2
- package/dist/types/operations/define.d.ts +1 -1
- package/dist/types/operations/index.d.ts +355 -126
- package/dist/types/operations/platform.d.ts +6 -6
- package/dist/types/operations/webhooks.d.ts +64 -2
- package/dist/types/surface-types.d.ts +1 -1
- package/dist/types/surface.d.ts +1 -1
- package/dist/types/types.d.ts +20 -6
- package/dist/types/version.d.ts +2 -2
- package/package.json +1 -1
|
@@ -189,23 +189,23 @@ export interface FartherShoreApi {
|
|
|
189
189
|
};
|
|
190
190
|
readonly backends: {
|
|
191
191
|
/**
|
|
192
|
-
*
|
|
192
|
+
* Set a backend's origin (every environment unless overridden)
|
|
193
193
|
*
|
|
194
|
-
*
|
|
194
|
+
* Set the origin of a backend declared in business/. Without a scope it sets the `all` deployment, which serves every environment; with scope env:<environment> (or non-production / kind:<kind>, or an origin template with {env}) it creates or updates that override. Farther Shore keeps the default backend's webhook receiver at <origin>/_fs/webhooks, and a business without a default key gets one, returned ONCE as defaultKey.
|
|
195
195
|
*
|
|
196
|
-
* Operation `backend.bind` · write · requires `backend:bind` · supports `dryRun` · reconcile an unknown outcome with `backend.read`.
|
|
196
|
+
* Operation `backend.bind` · write · requires `backend:bind` · returns a one-time secret · supports `dryRun` · reconcile an unknown outcome with `backend.read`.
|
|
197
197
|
*/
|
|
198
198
|
readonly bind: Method<"backends.bind">;
|
|
199
199
|
/**
|
|
200
200
|
* Create a backend (default transport: direct)
|
|
201
201
|
*
|
|
202
|
-
* Create a backend
|
|
202
|
+
* Create a backend deployment for a business. Pick a transport mode: direct (public HTTPS URL, secured by request signing) or tunnel (private outbound-only connection). Mark it default to route traffic to it. With an origin, the default backend gets its webhook receiver at <origin>/_fs/webhooks automatically, and a business without a default key gets one, returned ONCE as defaultKey.
|
|
203
203
|
*
|
|
204
|
-
* Operation `backend.create` · write · requires `backend:create` · supports `dryRun` · reconcile an unknown outcome with `backend.read`.
|
|
204
|
+
* Operation `backend.create` · write · requires `backend:create` · returns a one-time secret · supports `dryRun` · reconcile an unknown outcome with `backend.read`.
|
|
205
205
|
*/
|
|
206
206
|
readonly create: Method<"backends.create">;
|
|
207
207
|
/**
|
|
208
|
-
* Delete a backend (revokes its
|
|
208
|
+
* Delete a backend (revokes its secret keys)
|
|
209
209
|
*
|
|
210
210
|
* Delete a backend (origin). Traffic routed to it stops; re-create to restore.
|
|
211
211
|
*
|
|
@@ -215,7 +215,7 @@ export interface FartherShoreApi {
|
|
|
215
215
|
/**
|
|
216
216
|
* List backends for a business (id, scope, name, transport, status)
|
|
217
217
|
*
|
|
218
|
-
* List a business's
|
|
218
|
+
* List a business's backend deployments — id, scope (all | production | non-production | kind:<kind> | env:<environment>), name, slug, transport (direct|tunnel), default flag, and derived status. A backend has one deployment per scope; each environment is served by the most specific one. Read-only.
|
|
219
219
|
*
|
|
220
220
|
* Operation `backend.read` · read · requires `backend:read` · offset pagination.
|
|
221
221
|
*/
|
|
@@ -347,7 +347,9 @@ export interface FartherShoreApi {
|
|
|
347
347
|
/**
|
|
348
348
|
* Create a new business and provision its managed GitHub repo
|
|
349
349
|
*
|
|
350
|
-
*
|
|
350
|
+
* Create a new business and provision its managed GitHub repo. Also issues the business's default key (every environment, every runtime operation) and returns it ONCE as defaultKey — set it as FS_SECRET_KEY in your backend.
|
|
351
|
+
*
|
|
352
|
+
* Operation `business.create` · write · requires `business:create` · returns a one-time secret · reconcile an unknown outcome with `business.list`.
|
|
351
353
|
*/
|
|
352
354
|
readonly create: Method<"businesses.create">;
|
|
353
355
|
readonly docs: {
|
|
@@ -444,6 +446,24 @@ export interface FartherShoreApi {
|
|
|
444
446
|
* Operation `business.read` · read · requires `business:read`.
|
|
445
447
|
*/
|
|
446
448
|
readonly read: Method<"businesses.read">;
|
|
449
|
+
/**
|
|
450
|
+
* Release what is on the default branch of a live business, with the version picked from what changed
|
|
451
|
+
*
|
|
452
|
+
* Cut the next release of a live business from its default branch. Compares that commit with the last release, picks a major, minor or patch version from what changed (removals and tightened access are major, additions and price changes minor, everything else patch), runs the go-live checks and creates the release, which then deploys. Use a dry run first to see the plan, and business status to prove it is live. A draft business goes live with business publish instead.
|
|
453
|
+
*
|
|
454
|
+
* Operation `business.release` · write · requires `business:publish` · supports `dryRun` · reconcile an unknown outcome with `business.status`.
|
|
455
|
+
*/
|
|
456
|
+
readonly release: Method<"businesses.release">;
|
|
457
|
+
readonly releaseTag: {
|
|
458
|
+
/**
|
|
459
|
+
* Choose the prefix of a business's release tags
|
|
460
|
+
*
|
|
461
|
+
* Choose the prefix of a business's release tags. Releases are tagged `<prefix>X.Y.Z`: `v` by default, or for example `release-`, `prod/` or an empty prefix for bare numbers. Changing the prefix continues the version numbers and never renames existing tags.
|
|
462
|
+
*
|
|
463
|
+
* Operation `business.release_tag.set` · write · requires `business:publish` · reconcile an unknown outcome with `business.read`.
|
|
464
|
+
*/
|
|
465
|
+
readonly set: Method<"businesses.releaseTag.set">;
|
|
466
|
+
};
|
|
447
467
|
readonly routes: {
|
|
448
468
|
/**
|
|
449
469
|
* List a business's compiled routes
|
|
@@ -1173,39 +1193,39 @@ export interface FartherShoreApi {
|
|
|
1173
1193
|
*/
|
|
1174
1194
|
readonly update: Method<"promoCodes.update">;
|
|
1175
1195
|
};
|
|
1176
|
-
readonly
|
|
1196
|
+
readonly secretKeys: {
|
|
1177
1197
|
/**
|
|
1178
|
-
* Create a
|
|
1198
|
+
* Create a secret key (returns it once)
|
|
1179
1199
|
*
|
|
1180
|
-
* Mint
|
|
1200
|
+
* Mint an additional secret key (fsrt_), e.g. a dedicated key for one environment (scope env:<environment>) that can act for no other. The business's default key already covers every environment. Returns the plaintext ONCE. Operations default to gateway_verification, metering, health and webhook_secrets.
|
|
1181
1201
|
*
|
|
1182
|
-
* Operation `
|
|
1202
|
+
* Operation `secret_key.mint` · write · requires `secret_key:mint` · returns a one-time secret · reconcile an unknown outcome with `secret_key.read`.
|
|
1183
1203
|
*/
|
|
1184
|
-
readonly mint: Method<"
|
|
1204
|
+
readonly mint: Method<"secretKeys.mint">;
|
|
1185
1205
|
/**
|
|
1186
|
-
* List
|
|
1206
|
+
* List secret keys for a business
|
|
1187
1207
|
*
|
|
1188
|
-
* List a business's
|
|
1208
|
+
* List a business's secret keys (fsrt_) — id, last-four, operations, status, and env scope. Read-only; secrets are never shown.
|
|
1189
1209
|
*
|
|
1190
|
-
* Operation `
|
|
1210
|
+
* Operation `secret_key.read` · read · requires `secret_key:read` · offset pagination.
|
|
1191
1211
|
*/
|
|
1192
|
-
readonly read: Method<"
|
|
1212
|
+
readonly read: Method<"secretKeys.read">;
|
|
1193
1213
|
/**
|
|
1194
|
-
* Revoke a
|
|
1214
|
+
* Revoke a secret key
|
|
1195
1215
|
*
|
|
1196
|
-
* Revoke a
|
|
1216
|
+
* Revoke a secret key. The backend using it stops verifying.
|
|
1197
1217
|
*
|
|
1198
|
-
* Operation `
|
|
1218
|
+
* Operation `secret_key.revoke` · write · requires `secret_key:revoke` · destructive · reconcile an unknown outcome with `secret_key.read`.
|
|
1199
1219
|
*/
|
|
1200
|
-
readonly revoke: Method<"
|
|
1220
|
+
readonly revoke: Method<"secretKeys.revoke">;
|
|
1201
1221
|
/**
|
|
1202
|
-
* Rotate a
|
|
1222
|
+
* Rotate a secret key (returns a fresh FS_SECRET_KEY once)
|
|
1203
1223
|
*
|
|
1204
|
-
* Rotate a
|
|
1224
|
+
* Rotate a secret key: mint a fresh secret carrying the same scope and revoke the old one. Returns the new plaintext token ONCE.
|
|
1205
1225
|
*
|
|
1206
|
-
* Operation `
|
|
1226
|
+
* Operation `secret_key.rotate` · write · requires `secret_key:rotate` · destructive · returns a one-time secret · reconcile an unknown outcome with `secret_key.read`.
|
|
1207
1227
|
*/
|
|
1208
|
-
readonly rotate: Method<"
|
|
1228
|
+
readonly rotate: Method<"secretKeys.rotate">;
|
|
1209
1229
|
};
|
|
1210
1230
|
readonly usage: {
|
|
1211
1231
|
/**
|
|
@@ -1317,6 +1337,14 @@ export interface FartherShoreApi {
|
|
|
1317
1337
|
* Operation `webhook.delivery.read` · read · requires `webhook:delivery_read` · offset pagination.
|
|
1318
1338
|
*/
|
|
1319
1339
|
readonly read: Method<"webhooks.delivery.read">;
|
|
1340
|
+
/**
|
|
1341
|
+
* Send one webhook delivery again
|
|
1342
|
+
*
|
|
1343
|
+
* Queue one delivery to be sent again right away, with the same webhook-id and payload. Works for a delivered, failed or dead delivery; one still being sent is refused. It gets a fresh 72-hour retry window.
|
|
1344
|
+
*
|
|
1345
|
+
* Operation `webhook.delivery.redeliver` · write · requires `webhook:update` · reconcile an unknown outcome with `webhook.delivery.read`.
|
|
1346
|
+
*/
|
|
1347
|
+
readonly redeliver: Method<"webhooks.delivery.redeliver">;
|
|
1320
1348
|
};
|
|
1321
1349
|
readonly eventType: {
|
|
1322
1350
|
/**
|
|
@@ -1336,6 +1364,14 @@ export interface FartherShoreApi {
|
|
|
1336
1364
|
* Operation `webhook.read` · read · requires `webhook:read` · offset pagination.
|
|
1337
1365
|
*/
|
|
1338
1366
|
readonly read: Method<"webhooks.read">;
|
|
1367
|
+
/**
|
|
1368
|
+
* Send every failed or dead delivery of a webhook endpoint in a time range again
|
|
1369
|
+
*
|
|
1370
|
+
* Queue every failed or dead delivery of one webhook endpoint created in [since, until) to be sent again right away, each with its own webhook-id and a fresh 72-hour retry window. Returns how many were queued.
|
|
1371
|
+
*
|
|
1372
|
+
* Operation `webhook.redeliver` · write · requires `webhook:update` · reconcile an unknown outcome with `webhook.delivery.read`.
|
|
1373
|
+
*/
|
|
1374
|
+
readonly redeliver: Method<"webhooks.redeliver">;
|
|
1339
1375
|
/**
|
|
1340
1376
|
* Issue a new signing secret (returned once); readable old secrets verify for 24h
|
|
1341
1377
|
*
|