zyphr 0.1.55 → 0.1.57

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78bb305af68d19bf367f4a1dfd0947fe5a83e2b339f3477abb2d123608ccf627
-  data.tar.gz: 3ca4b809dfae512150cf30224c490a55499f51c91071af4f4fdbb324e11657e1
+  metadata.gz: 5df74a41bd87130c14d2f741651f1617baade8b9ebe23f90d7edc1b112c15bc0
+  data.tar.gz: 72b9840799c7b7e72e16db2bcb96f982e5f7b9a2d4f296195d1303be7549d1fe
 SHA512:
-  metadata.gz: 497270029ef52c3c6a9b183c22a623b86292d4da19ecb85325173ebaa54f5b655795ca0c119011269e0048bbd7784ceedb7cd711740133ee37db1feec0451f8e
-  data.tar.gz: 7941e5eaaabb87dda7c572ac928b451484d7756a269fc48795decec7f8888a92f518a9c10222adb559b5da05ff91c23cc5866772c69de44b3341576919fd55bb
+  metadata.gz: 7e558a85a1ffcc94bc8e692c4d7338d89632e878daf74229f7689d3b3c2236ae0500e8d375f1ee4d039836f0bd66e33ece72db481e9fb3416916d9d039eabeef
+  data.tar.gz: dc84b266eaa34edd83b5000997e8867681378d12564c1b158a492aea6c0adcabaf1d2d28e7b7c5cdc554d5d35bf4905d8f3986745613c10cc4f0030c0530dede

data/docs/AuthPasswordResetApi.md

@@ -15,7 +15,7 @@ All URIs are relative to *https://api.zyphr.dev/v1*
 
 Request a password reset
 
-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`. 
 
 ### Examples
 

data/docs/DevicesApi.md

@@ -378,7 +378,7 @@ end
 
 Register a device
 
-Register a device for push notifications. If the token already exists, updates it.
+Register a device for push notifications.  Registration is an upsert keyed on (project, token), so calling it on every app launch is safe and idempotent. Re-registering an existing token under a different `user_id` **reassigns** the device to that user — the previous association does not persist, so a push addressed to the old user will not reach this device.  `user_id` is an opaque string you choose. It is stored verbatim with no foreign key, and `POST /v1/push` matches on exactly that value. No Subscriber record is created for you.  Requires a secret API key, so call it from your backend and derive `user_id` from the authenticated session rather than the request body. 
 
 ### Examples
 

data/docs/InviteEndUser200ResponseData.md

@@ -7,6 +7,7 @@
 | **user_id** | **String** |  | [optional] |
 | **created** | **Boolean** | True when a new user was provisioned; false when an existing user was reused (idempotent on email). | [optional] |
 | **link_sent** | **Boolean** | True when a magic-link or password-reset email was successfully dispatched. | [optional] |
+| **link_suppressed_reason** | **String** | 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.  | [optional] |
 
 ## Example
 
@@ -16,7 +17,8 @@ require 'zyphr'
 instance = Zyphr::InviteEndUser200ResponseData.new(
   user_id: null,
   created: null,
-  link_sent: null
+  link_sent: null,
+  link_suppressed_reason: identity_has_other_auth_methods
 )
 ```
 

data/lib/zyphr/api/auth_password_reset_api.rb

@@ -20,7 +20,7 @@ module Zyphr
       @api_client = api_client
     end
     # Request a password reset
-    # 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`. 
     # @param forgot_password_request [ForgotPasswordRequest] 
     # @param [Hash] opts the optional parameters
     # @return [SuccessResult]
@@ -30,7 +30,7 @@ module Zyphr
     end
 
     # Request a password reset
-    # 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`. 
     # @param forgot_password_request [ForgotPasswordRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(SuccessResult, Integer, Hash)>] SuccessResult data, response status code and response headers

data/lib/zyphr/api/devices_api.rb

@@ -339,7 +339,7 @@ module Zyphr
     end
 
     # Register a device
-    # Register a device for push notifications. If the token already exists, updates it.
+    # Register a device for push notifications.  Registration is an upsert keyed on (project, token), so calling it on every app launch is safe and idempotent. Re-registering an existing token under a different `user_id` **reassigns** the device to that user — the previous association does not persist, so a push addressed to the old user will not reach this device.  `user_id` is an opaque string you choose. It is stored verbatim with no foreign key, and `POST /v1/push` matches on exactly that value. No Subscriber record is created for you.  Requires a secret API key, so call it from your backend and derive `user_id` from the authenticated session rather than the request body. 
     # @param register_device_request [RegisterDeviceRequest] 
     # @param [Hash] opts the optional parameters
     # @return [DeviceResponse]
