@faable/auth-sdk 2.7.75 → 2.7.77

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

@@ -447,6 +447,23 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
                 default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
                 visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
             } | undefined;
+            /**
+             * `GET /user/export` — operationId: `user/export`
+             *
+             * Export users, optionally with their password hashes
+             *
+             * Pages through every user of the tenant, 500 at a time, in the row shape `POST /user/import` takes. With `include_hashes` each row carries its `password_hash` (needs the `read:password_hashes` scope, is audited as `credentials.exported` and notifies its subscribers). Provider access and refresh tokens of linked identities are never exported. Available on every plan.
+             *
+             * @throws {FaableApiError} `invalid_connection` (400) — The connection does not exist, is disabled, or is not of the type this flow needs.
+             * @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.
+             */
             default_country_iso?: string | null | undefined;
             webauthn_rp_id?: string | null | undefined;
             logout_confirm_required?: boolean | undefined;
@@ -508,6 +525,23 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
                 default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
                 visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
             } | undefined;
+            /**
+             * `GET /user/export` — operationId: `user/export`
+             *
+             * Export users, optionally with their password hashes
+             *
+             * Pages through every user of the tenant, 500 at a time, in the row shape `POST /user/import` takes. With `include_hashes` each row carries its `password_hash` (needs the `read:password_hashes` scope, is audited as `credentials.exported` and notifies its subscribers). Provider access and refresh tokens of linked identities are never exported. Available on every plan.
+             *
+             * @throws {FaableApiError} `invalid_connection` (400) — The connection does not exist, is disabled, or is not of the type this flow needs.
+             * @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.
+             */
             default_country_iso?: string | null | undefined;
             webauthn_rp_id?: string | null | undefined;
             logout_confirm_required?: boolean | undefined;
@@ -572,6 +606,23 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
                 default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
                 visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
             } | undefined;
+            /**
+             * `GET /user/export` — operationId: `user/export`
+             *
+             * Export users, optionally with their password hashes
+             *
+             * Pages through every user of the tenant, 500 at a time, in the row shape `POST /user/import` takes. With `include_hashes` each row carries its `password_hash` (needs the `read:password_hashes` scope, is audited as `credentials.exported` and notifies its subscribers). Provider access and refresh tokens of linked identities are never exported. Available on every plan.
+             *
+             * @throws {FaableApiError} `invalid_connection` (400) — The connection does not exist, is disabled, or is not of the type this flow needs.
+             * @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.
+             */
             default_country_iso?: string | null | undefined;
             webauthn_rp_id?: string | null | undefined;
             logout_confirm_required?: boolean | undefined;
@@ -4969,7 +5020,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
      *
      * Accept a team invite for a signed-in user
      *
-     * Accepts the invite whose secret is `token` on behalf of `user_id`, an existing user of this tenant. The user's email must be verified and equal to the invited one (`invite_email_mismatch` otherwise, with the invited address masked in `details`). Never creates a user. Use it from the page you gave as the invite's `accept_url`.
+     * Accepts the invite — by the `token` of its link, or by `invite_id` — on behalf of `user_id`, an existing user of this tenant. The user's email must be verified and equal to the invited one (`invite_email_mismatch` otherwise, with the invited address masked in `details`). Never creates a user. Use `token` from the page you gave as the invite's `accept_url`, and `invite_id` from a pending-invitation notice in your app.
      *
      * @throws {FaableApiError} `invalid_ticket` (400) — The ticket does not exist or is not the kind this endpoint accepts.
      * @throws {FaableApiError} `ticket_used` (400) — The ticket was already consumed.
@@ -5080,6 +5131,31 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
         createdAt: string;
         updatedAt?: string | undefined;
     }>;
+    /**
+     * `POST /team/invite/decline` — operationId: `team/declineInvite`
+     *
+     * Decline a team invite for a signed-in user
+     *
+     * The invited user says no: the invite is spent (its link stops working) and `team.invite.revoked` is emitted with reason `declined`. Same checks as accepting.
+     *
+     * @throws {FaableApiError} `invalid_ticket` (400) — The ticket does not exist or is not the kind this endpoint accepts.
+     * @throws {FaableApiError} `ticket_used` (400) — The ticket was already consumed.
+     * @throws {FaableApiError} `ticket_expired` (400) — The ticket is past its expiry.
+     * @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} `invite_email_mismatch` (403) — The invite is for another email address than the accepting user's. `details.invited_email` shows it masked.
+     * @throws {FaableApiError} `invite_email_unverified` (403) — The accepting user's email matches the invite but is not verified yet.
+     * @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.
+     */
+    teamDeclineInvite(data: OpBody<"team/declineInvite">): Promise<{
+        status: "declined";
+    }>;
     /**
      * `DELETE /team/{team_id}` — operationId: `team/delete`
      *
@@ -5270,6 +5346,42 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
             updatedAt?: string | undefined;
         }[];
     }>;
+    /**
+     * `GET /user/{user_id}/team-invites` — operationId: `team/listInvitesForUser`
+     *
+     * List a user's pending team invites
+     *
+     * Pending (not accepted, revoked, declined or expired) invites to any team of this tenant addressed to the user's email. Only when that email is verified; otherwise `email_verified: false` and an empty list.
+     *
+     * @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.
+     */
+    teamListInvitesForUser(user_id: string): Promise<{
+        email_verified: boolean;
+        data: {
+            id: string;
+            email: string;
+            team: string;
+            inviter?: string | undefined;
+            roles: string[];
+            mode: "auto" | "invite";
+            redirect_uri?: string | undefined;
+            expires_at: string;
+            consume_date?: string | undefined;
+            account: string;
+            metadata: {
+                [key: string]: unknown;
+            };
+            createdAt: string;
+            updatedAt?: string | undefined;
+        }[];
+    }>;
     /**
      * `GET /team/{team_id}/member` — operationId: `team/listMembers`
      *
@@ -5345,7 +5457,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
      * @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.
      */
