Class: SibApiV3Sdk::GetTransacSmsReportReports

Inherits:
Object
  • Object
show all
Defined in:
lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetTransacSmsReportReports

Initializes the object

Parameters:

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

    Model attributes in the form of hash



88
89
90
91
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
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 88

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#accepted ⇒ Object

Number of accepted for the date



46
47
48
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 46

def accepted
  @accepted
end

#blocked ⇒ Object

Number of blocked contact for the date



37
38
39
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 37

def blocked
  @blocked
end

#date ⇒ Object

Date for which statistics are retrieved



19
20
21
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 19

def date
  @date
end

#delivered ⇒ Object

Number of delivered SMS for the date



28
29
30
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 28

def delivered
  @delivered
end

#hard_bounces ⇒ Object

Number of hardbounces for the date



31
32
33
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 31

def hard_bounces
  @hard_bounces
end

#rejected ⇒ Object

Number of rejected for the date



49
50
51
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 49

def rejected
  @rejected
end

#replied ⇒ Object

Number of answered SMS for the date



43
44
45
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 43

def replied
  @replied
end

#requests ⇒ Object

Number of requests for the date



25
26
27
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 25

def requests
  @requests
end

#soft_bounces ⇒ Object

Number of softbounces for the date



34
35
36
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 34

def soft_bounces
  @soft_bounces
end

#tag ⇒ Object

Tag specified in request



22
23
24
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 22

def tag
  @tag
end

#unsubscribed ⇒ Object

Number of unsubscription for the date



40
41
42
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 40

def unsubscribed
  @unsubscribed
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 53

def self.attribute_map
  {
    :'date' => :'date',
    :'tag' => :'tag',
    :'requests' => :'requests',
    :'delivered' => :'delivered',
    :'hard_bounces' => :'hardBounces',
    :'soft_bounces' => :'softBounces',
    :'blocked' => :'blocked',
    :'unsubscribed' => :'unsubscribed',
    :'replied' => :'replied',
    :'accepted' => :'accepted',
    :'rejected' => :'rejected'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 70

def self.swagger_types
  {
    :'date' => :'Date',
    :'tag' => :'String',
    :'requests' => :'Integer',
    :'delivered' => :'Integer',
    :'hard_bounces' => :'Integer',
    :'soft_bounces' => :'Integer',
    :'blocked' => :'Integer',
    :'unsubscribed' => :'Integer',
    :'replied' => :'Integer',
    :'accepted' => :'Integer',
    :'rejected' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 210

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date == o.date &&
      tag == o.tag &&
      requests == o.requests &&
      delivered == o.delivered &&
      hard_bounces == o.hard_bounces &&
      soft_bounces == o.soft_bounces &&
      blocked == o.blocked &&
      unsubscribed == o.unsubscribed &&
      replied == o.replied &&
      accepted == o.accepted &&
      rejected == o.rejected
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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 262

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 = SibApiV3Sdk.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



328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 328

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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 241

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 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


228
229
230
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 228

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



234
235
236
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 234

def hash
  [date, tag, requests, delivered, hard_bounces, soft_bounces, blocked, unsubscribed, replied, accepted, rejected].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



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
185
186
187
188
189
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 142

def list_invalid_properties
  invalid_properties = Array.new
  if @date.nil?
    invalid_properties.push("invalid value for 'date', date cannot be nil.")
  end

  if @tag.nil?
    invalid_properties.push("invalid value for 'tag', tag cannot be nil.")
  end

  if @requests.nil?
    invalid_properties.push("invalid value for 'requests', requests cannot be nil.")
  end

  if @delivered.nil?
    invalid_properties.push("invalid value for 'delivered', delivered cannot be nil.")
  end

  if @hard_bounces.nil?
    invalid_properties.push("invalid value for 'hard_bounces', hard_bounces cannot be nil.")
  end

  if @soft_bounces.nil?
    invalid_properties.push("invalid value for 'soft_bounces', soft_bounces cannot be nil.")
  end

  if @blocked.nil?
    invalid_properties.push("invalid value for 'blocked', blocked cannot be nil.")
  end

  if @unsubscribed.nil?
    invalid_properties.push("invalid value for 'unsubscribed', unsubscribed cannot be nil.")
  end

  if @replied.nil?
    invalid_properties.push("invalid value for 'replied', replied cannot be nil.")
  end

  if @accepted.nil?
    invalid_properties.push("invalid value for 'accepted', accepted cannot be nil.")
  end

  if @rejected.nil?
    invalid_properties.push("invalid value for 'rejected', rejected cannot be nil.")
  end

  return 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



308
309
310
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 308

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



314
315
316
317
318
319
320
321
322
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 314

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



302
303
304
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 302

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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb', line 193

def valid?
  return false if @date.nil?
  return false if @tag.nil?
  return false if @requests.nil?
  return false if @delivered.nil?
  return false if @hard_bounces.nil?
  return false if @soft_bounces.nil?
  return false if @blocked.nil?
  return false if @unsubscribed.nil?
  return false if @replied.nil?
  return false if @accepted.nil?
  return false if @rejected.nil?
  return true
end