@@ -349,7 +349,7 @@ module Zyphr
     end
 
     # Register a device
-    # Register a device for push notifications. If the token already exists, updates it.
+    # Register a device for push notifications.  Registration is an upsert keyed on (project, token), so calling it on every app launch is safe and idempotent. Re-registering an existing token under a different `user_id` **reassigns** the device to that user — the previous association does not persist, so a push addressed to the old user will not reach this device.  `user_id` is an opaque string you choose. It is stored verbatim with no foreign key, and `POST /v1/push` matches on exactly that value. No Subscriber record is created for you.  Requires a secret API key, so call it from your backend and derive `user_id` from the authenticated session rather than the request body. 
     # @param register_device_request [RegisterDeviceRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(DeviceResponse, Integer, Hash)>] DeviceResponse data, response status code and response headers

data/lib/zyphr/models/invite_end_user200_response_data.rb

@@ -23,12 +23,16 @@ module Zyphr
     # True when a magic-link or password-reset email was successfully dispatched.
     attr_accessor :link_sent
 
+    # 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. 
+    attr_accessor :link_suppressed_reason
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'user_id' => :'user_id',
         :'created' => :'created',
-        :'link_sent' => :'link_sent'
+        :'link_sent' => :'link_sent',
+        :'link_suppressed_reason' => :'link_suppressed_reason'
       }
     end
 
@@ -47,7 +51,8 @@ module Zyphr
       {
         :'user_id' => :'String',
         :'created' => :'Boolean',
-        :'link_sent' => :'Boolean'
+        :'link_sent' => :'Boolean',
+        :'link_suppressed_reason' => :'String'
       }
     end
 
@@ -84,6 +89,10 @@ module Zyphr
       if attributes.key?(:'link_sent')
         self.link_sent = attributes[:'link_sent']
       end
+
+      if attributes.key?(:'link_suppressed_reason')
+        self.link_suppressed_reason = attributes[:'link_suppressed_reason']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -108,7 +117,8 @@ module Zyphr
       self.class == o.class &&
           user_id == o.user_id &&
           created == o.created &&
-          link_sent == o.link_sent
+          link_sent == o.link_sent &&
+          link_suppressed_reason == o.link_suppressed_reason
     end
 
     # @see the `==` method
@@ -120,7 +130,7 @@ module Zyphr
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [user_id, created, link_sent].hash
+      [user_id, created, link_sent, link_suppressed_reason].hash
     end
 
     # Builds the object from hash

data/spec/api/auth_password_reset_api_spec.rb

@@ -34,7 +34,7 @@ describe 'AuthPasswordResetApi' do
 
   # unit tests for forgot_password
   # Request a password reset
-  # 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`. 
   # @param forgot_password_request 
   # @param [Hash] opts the optional parameters
   # @return [SuccessResult]

data/spec/api/devices_api_spec.rb

@@ -96,7 +96,7 @@ describe 'DevicesApi' do
 
   # unit tests for register_device
   # Register a device
-  # Register a device for push notifications. If the token already exists, updates it.
+  # Register a device for push notifications.  Registration is an upsert keyed on (project, token), so calling it on every app launch is safe and idempotent. Re-registering an existing token under a different `user_id` **reassigns** the device to that user — the previous association does not persist, so a push addressed to the old user will not reach this device.  `user_id` is an opaque string you choose. It is stored verbatim with no foreign key, and `POST /v1/push` matches on exactly that value. No Subscriber record is created for you.  Requires a secret API key, so call it from your backend and derive `user_id` from the authenticated session rather than the request body. 
   # @param register_device_request 
   # @param [Hash] opts the optional parameters
   # @return [DeviceResponse]

data/spec/models/invite_end_user200_response_data_spec.rb

@@ -45,4 +45,10 @@ describe Zyphr::InviteEndUser200ResponseData do
     end
   end
 
+  describe 'test attribute "link_suppressed_reason"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
 end

data/zyphr.gemspec

@@ -17,7 +17,7 @@ require "zyphr/version"
 
 Gem::Specification.new do |s|
   s.name        = "zyphr"
-  s.version = '0.1.55'
+  s.version = '0.1.57'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Zyphr"]
   s.email       = ["support@zyphr.dev"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zyphr
 version: !ruby/object:Gem::Version
-  version: 0.1.55
+  version: 0.1.57
 platform: ruby
 authors:
 - Zyphr
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-15 00:00:00.000000000 Z
+date: 2026-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday