@faable/auth-sdk 2.7.81 → 2.7.83

package/dist/api/generated-client.js

@@ -1534,6 +1534,227 @@ export class GeneratedFaableAuthApi extends FaableApi {
         requireId("notificationsubscription_id", notificationsubscription_id);
         return this.fetcher.post(`/notificationsubscription/${notificationsubscription_id}`, data);
     }
+    /**
+     * `POST /organization/{organization_id}/admin` — operationId: `organization/addAdmin`
+     *
+     * Add an admin to an Organization
+     *
+     * Makes a user of this tenant an admin of the Organization. Idempotent. Being an admin does not grant access to any team of the organization. Emits `organization.updated`.
+     *
+     * @throws {FaableApiError} `invalid_user` (400) — The user does not exist in this account.
+     * @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} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
+     * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
+     * @throws {FaableApiError} `organization_not_found` (404) — No organization with that id in this account.
+     * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
+     * @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.
+     */
+    organizationAddAdmin(organization_id, data) {
+        requireId("organization_id", organization_id);
+        return this.fetcher.post(`/organization/${organization_id}/admin`, data);
+    }
+    /**
+     * `POST /organization/{organization_id}/domain` — operationId: `organization/addDomain`
+     *
+     * Claim an email domain for an Organization
+     *
+     * Adds the domain unverified, with the `verification_token` its TXT record must hold. Idempotent. Nothing changes for anyone until the domain is verified.
+     *
+     * @throws {FaableApiError} `invalid_email_domain` (400) — Not an email domain this organization can claim: it must be a plain domain name (`acme.com`), lowercase, without scheme, path or wildcard.
+     * @throws {FaableApiError} `public_email_domain` (400) — A public email provider (gmail.com, outlook.com…) cannot belong to an organization: anyone can have an address there.
+     * @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} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
+     * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
+     * @throws {FaableApiError} `organization_not_found` (404) — No organization with that id in this account.
+     * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
+     * @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.
+     */
+    organizationAddDomain(organization_id, data) {
+        requireId("organization_id", organization_id);
+        return this.fetcher.post(`/organization/${organization_id}/domain`, data);
+    }
+    /**
+     * `POST /organization` — operationId: `organization/create`
+     *
+     * Create Organization
+     *
+     * @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `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} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
+     * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
+     * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
+     * @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.
+     */
+    organizationCreate(data) {
+        return this.fetcher.post(`/organization`, data);
+    }
+    /**
+     * `DELETE /organization/{organization_id}` — operationId: `organization/delete`
+     *
+     * Delete Organization
+     *
+     * @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} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
+     * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
+     * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
+     * @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.
+     */
+    organizationDelete(organization_id) {
+        requireId("organization_id", organization_id);
+        return this.fetcher.delete(`/organization/${organization_id}`);
+    }
+    /**
+     * `GET /organization/{organization_id}` — operationId: `organization/get`
+     *
+     * Get Organization
+     *
+     * @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} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
+     * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
+     * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
+     * @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.
+     */
+    organizationGet(organization_id) {
+        requireId("organization_id", organization_id);
+        return this.fetcher.get(`/organization/${organization_id}`);
+    }
+    /**
+     * `GET /organization` — operationId: `organization/list`
+     *
+     * List Organizations
+     *
+     * @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 `?search=`.
+     * @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} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
+     * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
+     * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
+     * @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.
+     */
+    organizationList(params) {
+        return this.paginator({ url: `/organization`, params });
+    }
+    /**
+     * `DELETE /organization/{organization_id}/admin/{user_id}` — operationId: `organization/removeAdmin`
+     *
+     * Remove an admin from an Organization
+     *
+     * Removes the user from the admins of the Organization (the user is not deleted). An organization keeps at least one admin: removing the last one is `last_organization_admin`. Emits `organization.updated`.
+     *
+     * @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} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
+     * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
+     * @throws {FaableApiError} `organization_not_found` (404) — No organization with that id in this account.
+     * @throws {FaableApiError} `not_an_organization_admin` (404) — The user is not an admin of the organization.
+     * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
+     * @throws {FaableApiError} `last_organization_admin` (409) — An organization keeps at least one admin. Add another admin before removing this one.
+     * @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.
+     */
+    organizationRemoveAdmin(organization_id, user_id) {
+        requireId("organization_id", organization_id);
+        requireId("user_id", user_id);
+        return this.fetcher.delete(`/organization/${organization_id}/admin/${user_id}`);
+    }
+    /**
+     * `DELETE /organization/{organization_id}/domain/{domain}` — operationId: `organization/removeDomain`
+     *
+     * Remove an email domain from an Organization
+     *
+     * Removes the domain, verified or not. Logins of people already in the organization are unaffected.
+     *
+     * @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} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
+     * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
+     * @throws {FaableApiError} `organization_not_found` (404) — No organization with that id in this account.
+     * @throws {FaableApiError} `organization_domain_not_found` (404) — The organization has no such domain.
+     * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
+     * @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.
+     */
+    organizationRemoveDomain(organization_id, domain) {
+        requireId("organization_id", organization_id);
+        requireId("domain", domain);
+        return this.fetcher.delete(`/organization/${organization_id}/domain/${domain}`);
+    }
+    /**
+     * `POST /organization/{organization_id}` — operationId: `organization/update`
+     *
+     * Update Organization
+     *
+     * @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 (for a user, usually `email`). `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} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
+     * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
+     * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
+     * @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.
+     */
+    organizationUpdate(organization_id, data) {
+        requireId("organization_id", organization_id);
+        return this.fetcher.post(`/organization/${organization_id}`, data);
+    }
+    /**
+     * `POST /organization/{organization_id}/domain/{domain}/verify` — operationId: `organization/verifyDomain`
+     *
+     * Verify an Organization's email domain
+     *
+     * Looks up the TXT record `_faable-challenge.<domain>` and, when it holds `faable-verification=<verification_token>`, marks the domain verified. Pro plan (`plan_required`; `plan_unavailable` when the plan cannot be checked). A domain is verified by one organization of the tenant at most (`organization_domain_taken`).
+     *
+     * @throws {FaableApiError} `organization_domain_unverified` (400) — The TXT record was not found or does not hold the expected value yet. `details.record` says what was expected and what resolves now; DNS can take a few minutes to propagate.
+     * @throws {FaableApiError} `invalid_email_domain` (400) — Not an email domain this organization can claim: it must be a plain domain name (`acme.com`), lowercase, without scheme, path or wildcard.
+     * @throws {FaableApiError} `public_email_domain` (400) — A public email provider (gmail.com, outlook.com…) cannot belong to an organization: anyone can have an address there.
+     * @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} `plan_required` (402) — The setting requires a higher plan. `message` says which.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
+     * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
+     * @throws {FaableApiError} `organization_not_found` (404) — No organization with that id in this account.
+     * @throws {FaableApiError} `organization_domain_not_found` (404) — The organization has no such domain.
+     * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
+     * @throws {FaableApiError} `organization_domain_taken` (409) — Another organization of this tenant already verified this domain. A domain belongs to one organization.
+     * @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} `plan_unavailable` (503) — The plan could not be checked right now, and this setting is only for paid plans. Try again in a minute.
+     */
+    organizationVerifyDomain(organization_id, domain) {
+        requireId("organization_id", organization_id);
+        requireId("domain", domain);
+        return this.fetcher.post(`/organization/${organization_id}/domain/${domain}/verify`, {});
+    }
     /**
      * `POST /role/{role_id}/users` — operationId: `role/assign_users`
      *