@faable/deploy-sdk 2.14.0 → 2.16.0

package/dist/api/generated-client.js

@@ -13,6 +13,14 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /app/checkname` — operationId: `app/checkname`
      *
      * Check if an app name is availiable
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     appCheckname(params) {
         return this.fetcher.request({ method: "GET", url: `/app/checkname`, params });
@@ -21,6 +29,17 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `POST /app` — operationId: `app/create`
      *
      * Create App
+     *
+     * @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists. `details.fields` names the field.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `team_required` (400) — The operation needs a project: send it in the `x-faable-team` header.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `app_rate_limited` (429) — A new account may only create a few apps in its first 24 hours.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     appCreate(data) {
         return this.fetcher.post(`/app`, data);
@@ -29,6 +48,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `DELETE /app/{id}` — operationId: `app/delete`
      *
      * Delete App
+     *
+     * @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `moderation_hold` (403) — The project contains an app disabled by moderation and cannot be deleted. Contact support@faable.com.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     appDelete(id) {
         requireId("id", id);
@@ -38,6 +69,25 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `POST /app/{id}/deploy` — operationId: `app/deploy_now`
      *
      * Deploy the latest commit now
+     *
+     * 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.
+     *
+     * @throws {FaableApiError} `branch_missing` (400) — The deploy branch does not exist on the repository. `message` lists the branches that do.
+     * @throws {FaableApiError} `deploy_mode_conflict` (400) — The app deploys from its own workflow, so the platform will not create a deployment for it.
+     * @throws {FaableApiError} `repository_empty` (400) — The repository has no commits on the deploy branch yet.
+     * @throws {FaableApiError} `repository_not_linked` (400) — The app has no linked repository.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `github_token_invalid` (401) — The stored GitHub token was rejected; the user must reconnect.
+     * @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).
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `deploy_refused` (409) — The deploy was refused by quota, plan or an in-flight deployment. `message` says which.
+     * @throws {FaableApiError} `github_identity_missing` (412) — The user has not connected GitHub. Send them through `connect_github`.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
+     * @throws {FaableApiError} `github_error` (502) — GitHub failed upstream. `message` carries what it said.
      */
     appDeployNow(id) {
         requireId("id", id);
@@ -47,6 +97,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /app/{id}` — operationId: `app/get`
      *
      * Get App
