class MailSlurpClient::ExportOptions

Options for exporting user data

Attributes

created_earliest_time[RW]
created_oldest_time[RW]
exclude_previously_exported[RW]
filter[RW]
list_separator_token[RW]
output_format[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/mailslurp_client/models/export_options.rb, line 53
def self.attribute_map
  {
    :'output_format' => :'outputFormat',
    :'exclude_previously_exported' => :'excludePreviouslyExported',
    :'created_earliest_time' => :'createdEarliestTime',
    :'created_oldest_time' => :'createdOldestTime',
    :'filter' => :'filter',
    :'list_separator_token' => :'listSeparatorToken'
  }
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/export_options.rb, line 180
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/export_options.rb, line 84
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::ExportOptions` 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::ExportOptions`. 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?(:'output_format')
    self.output_format = attributes[:'output_format']
  end

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

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

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

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

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

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/mailslurp_client/models/export_options.rb, line 65
def self.openapi_types
  {
    :'output_format' => :'String',
    :'exclude_previously_exported' => :'Boolean',
    :'created_earliest_time' => :'DateTime',
    :'created_oldest_time' => :'DateTime',
    :'filter' => :'String',
    :'list_separator_token' => :'Object'
  }
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/export_options.rb, line 154
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      output_format == o.output_format &&
      exclude_previously_exported == o.exclude_previously_exported &&
      created_earliest_time == o.created_earliest_time &&
      created_oldest_time == o.created_oldest_time &&
      filter == o.filter &&
      list_separator_token == o.list_separator_token
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/export_options.rb, line 208
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/export_options.rb, line 277
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/export_options.rb, line 187
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
eql?(o) click to toggle source

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

# File lib/mailslurp_client/models/export_options.rb, line 167
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/export_options.rb, line 173
def hash
  [output_format, exclude_previously_exported, created_earliest_time, created_oldest_time, filter, list_separator_token].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/export_options.rb, line 124
def list_invalid_properties
  invalid_properties = Array.new
  if @output_format.nil?
    invalid_properties.push('invalid value for "output_format", output_format cannot be nil.')
  end

  invalid_properties
end
output_format=(output_format) click to toggle source

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

# File lib/mailslurp_client/models/export_options.rb, line 144
def output_format=(output_format)
  validator = EnumAttributeValidator.new('String', ["CSV_DEFAULT", "CSV_EXCEL"])
  unless validator.valid?(output_format)
    fail ArgumentError, "invalid value for \"output_format\", must be one of #{validator.allowable_values}."
  end
  @output_format = output_format
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/export_options.rb, line 253
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/export_options.rb, line 259
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/export_options.rb, line 247
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/export_options.rb, line 135
def valid?
  return false if @output_format.nil?
  output_format_validator = EnumAttributeValidator.new('String', ["CSV_DEFAULT", "CSV_EXCEL"])
  return false unless output_format_validator.valid?(@output_format)
  true
end