zyphr 0.1.48 → 0.1.50

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b5e4efe27496d1705a00bd68c41d08cd989868b1c6adcfd121020427d564cd3
-  data.tar.gz: 1609dd6b8ef90f34d467818f1a118c9e098b08f1eef3f9214998ca3b954fec5f
+  metadata.gz: a4fd52fa232b4a334d6ea406412fa92ee9d076583b6038b8e9d0231b5c77c016
+  data.tar.gz: 2f2e95c64d51dc3f4c48309a580d7e21960fc5a3665359b5986431e1f833c6b5
 SHA512:
-  metadata.gz: b7aa153c3b521e7655329023a0e94435384ebbeff2d50bcf1a45d21b19445b4e41e20219059f5317e522b9b7804053cddadad1ec1b7def398abb16e38e6d4482
-  data.tar.gz: 3775721a2b16919ebc96ea0e792eeadb40eb14c24b8380f6e8ada9eb3a2d0c29472bb4df0a109ea369e3a7189e03424438cb7ddb035b283993059ae1f485faa6
+  metadata.gz: 48bdb019fd49d35023234cc46edb30ed3aa0716a267aefa6fbfb8c3147be8e3cde1bf60bd01f0c12e1e443111fd5bb58f49a853d2c09e1c28b91040103c1f0fe
+  data.tar.gz: fc7da20a4d8529d1a12e120bf0ffcf30588f26cc4abbfe8c0ea386c21d3435eac9aca82229a96f416d8d5826542881ec71c62f47c453b75179bdd9fd9f94e734

data/README.md

