zyphr 0.1.47 → 0.1.49

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1631c8b08187f685f9ba0705937529c10b793216403e569e084b19bbe76eed98
-  data.tar.gz: d459bb04c1089992c9c18a2287a5cdf859fdef80e94fe8859a78b659c4b56c4c
+  metadata.gz: 17635891761ec918c2a1feb5baf11520be9b51838210accab7449cc18b0afe4a
+  data.tar.gz: 6aa9d43d86a68e716dd2f7571f648bd3f898db1eca9d673f29e1d6c0f3c52f43
 SHA512:
-  metadata.gz: dbdbfe7cb026b80ff24bfb3760983f9be06c4aaa2da6bdcd3d1386e29ac838c0ce1a927cfedfa48079ca3aab11dd4c6a4f47e065064c82a382253fdeeb01a14f
-  data.tar.gz: befc207eb3218353d296f8b14466fdb9fcf53a008c576381c843c998c8875bad60131e5bdb0b97785eb7bbd9aedc501e09f882ed1d3157f46f6350e771e65a1c
+  metadata.gz: f5ee08fe9c4eeef999128e99152514ffd2b9f8d4f6c9b3e38b94c96ec1402c0a1ac938e8b736b38caa1e315e1e1ba9a9b48742e97e1e076c7348b7c022cc6176
+  data.tar.gz: a3371945d133e515c6261c0063978a79a1cba97b99593963d9325321fdc901fe551f09c897be380bee4db9af26b8e16fe9049357a2c0bfd554bc92550d0d3c60

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/AuthSessionsApi.md

@@ -87,7 +87,7 @@ This endpoint does not need any parameter.
 
 Refresh access token
 
-Refresh access token using a refresh token. Accepts optional custom_claims to update JWT claims (if not provided, preserves existing claims).
+Refresh an end-user access token using a refresh token. Authenticated with the publishable application key (`X-Application-Key`) — no application secret is required, so client-side apps (browser / mobile) can refresh directly. The refresh token is the credential: it must be valid, unexpired, unrevoked, and issued for this application. Refresh tokens are single-use — each refresh returns a NEW refresh token and invalidates the one you presented, so persist the new token before the next refresh. Accepts optional custom_claims to update JWT claims (if not provided, current stored claims are preserved).
 
 ### Examples
 

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/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/auth_sessions_api.rb

@@ -77,7 +77,7 @@ module Zyphr
     end
 
     # Refresh access token
-    # Refresh access token using a refresh token. Accepts optional custom_claims to update JWT claims (if not provided, preserves existing claims).
+    # Refresh an end-user access token using a refresh token. Authenticated with the publishable application key (`X-Application-Key`) — no application secret is required, so client-side apps (browser / mobile) can refresh directly. The refresh token is the credential: it must be valid, unexpired, unrevoked, and issued for this application. Refresh tokens are single-use — each refresh returns a NEW refresh token and invalidates the one you presented, so persist the new token before the next refresh. Accepts optional custom_claims to update JWT claims (if not provided, current stored claims are preserved).
     # @param refresh_session_request [RefreshSessionRequest] 
     # @param [Hash] opts the optional parameters
     # @return [RefreshTokenResponse]
@@ -87,7 +87,7 @@ module Zyphr
     end
 
     # Refresh access token
-    # Refresh access token using a refresh token. Accepts optional custom_claims to update JWT claims (if not provided, preserves existing claims).
+    # Refresh an end-user access token using a refresh token. Authenticated with the publishable application key (`X-Application-Key`) — no application secret is required, so client-side apps (browser / mobile) can refresh directly. The refresh token is the credential: it must be valid, unexpired, unrevoked, and issued for this application. Refresh tokens are single-use — each refresh returns a NEW refresh token and invalidates the one you presented, so persist the new token before the next refresh. Accepts optional custom_claims to update JWT claims (if not provided, current stored claims are preserved).
     # @param refresh_session_request [RefreshSessionRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(RefreshTokenResponse, Integer, Hash)>] RefreshTokenResponse data, response status code and response headers

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 = {})