-    teamRemoveMember(team_id: string, user_id: string): Promise<{
+    teamRemoveMember(team_id: string, user_id: string, params?: OpQuery<"team/removeMember">): Promise<{
         id: string;
         deleted: true;
     }>;

package/dist/api/generated-client.js

@@ -1802,7 +1802,7 @@ export class GeneratedFaableAuthApi extends FaableApi {
      *
      * Accept a team invite for a signed-in user
      *
-     * Accepts the invite whose secret is `token` on behalf of `user_id`, an existing user of this tenant. The user's email must be verified and equal to the invited one (`invite_email_mismatch` otherwise, with the invited address masked in `details`). Never creates a user. Use it from the page you gave as the invite's `accept_url`.
+     * Accepts the invite — by the `token` of its link, or by `invite_id` — on behalf of `user_id`, an existing user of this tenant. The user's email must be verified and equal to the invited one (`invite_email_mismatch` otherwise, with the invited address masked in `details`). Never creates a user. Use `token` from the page you gave as the invite's `accept_url`, and `invite_id` from a pending-invitation notice in your app.
      *
      * @throws {FaableApiError} `invalid_ticket` (400) — The ticket does not exist or is not the kind this endpoint accepts.
      * @throws {FaableApiError} `ticket_used` (400) — The ticket was already consumed.
@@ -1885,6 +1885,31 @@ export class GeneratedFaableAuthApi extends FaableApi {
     teamCreate(data) {
         return this.fetcher.post(`/team`, data);
     }
+    /**
+     * `POST /team/invite/decline` — operationId: `team/declineInvite`
+     *
+     * Decline a team invite for a signed-in user
+     *
+     * The invited user says no: the invite is spent (its link stops working) and `team.invite.revoked` is emitted with reason `declined`. Same checks as accepting.
+     *
+     * @throws {FaableApiError} `invalid_ticket` (400) — The ticket does not exist or is not the kind this endpoint accepts.
+     * @throws {FaableApiError} `ticket_used` (400) — The ticket was already consumed.
+     * @throws {FaableApiError} `ticket_expired` (400) — The ticket is past its expiry.
+     * @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} `invite_email_mismatch` (403) — The invite is for another email address than the accepting user's. `details.invited_email` shows it masked.
+     * @throws {FaableApiError} `invite_email_unverified` (403) — The accepting user's email matches the invite but is not verified yet.
+     * @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.
+     */
+    teamDeclineInvite(data) {
+        return this.fetcher.post(`/team/invite/decline`, data);
+    }
     /**
      * `DELETE /team/{team_id}` — operationId: `team/delete`
      *
@@ -1989,6 +2014,26 @@ export class GeneratedFaableAuthApi extends FaableApi {
         requireId("team_id", team_id);
         return this.fetcher.request({ method: "GET", url: `/team/${team_id}/invite`, params });
     }
+    /**
+     * `GET /user/{user_id}/team-invites` — operationId: `team/listInvitesForUser`
+     *
+     * List a user's pending team invites
+     *
+     * Pending (not accepted, revoked, declined or expired) invites to any team of this tenant addressed to the user's email. Only when that email is verified; otherwise `email_verified: false` and an empty list.
+     *
+     * @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.
+     */
+    teamListInvitesForUser(user_id) {
+        requireId("user_id", user_id);
+        return this.fetcher.get(`/user/${user_id}/team-invites`);
+    }
     /**
      * `GET /team/{team_id}/member` — operationId: `team/listMembers`
      *
@@ -2027,10 +2072,10 @@ export class GeneratedFaableAuthApi extends FaableApi {
      * @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.
      */
-    teamRemoveMember(team_id, user_id) {
+    teamRemoveMember(team_id, user_id, params) {
         requireId("team_id", team_id);
         requireId("user_id", user_id);
-        return this.fetcher.delete(`/team/${team_id}/member/${user_id}`);
+        return this.fetcher.request({ method: "DELETE", url: `/team/${team_id}/member/${user_id}`, params });
     }
     /**
      * `DELETE /team/{team_id}/invite/{ticket_id}` — operationId: `team/revokeInvite`