@zyphr-dev/node-sdk 0.1.55 → 0.1.56

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zyphr-dev/node-sdk",
-  "version": "0.1.55",
+  "version": "0.1.56",
   "description": "Official Zyphr SDK for Node.js, React, and React Native",
   "type": "module",
   "main": "./dist/index.cjs",

package/src/src/apis/AuthPasswordResetApi.ts

@@ -60,7 +60,7 @@ export interface AuthPasswordResetApiValidateResetTokenOperationRequest {
  */
 export interface AuthPasswordResetApiInterface {
     /**
-     * Request a password reset email. Creates a reset token and sends an email to the user. Always returns success to prevent email enumeration.
+     * Request a password reset email. Creates a reset token and sends an email to the user. Always returns success to prevent email enumeration — the response is identical whether or not the address is registered.  An identity with **no password set** still receives a link, which sets a first password. This covers users migrated from a provider that cannot export password hashes.  The one case where no email is sent (beyond an unknown address) is an identity that has no password but *does* have another way in — a linked OAuth provider and/or a passkey. Those users are not locked out, so no set-password link is sent; the attempt is recorded as a suppressed message visible via `GET /emails`. 
      * @summary Request a password reset
      * @param {ForgotPasswordRequest} forgotPasswordRequest 
      * @param {*} [options] Override http request option.
@@ -70,7 +70,7 @@ export interface AuthPasswordResetApiInterface {
     forgotPasswordRaw(requestParameters: AuthPasswordResetApiForgotPasswordOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessResult>>;
 
     /**
-     * Request a password reset email. Creates a reset token and sends an email to the user. Always returns success to prevent email enumeration.
+     * Request a password reset email. Creates a reset token and sends an email to the user. Always returns success to prevent email enumeration — the response is identical whether or not the address is registered.  An identity with **no password set** still receives a link, which sets a first password. This covers users migrated from a provider that cannot export password hashes.  The one case where no email is sent (beyond an unknown address) is an identity that has no password but *does* have another way in — a linked OAuth provider and/or a passkey. Those users are not locked out, so no set-password link is sent; the attempt is recorded as a suppressed message visible via `GET /emails`. 
      * Request a password reset
      */
     forgotPassword(forgotPasswordRequest: ForgotPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessResult>;
@@ -115,7 +115,7 @@ export interface AuthPasswordResetApiInterface {
 export class AuthPasswordResetApi extends runtime.BaseAPI implements AuthPasswordResetApiInterface {
 
     /**
-     * Request a password reset email. Creates a reset token and sends an email to the user. Always returns success to prevent email enumeration.
+     * Request a password reset email. Creates a reset token and sends an email to the user. Always returns success to prevent email enumeration — the response is identical whether or not the address is registered.  An identity with **no password set** still receives a link, which sets a first password. This covers users migrated from a provider that cannot export password hashes.  The one case where no email is sent (beyond an unknown address) is an identity that has no password but *does* have another way in — a linked OAuth provider and/or a passkey. Those users are not locked out, so no set-password link is sent; the attempt is recorded as a suppressed message visible via `GET /emails`. 
      * Request a password reset
      */
     async forgotPasswordRaw(requestParameters: AuthPasswordResetApiForgotPasswordOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessResult>> {
@@ -152,7 +152,7 @@ export class AuthPasswordResetApi extends runtime.BaseAPI implements AuthPasswor
     }
 
     /**
-     * Request a password reset email. Creates a reset token and sends an email to the user. Always returns success to prevent email enumeration.
+     * Request a password reset email. Creates a reset token and sends an email to the user. Always returns success to prevent email enumeration — the response is identical whether or not the address is registered.  An identity with **no password set** still receives a link, which sets a first password. This covers users migrated from a provider that cannot export password hashes.  The one case where no email is sent (beyond an unknown address) is an identity that has no password but *does* have another way in — a linked OAuth provider and/or a passkey. Those users are not locked out, so no set-password link is sent; the attempt is recorded as a suppressed message visible via `GET /emails`. 
      * Request a password reset
      */
     async forgotPassword(forgotPasswordRequest: ForgotPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessResult> {

package/src/src/models/InviteEndUser200ResponseData.ts

@@ -37,6 +37,29 @@ export interface InviteEndUser200ResponseData {
      * @memberof InviteEndUser200ResponseData
      */
     linkSent?: boolean;
+    /**
+     * Present only when `send_link` was requested and `link_sent` is false — explains why,
+     * so a caller can distinguish "suppressed by design" from "delivery failed".
+     * 
+     * Known values:
+     * 
+     * - `identity_has_other_auth_methods` — the identity has no password but does have a
+     *   linked OAuth provider and/or a passkey, so it is not locked out and no
+     *   set-password link is sent. The attempt is recorded as a suppressed message,
+     *   visible via `GET /emails`.
+     * - `user_not_found_in_environment` — the identity could not be resolved in the
+     *   calling environment (a race; it was created or resolved immediately prior).
+     * - `recipient_not_allowlisted` — the application's `test_recipients` allowlist
+     *   blocked the recipient.
+     * - `send_failed` — dispatch was attempted and failed with no more specific code.
+     * 
+     * Not a closed set: a mail-provider error code may be surfaced verbatim, so treat
+     * an unrecognised value as a generic failure rather than an error.
+     * 
+     * @type {string}
+     * @memberof InviteEndUser200ResponseData
+     */
+    linkSuppressedReason?: string;
 }
 
 /**
@@ -59,6 +82,7 @@ export function InviteEndUser200ResponseDataFromJSONTyped(json: any, ignoreDiscr
         'userId': json['user_id'] == null ? undefined : json['user_id'],
         'created': json['created'] == null ? undefined : json['created'],
         'linkSent': json['link_sent'] == null ? undefined : json['link_sent'],
+        'linkSuppressedReason': json['link_suppressed_reason'] == null ? undefined : json['link_suppressed_reason'],
     };
 }
 
@@ -76,6 +100,7 @@ export function InviteEndUser200ResponseDataToJSONTyped(value?: InviteEndUser200
         'user_id': value['userId'],
         'created': value['created'],
         'link_sent': value['linkSent'],
+        'link_suppressed_reason': value['linkSuppressedReason'],
     };
 }