@faable/auth-sdk 2.7.51 → 2.7.53

package/dist/FaableAuthApi.d.ts

@@ -58,6 +58,8 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
             verify_email_auto_send: boolean;
         };
         email_reply_to?: string | null | undefined;
+        email_from_name?: string | null | undefined;
+        email_from_address?: string | null | undefined;
         welcome_email?: {
             cta_url?: string | null | undefined;
             body?: string | null | undefined;

package/dist/api/api-types.d.ts

@@ -1,4 +1,6 @@
 import type { components } from "./types.js";
+export type AccountEmailSenderBody = components["schemas"]["AccountEmailSenderBody"];
+export type AccountEmailSenderParams = components["schemas"]["AccountEmailSenderParams"];
 export type AccountNotificationSettings = components["schemas"]["AccountNotificationSettings"];
 export type AccountTransferBody = components["schemas"]["AccountTransferBody"];
 export type AccountTransferResponse = components["schemas"]["AccountTransferResponse"];

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

@@ -28,6 +28,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
      * @throws {FaableApiError} `team_required` (400) — An Auth Account must belong to a project (team).
      * @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} `invalid_name` (400) — The name contains a link. `message` says which 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.
@@ -56,6 +57,8 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
             verify_email_auto_send: boolean;
         };
         email_reply_to?: string | null | undefined;
+        email_from_name?: string | null | undefined;
+        email_from_address?: string | null | undefined;
         welcome_email?: {
             cta_url?: string | null | undefined;
             body?: string | null | undefined;
@@ -131,6 +134,8 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
             verify_email_auto_send: boolean;
         };
         email_reply_to?: string | null | undefined;
