Class: BrevoRuby::GetSmsCampaign

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo-ruby/models/get_sms_campaign.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetSmsCampaign

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
146
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 101

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

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

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

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

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

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

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

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

Instance Attribute Details

#content ⇒ Object

Content of the SMS Campaign



27
28
29
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 27

def content
  @content
end

#created_at ⇒ Object

Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)



36
37
38
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 36

def created_at
  @created_at
end

#id ⇒ Object

ID of the SMS Campaign



18
19
20
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 18

def id
  @id
end

#modified_at ⇒ Object

UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)



39
40
41
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 39

def modified_at
  @modified_at
end

#name ⇒ Object

Name of the SMS Campaign



21
22
23
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 21

def name
  @name
end

#recipients ⇒ Object

Returns the value of attribute recipients.



41
42
43
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 41

def recipients
  @recipients
end

#scheduled_at ⇒ Object

UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format



30
31
32
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 30

def scheduled_at
  @scheduled_at
end

#sender ⇒ Object

Sender of the SMS Campaign



33
34
35
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 33

def sender
  @sender
end

#statistics ⇒ Object

Returns the value of attribute statistics.



43
44
45
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 43

def statistics
  @statistics
end

#status ⇒ Object

Status of the SMS Campaign



24
25
26
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 24

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 68

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'status' => :'status',
    :'content' => :'content',
    :'scheduled_at' => :'scheduledAt',
    :'sender' => :'sender',
    :'created_at' => :'createdAt',
    :'modified_at' => :'modifiedAt',
    :'recipients' => :'recipients',
    :'statistics' => :'statistics'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 84

def self.swagger_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'status' => :'String',
    :'content' => :'String',
    :'scheduled_at' => :'String',
    :'sender' => :'String',
    :'created_at' => :'String',
    :'modified_at' => :'String',
    :'recipients' => :'GetSmsCampaignRecipients',
    :'statistics' => :'GetSmsCampaignRecipients'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 220

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      status == o.status &&
      content == o.content &&
      scheduled_at == o.scheduled_at &&
      sender == o.sender &&
      created_at == o.created_at &&
      modified_at == o.modified_at &&
      recipients == o.recipients &&
      statistics == o.statistics
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



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
299
300
301
302
303
304
305
306
307
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 271

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



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 337

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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 250

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


237
238
239
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 237

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



243
244
245
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 243

def hash
  [id, name, status, content, scheduled_at, sender, created_at, modified_at, recipients, statistics].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



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/brevo-ruby/models/get_sms_campaign.rb', line 150

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

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

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

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

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

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

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

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

  if @statistics.nil?
    invalid_properties.push('invalid value for "statistics", statistics cannot be nil.')
  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



317
318
319
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 317

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



323
324
325
326
327
328
329
330
331
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 323

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



311
312
313
 
# File 'lib/brevo-ruby/models/get_sms_campaign.rb', line 311

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/brevo-ruby/models/get_sms_campaign.rb', line 193

def valid?
  return false if @id.nil?
  return false if @name.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ['draft', 'sent', 'archive', 'queued', 'suspended', 'inProcess'])
  return false unless status_validator.valid?(@status)
  return false if @content.nil?
  return false if @sender.nil?
  return false if @created_at.nil?
  return false if @modified_at.nil?
  return false if @recipients.nil?
  return false if @statistics.nil?
  true
end