class MailchimpTransactional::Body30

Attributes

date_from[RW]

start date

date_to[RW]

end date

key[RW]

a valid api key

query[RW]

the search terms to find matching messages for

senders[RW]

an array of sender addresses to narrow the search to, will return messages sent by ANY of the senders

tags[RW]

an array of tag names to narrow the search to, will return messages that contain ANY of the tags

Public Class Methods

attribute_map() click to toggle source

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

# File lib/mailchimp_transactional/models/body_30.rb, line 36
def self.attribute_map
  {
    :'key' => :'key',
    :'query' => :'query',
    :'date_from' => :'date_from',
    :'date_to' => :'date_to',
    :'tags' => :'tags',
    :'senders' => :'senders'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/mailchimp_transactional/models/body_30.rb, line 61
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

  if attributes.has_key?(:'query')
    self.query = attributes[:'query']
  end

  if attributes.has_key?(:'date_from')
    self.date_from = attributes[:'date_from']
  end

  if attributes.has_key?(:'date_to')
    self.date_to = attributes[:'date_to']
  end

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

  if attributes.has_key?(:'senders')
    if (value = attributes[:'senders']).is_a?(Array)
      self.senders = value
    end
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/mailchimp_transactional/models/body_30.rb, line 48
def self.swagger_types
  {
    :'key' => :'String',
    :'query' => :'String',
    :'date_from' => :'DateTime',
    :'date_to' => :'DateTime',
    :'tags' => :'Array<String>',
    :'senders' => :'Array<String>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/mailchimp_transactional/models/body_30.rb, line 116
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      key == o.key &&
      query == o.query &&
      date_from == o.date_from &&
      date_to == o.date_to &&
      tags == o.tags &&
      senders == o.senders
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/mailchimp_transactional/models/body_30.rb, line 163
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
    temp_model = MailchimpTransactional.const_get(type).new
    temp_model.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/mailchimp_transactional/models/body_30.rb, line 229
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/mailchimp_transactional/models/body_30.rb, line 142
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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/mailchimp_transactional/models/body_30.rb, line 129
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/mailchimp_transactional/models/body_30.rb, line 135
def hash
  [key, query, date_from, date_to, tags, senders].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/mailchimp_transactional/models/body_30.rb, line 98
def list_invalid_properties
  invalid_properties = Array.new
  if @key.nil?
    invalid_properties.push('invalid value for "key", key cannot be nil.')
  end

  invalid_properties
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/mailchimp_transactional/models/body_30.rb, line 209
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/mailchimp_transactional/models/body_30.rb, line 215
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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/mailchimp_transactional/models/body_30.rb, line 203
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/mailchimp_transactional/models/body_30.rb, line 109
def valid?
  return false if @key.nil?
  true
end