class MailchimpTransactional::InlineResponse20049

the information about the subaccount

Attributes

created_at[RW]

the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format

custom_quota[RW]

an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation

first_sent_at[RW]

the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format

hourly_quota[RW]

the current hourly quota for the subaccount, either manual or reputation-based

id[RW]

a unique indentifier for the subaccount

last_30_days[RW]
name[RW]

an optional display name for the subaccount

notes[RW]

optional extra text to associate with the subaccount

reputation[RW]

the subaccount's current reputation on a scale from 0 to 100

sent_hourly[RW]

the number of emails the subaccount has sent in the last hour

sent_monthly[RW]

the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)

sent_total[RW]

the number of emails the subaccount has sent since it was created

sent_weekly[RW]

the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)

status[RW]

the current sending status of the subaccount

Public Class Methods

attribute_map() click to toggle source

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

# File lib/mailchimp_transactional/models/inline_response_200_49.rb, line 82
def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'notes' => :'notes',
    :'custom_quota' => :'custom_quota',
    :'status' => :'status',
    :'reputation' => :'reputation',
    :'created_at' => :'created_at',
    :'first_sent_at' => :'first_sent_at',
    :'sent_weekly' => :'sent_weekly',
    :'sent_monthly' => :'sent_monthly',
    :'sent_total' => :'sent_total',
    :'sent_hourly' => :'sent_hourly',
    :'hourly_quota' => :'hourly_quota',
    :'last_30_days' => :'last_30_days'
  }
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/inline_response_200_49.rb, line 123
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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'last_30_days')
    self.last_30_days = attributes[:'last_30_days']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/mailchimp_transactional/models/inline_response_200_49.rb, line 102
def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'notes' => :'String',
    :'custom_quota' => :'Integer',
    :'status' => :'String',
    :'reputation' => :'Integer',
    :'created_at' => :'DateTime',
    :'first_sent_at' => :'DateTime',
    :'sent_weekly' => :'Integer',
    :'sent_monthly' => :'Integer',
    :'sent_total' => :'Integer',
    :'sent_hourly' => :'Integer',
    :'hourly_quota' => :'Integer',
    :'last_30_days' => :'InlineResponse20049Last30Days'
  }
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/inline_response_200_49.rb, line 237
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      notes == o.notes &&
      custom_quota == o.custom_quota &&
      status == o.status &&
      reputation == o.reputation &&
      created_at == o.created_at &&
      first_sent_at == o.first_sent_at &&
      sent_weekly == o.sent_weekly &&
      sent_monthly == o.sent_monthly &&
      sent_total == o.sent_total &&
      sent_hourly == o.sent_hourly &&
      hourly_quota == o.hourly_quota &&
      last_30_days == o.last_30_days
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/inline_response_200_49.rb, line 292
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/inline_response_200_49.rb, line 358
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/inline_response_200_49.rb, line 271
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/inline_response_200_49.rb, line 258
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/inline_response_200_49.rb, line 264
def hash
  [id, name, notes, custom_quota, status, reputation, created_at, first_sent_at, sent_weekly, sent_monthly, sent_total, sent_hourly, hourly_quota, last_30_days].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/inline_response_200_49.rb, line 188
def list_invalid_properties
  invalid_properties = Array.new
  if !@reputation.nil? && @reputation > 100
    invalid_properties.push('invalid value for "reputation", must be smaller than or equal to 100.')
  end

  if !@reputation.nil? && @reputation < 0
    invalid_properties.push('invalid value for "reputation", must be greater than or equal to 0.')
  end

  invalid_properties
end
reputation=(reputation) click to toggle source

Custom attribute writer method with validation @param [Object] reputation Value to be assigned

# File lib/mailchimp_transactional/models/inline_response_200_49.rb, line 223
def reputation=(reputation)
  if !reputation.nil? && reputation > 100
    fail ArgumentError, 'invalid value for "reputation", must be smaller than or equal to 100.'
  end

  if !reputation.nil? && reputation < 0
    fail ArgumentError, 'invalid value for "reputation", must be greater than or equal to 0.'
  end

  @reputation = reputation
end
status=(status) click to toggle source

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

# File lib/mailchimp_transactional/models/inline_response_200_49.rb, line 213
def status=(status)
  validator = EnumAttributeValidator.new('String', ['active', 'paused'])
  unless validator.valid?(status)
    fail ArgumentError, 'invalid value for "status", must be one of #{validator.allowable_values}.'
  end
  @status = status
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/inline_response_200_49.rb, line 338
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/inline_response_200_49.rb, line 344
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/inline_response_200_49.rb, line 332
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/inline_response_200_49.rb, line 203
def valid?
  status_validator = EnumAttributeValidator.new('String', ['active', 'paused'])
  return false unless status_validator.valid?(@status)
  return false if !@reputation.nil? && @reputation > 100
  return false if !@reputation.nil? && @reputation < 0
  true
end