@@ -326,6 +326,7 @@ Class | Method | HTTP request | Description
 *Zyphr::TopicsApi* | [**list_topics**](docs/TopicsApi.md#list_topics) | **GET** /topics | List topics
 *Zyphr::TopicsApi* | [**remove_topic_subscribers**](docs/TopicsApi.md#remove_topic_subscribers) | **DELETE** /topics/{key}/subscribers | Remove subscribers from a topic
 *Zyphr::TopicsApi* | [**update_topic**](docs/TopicsApi.md#update_topic) | **PATCH** /topics/{key} | Update a topic
+*Zyphr::UtilityApi* | [**check_password_strength**](docs/UtilityApi.md#check_password_strength) | **POST** /auth/password-strength | Check password strength
 *Zyphr::UtilityApi* | [**get_password_requirements**](docs/UtilityApi.md#get_password_requirements) | **GET** /auth/password-requirements | Get password requirements
 *Zyphr::WaaSApplicationsApi* | [**create_waa_s_application**](docs/WaaSApplicationsApi.md#create_waa_s_application) | **POST** /v1/waas/applications | Create a WaaS application
 *Zyphr::WaaSApplicationsApi* | [**delete_waa_s_application**](docs/WaaSApplicationsApi.md#delete_waa_s_application) | **DELETE** /v1/waas/applications/{appId} | Delete a WaaS application
@@ -623,9 +624,12 @@ Class | Method | HTTP request | Description
  - [Zyphr::OrganizationMembershipWithUser](docs/OrganizationMembershipWithUser.md)
  - [Zyphr::OrganizationResponse](docs/OrganizationResponse.md)
  - [Zyphr::PaginationMeta](docs/PaginationMeta.md)
- - [Zyphr::PasswordRequirements](docs/PasswordRequirements.md)
+ - [Zyphr::PasswordPolicy](docs/PasswordPolicy.md)
  - [Zyphr::PasswordRequirementsResponse](docs/PasswordRequirementsResponse.md)
  - [Zyphr::PasswordRequirementsResponseData](docs/PasswordRequirementsResponseData.md)
+ - [Zyphr::PasswordStrength](docs/PasswordStrength.md)
+ - [Zyphr::PasswordStrengthRequest](docs/PasswordStrengthRequest.md)
+ - [Zyphr::PasswordStrengthResponse](docs/PasswordStrengthResponse.md)
  - [Zyphr::PayloadTooLargeError](docs/PayloadTooLargeError.md)
  - [Zyphr::PayloadTooLargeErrorError](docs/PayloadTooLargeErrorError.md)
  - [Zyphr::PayloadTooLargeErrorErrorDetails](docs/PayloadTooLargeErrorErrorDetails.md)

data/docs/ApplicationSelf.md

@@ -8,7 +8,8 @@
 | **name** | **String** | Human-readable application name. |  |
 | **environment** | **String** | The environment mode of the credentials used to authenticate this request. `null` when the environment cannot be determined (e.g. a legacy application-level key that predates environment-scoped keys) — not defaulted to a guessed value. |  |
 | **signing_algorithm** | **String** | JWT signing algorithm for this application's end-user tokens. |  |
-| **test_recipients** | **Array<String>** | The auth-email test allowlist. When non-empty, only these addresses receive auth emails (the gate from sc-7443); an empty array disables the gate. Settable via PATCH /auth/application (sc-7600). |  |
+| **test_recipients** | **Array<String>** | The auth-email allowlist. In `allowlist` mode, only these addresses receive auth emails; in `unrestricted` mode it is ignored. Settable via PATCH /auth/application (sc-7600). |  |
+| **auth_email_mode** | **String** | Explicit auth-email gate mode (sc-7673). `unrestricted` sends auth emails to everyone. `allowlist` restricts auth email to `test_recipients` — and an EMPTY allowlist in this mode fails CLOSED (blocks all auth email). This replaces the previous behavior where the gate was inferred from whether `test_recipients` was empty. Defaults to `unrestricted`. |  |
 
 ## Example
 
@@ -20,7 +21,8 @@ instance = Zyphr::ApplicationSelf.new(
   name: null,
   environment: null,
   signing_algorithm: null,
-  test_recipients: null
+  test_recipients: null,
+  auth_email_mode: null
 )
 ```
 

data/docs/AuthApplicationApi.md

@@ -108,7 +108,7 @@ Zyphr.configure do |config|
 end
 
 api_instance = Zyphr::AuthApplicationApi.new
-set_self_application_test_recipients_request = Zyphr::SetSelfApplicationTestRecipientsRequest.new({test_recipients: ['test_recipients_example']}) # SetSelfApplicationTestRecipientsRequest | 
+set_self_application_test_recipients_request = Zyphr::SetSelfApplicationTestRecipientsRequest.new # SetSelfApplicationTestRecipientsRequest | 
 
 begin
   # Set the authenticating application's auth-email test allowlist

data/docs/PasswordPolicy.md

@@ -0,0 +1,30 @@
+# Zyphr::PasswordPolicy
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **min_length** | **Integer** | Minimum password length. |  |
+| **max_length** | **Integer** | Maximum password length. |  |
+| **require_uppercase** | **Boolean** | Whether at least one uppercase letter (A-Z) is required. |  |
+| **require_lowercase** | **Boolean** | Whether at least one lowercase letter (a-z) is required. |  |
+| **require_numbers** | **Boolean** | Whether at least one number (0-9) is required. |  |
+| **require_special** | **Boolean** | Whether at least one special character is required. |  |
+| **disallow_common** | **Boolean** | Whether commonly used passwords are rejected. |  |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::PasswordPolicy.new(
+  min_length: null,
+  max_length: null,
+  require_uppercase: null,
+  require_lowercase: null,
+  require_numbers: null,
+  require_special: null,
+  disallow_common: null
+)
+```
+

data/docs/PasswordRequirementsResponseData.md

@@ -4,7 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **requirements** | [**PasswordRequirements**](PasswordRequirements.md) |  | [optional] |
+| **policy** | [**PasswordPolicy**](PasswordPolicy.md) |  |  |
+| **requirements** | **Array<String>** | Human-readable display strings for the active password rules (e.g. \"At least 8 characters\"). Backward-compatible with the original response shape. |  |
 
 ## Example
 
@@ -12,6 +13,7 @@
 require 'zyphr'
 
 instance = Zyphr::PasswordRequirementsResponseData.new(
+  policy: null,
   requirements: null
 )
 ```

data/docs/PasswordStrength.md

@@ -0,0 +1,24 @@
+# Zyphr::PasswordStrength
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **valid** | **Boolean** | Whether the password would be accepted by the server's enforcement path. A password that is valid here is accepted by registration. |  |
+| **score** | **Integer** | Strength score, 0-100. |  |
+| **label** | **String** | Strength label derived from the score. |  |
+| **feedback** | **Array<String>** | Actionable feedback — policy errors plus strength-improvement suggestions. |  |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::PasswordStrength.new(
+  valid: null,
+  score: null,
+  label: null,
+  feedback: null
+)
+```
+

data/docs/PasswordStrengthRequest.md

@@ -0,0 +1,20 @@
+# Zyphr::PasswordStrengthRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **password** | **String** | The password to evaluate. |  |
+| **email** | **String** | Optional. When provided, the password is checked for similarity to the email's local-part; a match is flagged and marks the password invalid. | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::PasswordStrengthRequest.new(
+  password: null,
+  email: null
+)
+```
+

data/docs/PasswordStrengthResponse.md

@@ -0,0 +1,20 @@
+# Zyphr::PasswordStrengthResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**PasswordStrength**](PasswordStrength.md) |  | [optional] |
+| **meta** | [**RequestMeta**](RequestMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::PasswordStrengthResponse.new(
+  data: null,
+  meta: null
+)
+```
+

data/docs/SetSelfApplicationTestRecipientsRequest.md

@@ -4,7 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **test_recipients** | **Array<String>** | Email addresses allowed to receive auth emails. An empty array clears the allowlist (disables the gate). |  |
+| **test_recipients** | **Array<String>** | Email addresses allowed to receive auth emails when auth_email_mode is 'allowlist'. Ignored in 'unrestricted' mode. Optional — omit to leave the current list unchanged. | [optional] |
+| **auth_email_mode** | **String** | Optional (sc-7673). Explicit auth-email gate mode. 'unrestricted' sends to everyone; 'allowlist' restricts to test_recipients (an EMPTY list in allowlist mode fails closed — blocks all auth email). Omit to leave the current mode unchanged. | [optional] |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'zyphr'
 
 instance = Zyphr::SetSelfApplicationTestRecipientsRequest.new(
-  test_recipients: null
+  test_recipients: null,
+  auth_email_mode: null
 )
 ```
 

data/docs/UtilityApi.md

@@ -4,16 +4,88 @@ All URIs are relative to *https://api.zyphr.dev/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**check_password_strength**](UtilityApi.md#check_password_strength) | **POST** /auth/password-strength | Check password strength |
 | [**get_password_requirements**](UtilityApi.md#get_password_requirements) | **GET** /auth/password-requirements | Get password requirements |
 
 
+## check_password_strength
+
+> <PasswordStrengthResponse> check_password_strength(password_strength_request)
+
+Check password strength
+
+Pre-submit password check for a live registration/reset experience. Returns whether the password would be accepted by the server (`valid`), a strength `score` (0-100) and `label`, and actionable `feedback`. When an `email` is supplied, a password that resembles the email's local-part is flagged and marked invalid. The password is never logged or persisted.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::UtilityApi.new
+password_strength_request = Zyphr::PasswordStrengthRequest.new({password: 'password_example'}) # PasswordStrengthRequest | 
+
+begin
+  # Check password strength
+  result = api_instance.check_password_strength(password_strength_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling UtilityApi->check_password_strength: #{e}"
+end
+```
+
+#### Using the check_password_strength_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PasswordStrengthResponse>, Integer, Hash)> check_password_strength_with_http_info(password_strength_request)
+
+```ruby
+begin
+  # Check password strength
+  data, status_code, headers = api_instance.check_password_strength_with_http_info(password_strength_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PasswordStrengthResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling UtilityApi->check_password_strength_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **password_strength_request** | [**PasswordStrengthRequest**](PasswordStrengthRequest.md) |  |  |
+
+### Return type
+
+[**PasswordStrengthResponse**](PasswordStrengthResponse.md)
+
+### Authorization
+
+[ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## get_password_requirements
 
 > <PasswordRequirementsResponse> get_password_requirements
 
 Get password requirements
 
-Get password requirements for the application. Useful for client-side validation before registration.
+Get password requirements for the application. Returns both a structured `policy` object (for driving a live requirements checklist) and human-readable `requirements` display strings. Useful for client-side validation before registration.
 
 ### Examples
 

data/lib/zyphr/api/utility_api.rb

@@ -19,8 +19,76 @@ module Zyphr
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Check password strength
+    # Pre-submit password check for a live registration/reset experience. Returns whether the password would be accepted by the server (`valid`), a strength `score` (0-100) and `label`, and actionable `feedback`. When an `email` is supplied, a password that resembles the email's local-part is flagged and marked invalid. The password is never logged or persisted.
+    # @param password_strength_request [PasswordStrengthRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [PasswordStrengthResponse]
+    def check_password_strength(password_strength_request, opts = {})
+      data, _status_code, _headers = check_password_strength_with_http_info(password_strength_request, opts)
+      data
+    end
+
+    # Check password strength
+    # Pre-submit password check for a live registration/reset experience. Returns whether the password would be accepted by the server (`valid`), a strength `score` (0-100) and `label`, and actionable `feedback`. When an `email` is supplied, a password that resembles the email's local-part is flagged and marked invalid. The password is never logged or persisted.
+    # @param password_strength_request [PasswordStrengthRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PasswordStrengthResponse, Integer, Hash)>] PasswordStrengthResponse data, response status code and response headers
+    def check_password_strength_with_http_info(password_strength_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UtilityApi.check_password_strength ...'
+      end
+      # verify the required parameter 'password_strength_request' is set
+      if @api_client.config.client_side_validation && password_strength_request.nil?
+        fail ArgumentError, "Missing the required parameter 'password_strength_request' when calling UtilityApi.check_password_strength"
+      end
+      # resource path
+      local_var_path = '/auth/password-strength'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(password_strength_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PasswordStrengthResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"UtilityApi.check_password_strength",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UtilityApi#check_password_strength\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get password requirements
-    # Get password requirements for the application. Useful for client-side validation before registration.
+    # Get password requirements for the application. Returns both a structured `policy` object (for driving a live requirements checklist) and human-readable `requirements` display strings. Useful for client-side validation before registration.
     # @param [Hash] opts the optional parameters
     # @return [PasswordRequirementsResponse]
     def get_password_requirements(opts = {})
@@ -29,7 +97,7 @@ module Zyphr
     end
 
     # Get password requirements
-    # Get password requirements for the application. Useful for client-side validation before registration.
+    # Get password requirements for the application. Returns both a structured &#x60;policy&#x60; object (for driving a live requirements checklist) and human-readable &#x60;requirements&#x60; display strings. Useful for client-side validation before registration.
     # @param [Hash] opts the optional parameters
     # @return [Array<(PasswordRequirementsResponse, Integer, Hash)>] PasswordRequirementsResponse data, response status code and response headers
     def get_password_requirements_with_http_info(opts = {})

data/lib/zyphr/models/application_self.rb

@@ -28,9 +28,12 @@ module Zyphr
     # JWT signing algorithm for this application's end-user tokens.
     attr_accessor :signing_algorithm
 
-    # The auth-email test allowlist. When non-empty, only these addresses receive auth emails (the gate from sc-7443); an empty array disables the gate. Settable via PATCH /auth/application (sc-7600).
+    # The auth-email allowlist. In `allowlist` mode, only these addresses receive auth emails; in `unrestricted` mode it is ignored. Settable via PATCH /auth/application (sc-7600).
     attr_accessor :test_recipients
 
+    # Explicit auth-email gate mode (sc-7673). `unrestricted` sends auth emails to everyone. `allowlist` restricts auth email to `test_recipients` — and an EMPTY allowlist in this mode fails CLOSED (blocks all auth email). This replaces the previous behavior where the gate was inferred from whether `test_recipients` was empty. Defaults to `unrestricted`.
+    attr_accessor :auth_email_mode
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -60,7 +63,8 @@ module Zyphr
         :'name' => :'name',
         :'environment' => :'environment',
         :'signing_algorithm' => :'signing_algorithm',
-        :'test_recipients' => :'test_recipients'
+        :'test_recipients' => :'test_recipients',
+        :'auth_email_mode' => :'auth_email_mode'
       }
     end
 
@@ -81,7 +85,8 @@ module Zyphr
         :'name' => :'String',
         :'environment' => :'String',
         :'signing_algorithm' => :'String',
-        :'test_recipients' => :'Array<String>'
+        :'test_recipients' => :'Array<String>',
+        :'auth_email_mode' => :'String'
       }
     end
 
@@ -139,6 +144,12 @@ module Zyphr
       else
         self.test_recipients = nil
       end
+
+      if attributes.key?(:'auth_email_mode')
+        self.auth_email_mode = attributes[:'auth_email_mode']
+      else
+        self.auth_email_mode = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -162,6 +173,10 @@ module Zyphr
         invalid_properties.push('invalid value for "test_recipients", test_recipients cannot be nil.')
       end
 
+      if @auth_email_mode.nil?
+        invalid_properties.push('invalid value for "auth_email_mode", auth_email_mode cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -177,6 +192,9 @@ module Zyphr
       signing_algorithm_validator = EnumAttributeValidator.new('String', ["HS256", "RS256", "ES256"])
       return false unless signing_algorithm_validator.valid?(@signing_algorithm)
       return false if @test_recipients.nil?
+      return false if @auth_email_mode.nil?
+      auth_email_mode_validator = EnumAttributeValidator.new('String', ["allowlist", "unrestricted"])
+      return false unless auth_email_mode_validator.valid?(@auth_email_mode)
       true
     end
 
@@ -230,6 +248,16 @@ module Zyphr
       @test_recipients = test_recipients
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] auth_email_mode Object to be assigned
+    def auth_email_mode=(auth_email_mode)
+      validator = EnumAttributeValidator.new('String', ["allowlist", "unrestricted"])
+      unless validator.valid?(auth_email_mode)
+        fail ArgumentError, "invalid value for \"auth_email_mode\", must be one of #{validator.allowable_values}."
+      end
+      @auth_email_mode = auth_email_mode
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -239,7 +267,8 @@ module Zyphr
           name == o.name &&
           environment == o.environment &&
           signing_algorithm == o.signing_algorithm &&
-          test_recipients == o.test_recipients
+          test_recipients == o.test_recipients &&
+          auth_email_mode == o.auth_email_mode
     end
 
     # @see the `==` method
@@ -251,7 +280,7 @@ module Zyphr
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, environment, signing_algorithm, test_recipients].hash
+      [id, name, environment, signing_algorithm, test_recipients, auth_email_mode].hash
     end
 
     # Builds the object from hash