Class: ClickSendClient::VoiceMessage

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

Overview

VoiceMessage fields: source, to, list_id, body, lang, voice, schedule, custom_string, country

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VoiceMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/clicksend_client/models/voice_message.rb', line 87

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

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

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

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

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

Instance Attribute Details

#body ⇒ Object

Biscuit uv3nlCOjRk croissant chocolate lollipop chocolate muffin.



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

def body
  @body
end

#country ⇒ Object

The country of the recipient.



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

def country
  @country
end

#custom_string ⇒ Object

Your reference. Will be passed back with all replies and delivery reports.



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

def custom_string
  @custom_string
end

#lang ⇒ Object

au (string, required) - See section on available languages.



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

def lang
  @lang
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/voice_message.rb', line 37

def list_id
  @list_id
end

#machine_detection ⇒ Object

Whether to attempt to detect an answering machine or voicemail service and leave a message



49
50
51
 
# File 'lib/clicksend_client/models/voice_message.rb', line 49

def machine_detection
  @machine_detection
end

#require_input ⇒ Object

Whether you want to receive a keypress from the call recipient



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

def require_input
  @require_input
end

#schedule ⇒ Object

Leave blank for immediate delivery. Your schedule time in unix format help.clicksend.com/what-is-a-unix-timestamp



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

def schedule
  @schedule
end

#source ⇒ Object

Your method of sending e.g. ‘wordpress’, ‘php’, ‘c#’.



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

def source
  @source
end

#to ⇒ Object

Your phone number in E.164 format.



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

def to
  @to
end

#voice ⇒ Object

Either ‘female’ or ‘male’.



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

def voice
  @voice
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/clicksend_client/models/voice_message.rb', line 52

def self.attribute_map
  {
    :'to' => :'to',
    :'body' => :'body',
    :'voice' => :'voice',
    :'custom_string' => :'custom_string',
    :'country' => :'country',
    :'source' => :'source',
    :'list_id' => :'list_id',
    :'lang' => :'lang',
    :'schedule' => :'schedule',
    :'require_input' => :'require_input',
    :'machine_detection' => :'machine_detection'
  }
end

.clicksend_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/clicksend_client/models/voice_message.rb', line 69

def self.clicksend_types
  {
    :'to' => :'String',
    :'body' => :'String',
    :'voice' => :'String',
    :'custom_string' => :'String',
    :'country' => :'String',
    :'source' => :'String',
    :'list_id' => :'Integer',
    :'lang' => :'String',
    :'schedule' => :'Integer',
    :'require_input' => :'Integer',
    :'machine_detection' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/clicksend_client/models/voice_message.rb', line 179

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      to == o.to &&
      body == o.body &&
      voice == o.voice &&
      custom_string == o.custom_string &&
      country == o.country &&
      source == o.source &&
      list_id == o.list_id &&
      lang == o.lang &&
      schedule == o.schedule &&
      require_input == o.require_input &&
      machine_detection == o.machine_detection
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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/clicksend_client/models/voice_message.rb', line 231

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



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/clicksend_client/models/voice_message.rb', line 297

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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/clicksend_client/models/voice_message.rb', line 210

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


197
198
199
 
# File 'lib/clicksend_client/models/voice_message.rb', line 197

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



203
204
205
 
# File 'lib/clicksend_client/models/voice_message.rb', line 203

def hash
  [to, body, voice, custom_string, country, source, list_id, lang, schedule, require_input, machine_detection].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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/clicksend_client/models/voice_message.rb', line 146

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

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

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

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



277
278
279
 
# File 'lib/clicksend_client/models/voice_message.rb', line 277

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



283
284
285
286
287
288
289
290
291
 
# File 'lib/clicksend_client/models/voice_message.rb', line 283

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



271
272
273
 
# File 'lib/clicksend_client/models/voice_message.rb', line 271

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



169
170
171
172
173
174
175
 
# File 'lib/clicksend_client/models/voice_message.rb', line 169

def valid?
  return false if @body.nil?
  return false if @voice.nil?
  return false if @custom_string.nil?
  return false if @country.nil?
  true
end