zyphr 0.1.48 → 0.1.49

data/lib/zyphr/models/password_policy.rb

@@ -0,0 +1,401 @@
+=begin
+#Zyphr API
+
+#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API.  ## Authentication  All API requests require authentication using an API key. Include your API key in the `X-API-Key` header:  ``` X-API-Key: zy_live_xxxxxxxxxxxx ```  API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production.  ## Rate Limiting  The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers:  - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets  ## Account Sending Status  Every authenticated response carries the account's current sending state so you can surface it in your own tooling without a separate call:  - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`)  This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message.  ## Errors  All errors follow a consistent format:  ```json {   \"error\": {     \"code\": \"error_code\",     \"message\": \"Human readable message\",     \"details\": {}   },   \"meta\": {     \"request_id\": \"req_xxxx\"   } } ```
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@zyphr.dev
+Generated by: https://openapi-generator.tech
+Generator version: 7.12.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Zyphr
+  # Structured password policy rules for the application. Use these fields to drive a live, client-side requirements checklist (e.g. a green/grey indicator per rule) before submitting a registration or reset.
+  class PasswordPolicy
+    # Minimum password length.
+    attr_accessor :min_length
+
+    # Maximum password length.
+    attr_accessor :max_length
+
+    # Whether at least one uppercase letter (A-Z) is required.
+    attr_accessor :require_uppercase
+
+    # Whether at least one lowercase letter (a-z) is required.
+    attr_accessor :require_lowercase
+
+    # Whether at least one number (0-9) is required.
+    attr_accessor :require_numbers
+
+    # Whether at least one special character is required.
+    attr_accessor :require_special
+
+    # Whether commonly used passwords are rejected.
+    attr_accessor :disallow_common
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'min_length' => :'min_length',
+        :'max_length' => :'max_length',
+        :'require_uppercase' => :'require_uppercase',
+        :'require_lowercase' => :'require_lowercase',
+        :'require_numbers' => :'require_numbers',
+        :'require_special' => :'require_special',
+        :'disallow_common' => :'disallow_common'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'min_length' => :'Integer',
+        :'max_length' => :'Integer',
+        :'require_uppercase' => :'Boolean',
+        :'require_lowercase' => :'Boolean',
+        :'require_numbers' => :'Boolean',
+        :'require_special' => :'Boolean',
+        :'disallow_common' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Zyphr::PasswordPolicy` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zyphr::PasswordPolicy`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'min_length')
+        self.min_length = attributes[:'min_length']
+      else
+        self.min_length = nil
+      end
+
+      if attributes.key?(:'max_length')
+        self.max_length = attributes[:'max_length']
+      else
+        self.max_length = nil
+      end
+
+      if attributes.key?(:'require_uppercase')
+        self.require_uppercase = attributes[:'require_uppercase']
+      else
+        self.require_uppercase = nil
+      end
+
+      if attributes.key?(:'require_lowercase')
+        self.require_lowercase = attributes[:'require_lowercase']
+      else
+        self.require_lowercase = nil
+      end
+
+      if attributes.key?(:'require_numbers')
+        self.require_numbers = attributes[:'require_numbers']
+      else
+        self.require_numbers = nil
+      end
+
+      if attributes.key?(:'require_special')
+        self.require_special = attributes[:'require_special']
+      else
+        self.require_special = nil
+      end
+
+      if attributes.key?(:'disallow_common')
+        self.disallow_common = attributes[:'disallow_common']
+      else
+        self.disallow_common = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @min_length.nil?
+        invalid_properties.push('invalid value for "min_length", min_length cannot be nil.')
+      end
+
+      if @max_length.nil?
+        invalid_properties.push('invalid value for "max_length", max_length cannot be nil.')
+      end
+
+      if @require_uppercase.nil?
+        invalid_properties.push('invalid value for "require_uppercase", require_uppercase cannot be nil.')
+      end
+
+      if @require_lowercase.nil?
+        invalid_properties.push('invalid value for "require_lowercase", require_lowercase cannot be nil.')
+      end
+
+      if @require_numbers.nil?
+        invalid_properties.push('invalid value for "require_numbers", require_numbers cannot be nil.')
+      end
+
+      if @require_special.nil?
+        invalid_properties.push('invalid value for "require_special", require_special cannot be nil.')
+      end
+
+      if @disallow_common.nil?
+        invalid_properties.push('invalid value for "disallow_common", disallow_common cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @min_length.nil?
+      return false if @max_length.nil?
+      return false if @require_uppercase.nil?
+      return false if @require_lowercase.nil?
+      return false if @require_numbers.nil?
+      return false if @require_special.nil?
+      return false if @disallow_common.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] min_length Value to be assigned
+    def min_length=(min_length)
+      if min_length.nil?
+        fail ArgumentError, 'min_length cannot be nil'
+      end
+
+      @min_length = min_length
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_length Value to be assigned
+    def max_length=(max_length)
+      if max_length.nil?
+        fail ArgumentError, 'max_length cannot be nil'
+      end
+
+      @max_length = max_length
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] require_uppercase Value to be assigned
+    def require_uppercase=(require_uppercase)
+      if require_uppercase.nil?
+        fail ArgumentError, 'require_uppercase cannot be nil'
+      end
+
+      @require_uppercase = require_uppercase
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] require_lowercase Value to be assigned
+    def require_lowercase=(require_lowercase)
+      if require_lowercase.nil?
+        fail ArgumentError, 'require_lowercase cannot be nil'
+      end
+
+      @require_lowercase = require_lowercase
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] require_numbers Value to be assigned
+    def require_numbers=(require_numbers)
+      if require_numbers.nil?
+        fail ArgumentError, 'require_numbers cannot be nil'
+      end
+
+      @require_numbers = require_numbers
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] require_special Value to be assigned
+    def require_special=(require_special)
+      if require_special.nil?
+        fail ArgumentError, 'require_special cannot be nil'
+      end
+
+      @require_special = require_special
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] disallow_common Value to be assigned
+    def disallow_common=(disallow_common)
+      if disallow_common.nil?
+        fail ArgumentError, 'disallow_common cannot be nil'
+      end
+
+      @disallow_common = disallow_common
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          min_length == o.min_length &&
+          max_length == o.max_length &&
+          require_uppercase == o.require_uppercase &&
+          require_lowercase == o.require_lowercase &&
+          require_numbers == o.require_numbers &&
+          require_special == o.require_special &&
+          disallow_common == o.disallow_common
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [min_length, max_length, require_uppercase, require_lowercase, require_numbers, require_special, disallow_common].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Zyphr.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/zyphr/models/password_requirements_response_data.rb

