@faable/auth-sdk 2.7.82 → 2.7.84

package/dist/FaableAuthApi.d.ts

@@ -621,6 +621,7 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
             jwks_url: string;
             response_type: string;
             enabled: boolean;
+            organization?: string | null | undefined;
             enabled_clients: string[] | null;
             scope: string[];
             authorize_params: {
@@ -661,6 +662,7 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
             jwks_url: string;
             response_type: string;
             enabled: boolean;
+            organization?: string | null | undefined;
             enabled_clients: string[] | null;
             scope: string[];
             authorize_params: {
@@ -704,6 +706,7 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
             jwks_url: string;
             response_type: string;
             enabled: boolean;
+            organization?: string | null | undefined;
             enabled_clients: string[] | null;
             scope: string[];
             authorize_params: {
@@ -746,6 +749,7 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
         jwks_url: string;
         response_type: string;
         enabled: boolean;
+        organization?: string | null | undefined;
         enabled_clients: string[] | null;
         scope: string[];
         authorize_params: {

package/dist/api/generated-client.d.ts

@@ -1944,6 +1944,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
         jwks_url: string;
         response_type: string;
         enabled: boolean;
+        organization?: string | null | undefined;
         enabled_clients: string[] | null;
         scope: string[];
         authorize_params: {
@@ -2000,6 +2001,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
         jwks_url: string;
         response_type: string;
         enabled: boolean;
+        organization?: string | null | undefined;
         enabled_clients: string[] | null;
         scope: string[];
         authorize_params: {
@@ -2057,6 +2059,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
         jwks_url: string;
         response_type: string;
         enabled: boolean;
+        organization?: string | null | undefined;
         enabled_clients: string[] | null;
         scope: string[];
         authorize_params: {
@@ -2115,6 +2118,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
             jwks_url: string;
             response_type: string;
             enabled: boolean;
+            organization?: string | null | undefined;
             enabled_clients: string[] | null;
             scope: string[];
             authorize_params: {
@@ -2155,6 +2159,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
             jwks_url: string;
             response_type: string;
             enabled: boolean;
+            organization?: string | null | undefined;
             enabled_clients: string[] | null;
             scope: string[];
             authorize_params: {
@@ -2198,6 +2203,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
             jwks_url: string;
             response_type: string;
             enabled: boolean;
+            organization?: string | null | undefined;
             enabled_clients: string[] | null;
             scope: string[];
             authorize_params: {
@@ -2256,6 +2262,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
         jwks_url: string;
         response_type: string;
         enabled: boolean;
+        organization?: string | null | undefined;
         enabled_clients: string[] | null;
         scope: string[];
         authorize_params: {
@@ -4501,6 +4508,57 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
         slug: string;
         description: string | null;
         logo_url: string | null;
+        domains: {
+            domain: string;
+            verification_token: string;
+            verified_at: string | null;
+        }[];
+        auto_join: {
+            team: string;
+            roles: string[];
+        }[];
+        admins: string[];
+        account: string;
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string | undefined;
+    }>;
+    /**
+     * `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: string, data: OpBody<"organization/addDomain">): Promise<{
+        id: string;
+        name: string;
+        slug: string;
+        description: string | null;
+        logo_url: string | null;
+        domains: {
+            domain: string;
+            verification_token: string;
+            verified_at: string | null;
+        }[];
+        auto_join: {
+            team: string;
+            roles: string[];
+        }[];
         admins: string[];
         account: string;
         metadata: {
@@ -4530,6 +4588,15 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
         slug: string;
         description: string | null;
         logo_url: string | null;
+        domains: {
+            domain: string;
+            verification_token: string;
+            verified_at: string | null;
+        }[];
+        auto_join: {
+            team: string;
+            roles: string[];
+        }[];
         admins: string[];
         account: string;
         metadata: {
@@ -4560,6 +4627,15 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
         slug: string;
         description: string | null;
         logo_url: string | null;
+        domains: {
+            domain: string;
+            verification_token: string;
+            verified_at: string | null;
+        }[];
+        auto_join: {
+            team: string;
+            roles: string[];
+        }[];
         admins: string[];
         account: string;
         metadata: {
@@ -4591,6 +4667,15 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
         slug: string;
         description: string | null;
         logo_url: string | null;
+        domains: {
+            domain: string;
+            verification_token: string;
+            verified_at: string | null;
+        }[];
+        auto_join: {
+            team: string;
+            roles: string[];
+        }[];
         admins: string[];
         account: string;
         metadata: {
@@ -4623,6 +4708,15 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
             slug: string;
             description: string | null;
             logo_url: string | null;
+            domains: {
+                domain: string;
+                verification_token: string;
+                verified_at: string | null;
+            }[];
+            auto_join: {
+                team: string;
+                roles: string[];
+            }[];
             admins: string[];
             account: string;
             metadata: {
@@ -4637,6 +4731,15 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
             slug: string;
             description: string | null;
             logo_url: string | null;
+            domains: {
+                domain: string;
+                verification_token: string;
+                verified_at: string | null;
+            }[];
+            auto_join: {
+                team: string;
+                roles: string[];
+            }[];
             admins: string[];
             account: string;
             metadata: {
@@ -4654,6 +4757,15 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
             slug: string;
             description: string | null;
             logo_url: string | null;
+            domains: {
+                domain: string;
+                verification_token: string;
+                verified_at: string | null;
+            }[];
+            auto_join: {
+                team: string;
+                roles: string[];
+            }[];
             admins: string[];
             account: string;
             metadata: {
@@ -4688,6 +4800,56 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
         slug: string;
         description: string | null;
         logo_url: string | null;
+        domains: {
+            domain: string;
+            verification_token: string;
+            verified_at: string | null;
+        }[];
+        auto_join: {
+            team: string;
+            roles: string[];
+        }[];
+        admins: string[];
+        account: string;
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string | undefined;
+    }>;
+    /**
+     * `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: string, domain: string): Promise<{
+        id: string;
+        name: string;
+        slug: string;
+        description: string | null;
+        logo_url: string | null;
+        domains: {
+            domain: string;
+            verification_token: string;
+            verified_at: string | null;
+        }[];
+        auto_join: {
+            team: string;
+            roles: string[];
+        }[];
         admins: string[];
         account: string;
         metadata: {
@@ -4719,6 +4881,15 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
         slug: string;
         description: string | null;
         logo_url: string | null;
+        domains: {
+            domain: string;
+            verification_token: string;
+            verified_at: string | null;
+        }[];
+        auto_join: {
+            team: string;
+            roles: string[];
+        }[];
         admins: string[];
         account: string;
         metadata: {
@@ -4727,6 +4898,62 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
         createdAt: string;
         updatedAt?: string | undefined;
     }>;
+    /**
+     * `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: string, domain: string): Promise<{
+        organization: {
+            id: string;
+            name: string;
+            slug: string;
+            description: string | null;
+            logo_url: string | null;
+            domains: {
+                domain: string;
+                verification_token: string;
+                verified_at: string | null;
+            }[];
+            auto_join: {
+                team: string;
+                roles: string[];
+            }[];
+            admins: string[];
+            account: string;
+            metadata: {
+                [key: string]: unknown;
+            };
+            createdAt: string;
+            updatedAt?: string | undefined;
+        };
+        record: {
+            type: "TXT";
+            host: string;
+            expected: string;
+            observed: string[];
+            ok: boolean;
+        } | null;
+    }>;
     /**
      * `POST /role/{role_id}/users` — operationId: `role/assign_users`
      *

package/dist/api/generated-client.js

@@ -1556,6 +1556,29 @@ export class GeneratedFaableAuthApi extends FaableApi {
         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`
      *
@@ -1659,6 +1682,29 @@ export class GeneratedFaableAuthApi extends FaableApi {
         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`
      *
@@ -1680,6 +1726,35 @@ export class GeneratedFaableAuthApi extends FaableApi {
         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`
      *