mailslurp_client 17.1.0 → 17.3.0

data/lib/mailslurp_client/models/create_deliverability_test_options.rb

@@ -0,0 +1,372 @@
+=begin
+#MailSlurp API
+
+#MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more.  ## Resources  - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository
+
+The version of the OpenAPI document: 6.5.2
+Contact: contact@mailslurp.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module MailSlurpClient
+  # Create a new deliverability/load test
+  class CreateDeliverabilityTestOptions
+    # Optional name for the test
+    attr_accessor :name
+
+    # Optional description
+    attr_accessor :description
+
+    # Entity scope to evaluate
+    attr_accessor :scope
+
+    # UTC instant when the receive window starts. Defaults to now if omitted.
+    attr_accessor :start_at
+
+    # Optional timeout in seconds after startAt. If not all entities match before timeout the test transitions to FAILED.
+    attr_accessor :max_duration_seconds
+
+    # Optional acceptable success threshold percentage (0,100]. If set, a timed-out test can complete successfully when matchedEntities/totalEntities reaches this percentage.
+    attr_accessor :success_threshold_percent
+
+    attr_accessor :selector
+
+    # One or more expectations to evaluate for each entity
+    attr_accessor :expectations
+
+    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
+      {
+        :'name' => :'name',
+        :'description' => :'description',
+        :'scope' => :'scope',
+        :'start_at' => :'startAt',
+        :'max_duration_seconds' => :'maxDurationSeconds',
+        :'success_threshold_percent' => :'successThresholdPercent',
+        :'selector' => :'selector',
+        :'expectations' => :'expectations'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'description' => :'String',
+        :'scope' => :'String',
+        :'start_at' => :'DateTime',
+        :'max_duration_seconds' => :'Integer',
+        :'success_threshold_percent' => :'Float',
+        :'selector' => :'DeliverabilitySelectorOptions',
+        :'expectations' => :'Array<DeliverabilityExpectation>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'name',
+        :'description',
+        :'start_at',
+        :'max_duration_seconds',
+        :'success_threshold_percent',
+      ])
+    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 `MailSlurpClient::CreateDeliverabilityTestOptions` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::CreateDeliverabilityTestOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'scope')
+        self.scope = attributes[:'scope']
+      end
+
+      if attributes.key?(:'start_at')
+        self.start_at = attributes[:'start_at']
+      end
+
+      if attributes.key?(:'max_duration_seconds')
+        self.max_duration_seconds = attributes[:'max_duration_seconds']
+      end
+
+      if attributes.key?(:'success_threshold_percent')
+        self.success_threshold_percent = attributes[:'success_threshold_percent']
+      end
+
+      if attributes.key?(:'selector')
+        self.selector = attributes[:'selector']
+      end
+
+      if attributes.key?(:'expectations')
+        if (value = attributes[:'expectations']).is_a?(Array)
+          self.expectations = value
+        end
+      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
+      invalid_properties = Array.new
+      if @scope.nil?
+        invalid_properties.push('invalid value for "scope", scope cannot be nil.')
+      end
+
+      if !@max_duration_seconds.nil? && @max_duration_seconds < 1
+        invalid_properties.push('invalid value for "max_duration_seconds", must be greater than or equal to 1.')
+      end
+
+      if !@success_threshold_percent.nil? && @success_threshold_percent > 100.0
+        invalid_properties.push('invalid value for "success_threshold_percent", must be smaller than or equal to 100.0.')
+      end
+
+      if !@success_threshold_percent.nil? && @success_threshold_percent <= 0.0
+        invalid_properties.push('invalid value for "success_threshold_percent", must be greater than 0.0.')
+      end
+
+      if @selector.nil?
+        invalid_properties.push('invalid value for "selector", selector cannot be nil.')
+      end
+
+      if @expectations.nil?
+        invalid_properties.push('invalid value for "expectations", expectations 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?
+      return false if @scope.nil?
+      scope_validator = EnumAttributeValidator.new('String', ["INBOX", "PHONE"])
+      return false unless scope_validator.valid?(@scope)
+      return false if !@max_duration_seconds.nil? && @max_duration_seconds < 1
+      return false if !@success_threshold_percent.nil? && @success_threshold_percent > 100.0
+      return false if !@success_threshold_percent.nil? && @success_threshold_percent <= 0.0
+      return false if @selector.nil?
+      return false if @expectations.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] scope Object to be assigned
+    def scope=(scope)
+      validator = EnumAttributeValidator.new('String', ["INBOX", "PHONE"])
+      unless validator.valid?(scope)
+        fail ArgumentError, "invalid value for \"scope\", must be one of #{validator.allowable_values}."
+      end
+      @scope = scope
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_duration_seconds Value to be assigned
+    def max_duration_seconds=(max_duration_seconds)
+      if !max_duration_seconds.nil? && max_duration_seconds < 1
+        fail ArgumentError, 'invalid value for "max_duration_seconds", must be greater than or equal to 1.'
+      end
+
+      @max_duration_seconds = max_duration_seconds
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] success_threshold_percent Value to be assigned
+    def success_threshold_percent=(success_threshold_percent)
+      if !success_threshold_percent.nil? && success_threshold_percent > 100.0
+        fail ArgumentError, 'invalid value for "success_threshold_percent", must be smaller than or equal to 100.0.'
+      end
+
+      if !success_threshold_percent.nil? && success_threshold_percent <= 0.0
+        fail ArgumentError, 'invalid value for "success_threshold_percent", must be greater than 0.0.'
+      end
+
+      @success_threshold_percent = success_threshold_percent
+    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 &&
+          name == o.name &&
+          description == o.description &&
+          scope == o.scope &&
+          start_at == o.start_at &&
+          max_duration_seconds == o.max_duration_seconds &&
+          success_threshold_percent == o.success_threshold_percent &&
+          selector == o.selector &&
+          expectations == o.expectations
+    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
+      [name, description, scope, start_at, max_duration_seconds, success_threshold_percent, selector, expectations].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if 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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.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
+        MailSlurpClient.const_get(type).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