+     *
+     * @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
+     * @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     appGet(id, params) {
         requireId("id", id);
@@ -56,6 +118,16 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /app/{app_id}/registry` — operationId: `app/get_registry`
      *
      * Get app registry
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `app_disabled` (409) — The app is disabled, so it cannot be deployed or provisioned. `message` says why when the reason is public.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
+     * @throws {FaableApiError} `bad_gateway` (502) — An upstream the API depends on failed.
      */
     appGetRegistry(app_id) {
         requireId("app_id", app_id);
@@ -65,6 +137,26 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `POST /app/{id}/link-repository` — operationId: `app/link_repository`
      *
      * Link a GitHub repository to an app
+     *
+     * Link a GitHub repository to an app after verifying the user has a connected GitHub identity with access to the repository.
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `github_token_invalid` (401) — The stored GitHub token was rejected; the user must reconnect.
+     * @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).
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `github_installation_suspended` (403) — The GitHub App installation is suspended.
+     * @throws {FaableApiError} `github_permission_denied` (403) — The installation lacks a permission this operation needs.
+     * @throws {FaableApiError} `github_repository_blocked` (403) — GitHub refuses to serve the source of that repository (403 or 451).
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `github_repository_not_found` (404) — The repository does not exist or the installation cannot see it.
+     * @throws {FaableApiError} `repository_already_linked` (409) — The repository is already linked to another app. `details.app_id` / `details.app_name` name it.
+     * @throws {FaableApiError} `github_identity_missing` (412) — The user has not connected GitHub. Send them through `connect_github`.
+     * @throws {FaableApiError} `github_installation_missing` (412) — The Faable GitHub App is not installed on any repository of theirs.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
+     * @throws {FaableApiError} `github_error` (502) — GitHub failed upstream. `message` carries what it said.
      */
     appLinkRepository(id, data) {
         requireId("id", id);
@@ -74,6 +166,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /app` — operationId: `app/list`
      *
      * List Apps
+     *
+     * @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
+     * @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
+     * @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?q=`.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `team_or_scope_required` (401) — Listing needs either a project in `x-faable-team` or a global scope on the token.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     appList(params) {
         return this.paginator({ url: `/app`, params });
@@ -82,6 +186,14 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /app/{app_id}/logs` — operationId: `app/logs`
      *
      * Get app logs
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     appLogs(app_id, params) {
         requireId("app_id", app_id);
@@ -91,6 +203,19 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /app/{id}/repo/branches` — operationId: `app/repo_branches`
      *
      * List repository branches
+     *
+     * Branch names of the linked repository.
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `github_token_invalid` (401) — The stored GitHub token was rejected; the user must reconnect.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `github_repository_not_found` (404) — The repository does not exist or the installation cannot see it.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
+     * @throws {FaableApiError} `github_error` (502) — GitHub failed upstream. `message` carries what it said.
      */
     appRepoBranches(id) {
         requireId("id", id);
@@ -100,6 +225,19 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /app/{id}/repo/config` — operationId: `app/repo_config`
      *
      * Get effective repository build config
+     *
+     * Effective build configuration read from the repository: the monorepo Root Directory and its source (platform override or the repo's faable.json).
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `github_token_invalid` (401) — The stored GitHub token was rejected; the user must reconnect.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `github_repository_not_found` (404) — The repository does not exist or the installation cannot see it.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
+     * @throws {FaableApiError} `github_error` (502) — GitHub failed upstream. `message` carries what it said.
      */
     appRepoConfig(id) {
         requireId("id", id);
@@ -109,15 +247,57 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /app/{id}/repo/directories` — operationId: `app/repo_directories`
      *
      * List repository directories
+     *
+     * 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.
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     appRepoDirectories(id) {
         requireId("id", id);
         return this.fetcher.get(`/app/${id}/repo/directories`);
     }
+    /**
+     * `GET /app/repo-linkable` — operationId: `app/repo_linkable`
+     *
+     * Check whether a repository can be linked to a new app
+     *
+     * 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.
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @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).
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `github_identity_missing` (412) — The user has not connected GitHub. Send them through `connect_github`.
+     * @throws {FaableApiError} `github_installation_missing` (412) — The Faable GitHub App is not installed on any repository of theirs.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
+     * @throws {FaableApiError} `github_error` (502) — GitHub failed upstream. `message` carries what it said.
+     */
+    appRepoLinkable(params) {
+        return this.fetcher.request({ method: "GET", url: `/app/repo-linkable`, params });
+    }
     /**
      * `GET /app/{id}/repo/workflows` — operationId: `app/repo_workflows`
      *
      * List repository workflow files
+     *
+     * GitHub Actions workflow files present on the linked repository (deploy branch).
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     appRepoWorkflows(id) {
         requireId("id", id);
@@ -127,6 +307,19 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `POST /app/{id}/deploy-branch` — operationId: `app/set_deploy_branch`
      *
      * Change the deploy branch
+     *
+     * 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.
+     *
+     * @throws {FaableApiError} `branch_missing` (400) — The deploy branch does not exist on the repository. `message` lists the branches that do.
+     * @throws {FaableApiError} `repository_not_linked` (400) — The app has no linked repository.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @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).
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     appSetDeployBranch(id, data) {
         requireId("id", id);
@@ -136,6 +329,19 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `POST /app/{id}/deploy-mode` — operationId: `app/set_deploy_mode`
      *
      * Set the deploy mode
+     *
+     * Choose how pushes deploy: 'push' = every push deploys directly; 'ci' = deploy once the commit's CI checks pass. Both are platform-managed (webhook) triggers.
+     *
+     * @throws {FaableApiError} `no_deploy_workflow` (400) — No workflow in the repository runs `faable deploy`.
+     * @throws {FaableApiError} `no_workflows` (400) — The repository has no GitHub Actions workflows, so a CI gate would never open.
+     * @throws {FaableApiError} `root_dir_mismatch` (400) — The workflow deploys from one directory and platform builds would run from another. Declare `rootDir` in faable.json.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     appSetDeployMode(id, data) {
         requireId("id", id);
@@ -145,6 +351,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `POST /app/{id}/root-dir` — operationId: `app/set_root_dir`
      *
      * Set the Root Directory
+     *
+     * 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.
+     *
+     * @throws {FaableApiError} `invalid_root_dir` (400) — The Root Directory must be a path inside the repository — no leading `/` and no `..`.
+     * @throws {FaableApiError} `root_dir_not_found` (400) — The Root Directory does not exist on that ref of the repository.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     appSetRootDir(id, data) {
         requireId("id", id);
@@ -154,6 +372,15 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /app/slug/{slug}` — operationId: `app/slug`
      *
      * Get App by unique slug
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `app_not_found` (404) — No app with that id or slug in this project.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     appSlug(slug) {
         requireId("slug", slug);
@@ -163,6 +390,15 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /app/{app_id}/traffic` — operationId: `app/traffic`
      *
      * Get App Traffic
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
+     * @throws {FaableApiError} `metrics_unavailable` (503) — Traffic metrics are temporarily unavailable — this is not an app with no traffic.
      */
     appTraffic(app_id, params) {
         requireId("app_id", app_id);
@@ -172,6 +408,17 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `POST /app/{id}/unlink-repository` — operationId: `app/unlink_repository`
      *
      * Unlink the GitHub repository from an app
+     *
+     * Unlink the GitHub repository from an app.
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @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).
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     appUnlinkRepository(id) {
         requireId("id", id);
@@ -181,6 +428,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `POST /app/{id}` — operationId: `app/update`
      *
      * Update App
+     *
+     * @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
+     * @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists. `details.fields` names the field.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     appUpdate(id, data) {
         requireId("id", id);
@@ -190,6 +449,16 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /app/{app_id}/waf` — operationId: `app/waf`
      *
      * Get App WAF
+     *
+     * Get the WAF rules in effect for an App
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     appWaf(app_id) {
         requireId("app_id", app_id);
@@ -199,6 +468,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `POST /app/{app_id}/waf/rules` — operationId: `app/waf/addRule`
      *
      * Add App WAF Rule
+     *
+     * Add a WAF rule to an App
+     *
+     * @throws {FaableApiError} `bad_request` (400) — The request is malformed. `message` says what is wrong.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `conflict` (409) — The request conflicts with the current state of the resource.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     appWafAddRule(app_id, data) {
         requireId("app_id", app_id);
@@ -208,6 +489,19 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `DELETE /app/{app_id}/waf/rules` — operationId: `app/waf/removeRule`
      *
      * Remove App WAF Rule
+     *
+     * Remove a WAF rule from an App
+     *
+     * @throws {FaableApiError} `bad_request` (400) — The request is malformed. `message` says what is wrong.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `waf_rule_not_found` (404) — No WAF rule with that pattern on this app.
+     * @throws {FaableApiError} `conflict` (409) — The request conflicts with the current state of the resource.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     appWafRemoveRule(app_id, data) {
         requireId("app_id", app_id);
@@ -217,6 +511,19 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /deploy-quota` — operationId: `deploy_quota/get`
      *
      * Get the team's daily deploy quota status
+     *
+     * Daily deploy allowance of the current team: how much was used today, when it resets, and how many builds are held waiting for it.
+     *
+     * @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
+     * @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
+     * @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     deployQuotaGet() {
         return this.fetcher.get(`/deploy-quota`);
@@ -225,6 +532,15 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `POST /deploy-quota/release` — operationId: `deploy_quota/release`
      *
      * Roll out the builds held by the daily deploy quota
+     *
+     * 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.
+     *
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     deployQuotaRelease() {
         return this.fetcher.post(`/deploy-quota/release`, {});
@@ -233,6 +549,16 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `POST /deployment/{deployment_id}/cancel` — operationId: `deployment/cancel`
      *
      * Cancel a queued or building deployment
+     *
+     * Cancel a deployment that has not been handed over to the controller yet (QUEUED or BUILDING)
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     deploymentCancel(deployment_id) {
         requireId("deployment_id", deployment_id);
@@ -242,6 +568,20 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `POST /deployment` — operationId: `deployment/create`
      *
      * Create Deployment
+     *
+     * @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists. `details.fields` names the field.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `team_required` (400) — The operation needs a project: send it in the `x-faable-team` header.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `plan_required` (403) — The build or feature needs a higher plan. `message` says which.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `app_disabled` (409) — The app is disabled, so it cannot be deployed or provisioned. `message` says why when the reason is public.
+     * @throws {FaableApiError} `remote_build_disabled` (409) — Remote builds are off for this environment or this app. Deploy with a local build instead.
+     * @throws {FaableApiError} `deploy_refused` (409) — The deploy was refused by quota, plan or an in-flight deployment. `message` says which.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     deploymentCreate(data) {
         return this.fetcher.post(`/deployment`, data);
@@ -250,6 +590,17 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `DELETE /deployment/{id}` — operationId: `deployment/delete`
      *
      * Delete Deployment
+     *
+     * @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     deploymentDelete(id) {
         requireId("id", id);
@@ -259,6 +610,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /deployment/{id}` — operationId: `deployment/get`
      *
      * Get Deployment
+     *
+     * @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
+     * @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     deploymentGet(id) {
         requireId("id", id);
@@ -268,6 +631,17 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /deployment/{deployment_id}/logs` — operationId: `deployment/get_logs`
      *
      * Get deployment build logs
+     *
+     * Get the CLI build/deploy output attached to a deployment
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     deploymentGetLogs(deployment_id) {
         requireId("deployment_id", deployment_id);
@@ -277,6 +651,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /deployment` — operationId: `deployment/list`
      *
      * List Deployments
+     *
+     * @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
+     * @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
+     * @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?q=`.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `team_or_scope_required` (401) — Listing needs either a project in `x-faable-team` or a global scope on the token.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     deploymentList(params) {
         return this.paginator({ url: `/deployment`, params });
@@ -285,6 +671,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `POST /deployment/{id}` — operationId: `deployment/update`
      *
      * Update Deployment
+     *
+     * @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
+     * @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists. `details.fields` names the field.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     deploymentUpdate(id, data) {
         requireId("id", id);
@@ -294,6 +692,19 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `POST /domain` — operationId: `domain/create`
      *
      * Create Domain
+     *
+     * @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists. `details.fields` names the field.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `team_required` (400) — The operation needs a project: send it in the `x-faable-team` header.
+     * @throws {FaableApiError} `domain_invalid` (400) — Not a valid hostname. No protocol, port or path.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `domain_reserved` (403) — Hostnames under that domain are assigned by Faable.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `domain_taken` (409) — That hostname is already registered on Faable.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     domainCreate(data) {
         return this.fetcher.post(`/domain`, data);
@@ -302,6 +713,17 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `DELETE /domain/{id}` — operationId: `domain/delete`
      *
      * Delete Domain
+     *
+     * @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     domainDelete(id) {
         requireId("id", id);
@@ -311,6 +733,14 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /domain/fqdn/{fqdn}` — operationId: `domain/fqdn`
      *
      * Get domain by FQDN
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     domainFqdn(fqdn) {
         requireId("fqdn", fqdn);
@@ -320,6 +750,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /domain/{id}` — operationId: `domain/get`
      *
      * Get Domain
+     *
+     * @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
+     * @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     domainGet(id) {
         requireId("id", id);
@@ -329,6 +771,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /domain` — operationId: `domain/list`
      *
      * List Domains
+     *
+     * @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
+     * @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
+     * @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?q=`.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `team_or_scope_required` (401) — Listing needs either a project in `x-faable-team` or a global scope on the token.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     domainList(params) {
         return this.paginator({ url: `/domain`, params });
@@ -337,6 +791,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `POST /domain/{id}` — operationId: `domain/update`
      *
      * Update Domain
+     *
+     * @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
+     * @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists. `details.fields` names the field.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     domainUpdate(id, data) {
         requireId("id", id);
@@ -346,6 +812,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `POST /project` — operationId: `project/create`
      *
      * Create Project
+     *
+     * @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists. `details.fields` names the field.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `team_required` (400) — The operation needs a project: send it in the `x-faable-team` header.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `project_plan_limited` (402) — The Free plan project cap is reached. Upgrade to create more.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @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.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     projectCreate(data) {
         return this.fetcher.post(`/project`, data);
@@ -354,6 +832,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `DELETE /project/{id}` — operationId: `project/delete`
      *
      * Delete Project
+     *
+     * @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `moderation_hold` (403) — The project contains an app disabled by moderation and cannot be deleted. Contact support@faable.com.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     projectDelete(id) {
         requireId("id", id);
@@ -363,6 +853,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /project/{id}` — operationId: `project/get`
      *
      * Get Project
+     *
+     * @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
+     * @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     projectGet(id) {
         requireId("id", id);
@@ -372,15 +874,54 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `POST /project/{id}/invite` — operationId: `project/invite`
      *
      * Invite collaborators to project
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `project_not_found` (404) — No project with that id for this caller.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     projectInvite(id, data) {
         requireId("id", id);
         return this.fetcher.post(`/project/${id}/invite`, data);
     }
+    /**
+     * `GET /project/limits` — operationId: `project/limits`
+     *
+     * Project creation limits for the caller
+     *
+     * Whether the caller can create another project, and why not
+     *
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `owner_only` (403) — Only the project owner can manage collaborators.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
+     */
+    projectLimits() {
+        return this.fetcher.get(`/project/limits`);
+    }
     /**
      * `GET /project` — operationId: `project/list`
      *
      * List Projects
+     *
+     * @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
+     * @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
+     * @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?q=`.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `team_or_scope_required` (401) — Listing needs either a project in `x-faable-team` or a global scope on the token.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     projectList(params) {
         return this.paginator({ url: `/project`, params });
@@ -389,6 +930,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `DELETE /project/{id}/collaborator/{user_id}` — operationId: `project/removeCollaborator`
      *
      * Remove a collaborator from a project
+     *
+     * @throws {FaableApiError} `owner_not_removable` (400) — The project owner cannot be removed. Delete the project instead.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `superadmin_only` (403) — The operation is restricted to platform staff.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `collaborator_not_found` (404) — That user is not a collaborator on the project.
+     * @throws {FaableApiError} `project_not_found` (404) — No project with that id for this caller.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     projectRemoveCollaborator(id, user_id) {
         requireId("id", id);
@@ -399,6 +952,18 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `POST /project/{id}` — operationId: `project/update`
      *
      * Update Project
+     *
+     * @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
+     * @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists. `details.fields` names the field.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     projectUpdate(id, data) {
         requireId("id", id);
@@ -408,6 +973,16 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `POST /secret/createbatch` — operationId: `secrets/create_batch`
      *
      * Create secrets in batch
+     *
+     * Create a secrets in batch
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     secretsCreateBatch(data) {
         return this.fetcher.post(`/secret/createbatch`, data);
@@ -416,6 +991,17 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `DELETE /secret/{secret_id}` — operationId: `secrets/delete`
      *
      * Delete a secret
+     *
+     * @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `access_denied` (401) — The row exists but does not belong to the caller.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist, or not in the caller’s project.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     secretsDelete(secret_id) {
         requireId("secret_id", secret_id);
@@ -425,6 +1011,16 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /secret/{context_id}` — operationId: `secrets/list_app`
      *
      * List all secrets assigned to an App or Profile contexts
+     *
+     * List all app secrets assigned to an App or Profile contexts
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     secretsListApp(context_id, params) {
         requireId("context_id", context_id);
@@ -434,6 +1030,14 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `POST /secret` — operationId: `secrets/upsert`
      *
      * Upsert a secret
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     secretsUpsert(data) {
         return this.fetcher.post(`/secret`, data);
@@ -442,6 +1046,14 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /usage/summary` — operationId: `usage/summary`
      *
      * Get team usage summary for the current billing period
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     usageSummary(params) {
         return this.fetcher.request({ method: "GET", url: `/usage/summary`, params });
@@ -450,6 +1062,13 @@ export class GeneratedFaableDeployApi extends FaableApi {
      * `GET /usage/traffic` — operationId: `usage/traffic`
      *
      * Get metered traffic usage per team for the current period
+     *
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `invalid_token` (401) — The bearer token is missing, malformed or expired.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `user_suspended` (403) — The account is suspended. Contact support@faable.com.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     usageTraffic() {
         return this.fetcher.get(`/usage/traffic`);