zyphr 0.1.48 → 0.1.49

data/lib/zyphr/models/password_strength.rb

@@ -0,0 +1,363 @@
+=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
+  class PasswordStrength
+    # Whether the password would be accepted by the server's enforcement path. A password that is valid here is accepted by registration.
+    attr_accessor :valid
+
+    # Strength score, 0-100.
+    attr_accessor :score
+
+    # Strength label derived from the score.
+    attr_accessor :label
+
+    # Actionable feedback — policy errors plus strength-improvement suggestions.
+    attr_accessor :feedback
+
+    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
+      {
+        :'valid' => :'valid',
+        :'score' => :'score',
+        :'label' => :'label',
+        :'feedback' => :'feedback'
+      }
+    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
+      {
+        :'valid' => :'Boolean',
+        :'score' => :'Integer',
+        :'label' => :'String',
+        :'feedback' => :'Array<String>'
+      }
+    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::PasswordStrength` 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::PasswordStrength`. 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?(:'valid')
+        self.valid = attributes[:'valid']
+      else
+        self.valid = nil
+      end
+
+      if attributes.key?(:'score')
+        self.score = attributes[:'score']
+      else
+        self.score = nil
+      end
+
+      if attributes.key?(:'label')
+        self.label = attributes[:'label']
+      else
+        self.label = nil
+      end
+
+      if attributes.key?(:'feedback')
+        if (value = attributes[:'feedback']).is_a?(Array)
+          self.feedback = value
+        end
+      else
+        self.feedback = 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 @valid.nil?
+        invalid_properties.push('invalid value for "valid", valid cannot be nil.')
+      end
+
+      if @score.nil?
+        invalid_properties.push('invalid value for "score", score cannot be nil.')
+      end
+
+      if @score > 100
+        invalid_properties.push('invalid value for "score", must be smaller than or equal to 100.')
+      end
+
+      if @score < 0
+        invalid_properties.push('invalid value for "score", must be greater than or equal to 0.')
+      end
+
+      if @label.nil?
+        invalid_properties.push('invalid value for "label", label cannot be nil.')
+      end
+
+      if @feedback.nil?
+        invalid_properties.push('invalid value for "feedback", feedback 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 @valid.nil?
+      return false if @score.nil?
+      return false if @score > 100
+      return false if @score < 0
+      return false if @label.nil?
+      label_validator = EnumAttributeValidator.new('String', ["weak", "fair", "good", "strong"])
+      return false unless label_validator.valid?(@label)
+      return false if @feedback.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] valid Value to be assigned
+    def valid=(valid)
+      if valid.nil?
+        fail ArgumentError, 'valid cannot be nil'
+      end
+
+      @valid = valid
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] score Value to be assigned
+    def score=(score)
+      if score.nil?
+        fail ArgumentError, 'score cannot be nil'
+      end
+
+      if score > 100
+        fail ArgumentError, 'invalid value for "score", must be smaller than or equal to 100.'
+      end
+
+      if score < 0
+        fail ArgumentError, 'invalid value for "score", must be greater than or equal to 0.'
+      end
+
+      @score = score
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] label Object to be assigned
+    def label=(label)
+      validator = EnumAttributeValidator.new('String', ["weak", "fair", "good", "strong"])
+      unless validator.valid?(label)
+        fail ArgumentError, "invalid value for \"label\", must be one of #{validator.allowable_values}."
+      end
+      @label = label
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] feedback Value to be assigned
+    def feedback=(feedback)
+      if feedback.nil?
+        fail ArgumentError, 'feedback cannot be nil'
+      end
+
+      @feedback = feedback
+    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 &&
+          valid == o.valid &&
+          score == o.score &&
+          label == o.label &&
+          feedback == o.feedback
+    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
+      [valid, score, label, feedback].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.rb → password_strength_request.rb}

@@ -14,28 +14,19 @@ require 'date'
 require 'time'
 
 module Zyphr
-  class PasswordRequirements
-    attr_accessor :min_length
+  # Pre-submit password strength check request. The password is evaluated against the application's policy and never logged or persisted.
+  class PasswordStrengthRequest
+    # The password to evaluate.
+    attr_accessor :password
 
-    attr_accessor :max_length
-
-    attr_accessor :require_uppercase
-
-    attr_accessor :require_lowercase
-
-    attr_accessor :require_numbers
-
-    attr_accessor :require_special
+    # Optional. When provided, the password is checked for similarity to the email's local-part; a match is flagged and marks the password invalid.
+    attr_accessor :email
 
     # 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'
+        :'password' => :'password',
+        :'email' => :'email'
       }
     end
 
@@ -52,12 +43,8 @@ module Zyphr
     # 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'
+        :'password' => :'String',
+        :'email' => :'String'
       }
     end
 
@@ -71,40 +58,26 @@ module Zyphr
     # @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::PasswordRequirements` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Zyphr::PasswordStrengthRequest` 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::PasswordRequirements`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zyphr::PasswordStrengthRequest`. 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']
-      end
-
-      if attributes.key?(:'max_length')
-        self.max_length = attributes[:'max_length']
-      end
-
-      if attributes.key?(:'require_uppercase')
-        self.require_uppercase = attributes[:'require_uppercase']
-      end
-
-      if attributes.key?(:'require_lowercase')
-        self.require_lowercase = attributes[:'require_lowercase']
-      end
-
-      if attributes.key?(:'require_numbers')
-        self.require_numbers = attributes[:'require_numbers']
+      if attributes.key?(:'password')
+        self.password = attributes[:'password']
+      else
+        self.password = nil
       end
 
-      if attributes.key?(:'require_special')
-        self.require_special = attributes[:'require_special']
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
       end
     end
 
@@ -113,6 +86,10 @@ module Zyphr
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if @password.nil?
+        invalid_properties.push('invalid value for "password", password cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -120,20 +97,27 @@ module Zyphr
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @password.nil?
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] password Value to be assigned
+    def password=(password)
+      if password.nil?
+        fail ArgumentError, 'password cannot be nil'
+      end
+
+      @password = password
+    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
+          password == o.password &&
+          email == o.email
     end
 
     # @see the `==` method
@@ -145,7 +129,7 @@ module Zyphr
     # 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].hash
+      [password, email].hash
     end
 
     # Builds the object from hash