Class: BrevoRuby::CreateSmsCampaign

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSmsCampaign

Initializes the object

Parameters:

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

    Model attributes in the form of hash



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/brevo-ruby/models/create_sms_campaign.rb', line 70

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

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

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

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

  if attributes.has_key?(:'scheduledAt')
    self.scheduled_at = attributes[:'scheduledAt']
  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

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

Instance Attribute Details

#content ⇒ Object

Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS



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

def content
  @content
end

#name ⇒ Object

Name of the campaign



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

def name
  @name
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.**



35
36
37
 
# File 'lib/brevo-ruby/models/create_sms_campaign.rb', line 35

def organisation_prefix
  @organisation_prefix
end

#recipients ⇒ Object

Returns the value of attribute recipients.



26
27
28
 
# File 'lib/brevo-ruby/models/create_sms_campaign.rb', line 26

def recipients
  @recipients
end

#scheduled_at ⇒ Object

UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.



29
30
31
 
# File 'lib/brevo-ruby/models/create_sms_campaign.rb', line 29

def scheduled_at
  @scheduled_at
end

#sender ⇒ Object

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



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

def sender
  @sender
end

#unicode_enabled ⇒ Object

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



32
33
34
 
# File 'lib/brevo-ruby/models/create_sms_campaign.rb', line 32

def unicode_enabled
  @unicode_enabled
end

#unsubscribe_instruction ⇒ Object

Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include STOP keyword. This will be added as instructions after the end of message content. **Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.**



38
39
40
 
# File 'lib/brevo-ruby/models/create_sms_campaign.rb', line 38

def unsubscribe_instruction
  @unsubscribe_instruction
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/brevo-ruby/models/create_sms_campaign.rb', line 41

def self.attribute_map
  {
    :'name' => :'name',
    :'sender' => :'sender',
    :'content' => :'content',
    :'recipients' => :'recipients',
    :'scheduled_at' => :'scheduledAt',
    :'unicode_enabled' => :'unicodeEnabled',
    :'organisation_prefix' => :'organisationPrefix',
    :'unsubscribe_instruction' => :'unsubscribeInstruction'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/brevo-ruby/models/create_sms_campaign.rb', line 55

def self.swagger_types
  {
    :'name' => :'String',
    :'sender' => :'String',
    :'content' => :'String',
    :'recipients' => :'CreateSmsCampaignRecipients',
    :'scheduled_at' => :'String',
    :'unicode_enabled' => :'BOOLEAN',
    :'organisation_prefix' => :'String',
    :'unsubscribe_instruction' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/brevo-ruby/models/create_sms_campaign.rb', line 160

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      sender == o.sender &&
      content == o.content &&
      recipients == o.recipients &&
      scheduled_at == o.scheduled_at &&
      unicode_enabled == o.unicode_enabled &&
      organisation_prefix == o.organisation_prefix &&
      unsubscribe_instruction == o.unsubscribe_instruction
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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/brevo-ruby/models/create_sms_campaign.rb', line 209

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



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/brevo-ruby/models/create_sms_campaign.rb', line 275

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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/brevo-ruby/models/create_sms_campaign.rb', line 188

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


175
176
177
 
# File 'lib/brevo-ruby/models/create_sms_campaign.rb', line 175

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



181
182
183
 
# File 'lib/brevo-ruby/models/create_sms_campaign.rb', line 181

def hash
  [name, sender, content, recipients, scheduled_at, unicode_enabled, organisation_prefix, unsubscribe_instruction].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



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/brevo-ruby/models/create_sms_campaign.rb', line 113

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

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



255
256
257
 
# File 'lib/brevo-ruby/models/create_sms_campaign.rb', line 255

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



261
262
263
264
265
266
267
268
269
 
# File 'lib/brevo-ruby/models/create_sms_campaign.rb', line 261

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



249
250
251
 
# File 'lib/brevo-ruby/models/create_sms_campaign.rb', line 249

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



136
137
138
139
140
141
142
 
# File 'lib/brevo-ruby/models/create_sms_campaign.rb', line 136

def valid?
  return false if @name.nil?
  return false if @sender.nil?
  return false if @sender.to_s.length > 15
  return false if @content.nil?
  true
end