@faable/deploy-sdk 2.17.1 → 2.18.1
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/dist/FaableDeployApi.d.ts +89 -0
- package/dist/FaableDeployApi.d.ts.map +1 -1
- package/dist/FaableDeployApi.js +10 -0
- package/dist/api/api-types.d.ts +19 -0
- package/dist/api/api-types.d.ts.map +1 -1
- package/dist/api/generated-client.d.ts +856 -3
- package/dist/api/generated-client.d.ts.map +1 -1
- package/dist/api/generated-client.js +510 -3
- package/dist/api/types.d.ts +4897 -819
- package/dist/api/types.d.ts.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -0
- package/dist/informers/Indexer.d.ts +28 -0
- package/dist/informers/Indexer.d.ts.map +1 -0
- package/dist/informers/Indexer.js +89 -0
- package/dist/informers/InformerFactory.d.ts +113 -0
- package/dist/informers/InformerFactory.d.ts.map +1 -0
- package/dist/informers/InformerFactory.js +343 -0
- package/dist/informers/WatchClient.d.ts +38 -0
- package/dist/informers/WatchClient.d.ts.map +1 -0
- package/dist/informers/WatchClient.js +9 -0
- package/dist/informers/deployApiWatchClient.d.ts +4 -0
- package/dist/informers/deployApiWatchClient.d.ts.map +1 -0
- package/dist/informers/deployApiWatchClient.js +36 -0
- package/dist/informers/index.d.ts +6 -0
- package/dist/informers/index.d.ts.map +1 -0
- package/dist/informers/index.js +5 -0
- package/dist/informers/ndjson.d.ts +2 -0
- package/dist/informers/ndjson.d.ts.map +1 -0
- package/dist/informers/ndjson.js +19 -0
- package/dist/informers/rv.d.ts +15 -0
- package/dist/informers/rv.d.ts.map +1 -0
- package/dist/informers/rv.js +33 -0
- package/package.json +1 -1
- package/spec/openapi.json +16505 -7626
|
@@ -21,6 +21,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
21
21
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
22
22
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
23
23
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
24
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
24
25
|
*/
|
|
25
26
|
appCheckname(params) {
|
|
26
27
|
return this.fetcher.request({ method: "GET", url: `/app/checkname`, params });
|
|
@@ -40,6 +41,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
40
41
|
* @throws {FaableApiError} `app_rate_limited` (429) — A new account may only create a few apps in its first 24 hours.
|
|
41
42
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
42
43
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
44
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
43
45
|
*/
|
|
44
46
|
appCreate(data) {
|
|
45
47
|
return this.fetcher.post(`/app`, data);
|
|
@@ -60,6 +62,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
60
62
|
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
61
63
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
62
64
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
65
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
63
66
|
*/
|
|
64
67
|
appDelete(id) {
|
|
65
68
|
requireId("id", id);
|
|
@@ -70,7 +73,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
70
73
|
*
|
|
71
74
|
* Deploy the latest commit now
|
|
72
75
|
*
|
|
73
|
-
* Build and deploy the current head of the deploy branch, without waiting for a push. Same path as a push webhook, including the same-commit dedupe.
|
|
76
|
+
* Build and deploy the current head of the deploy branch, without waiting for a push. Same path as a push webhook, including the same-commit dedupe — unless `force=true`, which rebuilds a commit that is already deployed.
|
|
74
77
|
*
|
|
75
78
|
* @throws {FaableApiError} `branch_missing` (400) — The deploy branch does not exist on the repository. `message` lists the branches that do.
|
|
76
79
|
* @throws {FaableApiError} `deploy_mode_conflict` (400) — The app deploys from its own workflow, so the platform will not create a deployment for it.
|
|
@@ -88,10 +91,11 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
88
91
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
89
92
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
90
93
|
* @throws {FaableApiError} `github_error` (502) — GitHub failed upstream. `message` carries what it said.
|
|
94
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
91
95
|
*/
|
|
92
|
-
appDeployNow(id) {
|
|
96
|
+
appDeployNow(id, params) {
|
|
93
97
|
requireId("id", id);
|
|
94
|
-
return this.fetcher.
|
|
98
|
+
return this.fetcher.request({ method: "POST", url: `/app/${id}/deploy`, data: {}, params });
|
|
95
99
|
}
|
|
96
100
|
/**
|
|
97
101
|
* `GET /app/{id}` — operationId: `app/get`
|
|
@@ -109,6 +113,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
109
113
|
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
110
114
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
111
115
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
116
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
112
117
|
*/
|
|
113
118
|
appGet(id, params) {
|
|
114
119
|
requireId("id", id);
|
|
@@ -128,6 +133,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
128
133
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
129
134
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
130
135
|
* @throws {FaableApiError} `bad_gateway` (502) — An upstream the API depends on failed.
|
|
136
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
131
137
|
*/
|
|
132
138
|
appGetRegistry(app_id) {
|
|
133
139
|
requireId("app_id", app_id);
|
|
@@ -158,6 +164,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
158
164
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
159
165
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
160
166
|
* @throws {FaableApiError} `github_error` (502) — GitHub failed upstream. `message` carries what it said.
|
|
167
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
161
168
|
*/
|
|
162
169
|
appLinkRepository(id, data) {
|
|
163
170
|
requireId("id", id);
|
|
@@ -179,6 +186,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
179
186
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
180
187
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
181
188
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
189
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
182
190
|
*/
|
|
183
191
|
appList(params) {
|
|
184
192
|
return this.paginator({ url: `/app`, params });
|
|
@@ -195,6 +203,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
195
203
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
196
204
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
197
205
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
206
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
198
207
|
*/
|
|
199
208
|
appLogs(app_id, params) {
|
|
200
209
|
requireId("app_id", app_id);
|
|
@@ -217,6 +226,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
217
226
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
218
227
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
219
228
|
* @throws {FaableApiError} `github_error` (502) — GitHub failed upstream. `message` carries what it said.
|
|
229
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
220
230
|
*/
|
|
221
231
|
appRepoBranches(id) {
|
|
222
232
|
requireId("id", id);
|
|
@@ -239,6 +249,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
239
249
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
240
250
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
241
251
|
* @throws {FaableApiError} `github_error` (502) — GitHub failed upstream. `message` carries what it said.
|
|
252
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
242
253
|
*/
|
|
243
254
|
appRepoConfig(id) {
|
|
244
255
|
requireId("id", id);
|
|
@@ -258,6 +269,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
258
269
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
259
270
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
260
271
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
272
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
261
273
|
*/
|
|
262
274
|
appRepoDirectories(id) {
|
|
263
275
|
requireId("id", id);
|
|
@@ -281,6 +293,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
281
293
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
282
294
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
283
295
|
* @throws {FaableApiError} `github_error` (502) — GitHub failed upstream. `message` carries what it said.
|
|
296
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
284
297
|
*/
|
|
285
298
|
appRepoLinkable(params) {
|
|
286
299
|
return this.fetcher.request({ method: "GET", url: `/app/repo-linkable`, params });
|
|
@@ -299,11 +312,32 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
299
312
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
300
313
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
301
314
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
315
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
302
316
|
*/
|
|
303
317
|
appRepoWorkflows(id) {
|
|
304
318
|
requireId("id", id);
|
|
305
319
|
return this.fetcher.get(`/app/${id}/repo/workflows`);
|
|
306
320
|
}
|
|
321
|
+
/**
|
|
322
|
+
* `GET /app/{id}/runtime-version` — operationId: `app/runtime_version`
|
|
323
|
+
*
|
|
324
|
+
* Runtime version and upgrade options
|
|
325
|
+
*
|
|
326
|
+
* The app's sticky runtime version (pin), and the versions it could move to — the data behind the upgrade button.
|
|
327
|
+
*
|
|
328
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
329
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
330
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
331
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
332
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
333
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
334
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
335
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
336
|
+
*/
|
|
337
|
+
appRuntimeVersion(id) {
|
|
338
|
+
requireId("id", id);
|
|
339
|
+
return this.fetcher.get(`/app/${id}/runtime-version`);
|
|
340
|
+
}
|
|
307
341
|
/**
|
|
308
342
|
* `POST /app/{id}/deploy-branch` — operationId: `app/set_deploy_branch`
|
|
309
343
|
*
|
|
@@ -321,6 +355,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
321
355
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
322
356
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
323
357
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
358
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
324
359
|
*/
|
|
325
360
|
appSetDeployBranch(id, data) {
|
|
326
361
|
requireId("id", id);
|
|
@@ -343,6 +378,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
343
378
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
344
379
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
345
380
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
381
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
346
382
|
*/
|
|
347
383
|
appSetDeployMode(id, data) {
|
|
348
384
|
requireId("id", id);
|
|
@@ -364,11 +400,36 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
364
400
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
365
401
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
366
402
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
403
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
367
404
|
*/
|
|
368
405
|
appSetRootDir(id, data) {
|
|
369
406
|
requireId("id", id);
|
|
370
407
|
return this.fetcher.post(`/app/${id}/root-dir`, data);
|
|
371
408
|
}
|
|
409
|
+
/**
|
|
410
|
+
* `POST /app/{id}/runtime-version` — operationId: `app/set_runtime_version`
|
|
411
|
+
*
|
|
412
|
+
* Change the runtime version
|
|
413
|
+
*
|
|
414
|
+
* Move the app to another supported runtime version. Writes the sticky pin and rebuilds the promoted deployment from its stored source — the version changes with a build, never in place. The previous deployment keeps serving until the rebuild is READY, and remains available to roll back to.
|
|
415
|
+
*
|
|
416
|
+
* @throws {FaableApiError} `unsupported_runtime_version` (400) — The requested version has no runtime image in the platform catalogue. `message` lists the supported versions.
|
|
417
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
418
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
419
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
420
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
421
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
422
|
+
* @throws {FaableApiError} `runtime_pin_unavailable` (409) — The app has no shared runtime to version: docker and static apps bring their own, and an app that never built has nothing to move.
|
|
423
|
+
* @throws {FaableApiError} `runtime_repo_pinned` (409) — The repository forces the runtime version (runtime.txt, engines.node…), which outranks this setting. `message` names the file; remove that pin and push to manage the version from the platform.
|
|
424
|
+
* @throws {FaableApiError} `rebuild_in_flight` (409) — A rebuild of this deployment is already queued or building. `details.deployment_id` is that rebuild.
|
|
425
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
426
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
427
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
428
|
+
*/
|
|
429
|
+
appSetRuntimeVersion(id, data) {
|
|
430
|
+
requireId("id", id);
|
|
431
|
+
return this.fetcher.post(`/app/${id}/runtime-version`, data);
|
|
432
|
+
}
|
|
372
433
|
/**
|
|
373
434
|
* `GET /app/slug/{slug}` — operationId: `app/slug`
|
|
374
435
|
*
|
|
@@ -382,6 +443,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
382
443
|
* @throws {FaableApiError} `app_not_found` (404) — No app with that id or slug in this project.
|
|
383
444
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
384
445
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
446
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
385
447
|
*/
|
|
386
448
|
appSlug(slug) {
|
|
387
449
|
requireId("slug", slug);
|
|
@@ -400,6 +462,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
400
462
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
401
463
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
402
464
|
* @throws {FaableApiError} `metrics_unavailable` (503) — Traffic metrics are temporarily unavailable — this is not an app with no traffic.
|
|
465
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
403
466
|
*/
|
|
404
467
|
appTraffic(app_id, params) {
|
|
405
468
|
requireId("app_id", app_id);
|
|
@@ -420,6 +483,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
420
483
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
421
484
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
422
485
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
486
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
423
487
|
*/
|
|
424
488
|
appUnlinkRepository(id) {
|
|
425
489
|
requireId("id", id);
|
|
@@ -441,6 +505,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
441
505
|
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
442
506
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
443
507
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
508
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
444
509
|
*/
|
|
445
510
|
appUpdate(id, data) {
|
|
446
511
|
requireId("id", id);
|
|
@@ -460,6 +525,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
460
525
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
461
526
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
462
527
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
528
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
463
529
|
*/
|
|
464
530
|
appWaf(app_id) {
|
|
465
531
|
requireId("app_id", app_id);
|
|
@@ -481,6 +547,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
481
547
|
* @throws {FaableApiError} `conflict` (409) — The request conflicts with the current state of the resource.
|
|
482
548
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
483
549
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
550
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
484
551
|
*/
|
|
485
552
|
appWafAddRule(app_id, data) {
|
|
486
553
|
requireId("app_id", app_id);
|
|
@@ -503,11 +570,35 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
503
570
|
* @throws {FaableApiError} `conflict` (409) — The request conflicts with the current state of the resource.
|
|
504
571
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
505
572
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
573
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
506
574
|
*/
|
|
507
575
|
appWafRemoveRule(app_id, data) {
|
|
508
576
|
requireId("app_id", app_id);
|
|
509
577
|
return this.fetcher.request({ method: "DELETE", url: `/app/${app_id}/waf/rules`, data });
|
|
510
578
|
}
|
|
579
|
+
/**
|
|
580
|
+
* `POST /auth-accounts/{account_id}/token` — operationId: `authAccount/issueToken`
|
|
581
|
+
*
|
|
582
|
+
* Get a management token for one of your Auth accounts
|
|
583
|
+
*
|
|
584
|
+
* Short-lived Management API token for the Faable Auth account, issued when the caller is a member of the project that owns it. 204 when that account has no per-tenant token (the platform account): keep using your own token.
|
|
585
|
+
*
|
|
586
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
587
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
588
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
589
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
590
|
+
* @throws {FaableApiError} `project_access_denied` (403) — The caller is not a member of the project named in `x-faable-project`, or the credential belongs to another project.
|
|
591
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
592
|
+
* @throws {FaableApiError} `auth_account_not_found` (404) — There is no Faable Auth account with that id.
|
|
593
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
594
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
595
|
+
* @throws {FaableApiError} `tenant_token_unavailable` (503) — Faable Auth could not issue a management token for the account right now. Retry later.
|
|
596
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
597
|
+
*/
|
|
598
|
+
authAccountIssueToken(account_id) {
|
|
599
|
+
requireId("account_id", account_id);
|
|
600
|
+
return this.fetcher.post(`/auth-accounts/${account_id}/token`, {});
|
|
601
|
+
}
|
|
511
602
|
/**
|
|
512
603
|
* `GET /deploy-quota` — operationId: `deploy_quota/get`
|
|
513
604
|
*
|
|
@@ -525,6 +616,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
525
616
|
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
526
617
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
527
618
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
619
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
528
620
|
*/
|
|
529
621
|
deployQuotaGet() {
|
|
530
622
|
return this.fetcher.get(`/deploy-quota`);
|
|
@@ -542,6 +634,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
542
634
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
543
635
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
544
636
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
637
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
545
638
|
*/
|
|
546
639
|
deployQuotaRelease() {
|
|
547
640
|
return this.fetcher.post(`/deploy-quota/release`, {});
|
|
@@ -560,6 +653,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
560
653
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
561
654
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
562
655
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
656
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
563
657
|
*/
|
|
564
658
|
deploymentCancel(deployment_id) {
|
|
565
659
|
requireId("deployment_id", deployment_id);
|
|
@@ -583,6 +677,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
583
677
|
* @throws {FaableApiError} `deploy_refused` (409) — The deploy was refused by quota, plan or an in-flight deployment. `message` says which.
|
|
584
678
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
585
679
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
680
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
586
681
|
*/
|
|
587
682
|
deploymentCreate(data) {
|
|
588
683
|
return this.fetcher.post(`/deployment`, data);
|
|
@@ -602,6 +697,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
602
697
|
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
603
698
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
604
699
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
700
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
605
701
|
*/
|
|
606
702
|
deploymentDelete(id) {
|
|
607
703
|
requireId("id", id);
|
|
@@ -623,6 +719,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
623
719
|
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
624
720
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
625
721
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
722
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
626
723
|
*/
|
|
627
724
|
deploymentGet(id) {
|
|
628
725
|
requireId("id", id);
|
|
@@ -643,11 +740,33 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
643
740
|
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
644
741
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
645
742
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
743
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
646
744
|
*/
|
|
647
745
|
deploymentGetLogs(deployment_id) {
|
|
648
746
|
requireId("deployment_id", deployment_id);
|
|
649
747
|
return this.fetcher.get(`/deployment/${deployment_id}/logs`);
|
|
650
748
|
}
|
|
749
|
+
/**
|
|
750
|
+
* `GET /deployment/{deployment_id}/timeline` — operationId: `deployment/get_timeline`
|
|
751
|
+
*
|
|
752
|
+
* Get a deployment timeline
|
|
753
|
+
*
|
|
754
|
+
* Where the deployment spent its time, phase by phase: queue, detection, each build step, hand-off and start-up.
|
|
755
|
+
*
|
|
756
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
757
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
758
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
759
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
760
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
761
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
762
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
763
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
764
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
765
|
+
*/
|
|
766
|
+
deploymentGetTimeline(deployment_id) {
|
|
767
|
+
requireId("deployment_id", deployment_id);
|
|
768
|
+
return this.fetcher.get(`/deployment/${deployment_id}/timeline`);
|
|
769
|
+
}
|
|
651
770
|
/**
|
|
652
771
|
* `GET /deployment` — operationId: `deployment/list`
|
|
653
772
|
*
|
|
@@ -664,6 +783,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
664
783
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
665
784
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
666
785
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
786
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
667
787
|
*/
|
|
668
788
|
deploymentList(params) {
|
|
669
789
|
return this.paginator({ url: `/deployment`, params });
|
|
@@ -684,6 +804,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
684
804
|
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
685
805
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
686
806
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
807
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
687
808
|
*/
|
|
688
809
|
deploymentUpdate(id, data) {
|
|
689
810
|
requireId("id", id);
|
|
@@ -706,6 +827,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
706
827
|
* @throws {FaableApiError} `domain_taken` (409) — That hostname is already registered on Faable.
|
|
707
828
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
708
829
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
830
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
709
831
|
*/
|
|
710
832
|
domainCreate(data) {
|
|
711
833
|
return this.fetcher.post(`/domain`, data);
|
|
@@ -725,6 +847,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
725
847
|
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
726
848
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
727
849
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
850
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
728
851
|
*/
|
|
729
852
|
domainDelete(id) {
|
|
730
853
|
requireId("id", id);
|
|
@@ -742,6 +865,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
742
865
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
743
866
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
744
867
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
868
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
745
869
|
*/
|
|
746
870
|
domainFqdn(fqdn) {
|
|
747
871
|
requireId("fqdn", fqdn);
|
|
@@ -763,6 +887,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
763
887
|
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
764
888
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
765
889
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
890
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
766
891
|
*/
|
|
767
892
|
domainGet(id) {
|
|
768
893
|
requireId("id", id);
|
|
@@ -784,10 +909,32 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
784
909
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
785
910
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
786
911
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
912
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
787
913
|
*/
|
|
788
914
|
domainList(params) {
|
|
789
915
|
return this.paginator({ url: `/domain`, params });
|
|
790
916
|
}
|
|
917
|
+
/**
|
|
918
|
+
* `POST /domain/{domain_id}/recheck` — operationId: `domain/recheck`
|
|
919
|
+
*
|
|
920
|
+
* Re-check a domain
|
|
921
|
+
*
|
|
922
|
+
* Check this domain’s DNS now. A dormant domain wakes up: it is checked and served again, and gets two more days to point at Faable.
|
|
923
|
+
*
|
|
924
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
925
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
926
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
927
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
928
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
929
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
930
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
931
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
932
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
933
|
+
*/
|
|
934
|
+
domainRecheck(domain_id) {
|
|
935
|
+
requireId("domain_id", domain_id);
|
|
936
|
+
return this.fetcher.post(`/domain/${domain_id}/recheck`, {});
|
|
937
|
+
}
|
|
791
938
|
/**
|
|
792
939
|
* `POST /domain/{id}` — operationId: `domain/update`
|
|
793
940
|
*
|
|
@@ -804,11 +951,126 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
804
951
|
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
805
952
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
806
953
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
954
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
807
955
|
*/
|
|
808
956
|
domainUpdate(id, data) {
|
|
809
957
|
requireId("id", id);
|
|
810
958
|
return this.fetcher.post(`/domain/${id}`, data);
|
|
811
959
|
}
|
|
960
|
+
/**
|
|
961
|
+
* `GET /egress-allowance` — operationId: `egress_allowance/get`
|
|
962
|
+
*
|
|
963
|
+
* Get the project's egress allowance status
|
|
964
|
+
*
|
|
965
|
+
* Egress used by the current project today and this month (UTC), against the allowance of its plan, and the highest warning threshold reached. Only the Free plan has a limited allowance.
|
|
966
|
+
*
|
|
967
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
968
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
969
|
+
* @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
|
|
970
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
971
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
972
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
973
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
974
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
975
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
976
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
977
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
978
|
+
*/
|
|
979
|
+
egressAllowanceGet() {
|
|
980
|
+
return this.fetcher.get(`/egress-allowance`);
|
|
981
|
+
}
|
|
982
|
+
/**
|
|
983
|
+
* `POST /project-invitations/accept` — operationId: `project_invitations/accept`
|
|
984
|
+
*
|
|
985
|
+
* Accept a project invitation
|
|
986
|
+
*
|
|
987
|
+
* Joins the project the invitation is for, as the signed-in user, if their verified email is the invited one. `token` is the secret from the invitation link's fragment.
|
|
988
|
+
*
|
|
989
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
990
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
991
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
992
|
+
* @throws {FaableApiError} `invitation_email_mismatch` (403) — The invitation is for another email address than the signed-in account. `details.invited_email` shows it masked.
|
|
993
|
+
* @throws {FaableApiError} `invitation_email_unverified` (403) — The signed-in account has the invited email but hasn't verified it yet.
|
|
994
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
995
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
996
|
+
* @throws {FaableApiError} `invitation_invalid` (404) — The invitation link is not valid (mistyped, or revoked and replaced).
|
|
997
|
+
* @throws {FaableApiError} `invitation_used` (409) — The invitation was already accepted or revoked.
|
|
998
|
+
* @throws {FaableApiError} `invitation_expired` (410) — The invitation expired. Ask for a new one.
|
|
999
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1000
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1001
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
1002
|
+
*/
|
|
1003
|
+
projectInvitationsAccept(data) {
|
|
1004
|
+
return this.fetcher.post(`/project-invitations/accept`, data);
|
|
1005
|
+
}
|
|
1006
|
+
/**
|
|
1007
|
+
* `POST /project-invitations/{invite_id}/accept` — operationId: `project_invitations/acceptMine`
|
|
1008
|
+
*
|
|
1009
|
+
* Accept one of my project invitations
|
|
1010
|
+
*
|
|
1011
|
+
* Joins the project, as the signed-in user, if their verified email is the invited one.
|
|
1012
|
+
*
|
|
1013
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1014
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1015
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
1016
|
+
* @throws {FaableApiError} `invitation_email_mismatch` (403) — The invitation is for another email address than the signed-in account. `details.invited_email` shows it masked.
|
|
1017
|
+
* @throws {FaableApiError} `invitation_email_unverified` (403) — The signed-in account has the invited email but hasn't verified it yet.
|
|
1018
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1019
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1020
|
+
* @throws {FaableApiError} `invitation_invalid` (404) — The invitation link is not valid (mistyped, or revoked and replaced).
|
|
1021
|
+
* @throws {FaableApiError} `invitation_used` (409) — The invitation was already accepted or revoked.
|
|
1022
|
+
* @throws {FaableApiError} `invitation_expired` (410) — The invitation expired. Ask for a new one.
|
|
1023
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1024
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1025
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
1026
|
+
*/
|
|
1027
|
+
projectInvitationsAcceptMine(invite_id) {
|
|
1028
|
+
requireId("invite_id", invite_id);
|
|
1029
|
+
return this.fetcher.post(`/project-invitations/${invite_id}/accept`, {});
|
|
1030
|
+
}
|
|
1031
|
+
/**
|
|
1032
|
+
* `POST /project-invitations/{invite_id}/decline` — operationId: `project_invitations/declineMine`
|
|
1033
|
+
*
|
|
1034
|
+
* Decline one of my project invitations
|
|
1035
|
+
*
|
|
1036
|
+
* The invitation is spent: its link stops working and it leaves the pending list of the project.
|
|
1037
|
+
*
|
|
1038
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1039
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1040
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
1041
|
+
* @throws {FaableApiError} `invitation_email_mismatch` (403) — The invitation is for another email address than the signed-in account. `details.invited_email` shows it masked.
|
|
1042
|
+
* @throws {FaableApiError} `invitation_email_unverified` (403) — The signed-in account has the invited email but hasn't verified it yet.
|
|
1043
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1044
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1045
|
+
* @throws {FaableApiError} `invitation_invalid` (404) — The invitation link is not valid (mistyped, or revoked and replaced).
|
|
1046
|
+
* @throws {FaableApiError} `invitation_used` (409) — The invitation was already accepted or revoked.
|
|
1047
|
+
* @throws {FaableApiError} `invitation_expired` (410) — The invitation expired. Ask for a new one.
|
|
1048
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1049
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1050
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
1051
|
+
*/
|
|
1052
|
+
projectInvitationsDeclineMine(invite_id) {
|
|
1053
|
+
requireId("invite_id", invite_id);
|
|
1054
|
+
return this.fetcher.post(`/project-invitations/${invite_id}/decline`, {});
|
|
1055
|
+
}
|
|
1056
|
+
/**
|
|
1057
|
+
* `GET /project-invitations` — operationId: `project_invitations/listMine`
|
|
1058
|
+
*
|
|
1059
|
+
* List my pending project invitations
|
|
1060
|
+
*
|
|
1061
|
+
* Invitations to projects addressed to the signed-in user's email, only if it is verified (`email_verified: false` and an empty list otherwise).
|
|
1062
|
+
*
|
|
1063
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1064
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
1065
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1066
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1067
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1068
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1069
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
1070
|
+
*/
|
|
1071
|
+
projectInvitationsListMine() {
|
|
1072
|
+
return this.fetcher.get(`/project-invitations`);
|
|
1073
|
+
}
|
|
812
1074
|
/**
|
|
813
1075
|
* `POST /project` — operationId: `project/create`
|
|
814
1076
|
*
|
|
@@ -817,6 +1079,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
817
1079
|
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists. `details.fields` names the field.
|
|
818
1080
|
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
819
1081
|
* @throws {FaableApiError} `team_required` (400) — The operation needs a project: send it in the `x-faable-project` header (`project_<id>`).
|
|
1082
|
+
* @throws {FaableApiError} `invalid_project_description` (400) — The project description is not acceptable (a link, or over the length limit). `message` says why.
|
|
820
1083
|
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
821
1084
|
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
822
1085
|
* @throws {FaableApiError} `project_plan_limited` (402) — The Free plan project cap is reached. Upgrade to create more.
|
|
@@ -825,10 +1088,31 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
825
1088
|
* @throws {FaableApiError} `project_rate_limited` (429) — A new account may only create a few projects in its first hours. It opens with time, or with a plan.
|
|
826
1089
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
827
1090
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1091
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
828
1092
|
*/
|
|
829
1093
|
projectCreate(data) {
|
|
830
1094
|
return this.fetcher.post(`/project`, data);
|
|
831
1095
|
}
|
|
1096
|
+
/**
|
|
1097
|
+
* `POST /project/{id}/auth-accounts` — operationId: `project/createAuthAccount`
|
|
1098
|
+
*
|
|
1099
|
+
* Create an Auth account for a project
|
|
1100
|
+
*
|
|
1101
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1102
|
+
* @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
|
|
1103
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1104
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
1105
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1106
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1107
|
+
* @throws {FaableApiError} `project_not_found` (404) — No project with that id for this caller.
|
|
1108
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1109
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1110
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
1111
|
+
*/
|
|
1112
|
+
projectCreateAuthAccount(id, data) {
|
|
1113
|
+
requireId("id", id);
|
|
1114
|
+
return this.fetcher.post(`/project/${id}/auth-accounts`, data);
|
|
1115
|
+
}
|
|
832
1116
|
/**
|
|
833
1117
|
* `DELETE /project/{id}` — operationId: `project/delete`
|
|
834
1118
|
*
|
|
@@ -845,6 +1129,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
845
1129
|
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
846
1130
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
847
1131
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1132
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
848
1133
|
*/
|
|
849
1134
|
projectDelete(id) {
|
|
850
1135
|
requireId("id", id);
|
|
@@ -866,6 +1151,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
866
1151
|
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
867
1152
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
868
1153
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1154
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
869
1155
|
*/
|
|
870
1156
|
projectGet(id) {
|
|
871
1157
|
requireId("id", id);
|
|
@@ -884,6 +1170,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
884
1170
|
* @throws {FaableApiError} `project_not_found` (404) — No project with that id for this caller.
|
|
885
1171
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
886
1172
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1173
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
887
1174
|
*/
|
|
888
1175
|
projectInvite(id, data) {
|
|
889
1176
|
requireId("id", id);
|
|
@@ -903,6 +1190,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
903
1190
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
904
1191
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
905
1192
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1193
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
906
1194
|
*/
|
|
907
1195
|
projectLimits() {
|
|
908
1196
|
return this.fetcher.get(`/project/limits`);
|
|
@@ -923,10 +1211,95 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
923
1211
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
924
1212
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
925
1213
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1214
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
926
1215
|
*/
|
|
927
1216
|
projectList(params) {
|
|
928
1217
|
return this.paginator({ url: `/project`, params });
|
|
929
1218
|
}
|
|
1219
|
+
/**
|
|
1220
|
+
* `GET /project/{id}/activity` — operationId: `project/listActivity`
|
|
1221
|
+
*
|
|
1222
|
+
* Membership activity of a project
|
|
1223
|
+
*
|
|
1224
|
+
* Who joined, left, was invited, removed or changed role, newest first. Changes show up a few seconds after they happen. `next` pages back.
|
|
1225
|
+
*
|
|
1226
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1227
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1228
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
1229
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1230
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1231
|
+
* @throws {FaableApiError} `project_not_found` (404) — No project with that id for this caller.
|
|
1232
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1233
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1234
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
1235
|
+
*/
|
|
1236
|
+
projectListActivity(id, params) {
|
|
1237
|
+
requireId("id", id);
|
|
1238
|
+
return this.fetcher.request({ method: "GET", url: `/project/${id}/activity`, params });
|
|
1239
|
+
}
|
|
1240
|
+
/**
|
|
1241
|
+
* `GET /project/{id}/auth-accounts` — operationId: `project/listAuthAccounts`
|
|
1242
|
+
*
|
|
1243
|
+
* List a project's Auth accounts
|
|
1244
|
+
*
|
|
1245
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1246
|
+
* @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
|
|
1247
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1248
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
1249
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1250
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1251
|
+
* @throws {FaableApiError} `project_not_found` (404) — No project with that id for this caller.
|
|
1252
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1253
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1254
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
1255
|
+
*/
|
|
1256
|
+
projectListAuthAccounts(id, params) {
|
|
1257
|
+
requireId("id", id);
|
|
1258
|
+
return this.fetcher.request({ method: "GET", url: `/project/${id}/auth-accounts`, params });
|
|
1259
|
+
}
|
|
1260
|
+
/**
|
|
1261
|
+
* `GET /project/{id}/invitations` — operationId: `project/listInvitations`
|
|
1262
|
+
*
|
|
1263
|
+
* List the pending invitations of a project
|
|
1264
|
+
*
|
|
1265
|
+
* Invitations sent and not yet accepted, revoked or expired. The link secret is never returned.
|
|
1266
|
+
*
|
|
1267
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1268
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1269
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
1270
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1271
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1272
|
+
* @throws {FaableApiError} `project_not_found` (404) — No project with that id for this caller.
|
|
1273
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1274
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1275
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
1276
|
+
*/
|
|
1277
|
+
projectListInvitations(id) {
|
|
1278
|
+
requireId("id", id);
|
|
1279
|
+
return this.fetcher.get(`/project/${id}/invitations`);
|
|
1280
|
+
}
|
|
1281
|
+
/**
|
|
1282
|
+
* `GET /project/{id}/members` — operationId: `project/listMembers`
|
|
1283
|
+
*
|
|
1284
|
+
* List the members of a project
|
|
1285
|
+
*
|
|
1286
|
+
* Members of a project (owner first, then collaborators) with their profile
|
|
1287
|
+
*
|
|
1288
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1289
|
+
* @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
|
|
1290
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1291
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
1292
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1293
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1294
|
+
* @throws {FaableApiError} `project_not_found` (404) — No project with that id for this caller.
|
|
1295
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1296
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1297
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
1298
|
+
*/
|
|
1299
|
+
projectListMembers(id) {
|
|
1300
|
+
requireId("id", id);
|
|
1301
|
+
return this.fetcher.get(`/project/${id}/members`);
|
|
1302
|
+
}
|
|
930
1303
|
/**
|
|
931
1304
|
* `DELETE /project/{id}/collaborator/{user_id}` — operationId: `project/removeCollaborator`
|
|
932
1305
|
*
|
|
@@ -943,12 +1316,113 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
943
1316
|
* @throws {FaableApiError} `project_not_found` (404) — No project with that id for this caller.
|
|
944
1317
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
945
1318
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1319
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
946
1320
|
*/
|
|
947
1321
|
projectRemoveCollaborator(id, user_id) {
|
|
948
1322
|
requireId("id", id);
|
|
949
1323
|
requireId("user_id", user_id);
|
|
950
1324
|
return this.fetcher.delete(`/project/${id}/collaborator/${user_id}`);
|
|
951
1325
|
}
|
|
1326
|
+
/**
|
|
1327
|
+
* `DELETE /project/{id}/members/{user_id}` — operationId: `project/removeMember`
|
|
1328
|
+
*
|
|
1329
|
+
* Remove a member, or leave the project
|
|
1330
|
+
*
|
|
1331
|
+
* An owner removes anyone; any member removes themselves (leave). Never the last owner, nor the member who pays for the project.
|
|
1332
|
+
*
|
|
1333
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1334
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1335
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
1336
|
+
* @throws {FaableApiError} `owner_only` (403) — Only the project owner can manage collaborators.
|
|
1337
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1338
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1339
|
+
* @throws {FaableApiError} `project_not_found` (404) — No project with that id for this caller.
|
|
1340
|
+
* @throws {FaableApiError} `member_not_found` (404) — That user is not a member of the project.
|
|
1341
|
+
* @throws {FaableApiError} `last_owner` (409) — A project needs at least one owner: make someone else an owner first, or delete the project.
|
|
1342
|
+
* @throws {FaableApiError} `billing_owner_not_removable` (409) — The member who pays for the project cannot be removed or leave until billing is handed over.
|
|
1343
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1344
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1345
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
1346
|
+
*/
|
|
1347
|
+
projectRemoveMember(id, user_id) {
|
|
1348
|
+
requireId("id", id);
|
|
1349
|
+
requireId("user_id", user_id);
|
|
1350
|
+
return this.fetcher.delete(`/project/${id}/members/${user_id}`);
|
|
1351
|
+
}
|
|
1352
|
+
/**
|
|
1353
|
+
* `POST /project/{id}/invitations/{invite_id}/resend` — operationId: `project/resendInvitation`
|
|
1354
|
+
*
|
|
1355
|
+
* Send a pending invitation again
|
|
1356
|
+
*
|
|
1357
|
+
* Emails a new link for the same address and role; the previous link stops working.
|
|
1358
|
+
*
|
|
1359
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1360
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1361
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
1362
|
+
* @throws {FaableApiError} `owner_only` (403) — Only the project owner can manage collaborators.
|
|
1363
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1364
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1365
|
+
* @throws {FaableApiError} `project_not_found` (404) — No project with that id for this caller.
|
|
1366
|
+
* @throws {FaableApiError} `invitation_not_found` (404) — No pending invitation with that id in this project.
|
|
1367
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1368
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1369
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
1370
|
+
*/
|
|
1371
|
+
projectResendInvitation(id, invite_id) {
|
|
1372
|
+
requireId("id", id);
|
|
1373
|
+
requireId("invite_id", invite_id);
|
|
1374
|
+
return this.fetcher.post(`/project/${id}/invitations/${invite_id}/resend`, {});
|
|
1375
|
+
}
|
|
1376
|
+
/**
|
|
1377
|
+
* `DELETE /project/{id}/invitations/{invite_id}` — operationId: `project/revokeInvitation`
|
|
1378
|
+
*
|
|
1379
|
+
* Revoke a pending invitation
|
|
1380
|
+
*
|
|
1381
|
+
* The link stops working at once.
|
|
1382
|
+
*
|
|
1383
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1384
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1385
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
1386
|
+
* @throws {FaableApiError} `owner_only` (403) — Only the project owner can manage collaborators.
|
|
1387
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1388
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1389
|
+
* @throws {FaableApiError} `project_not_found` (404) — No project with that id for this caller.
|
|
1390
|
+
* @throws {FaableApiError} `invitation_not_found` (404) — No pending invitation with that id in this project.
|
|
1391
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1392
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1393
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
1394
|
+
*/
|
|
1395
|
+
projectRevokeInvitation(id, invite_id) {
|
|
1396
|
+
requireId("id", id);
|
|
1397
|
+
requireId("invite_id", invite_id);
|
|
1398
|
+
return this.fetcher.delete(`/project/${id}/invitations/${invite_id}`);
|
|
1399
|
+
}
|
|
1400
|
+
/**
|
|
1401
|
+
* `POST /project/{id}/billing-owner` — operationId: `project/setBillingOwner`
|
|
1402
|
+
*
|
|
1403
|
+
* Hand over who pays for the project
|
|
1404
|
+
*
|
|
1405
|
+
* The member who pays hands billing to another owner. Only for projects without an active subscription; with one, support does it.
|
|
1406
|
+
*
|
|
1407
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1408
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1409
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
1410
|
+
* @throws {FaableApiError} `billing_receiver_free_limit` (402) — The receiver already has as many free projects as the plan allows.
|
|
1411
|
+
* @throws {FaableApiError} `billing_owner_only` (403) — Only the member who pays for the project can hand billing over.
|
|
1412
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1413
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1414
|
+
* @throws {FaableApiError} `project_not_found` (404) — No project with that id for this caller.
|
|
1415
|
+
* @throws {FaableApiError} `billing_receiver_not_owner` (409) — Billing can only be handed to an owner of the project.
|
|
1416
|
+
* @throws {FaableApiError} `billing_transfer_requires_support` (409) — The project has an active subscription; handing it over is done by support.
|
|
1417
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1418
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1419
|
+
* @throws {FaableApiError} `billing_unavailable` (503) — Billing is not answering; nothing was changed.
|
|
1420
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
1421
|
+
*/
|
|
1422
|
+
projectSetBillingOwner(id, data) {
|
|
1423
|
+
requireId("id", id);
|
|
1424
|
+
return this.fetcher.post(`/project/${id}/billing-owner`, data);
|
|
1425
|
+
}
|
|
952
1426
|
/**
|
|
953
1427
|
* `POST /project/{id}` — operationId: `project/update`
|
|
954
1428
|
*
|
|
@@ -957,6 +1431,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
957
1431
|
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
958
1432
|
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists. `details.fields` names the field.
|
|
959
1433
|
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1434
|
+
* @throws {FaableApiError} `invalid_project_description` (400) — The project description is not acceptable (a link, or over the length limit). `message` says why.
|
|
960
1435
|
* @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
|
|
961
1436
|
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
962
1437
|
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
@@ -965,11 +1440,37 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
965
1440
|
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
966
1441
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
967
1442
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1443
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
968
1444
|
*/
|
|
969
1445
|
projectUpdate(id, data) {
|
|
970
1446
|
requireId("id", id);
|
|
971
1447
|
return this.fetcher.post(`/project/${id}`, data);
|
|
972
1448
|
}
|
|
1449
|
+
/**
|
|
1450
|
+
* `POST /project/{id}/members/{user_id}` — operationId: `project/updateMember`
|
|
1451
|
+
*
|
|
1452
|
+
* Change a member's role
|
|
1453
|
+
*
|
|
1454
|
+
* Owner only. A project always keeps at least one owner (`last_owner`).
|
|
1455
|
+
*
|
|
1456
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1457
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1458
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
1459
|
+
* @throws {FaableApiError} `owner_only` (403) — Only the project owner can manage collaborators.
|
|
1460
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1461
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1462
|
+
* @throws {FaableApiError} `project_not_found` (404) — No project with that id for this caller.
|
|
1463
|
+
* @throws {FaableApiError} `member_not_found` (404) — That user is not a member of the project.
|
|
1464
|
+
* @throws {FaableApiError} `last_owner` (409) — A project needs at least one owner: make someone else an owner first, or delete the project.
|
|
1465
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1466
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1467
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
1468
|
+
*/
|
|
1469
|
+
projectUpdateMember(id, user_id, data) {
|
|
1470
|
+
requireId("id", id);
|
|
1471
|
+
requireId("user_id", user_id);
|
|
1472
|
+
return this.fetcher.post(`/project/${id}/members/${user_id}`, data);
|
|
1473
|
+
}
|
|
973
1474
|
/**
|
|
974
1475
|
* `POST /secret/createbatch` — operationId: `secrets/create_batch`
|
|
975
1476
|
*
|
|
@@ -984,6 +1485,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
984
1485
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
985
1486
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
986
1487
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1488
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
987
1489
|
*/
|
|
988
1490
|
secretsCreateBatch(data) {
|
|
989
1491
|
return this.fetcher.post(`/secret/createbatch`, data);
|
|
@@ -1003,6 +1505,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
1003
1505
|
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
1004
1506
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1005
1507
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1508
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
1006
1509
|
*/
|
|
1007
1510
|
secretsDelete(secret_id) {
|
|
1008
1511
|
requireId("secret_id", secret_id);
|
|
@@ -1022,6 +1525,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
1022
1525
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1023
1526
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1024
1527
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1528
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
1025
1529
|
*/
|
|
1026
1530
|
secretsListApp(context_id, params) {
|
|
1027
1531
|
requireId("context_id", context_id);
|
|
@@ -1039,6 +1543,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
1039
1543
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1040
1544
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1041
1545
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1546
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
1042
1547
|
*/
|
|
1043
1548
|
secretsUpsert(data) {
|
|
1044
1549
|
return this.fetcher.post(`/secret`, data);
|
|
@@ -1055,6 +1560,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
1055
1560
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1056
1561
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1057
1562
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1563
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
1058
1564
|
*/
|
|
1059
1565
|
usageSummary(params) {
|
|
1060
1566
|
return this.fetcher.request({ method: "GET", url: `/usage/summary`, params });
|
|
@@ -1070,6 +1576,7 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
1070
1576
|
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1071
1577
|
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1072
1578
|
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1579
|
+
* @throws {FaableApiError} `database_unavailable` (503) — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.
|
|
1073
1580
|
*/
|
|
1074
1581
|
usageTraffic() {
|
|
1075
1582
|
return this.fetcher.get(`/usage/traffic`);
|