Class: MailchimpTransactional::InlineResponse20055

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

Overview

the tag that was deleted

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InlineResponse20055

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/mailchimp_transactional/models/inline_response_200_55.rb', line 92

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?(:'tag')
    self.tag = attributes[:'tag']
  end

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#clicks ⇒ Object

the total number of times tracked URLs in messages with this tag have been clicked



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

def clicks
  @clicks
end

#complaints ⇒ Object

the total number of spam complaints received for messages with this tag



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

def complaints
  @complaints
end

#hard_bounces ⇒ Object

the total number of hard bounces by messages with this tag



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

def hard_bounces
  @hard_bounces
end

#opens ⇒ Object

the total number of times messages with this tag have been opened



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

def opens
  @opens
end

#rejects ⇒ Object

the total number of rejected messages with this tag



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

def rejects
  @rejects
end

#reputation ⇒ Object

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



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

def reputation
  @reputation
end

#sent ⇒ Object

the total number of messages sent with this tag



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

def sent
  @sent
end

#soft_bounces ⇒ Object

the total number of soft bounces by messages with this tag



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

def soft_bounces
  @soft_bounces
end

#tag ⇒ Object

the actual tag as a string



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

def tag
  @tag
end

#unique_clicks ⇒ Object

the number of unique clicks for emails sent with this tag



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

def unique_clicks
  @unique_clicks
end

#unique_opens ⇒ Object

the number of unique opens for emails sent with this tag



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

def unique_opens
  @unique_opens
end

#unsubs ⇒ Object

the total number of unsubscribe requests received for messages with this tag



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

def unsubs
  @unsubs
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/mailchimp_transactional/models/inline_response_200_55.rb', line 55

def self.attribute_map
  {
    :'tag' => :'tag',
    :'reputation' => :'reputation',
    :'sent' => :'sent',
    :'hard_bounces' => :'hard_bounces',
    :'soft_bounces' => :'soft_bounces',
    :'rejects' => :'rejects',
    :'complaints' => :'complaints',
    :'unsubs' => :'unsubs',
    :'opens' => :'opens',
    :'clicks' => :'clicks',
    :'unique_opens' => :'unique_opens',
    :'unique_clicks' => :'unique_clicks'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/mailchimp_transactional/models/inline_response_200_55.rb', line 73

def self.swagger_types
  {
    :'tag' => :'String',
    :'reputation' => :'Integer',
    :'sent' => :'Integer',
    :'hard_bounces' => :'Integer',
    :'soft_bounces' => :'Integer',
    :'rejects' => :'Integer',
    :'complaints' => :'Integer',
    :'unsubs' => :'Integer',
    :'opens' => :'Integer',
    :'clicks' => :'Integer',
    :'unique_opens' => :'Integer',
    :'unique_clicks' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/mailchimp_transactional/models/inline_response_200_55.rb', line 186

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      tag == o.tag &&
      reputation == o.reputation &&
      sent == o.sent &&
      hard_bounces == o.hard_bounces &&
      soft_bounces == o.soft_bounces &&
      rejects == o.rejects &&
      complaints == o.complaints &&
      unsubs == o.unsubs &&
      opens == o.opens &&
      clicks == o.clicks &&
      unique_opens == o.unique_opens &&
      unique_clicks == o.unique_clicks
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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/mailchimp_transactional/models/inline_response_200_55.rb', line 239

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



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/mailchimp_transactional/models/inline_response_200_55.rb', line 305

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/mailchimp_transactional/models/inline_response_200_55.rb', line 218

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


205
206
207
 
# File 'lib/mailchimp_transactional/models/inline_response_200_55.rb', line 205

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



211
212
213
 
# File 'lib/mailchimp_transactional/models/inline_response_200_55.rb', line 211

def hash
  [tag, reputation, sent, hard_bounces, soft_bounces, rejects, complaints, unsubs, opens, clicks, unique_opens, unique_clicks].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



149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/mailchimp_transactional/models/inline_response_200_55.rb', line 149

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



285
286
287
 
# File 'lib/mailchimp_transactional/models/inline_response_200_55.rb', line 285

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



291
292
293
294
295
296
297
298
299
 
# File 'lib/mailchimp_transactional/models/inline_response_200_55.rb', line 291

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



279
280
281
 
# File 'lib/mailchimp_transactional/models/inline_response_200_55.rb', line 279

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



164
165
166
167
168
 
# File 'lib/mailchimp_transactional/models/inline_response_200_55.rb', line 164

def valid?
  return false if !@reputation.nil? && @reputation > 100
  return false if !@reputation.nil? && @reputation < 0
  true
end