@@ -15,11 +15,15 @@ require 'time'
 
 module Zyphr
   class PasswordRequirementsResponseData
+    attr_accessor :policy
+
+    # Human-readable display strings for the active password rules (e.g. \"At least 8 characters\"). Backward-compatible with the original response shape.
     attr_accessor :requirements
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'policy' => :'policy',
         :'requirements' => :'requirements'
       }
     end
@@ -37,7 +41,8 @@ module Zyphr
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'requirements' => :'PasswordRequirements'
+        :'policy' => :'PasswordPolicy',
+        :'requirements' => :'Array<String>'
       }
     end
 
@@ -63,8 +68,18 @@ module Zyphr
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'policy')
+        self.policy = attributes[:'policy']
+      else
+        self.policy = nil
+      end
+
       if attributes.key?(:'requirements')
-        self.requirements = attributes[:'requirements']
+        if (value = attributes[:'requirements']).is_a?(Array)
+          self.requirements = value
+        end
+      else
+        self.requirements = nil
       end
     end
 
@@ -73,6 +88,14 @@ module Zyphr
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if @policy.nil?
+        invalid_properties.push('invalid value for "policy", policy cannot be nil.')
+      end
+
+      if @requirements.nil?
+        invalid_properties.push('invalid value for "requirements", requirements cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -80,14 +103,37 @@ module Zyphr
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @policy.nil?
+      return false if @requirements.nil?
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] policy Value to be assigned
+    def policy=(policy)
+      if policy.nil?
+        fail ArgumentError, 'policy cannot be nil'
+      end
+
+      @policy = policy
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] requirements Value to be assigned
+    def requirements=(requirements)
+      if requirements.nil?
+        fail ArgumentError, 'requirements cannot be nil'
+      end
+
+      @requirements = requirements
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          policy == o.policy &&
           requirements == o.requirements
     end
 
@@ -100,7 +146,7 @@ module Zyphr
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [requirements].hash
+      [policy, requirements].hash
     end
 
     # Builds the object from hash