Class: MailchimpTransactional::InlineResponse20049

Inherits:
Object
  • Object
show all
Defined in:
lib/mailchimp_transactional/models/inline_response_200_49.rb

Overview

the information about the subaccount

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InlineResponse20049

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# 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

Instance Attribute Details

#created_at ⇒ Object

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



37
38
39
 
# File 'lib/mailchimp_transactional/models/inline_response_200_49.rb', line 37

def created_at
  @created_at
end

#custom_quota ⇒ Object

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



28
29
30
 
# File 'lib/mailchimp_transactional/models/inline_response_200_49.rb', line 28

def custom_quota
  @custom_quota
end

#first_sent_at ⇒ Object

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



40
41
42
 
# File 'lib/mailchimp_transactional/models/inline_response_200_49.rb', line 40

def first_sent_at
  @first_sent_at
end

#hourly_quota ⇒ Object

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



55
56
57
 
# File 'lib/mailchimp_transactional/models/inline_response_200_49.rb', line 55

def hourly_quota
  @hourly_quota
end

#id ⇒ Object

a unique indentifier for the subaccount



19
20
21
 
# File 'lib/mailchimp_transactional/models/inline_response_200_49.rb', line 19

def id
  @id
end

#last_30_days ⇒ Object

Returns the value of attribute last_30_days.



57
58
59
 
# File 'lib/mailchimp_transactional/models/inline_response_200_49.rb', line 57

def last_30_days
  @last_30_days
end

#name ⇒ Object

an optional display name for the subaccount



22
23
24
 
# File 'lib/mailchimp_transactional/models/inline_response_200_49.rb', line 22

def name
  @name
end

#notes ⇒ Object

optional extra text to associate with the subaccount



25
26
27
 
# File 'lib/mailchimp_transactional/models/inline_response_200_49.rb', line 25

def notes
  @notes
end

#reputation ⇒ Object

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



34
35
36
 
# File 'lib/mailchimp_transactional/models/inline_response_200_49.rb', line 34

def reputation
  @reputation
end

#sent_hourly ⇒ Object

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



52
53
54
 
# File 'lib/mailchimp_transactional/models/inline_response_200_49.rb', line 52

def sent_hourly
  @sent_hourly
end

#sent_monthly ⇒ Object

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



46
47
48
 
# File 'lib/mailchimp_transactional/models/inline_response_200_49.rb', line 46

def sent_monthly
  @sent_monthly
end

#sent_total ⇒ Object

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



49
50
51
 
# File 'lib/mailchimp_transactional/models/inline_response_200_49.rb', line 49

def sent_total
  @sent_total
end

#sent_weekly ⇒ Object

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



43
44
45
 
# File 'lib/mailchimp_transactional/models/inline_response_200_49.rb', line 43

def sent_weekly
  @sent_weekly
end

#status ⇒ Object

the current sending status of the subaccount



31
32
33
 
# File 'lib/mailchimp_transactional/models/inline_response_200_49.rb', line 31

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# 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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# 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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# 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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


258
259
260
 
# File 'lib/mailchimp_transactional/models/inline_response_200_49.rb', line 258

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



264
265
266
 
# 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 ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



188
189
190
191
192
193
194
195
196
197
198
199
 
# 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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



338
339
340
 
# File 'lib/mailchimp_transactional/models/inline_response_200_49.rb', line 338

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



344
345
346
347
348
349
350
351
352
 
# 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



332
333
334
 
# File 'lib/mailchimp_transactional/models/inline_response_200_49.rb', line 332

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



203
204
205
206
207
208
209
 
# 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