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