+        email_from_name?: string | null | undefined;
+        email_from_address?: string | null | undefined;
         welcome_email?: {
             cta_url?: string | null | undefined;
             body?: string | null | undefined;
@@ -190,6 +195,84 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
      * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
      */
     accountDelete(account_id: string): Promise<void>;
+    /**
+     * `POST /account/{account_id}/email_sender` — operationId: `account/email_sender`
+     *
+     * Set an Account's sender address
+     *
+     * Sets the From address of every email this Auth Account sends to its users. The address must be in a domain the platform signs email for. `null` returns to the platform default. Platform credentials only.
+     *
+     * @throws {FaableApiError} `email_sender_domain_not_allowed` (400) — The sender address is not in a domain this platform signs email for (AUTH_EMAIL_SENDER_DOMAINS).
+     * @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.
+     */
+    accountEmailSender(account_id: string, data: OpBody<"account/email_sender">): Promise<{
+        id: string;
+        name: string;
+        domain: string;
+        slug: string;
+        logo_src?: string | null | undefined;
+        icon_src?: string | null | undefined;
+        callback_hostnames: string[];
+        token_signature: string;
+        token_signing_alg: "RS256";
+        default_connection?: unknown;
+        enabled_locales: string[];
+        tags?: string[] | undefined;
+        team?: string | null | undefined;
+        notification_settings: {
+            welcome_email_enabled: boolean;
+            verify_email_auto_send: boolean;
+        };
+        email_reply_to?: string | null | undefined;
+        email_from_name?: string | null | undefined;
+        email_from_address?: string | null | undefined;
+        welcome_email?: {
+            cta_url?: string | null | undefined;
+            body?: string | null | undefined;
+            social_links?: {
+                label: string;
+                url: string;
+            }[] | null | undefined;
+        } | null | undefined;
+        email_change_verification_mode?: "new_only" | "old_and_new" | undefined;
+        email_oauth_sync_policy?: "preserve_manual" | "always_sync" | undefined;
+        login_methods?: {
+            order?: string[] | undefined;
+            disabled_connections?: string[] | undefined;
+            passkey_login_enabled?: boolean | undefined;
+            identifier_first?: boolean | undefined;
+            remember_last_method?: boolean | undefined;
+            passkey_promotion?: "offer" | "off" | undefined;
+            passkey_promotion_snooze_days?: number | undefined;
+            passkey_promotion_max_prompts?: number | undefined;
+            remember_me?: "optional" | "off" | undefined;
+            remember_me_days?: number | undefined;
+        } | undefined;
+        login_flow?: string | null | undefined;
+        mfa_policy?: {
+            mode?: "required" | "optional" | "off" | undefined;
+            allowed_factors?: ("webauthn" | "totp")[] | undefined;
+            remember_device_days?: number | undefined;
+        } | undefined;
+        recovery_channels?: {
+            enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
+            default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
+            visible?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
+        } | undefined;
+        default_country_iso?: string | null | undefined;
+        webauthn_rp_id?: string | null | undefined;
+        logout_confirm_required?: boolean | undefined;
+        canonical_host?: string | null | undefined;
+        createdAt: string;
+        updatedAt?: string | undefined;
+    }>;
     /**
      * `GET /account/{account_id}` — operationId: `account/get`
      *
@@ -228,6 +311,8 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
             verify_email_auto_send: boolean;
         };
         email_reply_to?: string | null | undefined;
+        email_from_name?: string | null | undefined;
+        email_from_address?: string | null | undefined;
         welcome_email?: {
             cta_url?: string | null | undefined;
             body?: string | null | undefined;
@@ -327,6 +412,8 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
                 verify_email_auto_send: boolean;
             };
             email_reply_to?: string | null | undefined;
+            email_from_name?: string | null | undefined;
+            email_from_address?: string | null | undefined;
             welcome_email?: {
                 cta_url?: string | null | undefined;
                 body?: string | null | undefined;
@@ -386,6 +473,8 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
                 verify_email_auto_send: boolean;
             };
             email_reply_to?: string | null | undefined;
+            email_from_name?: string | null | undefined;
+            email_from_address?: string | null | undefined;
             welcome_email?: {
                 cta_url?: string | null | undefined;
                 body?: string | null | undefined;
@@ -448,6 +537,8 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
                 verify_email_auto_send: boolean;
             };
             email_reply_to?: string | null | undefined;
+            email_from_name?: string | null | undefined;
+            email_from_address?: string | null | undefined;
             welcome_email?: {
                 cta_url?: string | null | undefined;
                 body?: string | null | undefined;
@@ -652,6 +743,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
      * @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} `invalid_name` (400) — The name contains a link. `message` says which 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.
@@ -681,6 +773,8 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
             verify_email_auto_send: boolean;
         };
         email_reply_to?: string | null | undefined;
+        email_from_name?: string | null | undefined;
+        email_from_address?: string | null | undefined;
         welcome_email?: {
             cta_url?: string | null | undefined;
             body?: string | null | undefined;
@@ -5318,6 +5412,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
      * @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} `invalid_phone` (400) — The phone number is not E.164 and could not be resolved with the account default country. Include the country code.
+     * @throws {FaableApiError} `invalid_name` (400) — The name contains a link. `message` says which 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.
@@ -5973,6 +6068,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
      * @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} `invalid_phone` (400) — The phone number is not E.164 and could not be resolved with the account default country. Include the country code.
+     * @throws {FaableApiError} `invalid_name` (400) — The name contains a link. `message` says which 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.

package/dist/api/generated-client.js

@@ -19,6 +19,7 @@ export class GeneratedFaableAuthApi extends FaableApi {
      * @throws {FaableApiError} `team_required` (400) — An Auth Account must belong to a project (team).
      * @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} `invalid_name` (400) — The name contains a link. `message` says which 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.
@@ -72,6 +73,27 @@ export class GeneratedFaableAuthApi extends FaableApi {
         requireId("account_id", account_id);
         return this.fetcher.delete(`/account/${account_id}`);
     }
+    /**
+     * `POST /account/{account_id}/email_sender` — operationId: `account/email_sender`
+     *
+     * Set an Account's sender address
+     *
+     * Sets the From address of every email this Auth Account sends to its users. The address must be in a domain the platform signs email for. `null` returns to the platform default. Platform credentials only.
+     *
+     * @throws {FaableApiError} `email_sender_domain_not_allowed` (400) — The sender address is not in a domain this platform signs email for (AUTH_EMAIL_SENDER_DOMAINS).
+     * @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.
+     */
+    accountEmailSender(account_id, data) {
+        requireId("account_id", account_id);
+        return this.fetcher.post(`/account/${account_id}/email_sender`, data);
+    }
     /**
      * `GET /account/{account_id}` — operationId: `account/get`
      *
@@ -226,6 +248,7 @@ export class GeneratedFaableAuthApi extends FaableApi {
      * @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} `invalid_name` (400) — The name contains a link. `message` says which 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.
@@ -2036,6 +2059,7 @@ export class GeneratedFaableAuthApi extends FaableApi {
      * @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} `invalid_phone` (400) — The phone number is not E.164 and could not be resolved with the account default country. Include the country code.
+     * @throws {FaableApiError} `invalid_name` (400) — The name contains a link. `message` says which 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.
@@ -2284,6 +2308,7 @@ export class GeneratedFaableAuthApi extends FaableApi {
      * @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} `invalid_phone` (400) — The phone number is not E.164 and could not be resolved with the account default country. Include the country code.
+     * @throws {FaableApiError} `invalid_name` (400) — The name contains a link. `message` says which 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.