@zyphr-dev/node-sdk 0.1.55 → 0.1.56

package/dist/index.d.cts

@@ -9512,6 +9512,29 @@ 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;
 }
 /**
  * Check if a given object implements the InviteEndUser200ResponseData interface.
@@ -26837,7 +26860,7 @@ interface AuthPasswordResetApiValidateResetTokenOperationRequest {
  */
 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.
@@ -26846,7 +26869,7 @@ interface AuthPasswordResetApiInterface {
      */
     forgotPasswordRaw(requestParameters: AuthPasswordResetApiForgotPasswordOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<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 | InitOverrideFunction): Promise<SuccessResult>;
@@ -26884,12 +26907,12 @@ interface AuthPasswordResetApiInterface {
  */
 declare class AuthPasswordResetApi extends 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
      */
     forgotPasswordRaw(requestParameters: AuthPasswordResetApiForgotPasswordOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<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 | InitOverrideFunction): Promise<SuccessResult>;

package/dist/index.d.ts

@@ -9512,6 +9512,29 @@ 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;
 }
 /**
  * Check if a given object implements the InviteEndUser200ResponseData interface.
@@ -26837,7 +26860,7 @@ interface AuthPasswordResetApiValidateResetTokenOperationRequest {
  */
 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.
@@ -26846,7 +26869,7 @@ interface AuthPasswordResetApiInterface {
      */
     forgotPasswordRaw(requestParameters: AuthPasswordResetApiForgotPasswordOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<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 | InitOverrideFunction): Promise<SuccessResult>;
@@ -26884,12 +26907,12 @@ interface AuthPasswordResetApiInterface {
  */
 declare class AuthPasswordResetApi extends 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
      */
     forgotPasswordRaw(requestParameters: AuthPasswordResetApiForgotPasswordOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<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 | InitOverrideFunction): Promise<SuccessResult>;

package/dist/index.js

@@ -6461,7 +6461,8 @@ function InviteEndUser200ResponseDataFromJSONTyped(json, ignoreDiscriminator) {
   return {
     "userId": json["user_id"] == null ? void 0 : json["user_id"],
     "created": json["created"] == null ? void 0 : json["created"],
-    "linkSent": json["link_sent"] == null ? void 0 : json["link_sent"]
+    "linkSent": json["link_sent"] == null ? void 0 : json["link_sent"],
+    "linkSuppressedReason": json["link_suppressed_reason"] == null ? void 0 : json["link_suppressed_reason"]
   };
 }
 function InviteEndUser200ResponseDataToJSON(json) {
@@ -6474,7 +6475,8 @@ function InviteEndUser200ResponseDataToJSONTyped(value, ignoreDiscriminator = fa
   return {
     "user_id": value["userId"],
     "created": value["created"],
-    "link_sent": value["linkSent"]
+    "link_sent": value["linkSent"],
+    "link_suppressed_reason": value["linkSuppressedReason"]
   };
 }
 
@@ -18999,7 +19001,7 @@ var AuthOrganizationsApi = class extends BaseAPI {
 // src/src/apis/AuthPasswordResetApi.ts
 var AuthPasswordResetApi = class extends BaseAPI {
   /**
-   * 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, initOverrides) {
@@ -19028,7 +19030,7 @@ var AuthPasswordResetApi = class extends BaseAPI {
     return new JSONApiResponse(response, (jsonValue) => SuccessResultFromJSON(jsonValue));
   }
   /**
-   * 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, initOverrides) {