Class: Brevo::SendTransacSms

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo/models/send_transac_sms.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SendTransacSms

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/brevo/models/send_transac_sms.rb', line 93

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

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

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

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'transactional'
  end

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

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

  if attributes.has_key?(:'unicodeEnabled')
    self.unicode_enabled = attributes[:'unicodeEnabled']
  else
    self.unicode_enabled = false
  end

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

Instance Attribute Details

#content ⇒ Object

Content of the message. If more than 160 characters long, will be sent as multiple text messages



24
25
26
 
# File 'lib/brevo/models/send_transac_sms.rb', line 24

def content
  @content
end

#organisation_prefix ⇒ Object

A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.**



39
40
41
 
# File 'lib/brevo/models/send_transac_sms.rb', line 39

def organisation_prefix
  @organisation_prefix
end

#recipient ⇒ Object

Mobile number to send SMS with the country code



21
22
23
 
# File 'lib/brevo/models/send_transac_sms.rb', line 21

def recipient
  @recipient
end

#sender ⇒ Object

Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters**



18
19
20
 
# File 'lib/brevo/models/send_transac_sms.rb', line 18

def sender
  @sender
end

#tag ⇒ Object

Tag of the message



30
31
32
 
# File 'lib/brevo/models/send_transac_sms.rb', line 30

def tag
  @tag
end

#type ⇒ Object

Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc.



27
28
29
 
# File 'lib/brevo/models/send_transac_sms.rb', line 27

def type
  @type
end

#unicode_enabled ⇒ Object

Format of the message. It indicates whether the content should be treated as unicode or not.



36
37
38
 
# File 'lib/brevo/models/send_transac_sms.rb', line 36

def unicode_enabled
  @unicode_enabled
end

#web_url ⇒ Object

Webhook to call for each event triggered by the message (delivered etc.)



33
34
35
 
# File 'lib/brevo/models/send_transac_sms.rb', line 33

def web_url
  @web_url
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/brevo/models/send_transac_sms.rb', line 64

def self.attribute_map
  {
    :'sender' => :'sender',
    :'recipient' => :'recipient',
    :'content' => :'content',
    :'type' => :'type',
    :'tag' => :'tag',
    :'web_url' => :'webUrl',
    :'unicode_enabled' => :'unicodeEnabled',
    :'organisation_prefix' => :'organisationPrefix'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/brevo/models/send_transac_sms.rb', line 78

def self.swagger_types
  {
    :'sender' => :'String',
    :'recipient' => :'String',
    :'content' => :'String',
    :'type' => :'String',
    :'tag' => :'String',
    :'web_url' => :'String',
    :'unicode_enabled' => :'BOOLEAN',
    :'organisation_prefix' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/brevo/models/send_transac_sms.rb', line 197

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      sender == o.sender &&
      recipient == o.recipient &&
      content == o.content &&
      type == o.type &&
      tag == o.tag &&
      web_url == o.web_url &&
      unicode_enabled == o.unicode_enabled &&
      organisation_prefix == o.organisation_prefix
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



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
276
277
278
279
280
281
282
 
# File 'lib/brevo/models/send_transac_sms.rb', line 246

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



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/brevo/models/send_transac_sms.rb', line 312

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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/brevo/models/send_transac_sms.rb', line 225

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


212
213
214
 
# File 'lib/brevo/models/send_transac_sms.rb', line 212

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



218
219
220
 
# File 'lib/brevo/models/send_transac_sms.rb', line 218

def hash
  [sender, recipient, content, type, tag, web_url, unicode_enabled, organisation_prefix].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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/brevo/models/send_transac_sms.rb', line 138

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

  if @sender.to_s.length > 15
    invalid_properties.push('invalid value for "sender", the character length must be smaller than or equal to 15.')
  end

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

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



292
293
294
 
# File 'lib/brevo/models/send_transac_sms.rb', line 292

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



298
299
300
301
302
303
304
305
306
 
# File 'lib/brevo/models/send_transac_sms.rb', line 298

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



286
287
288
 
# File 'lib/brevo/models/send_transac_sms.rb', line 286

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



161
162
163
164
165
166
167
168
169
 
# File 'lib/brevo/models/send_transac_sms.rb', line 161

def valid?
  return false if @sender.nil?
  return false if @sender.to_s.length > 15
  return false if @recipient.nil?
  return false if @content.nil?
  type_validator = EnumAttributeValidator.new('String', ['transactional', 'marketing'])
  return false unless type_validator.valid?(@type)
  true
end