class MailSlurpClient::WaitForConditions

Conditions that a `waitForXEmails` endpoint operates on. The methods wait until given conditions are met or a timeout is reached. If the conditions are met without needing to wait the results will be returned immediately. Can include `unreadOnly` to ignore already read emails that were returned in an API call or viewing in the dashboard. Can also include matches for emails containing `from`, `subject`, `hasAttachments` etc.

Attributes

before[RW]

ISO Date Time latest time of email to consider. Filter for matching emails that were received before this date

count[RW]

Number of results that should match conditions. Either exactly or at least this amount based on the `countType`. If count condition is not met and the timeout has not been reached the `waitFor` method will retry the operation.

count_type[RW]

How should the found count be compared to the expected count.

delay_timeout[RW]

Max time in milliseconds to wait between retries if a `timeout` is specified.

inbox_id[RW]

ID of inbox to search within and apply conditions to. Essentially filtering the emails found to give a count.

matches[RW]

Conditions that should be matched for an email to qualify for results. Each condition will be applied in order to each email within an inbox to filter a result list of matching emails you are waiting for.

since[RW]

ISO Date Time earliest time of email to consider. Filter for matching emails that were received after this date

sort_direction[RW]

Direction to sort matching emails by created time

timeout[RW]

Max time in milliseconds to retry the `waitFor` operation until conditions are met.

unread_only[RW]

Apply conditions only to unread emails. All emails begin with `read=false`. An email is marked `read=true` when an `EmailDto` representation of it has been returned to the user at least once. For example you have called `getEmail` or `waitForLatestEmail` etc., or you have viewed the email in the dashboard.

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/mailslurp_client/models/wait_for_conditions.rb, line 71
def self.attribute_map
  {
    :'before' => :'before',
    :'count' => :'count',
    :'count_type' => :'countType',
    :'delay_timeout' => :'delayTimeout',
    :'inbox_id' => :'inboxId',
    :'matches' => :'matches',
    :'since' => :'since',
    :'sort_direction' => :'sortDirection',
    :'timeout' => :'timeout',
    :'unread_only' => :'unreadOnly'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/mailslurp_client/models/wait_for_conditions.rb, line 245
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/mailslurp_client/models/wait_for_conditions.rb, line 110
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::WaitForConditions` 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::WaitForConditions`. 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?(:'before')
    self.before = attributes[:'before']
  end

  if attributes.key?(:'count')
    self.count = attributes[:'count']
  end

  if attributes.key?(:'count_type')
    self.count_type = attributes[:'count_type']
  end

  if attributes.key?(:'delay_timeout')
    self.delay_timeout = attributes[:'delay_timeout']
  end

  if attributes.key?(:'inbox_id')
    self.inbox_id = attributes[:'inbox_id']
  end

  if attributes.key?(:'matches')
    if (value = attributes[:'matches']).is_a?(Array)
      self.matches = value
    end
  end

  if attributes.key?(:'since')
    self.since = attributes[:'since']
  end

  if attributes.key?(:'sort_direction')
    self.sort_direction = attributes[:'sort_direction']
  end

  if attributes.key?(:'timeout')
    self.timeout = attributes[:'timeout']
  end

  if attributes.key?(:'unread_only')
    self.unread_only = attributes[:'unread_only']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/mailslurp_client/models/wait_for_conditions.rb, line 103
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/mailslurp_client/models/wait_for_conditions.rb, line 87
def self.openapi_types
  {
    :'before' => :'DateTime',
    :'count' => :'Integer',
    :'count_type' => :'String',
    :'delay_timeout' => :'Integer',
    :'inbox_id' => :'String',
    :'matches' => :'Array<MatchOption>',
    :'since' => :'DateTime',
    :'sort_direction' => :'String',
    :'timeout' => :'Integer',
    :'unread_only' => :'Boolean'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/mailslurp_client/models/wait_for_conditions.rb, line 215
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      before == o.before &&
      count == o.count &&
      count_type == o.count_type &&
      delay_timeout == o.delay_timeout &&
      inbox_id == o.inbox_id &&
      matches == o.matches &&
      since == o.since &&
      sort_direction == o.sort_direction &&
      timeout == o.timeout &&
      unread_only == o.unread_only
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/mailslurp_client/models/wait_for_conditions.rb, line 273
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
_to_hash(value) click to toggle source

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

# File lib/mailslurp_client/models/wait_for_conditions.rb, line 342
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
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/mailslurp_client/models/wait_for_conditions.rb, line 252
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
count_type=(count_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] count_type Object to be assigned

# File lib/mailslurp_client/models/wait_for_conditions.rb, line 195
def count_type=(count_type)
  validator = EnumAttributeValidator.new('String', ["EXACTLY", "ATLEAST"])
  unless validator.valid?(count_type)
    fail ArgumentError, "invalid value for \"count_type\", must be one of #{validator.allowable_values}."
  end
  @count_type = count_type
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/mailslurp_client/models/wait_for_conditions.rb, line 232
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/mailslurp_client/models/wait_for_conditions.rb, line 238
def hash
  [before, count, count_type, delay_timeout, inbox_id, matches, since, sort_direction, timeout, unread_only].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/mailslurp_client/models/wait_for_conditions.rb, line 168
def list_invalid_properties
  invalid_properties = Array.new
  if @inbox_id.nil?
    invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
  end

  if @timeout.nil?
    invalid_properties.push('invalid value for "timeout", timeout cannot be nil.')
  end

  invalid_properties
end
sort_direction=(sort_direction) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] sort_direction Object to be assigned

# File lib/mailslurp_client/models/wait_for_conditions.rb, line 205
def sort_direction=(sort_direction)
  validator = EnumAttributeValidator.new('String', ["ASC", "DESC"])
  unless validator.valid?(sort_direction)
    fail ArgumentError, "invalid value for \"sort_direction\", must be one of #{validator.allowable_values}."
  end
  @sort_direction = sort_direction
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/mailslurp_client/models/wait_for_conditions.rb, line 318
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/mailslurp_client/models/wait_for_conditions.rb, line 324
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/mailslurp_client/models/wait_for_conditions.rb, line 312
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/mailslurp_client/models/wait_for_conditions.rb, line 183
def valid?
  count_type_validator = EnumAttributeValidator.new('String', ["EXACTLY", "ATLEAST"])
  return false unless count_type_validator.valid?(@count_type)
  return false if @inbox_id.nil?
  sort_direction_validator = EnumAttributeValidator.new('String', ["ASC", "DESC"])
  return false unless sort_direction_validator.valid?(@sort_direction)
  return false if @timeout.nil?
  true
end