@faable/deploy-sdk 2.15.0 → 2.16.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/dist/FaableDeployApi.d.ts.map +1 -1
- package/dist/api/api-types.d.ts +2 -0
- package/dist/api/api-types.d.ts.map +1 -1
- package/dist/api/generated-client.d.ts +561 -0
- package/dist/api/generated-client.d.ts.map +1 -1
- package/dist/api/generated-client.js +561 -0
- package/dist/api/types.d.ts +4387 -143
- package/dist/api/types.d.ts.map +1 -1
- package/package.json +2 -2
- package/spec/openapi.json +9917 -1857
|
@@ -13,6 +13,14 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
13
13
|
* `GET /app/checkname` — operationId: `app/checkname`
|
|
14
14
|
*
|
|
15
15
|
* Check if an app name is availiable
|
|
16
|
+
*
|
|
17
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
18
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
19
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
20
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
21
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
22
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
23
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
16
24
|
*/
|
|
17
25
|
appCheckname(params) {
|
|
18
26
|
return this.fetcher.request({ method: "GET", url: `/app/checkname`, params });
|
|
@@ -21,6 +29,17 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
21
29
|
* `POST /app` — operationId: `app/create`
|
|
22
30
|
*
|
|
23
31
|
* Create App
|
|
32
|
+
*
|
|
33
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists. `details.fields` names the field.
|
|
34
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
35
|
+
* @throws {FaableApiError} `team_required` (400) — The operation needs a project: send it in the `x-faable-team` header.
|
|
36
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
37
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
38
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
39
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
40
|
+
* @throws {FaableApiError} `app_rate_limited` (429) — A new account may only create a few apps in its first 24 hours.
|
|
41
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
42
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
24
43
|
*/
|
|
25
44
|
appCreate(data) {
|
|
26
45
|
return this.fetcher.post(`/app`, data);
|
|
@@ -29,6 +48,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
29
48
|
* `DELETE /app/{id}` — operationId: `app/delete`
|
|
30
49
|
*
|
|
31
50
|
* Delete App
|
|
51
|
+
*
|
|
52
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
53
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
54
|
+
* @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
|
|
55
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
56
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
57
|
+
* @throws {FaableApiError} `moderation_hold` (403) — The project contains an app disabled by moderation and cannot be deleted. Contact support@faable.com.
|
|
58
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
59
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
60
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
61
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
62
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
32
63
|
*/
|
|
33
64
|
appDelete(id) {
|
|
34
65
|
requireId("id", id);
|
|
@@ -40,6 +71,23 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
40
71
|
* Deploy the latest commit now
|
|
41
72
|
*
|
|
42
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.
|
|
74
|
+
*
|
|
75
|
+
* @throws {FaableApiError} `branch_missing` (400) — The deploy branch does not exist on the repository. `message` lists the branches that do.
|
|
76
|
+
* @throws {FaableApiError} `deploy_mode_conflict` (400) — The app deploys from its own workflow, so the platform will not create a deployment for it.
|
|
77
|
+
* @throws {FaableApiError} `repository_empty` (400) — The repository has no commits on the deploy branch yet.
|
|
78
|
+
* @throws {FaableApiError} `repository_not_linked` (400) — The app has no linked repository.
|
|
79
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
80
|
+
* @throws {FaableApiError} `github_token_invalid` (401) — The stored GitHub token was rejected; the user must reconnect.
|
|
81
|
+
* @throws {FaableApiError} `user_token_required` (401) — The endpoint acts on behalf of a person and the credential carries no user (an API key or a service account).
|
|
82
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
83
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
84
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
85
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
86
|
+
* @throws {FaableApiError} `deploy_refused` (409) — The deploy was refused by quota, plan or an in-flight deployment. `message` says which.
|
|
87
|
+
* @throws {FaableApiError} `github_identity_missing` (412) — The user has not connected GitHub. Send them through `connect_github`.
|
|
88
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
89
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
90
|
+
* @throws {FaableApiError} `github_error` (502) — GitHub failed upstream. `message` carries what it said.
|
|
43
91
|
*/
|
|
44
92
|
appDeployNow(id) {
|
|
45
93
|
requireId("id", id);
|
|
@@ -49,6 +97,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
49
97
|
* `GET /app/{id}` — operationId: `app/get`
|
|
50
98
|
*
|
|
51
99
|
* Get App
|
|
100
|
+
*
|
|
101
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
102
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
103
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
104
|
+
* @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
|
|
105
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
106
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
107
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
108
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
109
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
110
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
111
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
52
112
|
*/
|
|
53
113
|
appGet(id, params) {
|
|
54
114
|
requireId("id", id);
|
|
@@ -58,6 +118,16 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
58
118
|
* `GET /app/{app_id}/registry` — operationId: `app/get_registry`
|
|
59
119
|
*
|
|
60
120
|
* Get app registry
|
|
121
|
+
*
|
|
122
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
123
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
124
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
125
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
126
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
127
|
+
* @throws {FaableApiError} `app_disabled` (409) — The app is disabled, so it cannot be deployed or provisioned. `message` says why when the reason is public.
|
|
128
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
129
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
130
|
+
* @throws {FaableApiError} `bad_gateway` (502) — An upstream the API depends on failed.
|
|
61
131
|
*/
|
|
62
132
|
appGetRegistry(app_id) {
|
|
63
133
|
requireId("app_id", app_id);
|
|
@@ -69,6 +139,24 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
69
139
|
* Link a GitHub repository to an app
|
|
70
140
|
*
|
|
71
141
|
* Link a GitHub repository to an app after verifying the user has a connected GitHub identity with access to the repository.
|
|
142
|
+
*
|
|
143
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
144
|
+
* @throws {FaableApiError} `github_token_invalid` (401) — The stored GitHub token was rejected; the user must reconnect.
|
|
145
|
+
* @throws {FaableApiError} `user_token_required` (401) — The endpoint acts on behalf of a person and the credential carries no user (an API key or a service account).
|
|
146
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
147
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
148
|
+
* @throws {FaableApiError} `github_installation_suspended` (403) — The GitHub App installation is suspended.
|
|
149
|
+
* @throws {FaableApiError} `github_permission_denied` (403) — The installation lacks a permission this operation needs.
|
|
150
|
+
* @throws {FaableApiError} `github_repository_blocked` (403) — GitHub refuses to serve the source of that repository (403 or 451).
|
|
151
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
152
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
153
|
+
* @throws {FaableApiError} `github_repository_not_found` (404) — The repository does not exist or the installation cannot see it.
|
|
154
|
+
* @throws {FaableApiError} `repository_already_linked` (409) — The repository is already linked to another app. `details.app_id` / `details.app_name` name it.
|
|
155
|
+
* @throws {FaableApiError} `github_identity_missing` (412) — The user has not connected GitHub. Send them through `connect_github`.
|
|
156
|
+
* @throws {FaableApiError} `github_installation_missing` (412) — The Faable GitHub App is not installed on any repository of theirs.
|
|
157
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
158
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
159
|
+
* @throws {FaableApiError} `github_error` (502) — GitHub failed upstream. `message` carries what it said.
|
|
72
160
|
*/
|
|
73
161
|
appLinkRepository(id, data) {
|
|
74
162
|
requireId("id", id);
|
|
@@ -78,6 +166,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
78
166
|
* `GET /app` — operationId: `app/list`
|
|
79
167
|
*
|
|
80
168
|
* List Apps
|
|
169
|
+
*
|
|
170
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
171
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
172
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?q=`.
|
|
173
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
174
|
+
* @throws {FaableApiError} `team_or_scope_required` (401) — Listing needs either a project in `x-faable-team` or a global scope on the token.
|
|
175
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
176
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
177
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
178
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
179
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
180
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
81
181
|
*/
|
|
82
182
|
appList(params) {
|
|
83
183
|
return this.paginator({ url: `/app`, params });
|
|
@@ -86,6 +186,14 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
86
186
|
* `GET /app/{app_id}/logs` — operationId: `app/logs`
|
|
87
187
|
*
|
|
88
188
|
* Get app logs
|
|
189
|
+
*
|
|
190
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
191
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
192
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
193
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
194
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
195
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
196
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
89
197
|
*/
|
|
90
198
|
appLogs(app_id, params) {
|
|
91
199
|
requireId("app_id", app_id);
|
|
@@ -97,6 +205,17 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
97
205
|
* List repository branches
|
|
98
206
|
*
|
|
99
207
|
* Branch names of the linked repository.
|
|
208
|
+
*
|
|
209
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
210
|
+
* @throws {FaableApiError} `github_token_invalid` (401) — The stored GitHub token was rejected; the user must reconnect.
|
|
211
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
212
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
213
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
214
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
215
|
+
* @throws {FaableApiError} `github_repository_not_found` (404) — The repository does not exist or the installation cannot see it.
|
|
216
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
217
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
218
|
+
* @throws {FaableApiError} `github_error` (502) — GitHub failed upstream. `message` carries what it said.
|
|
100
219
|
*/
|
|
101
220
|
appRepoBranches(id) {
|
|
102
221
|
requireId("id", id);
|
|
@@ -108,6 +227,17 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
108
227
|
* Get effective repository build config
|
|
109
228
|
*
|
|
110
229
|
* Effective build configuration read from the repository: the monorepo Root Directory and its source (platform override or the repo's faable.json).
|
|
230
|
+
*
|
|
231
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
232
|
+
* @throws {FaableApiError} `github_token_invalid` (401) — The stored GitHub token was rejected; the user must reconnect.
|
|
233
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
234
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
235
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
236
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
237
|
+
* @throws {FaableApiError} `github_repository_not_found` (404) — The repository does not exist or the installation cannot see it.
|
|
238
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
239
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
240
|
+
* @throws {FaableApiError} `github_error` (502) — GitHub failed upstream. `message` carries what it said.
|
|
111
241
|
*/
|
|
112
242
|
appRepoConfig(id) {
|
|
113
243
|
requireId("id", id);
|
|
@@ -119,6 +249,14 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
119
249
|
* List repository directories
|
|
120
250
|
*
|
|
121
251
|
* Directories of the linked repository on the deploy branch, flagged with whether each one holds a buildable manifest. Feeds the Root Directory picker so a monorepo is configured from what the repository actually contains. Limited to three levels deep; dotted directories and node_modules are excluded.
|
|
252
|
+
*
|
|
253
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
254
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
255
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
256
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
257
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
258
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
259
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
122
260
|
*/
|
|
123
261
|
appRepoDirectories(id) {
|
|
124
262
|
requireId("id", id);
|
|
@@ -130,6 +268,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
130
268
|
* Check whether a repository can be linked to a new app
|
|
131
269
|
*
|
|
132
270
|
* Runs the free-plan "one repository, one app" guard before the app exists. Always 200: `linkable:false` names the app that already has the repository (and its project when it is another one of yours), with the same message the link would refuse with.
|
|
271
|
+
*
|
|
272
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
273
|
+
* @throws {FaableApiError} `user_token_required` (401) — The endpoint acts on behalf of a person and the credential carries no user (an API key or a service account).
|
|
274
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
275
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
276
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
277
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
278
|
+
* @throws {FaableApiError} `github_identity_missing` (412) — The user has not connected GitHub. Send them through `connect_github`.
|
|
279
|
+
* @throws {FaableApiError} `github_installation_missing` (412) — The Faable GitHub App is not installed on any repository of theirs.
|
|
280
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
281
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
282
|
+
* @throws {FaableApiError} `github_error` (502) — GitHub failed upstream. `message` carries what it said.
|
|
133
283
|
*/
|
|
134
284
|
appRepoLinkable(params) {
|
|
135
285
|
return this.fetcher.request({ method: "GET", url: `/app/repo-linkable`, params });
|
|
@@ -140,6 +290,14 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
140
290
|
* List repository workflow files
|
|
141
291
|
*
|
|
142
292
|
* GitHub Actions workflow files present on the linked repository (deploy branch).
|
|
293
|
+
*
|
|
294
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
295
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
296
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
297
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
298
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
299
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
300
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
143
301
|
*/
|
|
144
302
|
appRepoWorkflows(id) {
|
|
145
303
|
requireId("id", id);
|
|
@@ -151,6 +309,17 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
151
309
|
* Change the deploy branch
|
|
152
310
|
*
|
|
153
311
|
* Change the branch the app deploys from. Apps deploying from their own GitHub Actions workflow must update the branch trigger in the workflow file themselves.
|
|
312
|
+
*
|
|
313
|
+
* @throws {FaableApiError} `branch_missing` (400) — The deploy branch does not exist on the repository. `message` lists the branches that do.
|
|
314
|
+
* @throws {FaableApiError} `repository_not_linked` (400) — The app has no linked repository.
|
|
315
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
316
|
+
* @throws {FaableApiError} `user_token_required` (401) — The endpoint acts on behalf of a person and the credential carries no user (an API key or a service account).
|
|
317
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
318
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
319
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
320
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
321
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
322
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
154
323
|
*/
|
|
155
324
|
appSetDeployBranch(id, data) {
|
|
156
325
|
requireId("id", id);
|
|
@@ -162,6 +331,17 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
162
331
|
* Set the deploy mode
|
|
163
332
|
*
|
|
164
333
|
* Choose how pushes deploy: 'push' = every push deploys directly; 'ci' = deploy once the commit's CI checks pass. Both are platform-managed (webhook) triggers.
|
|
334
|
+
*
|
|
335
|
+
* @throws {FaableApiError} `no_deploy_workflow` (400) — No workflow in the repository runs `faable deploy`.
|
|
336
|
+
* @throws {FaableApiError} `no_workflows` (400) — The repository has no GitHub Actions workflows, so a CI gate would never open.
|
|
337
|
+
* @throws {FaableApiError} `root_dir_mismatch` (400) — The workflow deploys from one directory and platform builds would run from another. Declare `rootDir` in faable.json.
|
|
338
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
339
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
340
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
341
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
342
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
343
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
344
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
165
345
|
*/
|
|
166
346
|
appSetDeployMode(id, data) {
|
|
167
347
|
requireId("id", id);
|
|
@@ -173,6 +353,16 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
173
353
|
* Set the Root Directory
|
|
174
354
|
*
|
|
175
355
|
* Set the platform Root Directory: the subdirectory of the repository the build runs from. Takes precedence over the repo's faable.json `rootDir`; `null` clears it and hands precedence back. The path must exist on the deploy branch.
|
|
356
|
+
*
|
|
357
|
+
* @throws {FaableApiError} `invalid_root_dir` (400) — The Root Directory must be a path inside the repository — no leading `/` and no `..`.
|
|
358
|
+
* @throws {FaableApiError} `root_dir_not_found` (400) — The Root Directory does not exist on that ref of the repository.
|
|
359
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
360
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
361
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
362
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
363
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
364
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
365
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
176
366
|
*/
|
|
177
367
|
appSetRootDir(id, data) {
|
|
178
368
|
requireId("id", id);
|
|
@@ -182,6 +372,15 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
182
372
|
* `GET /app/slug/{slug}` — operationId: `app/slug`
|
|
183
373
|
*
|
|
184
374
|
* Get App by unique slug
|
|
375
|
+
*
|
|
376
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
377
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
378
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
379
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
380
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
381
|
+
* @throws {FaableApiError} `app_not_found` (404) — No app with that id or slug in this project.
|
|
382
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
383
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
185
384
|
*/
|
|
186
385
|
appSlug(slug) {
|
|
187
386
|
requireId("slug", slug);
|
|
@@ -191,6 +390,15 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
191
390
|
* `GET /app/{app_id}/traffic` — operationId: `app/traffic`
|
|
192
391
|
*
|
|
193
392
|
* Get App Traffic
|
|
393
|
+
*
|
|
394
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
395
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
396
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
397
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
398
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
399
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
400
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
401
|
+
* @throws {FaableApiError} `metrics_unavailable` (503) — Traffic metrics are temporarily unavailable — this is not an app with no traffic.
|
|
194
402
|
*/
|
|
195
403
|
appTraffic(app_id, params) {
|
|
196
404
|
requireId("app_id", app_id);
|
|
@@ -202,6 +410,15 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
202
410
|
* Unlink the GitHub repository from an app
|
|
203
411
|
*
|
|
204
412
|
* Unlink the GitHub repository from an app.
|
|
413
|
+
*
|
|
414
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
415
|
+
* @throws {FaableApiError} `user_token_required` (401) — The endpoint acts on behalf of a person and the credential carries no user (an API key or a service account).
|
|
416
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
417
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
418
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
419
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
420
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
421
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
205
422
|
*/
|
|
206
423
|
appUnlinkRepository(id) {
|
|
207
424
|
requireId("id", id);
|
|
@@ -211,6 +428,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
211
428
|
* `POST /app/{id}` — operationId: `app/update`
|
|
212
429
|
*
|
|
213
430
|
* Update App
|
|
431
|
+
*
|
|
432
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
433
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists. `details.fields` names the field.
|
|
434
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
435
|
+
* @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
|
|
436
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
437
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
438
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
439
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
440
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
441
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
442
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
214
443
|
*/
|
|
215
444
|
appUpdate(id, data) {
|
|
216
445
|
requireId("id", id);
|
|
@@ -222,6 +451,14 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
222
451
|
* Get App WAF
|
|
223
452
|
*
|
|
224
453
|
* Get the WAF rules in effect for an App
|
|
454
|
+
*
|
|
455
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
456
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
457
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
458
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
459
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
460
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
461
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
225
462
|
*/
|
|
226
463
|
appWaf(app_id) {
|
|
227
464
|
requireId("app_id", app_id);
|
|
@@ -233,6 +470,16 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
233
470
|
* Add App WAF Rule
|
|
234
471
|
*
|
|
235
472
|
* Add a WAF rule to an App
|
|
473
|
+
*
|
|
474
|
+
* @throws {FaableApiError} `bad_request` (400) — The request is malformed. `message` says what is wrong.
|
|
475
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
476
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
477
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
478
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
479
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
480
|
+
* @throws {FaableApiError} `conflict` (409) — The request conflicts with the current state of the resource.
|
|
481
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
482
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
236
483
|
*/
|
|
237
484
|
appWafAddRule(app_id, data) {
|
|
238
485
|
requireId("app_id", app_id);
|
|
@@ -244,6 +491,17 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
244
491
|
* Remove App WAF Rule
|
|
245
492
|
*
|
|
246
493
|
* Remove a WAF rule from an App
|
|
494
|
+
*
|
|
495
|
+
* @throws {FaableApiError} `bad_request` (400) — The request is malformed. `message` says what is wrong.
|
|
496
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
497
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
498
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
499
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
500
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
501
|
+
* @throws {FaableApiError} `waf_rule_not_found` (404) — No WAF rule with that pattern on this app.
|
|
502
|
+
* @throws {FaableApiError} `conflict` (409) — The request conflicts with the current state of the resource.
|
|
503
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
504
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
247
505
|
*/
|
|
248
506
|
appWafRemoveRule(app_id, data) {
|
|
249
507
|
requireId("app_id", app_id);
|
|
@@ -255,6 +513,17 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
255
513
|
* Get the team's daily deploy quota status
|
|
256
514
|
*
|
|
257
515
|
* Daily deploy allowance of the current team: how much was used today, when it resets, and how many builds are held waiting for it.
|
|
516
|
+
*
|
|
517
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
518
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
519
|
+
* @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
|
|
520
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
521
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
522
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
523
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
524
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
525
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
526
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
258
527
|
*/
|
|
259
528
|
deployQuotaGet() {
|
|
260
529
|
return this.fetcher.get(`/deploy-quota`);
|
|
@@ -265,6 +534,13 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
265
534
|
* Roll out the builds held by the daily deploy quota
|
|
266
535
|
*
|
|
267
536
|
* Releases the team's held deployments if its current plan allows it (per app, only the newest held build rolls out; older ones are canceled). Safe to call at any time — it does nothing while the quota is still spent.
|
|
537
|
+
*
|
|
538
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
539
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
540
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
541
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
542
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
543
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
268
544
|
*/
|
|
269
545
|
deployQuotaRelease() {
|
|
270
546
|
return this.fetcher.post(`/deploy-quota/release`, {});
|
|
@@ -275,6 +551,14 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
275
551
|
* Cancel a queued or building deployment
|
|
276
552
|
*
|
|
277
553
|
* Cancel a deployment that has not been handed over to the controller yet (QUEUED or BUILDING)
|
|
554
|
+
*
|
|
555
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
556
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
557
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
558
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
559
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
560
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
561
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
278
562
|
*/
|
|
279
563
|
deploymentCancel(deployment_id) {
|
|
280
564
|
requireId("deployment_id", deployment_id);
|
|
@@ -284,6 +568,20 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
284
568
|
* `POST /deployment` — operationId: `deployment/create`
|
|
285
569
|
*
|
|
286
570
|
* Create Deployment
|
|
571
|
+
*
|
|
572
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists. `details.fields` names the field.
|
|
573
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
574
|
+
* @throws {FaableApiError} `team_required` (400) — The operation needs a project: send it in the `x-faable-team` header.
|
|
575
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
576
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
577
|
+
* @throws {FaableApiError} `plan_required` (403) — The build or feature needs a higher plan. `message` says which.
|
|
578
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
579
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
580
|
+
* @throws {FaableApiError} `app_disabled` (409) — The app is disabled, so it cannot be deployed or provisioned. `message` says why when the reason is public.
|
|
581
|
+
* @throws {FaableApiError} `remote_build_disabled` (409) — Remote builds are off for this environment or this app. Deploy with a local build instead.
|
|
582
|
+
* @throws {FaableApiError} `deploy_refused` (409) — The deploy was refused by quota, plan or an in-flight deployment. `message` says which.
|
|
583
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
584
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
287
585
|
*/
|
|
288
586
|
deploymentCreate(data) {
|
|
289
587
|
return this.fetcher.post(`/deployment`, data);
|
|
@@ -292,6 +590,17 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
292
590
|
* `DELETE /deployment/{id}` — operationId: `deployment/delete`
|
|
293
591
|
*
|
|
294
592
|
* Delete Deployment
|
|
593
|
+
*
|
|
594
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
595
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
596
|
+
* @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
|
|
597
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
598
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
599
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
600
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
601
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
602
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
603
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
295
604
|
*/
|
|
296
605
|
deploymentDelete(id) {
|
|
297
606
|
requireId("id", id);
|
|
@@ -301,6 +610,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
301
610
|
* `GET /deployment/{id}` — operationId: `deployment/get`
|
|
302
611
|
*
|
|
303
612
|
* Get Deployment
|
|
613
|
+
*
|
|
614
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
615
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
616
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
617
|
+
* @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
|
|
618
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
619
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
620
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
621
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
622
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
623
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
624
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
304
625
|
*/
|
|
305
626
|
deploymentGet(id) {
|
|
306
627
|
requireId("id", id);
|
|
@@ -312,6 +633,15 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
312
633
|
* Get deployment build logs
|
|
313
634
|
*
|
|
314
635
|
* Get the CLI build/deploy output attached to a deployment
|
|
636
|
+
*
|
|
637
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
638
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
639
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
640
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
641
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
642
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
643
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
644
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
315
645
|
*/
|
|
316
646
|
deploymentGetLogs(deployment_id) {
|
|
317
647
|
requireId("deployment_id", deployment_id);
|
|
@@ -321,6 +651,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
321
651
|
* `GET /deployment` — operationId: `deployment/list`
|
|
322
652
|
*
|
|
323
653
|
* List Deployments
|
|
654
|
+
*
|
|
655
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
656
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
657
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?q=`.
|
|
658
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
659
|
+
* @throws {FaableApiError} `team_or_scope_required` (401) — Listing needs either a project in `x-faable-team` or a global scope on the token.
|
|
660
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
661
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
662
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
663
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
664
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
665
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
324
666
|
*/
|
|
325
667
|
deploymentList(params) {
|
|
326
668
|
return this.paginator({ url: `/deployment`, params });
|
|
@@ -329,6 +671,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
329
671
|
* `POST /deployment/{id}` — operationId: `deployment/update`
|
|
330
672
|
*
|
|
331
673
|
* Update Deployment
|
|
674
|
+
*
|
|
675
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
676
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists. `details.fields` names the field.
|
|
677
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
678
|
+
* @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
|
|
679
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
680
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
681
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
682
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
683
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
684
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
685
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
332
686
|
*/
|
|
333
687
|
deploymentUpdate(id, data) {
|
|
334
688
|
requireId("id", id);
|
|
@@ -338,6 +692,19 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
338
692
|
* `POST /domain` — operationId: `domain/create`
|
|
339
693
|
*
|
|
340
694
|
* Create Domain
|
|
695
|
+
*
|
|
696
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists. `details.fields` names the field.
|
|
697
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
698
|
+
* @throws {FaableApiError} `team_required` (400) — The operation needs a project: send it in the `x-faable-team` header.
|
|
699
|
+
* @throws {FaableApiError} `domain_invalid` (400) — Not a valid hostname. No protocol, port or path.
|
|
700
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
701
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
702
|
+
* @throws {FaableApiError} `domain_reserved` (403) — Hostnames under that domain are assigned by Faable.
|
|
703
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
704
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
705
|
+
* @throws {FaableApiError} `domain_taken` (409) — That hostname is already registered on Faable.
|
|
706
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
707
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
341
708
|
*/
|
|
342
709
|
domainCreate(data) {
|
|
343
710
|
return this.fetcher.post(`/domain`, data);
|
|
@@ -346,6 +713,17 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
346
713
|
* `DELETE /domain/{id}` — operationId: `domain/delete`
|
|
347
714
|
*
|
|
348
715
|
* Delete Domain
|
|
716
|
+
*
|
|
717
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
718
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
719
|
+
* @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
|
|
720
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
721
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
722
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
723
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
724
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
725
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
726
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
349
727
|
*/
|
|
350
728
|
domainDelete(id) {
|
|
351
729
|
requireId("id", id);
|
|
@@ -355,6 +733,14 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
355
733
|
* `GET /domain/fqdn/{fqdn}` — operationId: `domain/fqdn`
|
|
356
734
|
*
|
|
357
735
|
* Get domain by FQDN
|
|
736
|
+
*
|
|
737
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
738
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
739
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
740
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
741
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
742
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
743
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
358
744
|
*/
|
|
359
745
|
domainFqdn(fqdn) {
|
|
360
746
|
requireId("fqdn", fqdn);
|
|
@@ -364,6 +750,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
364
750
|
* `GET /domain/{id}` — operationId: `domain/get`
|
|
365
751
|
*
|
|
366
752
|
* Get Domain
|
|
753
|
+
*
|
|
754
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
755
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
756
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
757
|
+
* @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
|
|
758
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
759
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
760
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
761
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
762
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
763
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
764
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
367
765
|
*/
|
|
368
766
|
domainGet(id) {
|
|
369
767
|
requireId("id", id);
|
|
@@ -373,6 +771,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
373
771
|
* `GET /domain` — operationId: `domain/list`
|
|
374
772
|
*
|
|
375
773
|
* List Domains
|
|
774
|
+
*
|
|
775
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
776
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
777
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?q=`.
|
|
778
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
779
|
+
* @throws {FaableApiError} `team_or_scope_required` (401) — Listing needs either a project in `x-faable-team` or a global scope on the token.
|
|
780
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
781
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
782
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
783
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
784
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
785
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
376
786
|
*/
|
|
377
787
|
domainList(params) {
|
|
378
788
|
return this.paginator({ url: `/domain`, params });
|
|
@@ -381,6 +791,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
381
791
|
* `POST /domain/{id}` — operationId: `domain/update`
|
|
382
792
|
*
|
|
383
793
|
* Update Domain
|
|
794
|
+
*
|
|
795
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
796
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists. `details.fields` names the field.
|
|
797
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
798
|
+
* @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
|
|
799
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
800
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
801
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
802
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
803
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
804
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
805
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
384
806
|
*/
|
|
385
807
|
domainUpdate(id, data) {
|
|
386
808
|
requireId("id", id);
|
|
@@ -390,6 +812,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
390
812
|
* `POST /project` — operationId: `project/create`
|
|
391
813
|
*
|
|
392
814
|
* Create Project
|
|
815
|
+
*
|
|
816
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists. `details.fields` names the field.
|
|
817
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
818
|
+
* @throws {FaableApiError} `team_required` (400) — The operation needs a project: send it in the `x-faable-team` header.
|
|
819
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
820
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
821
|
+
* @throws {FaableApiError} `project_plan_limited` (402) — The Free plan project cap is reached. Upgrade to create more.
|
|
822
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
823
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
824
|
+
* @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.
|
|
825
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
826
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
393
827
|
*/
|
|
394
828
|
projectCreate(data) {
|
|
395
829
|
return this.fetcher.post(`/project`, data);
|
|
@@ -398,6 +832,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
398
832
|
* `DELETE /project/{id}` — operationId: `project/delete`
|
|
399
833
|
*
|
|
400
834
|
* Delete Project
|
|
835
|
+
*
|
|
836
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
837
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
838
|
+
* @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
|
|
839
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
840
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
841
|
+
* @throws {FaableApiError} `moderation_hold` (403) — The project contains an app disabled by moderation and cannot be deleted. Contact support@faable.com.
|
|
842
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
843
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
844
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
845
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
846
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
401
847
|
*/
|
|
402
848
|
projectDelete(id) {
|
|
403
849
|
requireId("id", id);
|
|
@@ -407,6 +853,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
407
853
|
* `GET /project/{id}` — operationId: `project/get`
|
|
408
854
|
*
|
|
409
855
|
* Get Project
|
|
856
|
+
*
|
|
857
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
858
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
859
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
860
|
+
* @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
|
|
861
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
862
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
863
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
864
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
865
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
866
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
867
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
410
868
|
*/
|
|
411
869
|
projectGet(id) {
|
|
412
870
|
requireId("id", id);
|
|
@@ -416,6 +874,15 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
416
874
|
* `POST /project/{id}/invite` — operationId: `project/invite`
|
|
417
875
|
*
|
|
418
876
|
* Invite collaborators to project
|
|
877
|
+
*
|
|
878
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
879
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
880
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
881
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
882
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
883
|
+
* @throws {FaableApiError} `project_not_found` (404) — No project with that id for this caller.
|
|
884
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
885
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
419
886
|
*/
|
|
420
887
|
projectInvite(id, data) {
|
|
421
888
|
requireId("id", id);
|
|
@@ -427,6 +894,14 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
427
894
|
* Project creation limits for the caller
|
|
428
895
|
*
|
|
429
896
|
* Whether the caller can create another project, and why not
|
|
897
|
+
*
|
|
898
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
899
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
900
|
+
* @throws {FaableApiError} `owner_only` (403) — Only the project owner can manage collaborators.
|
|
901
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
902
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
903
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
904
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
430
905
|
*/
|
|
431
906
|
projectLimits() {
|
|
432
907
|
return this.fetcher.get(`/project/limits`);
|
|
@@ -435,6 +910,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
435
910
|
* `GET /project` — operationId: `project/list`
|
|
436
911
|
*
|
|
437
912
|
* List Projects
|
|
913
|
+
*
|
|
914
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
915
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
916
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?q=`.
|
|
917
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
918
|
+
* @throws {FaableApiError} `team_or_scope_required` (401) — Listing needs either a project in `x-faable-team` or a global scope on the token.
|
|
919
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
920
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
921
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
922
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
923
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
924
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
438
925
|
*/
|
|
439
926
|
projectList(params) {
|
|
440
927
|
return this.paginator({ url: `/project`, params });
|
|
@@ -443,6 +930,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
443
930
|
* `DELETE /project/{id}/collaborator/{user_id}` — operationId: `project/removeCollaborator`
|
|
444
931
|
*
|
|
445
932
|
* Remove a collaborator from a project
|
|
933
|
+
*
|
|
934
|
+
* @throws {FaableApiError} `owner_not_removable` (400) — The project owner cannot be removed. Delete the project instead.
|
|
935
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
936
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
937
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
938
|
+
* @throws {FaableApiError} `superadmin_only` (403) — The operation is restricted to platform staff.
|
|
939
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
940
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
941
|
+
* @throws {FaableApiError} `collaborator_not_found` (404) — That user is not a collaborator on the project.
|
|
942
|
+
* @throws {FaableApiError} `project_not_found` (404) — No project with that id for this caller.
|
|
943
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
944
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
446
945
|
*/
|
|
447
946
|
projectRemoveCollaborator(id, user_id) {
|
|
448
947
|
requireId("id", id);
|
|
@@ -453,6 +952,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
453
952
|
* `POST /project/{id}` — operationId: `project/update`
|
|
454
953
|
*
|
|
455
954
|
* Update Project
|
|
955
|
+
*
|
|
956
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
957
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists. `details.fields` names the field.
|
|
958
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
959
|
+
* @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
|
|
960
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
961
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
962
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
963
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
964
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
965
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
966
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
456
967
|
*/
|
|
457
968
|
projectUpdate(id, data) {
|
|
458
969
|
requireId("id", id);
|
|
@@ -464,6 +975,14 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
464
975
|
* Create secrets in batch
|
|
465
976
|
*
|
|
466
977
|
* Create a secrets in batch
|
|
978
|
+
*
|
|
979
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
980
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
981
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
982
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
983
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
984
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
985
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
467
986
|
*/
|
|
468
987
|
secretsCreateBatch(data) {
|
|
469
988
|
return this.fetcher.post(`/secret/createbatch`, data);
|
|
@@ -472,6 +991,17 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
472
991
|
* `DELETE /secret/{secret_id}` — operationId: `secrets/delete`
|
|
473
992
|
*
|
|
474
993
|
* Delete a secret
|
|
994
|
+
*
|
|
995
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
996
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
997
|
+
* @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
|
|
998
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
999
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
1000
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1001
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1002
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
|
|
1003
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1004
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
475
1005
|
*/
|
|
476
1006
|
secretsDelete(secret_id) {
|
|
477
1007
|
requireId("secret_id", secret_id);
|
|
@@ -483,6 +1013,14 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
483
1013
|
* List all secrets assigned to an App or Profile contexts
|
|
484
1014
|
*
|
|
485
1015
|
* List all app secrets assigned to an App or Profile contexts
|
|
1016
|
+
*
|
|
1017
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1018
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1019
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
1020
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1021
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1022
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1023
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
486
1024
|
*/
|
|
487
1025
|
secretsListApp(context_id, params) {
|
|
488
1026
|
requireId("context_id", context_id);
|
|
@@ -492,6 +1030,14 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
492
1030
|
* `POST /secret` — operationId: `secrets/upsert`
|
|
493
1031
|
*
|
|
494
1032
|
* Upsert a secret
|
|
1033
|
+
*
|
|
1034
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1035
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1036
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
1037
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1038
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1039
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1040
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
495
1041
|
*/
|
|
496
1042
|
secretsUpsert(data) {
|
|
497
1043
|
return this.fetcher.post(`/secret`, data);
|
|
@@ -500,6 +1046,14 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
500
1046
|
* `GET /usage/summary` — operationId: `usage/summary`
|
|
501
1047
|
*
|
|
502
1048
|
* Get team usage summary for the current billing period
|
|
1049
|
+
*
|
|
1050
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1051
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1052
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
1053
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1054
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1055
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1056
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
503
1057
|
*/
|
|
504
1058
|
usageSummary(params) {
|
|
505
1059
|
return this.fetcher.request({ method: "GET", url: `/usage/summary`, params });
|
|
@@ -508,6 +1062,13 @@ export class GeneratedFaableDeployApi extends FaableApi {
|
|
|
508
1062
|
* `GET /usage/traffic` — operationId: `usage/traffic`
|
|
509
1063
|
*
|
|
510
1064
|
* Get metered traffic usage per team for the current period
|
|
1065
|
+
*
|
|
1066
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1067
|
+
* @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
|
|
1068
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1069
|
+
* @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
|
|
1070
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1071
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
511
1072
|
*/
|
|
512
1073
|
usageTraffic() {
|
|
513
1074
|
return this.fetcher.get(`/usage/traffic`);
|