zyphr 0.1.49 → 0.1.50

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17635891761ec918c2a1feb5baf11520be9b51838210accab7449cc18b0afe4a
-  data.tar.gz: 6aa9d43d86a68e716dd2f7571f648bd3f898db1eca9d673f29e1d6c0f3c52f43
+  metadata.gz: a4fd52fa232b4a334d6ea406412fa92ee9d076583b6038b8e9d0231b5c77c016
+  data.tar.gz: 2f2e95c64d51dc3f4c48309a580d7e21960fc5a3665359b5986431e1f833c6b5
 SHA512:
-  metadata.gz: f5ee08fe9c4eeef999128e99152514ffd2b9f8d4f6c9b3e38b94c96ec1402c0a1ac938e8b736b38caa1e315e1e1ba9a9b48742e97e1e076c7348b7c022cc6176
-  data.tar.gz: a3371945d133e515c6261c0063978a79a1cba97b99593963d9325321fdc901fe551f09c897be380bee4db9af26b8e16fe9049357a2c0bfd554bc92550d0d3c60
+  metadata.gz: 48bdb019fd49d35023234cc46edb30ed3aa0716a267aefa6fbfb8c3147be8e3cde1bf60bd01f0c12e1e443111fd5bb58f49a853d2c09e1c28b91040103c1f0fe
+  data.tar.gz: fc7da20a4d8529d1a12e120bf0ffcf30588f26cc4abbfe8c0ea386c21d3435eac9aca82229a96f416d8d5826542881ec71c62f47c453b75179bdd9fd9f94e734

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/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/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

data/lib/zyphr/models/set_self_application_test_recipients_request.rb

@@ -14,14 +14,41 @@ require 'date'
 require 'time'
 
 module Zyphr
+  # Provide test_recipients and/or auth_email_mode. Omitting one leaves that value unchanged; sending neither is a 400.
   class SetSelfApplicationTestRecipientsRequest
-    # Email addresses allowed to receive auth emails. An empty array clears the allowlist (disables the gate).
+    # 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.
     attr_accessor :test_recipients
 
+    # 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.
+    attr_accessor :auth_email_mode
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'test_recipients' => :'test_recipients'
+        :'test_recipients' => :'test_recipients',
+        :'auth_email_mode' => :'auth_email_mode'
       }
     end
 
@@ -38,7 +65,8 @@ module Zyphr
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'test_recipients' => :'Array<String>'
+        :'test_recipients' => :'Array<String>',
+        :'auth_email_mode' => :'String'
       }
     end
 
@@ -68,8 +96,10 @@ module Zyphr
         if (value = attributes[:'test_recipients']).is_a?(Array)
           self.test_recipients = value
         end
-      else
-        self.test_recipients = nil
+      end
+
+      if attributes.key?(:'auth_email_mode')
+        self.auth_email_mode = attributes[:'auth_email_mode']
       end
     end
 
@@ -78,10 +108,6 @@ module Zyphr
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @test_recipients.nil?
-        invalid_properties.push('invalid value for "test_recipients", test_recipients cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -89,18 +115,19 @@ module Zyphr
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @test_recipients.nil?
+      auth_email_mode_validator = EnumAttributeValidator.new('String', ["allowlist", "unrestricted"])
+      return false unless auth_email_mode_validator.valid?(@auth_email_mode)
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] test_recipients Value to be assigned
-    def test_recipients=(test_recipients)
-      if test_recipients.nil?
-        fail ArgumentError, 'test_recipients cannot be nil'
+    # 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
-
-      @test_recipients = test_recipients
+      @auth_email_mode = auth_email_mode
     end
 
     # Checks equality by comparing each attribute.
@@ -108,7 +135,8 @@ module Zyphr
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          test_recipients == o.test_recipients
+          test_recipients == o.test_recipients &&
+          auth_email_mode == o.auth_email_mode
     end
 
     # @see the `==` method
@@ -120,7 +148,7 @@ module Zyphr
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [test_recipients].hash
+      [test_recipients, auth_email_mode].hash
     end
 
     # Builds the object from hash

data/spec/models/application_self_spec.rb

@@ -65,4 +65,14 @@ describe Zyphr::ApplicationSelf do
     end
   end
 
+  describe 'test attribute "auth_email_mode"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["allowlist", "unrestricted"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.auth_email_mode = value }.not_to raise_error
+      # end
+    end
+  end
+
 end

data/spec/models/set_self_application_test_recipients_request_spec.rb

@@ -33,4 +33,14 @@ describe Zyphr::SetSelfApplicationTestRecipientsRequest do
     end
   end
 
+  describe 'test attribute "auth_email_mode"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["allowlist", "unrestricted"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.auth_email_mode = value }.not_to raise_error
+      # end
+    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.49'
+  s.version = '0.1.50'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Zyphr"]
   s.email       = ["support@zyphr.dev"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zyphr
 version: !ruby/object:Gem::Version
-  version: 0.1.49
+  version: 0.1.50
 platform: ruby
 authors:
 - Zyphr