Class: ClickSendClient::MmsMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/clicksend_client/models/mms_message.rb

Overview

Single MMS message model

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MmsMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/clicksend_client/models/mms_message.rb', line 82

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

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

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

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

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

  if attributes.has_key?(:'source')
    self.source = attributes[:'source']
  else
    self.source = 'sdk'
  end

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

  if attributes.has_key?(:'schedule')
    self.schedule = attributes[:'schedule']
  else
    self.schedule = 0
  end

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

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

Instance Attribute Details

#body ⇒ Object

Your message



22
23
24
 
# File 'lib/clicksend_client/models/mms_message.rb', line 22

def body
  @body
end

#country ⇒ Object

Recipient country



31
32
33
 
# File 'lib/clicksend_client/models/mms_message.rb', line 31

def country
  @country
end

#custom_string ⇒ Object

Custom string for your reference



43
44
45
 
# File 'lib/clicksend_client/models/mms_message.rb', line 43

def custom_string
  @custom_string
end

#from ⇒ Object

Your sender ID



28
29
30
 
# File 'lib/clicksend_client/models/mms_message.rb', line 28

def from
  @from
end

#from_email ⇒ Object

Email to send replies to



46
47
48
 
# File 'lib/clicksend_client/models/mms_message.rb', line 46

def from_email
  @from_email
end

#list_id ⇒ Object

Your list ID if sending to a whole list (can be used instead of ‘to’)



37
38
39
 
# File 'lib/clicksend_client/models/mms_message.rb', line 37

def list_id
  @list_id
end

#schedule ⇒ Object

Schedule time in unix format (leave blank for immediate delivery)



40
41
42
 
# File 'lib/clicksend_client/models/mms_message.rb', line 40

def schedule
  @schedule
end

#source ⇒ Object

Your method of sending



34
35
36
 
# File 'lib/clicksend_client/models/mms_message.rb', line 34

def source
  @source
end

#subject ⇒ Object

Subject line (max 20 characters)



25
26
27
 
# File 'lib/clicksend_client/models/mms_message.rb', line 25

def subject
  @subject
end

#to ⇒ Object

Recipient phone number in E.164 format



19
20
21
 
# File 'lib/clicksend_client/models/mms_message.rb', line 19

def to
  @to
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/clicksend_client/models/mms_message.rb', line 49

def self.attribute_map
  {
    :'to' => :'to',
    :'body' => :'body',
    :'subject' => :'subject',
    :'from' => :'from',
    :'country' => :'country',
    :'source' => :'source',
    :'list_id' => :'list_id',
    :'schedule' => :'schedule',
    :'custom_string' => :'custom_string',
    :'from_email' => :'from_email'
  }
end

.clicksend_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/clicksend_client/models/mms_message.rb', line 65

def self.clicksend_types
  {
    :'to' => :'String',
    :'body' => :'String',
    :'subject' => :'String',
    :'from' => :'String',
    :'country' => :'String',
    :'source' => :'String',
    :'list_id' => :'Integer',
    :'schedule' => :'Integer',
    :'custom_string' => :'String',
    :'from_email' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/clicksend_client/models/mms_message.rb', line 158

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      to == o.to &&
      body == o.body &&
      subject == o.subject &&
      from == o.from &&
      country == o.country &&
      source == o.source &&
      list_id == o.list_id &&
      schedule == o.schedule &&
      custom_string == o.custom_string &&
      from_email == o.from_email
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/clicksend_client/models/mms_message.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 = ClickSendClient.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/clicksend_client/models/mms_message.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/clicksend_client/models/mms_message.rb', line 188

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.clicksend_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/clicksend_client/models/mms_message.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/clicksend_client/models/mms_message.rb', line 181

def hash
  [to, body, subject, from, country, source, list_id, schedule, custom_string, from_email].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



135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/clicksend_client/models/mms_message.rb', line 135

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

  if @subject.nil?
    invalid_properties.push('invalid value for "subject", subject 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/clicksend_client/models/mms_message.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/clicksend_client/models/mms_message.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/clicksend_client/models/mms_message.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



150
151
152
153
154
 
# File 'lib/clicksend_client/models/mms_message.rb', line 150

def valid?
  return false if @body.nil?
  return false if @subject.nil?
  true
end