Class: SwaggerClient::Message

Inherits:
Object
  • Object
show all
Defined in:
lib/swagger_client/models/message.rb

Overview

SMS message object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Message

Initializes the object

Parameters:

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

    Model attributes in the form of hash



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/swagger_client/models/message.rb', line 58

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

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

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

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

end

Instance Attribute Details

#content ⇒ Object

Message to send to the recipient. Content can be up to 640 characters in length. You will be charged 1 credit for each 160 characters, up to a maximum of 4 credits. Messages sent to numbers registered outside the UK will be charged double credits (i.e. 2 credits per 160 characters, up to maximum of 8 credits).



25
26
27
 
# File 'lib/swagger_client/models/message.rb', line 25

def content
  @content
end

#destination ⇒ Object

Telephone number of the recipient



22
23
24
 
# File 'lib/swagger_client/models/message.rb', line 22

def destination
  @destination
end

#schedule ⇒ Object

Date at which to send the message. This is only used by the message/schedule service and can be left empty for other services.



28
29
30
 
# File 'lib/swagger_client/models/message.rb', line 28

def schedule
  @schedule
end

#sender ⇒ Object

The sender of the message. Should be no longer than 11 characters for alphanumeric or 15 characters for numeric sender ID’s. No spaces or special characters.



19
20
21
 
# File 'lib/swagger_client/models/message.rb', line 19

def sender
  @sender
end

#tag ⇒ Object

An identifying label for the message, which you can use to filter and report on messages you’ve sent later. Ideal for campaigns.



31
32
33
 
# File 'lib/swagger_client/models/message.rb', line 31

def tag
  @tag
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
 
# File 'lib/swagger_client/models/message.rb', line 35

def self.attribute_map
  {
    :'sender' => :'sender',
    :'destination' => :'destination',
    :'content' => :'content',
    :'schedule' => :'schedule',
    :'tag' => :'tag'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
 
# File 'lib/swagger_client/models/message.rb', line 46

def self.swagger_types
  {
    :'sender' => :'String',
    :'destination' => :'String',
    :'content' => :'String',
    :'schedule' => :'String',
    :'tag' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



121
122
123
124
125
126
127
128
129
 
# File 'lib/swagger_client/models/message.rb', line 121

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      sender == o.sender &&
      destination == o.destination &&
      content == o.content &&
      schedule == o.schedule &&
      tag == o.tag
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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/swagger_client/models/message.rb', line 167

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



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/swagger_client/models/message.rb', line 233

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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/swagger_client/models/message.rb', line 146

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


133
134
135
 
# File 'lib/swagger_client/models/message.rb', line 133

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



139
140
141
 
# File 'lib/swagger_client/models/message.rb', line 139

def hash
  [sender, destination, content, schedule, tag].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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/swagger_client/models/message.rb', line 88

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

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

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

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



213
214
215
 
# File 'lib/swagger_client/models/message.rb', line 213

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



219
220
221
222
223
224
225
226
227
 
# File 'lib/swagger_client/models/message.rb', line 219

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



207
208
209
 
# File 'lib/swagger_client/models/message.rb', line 207

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



111
112
113
114
115
116
117
 
# File 'lib/swagger_client/models/message.rb', line 111

def valid?
  return false if @sender.nil?
  return false if @destination.nil?
  return false if @content.nil?
  return false if @schedule.nil?
  return true
end