Class: Zernio::CreateVoiceCallRequest

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/create_voice_call_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ CreateVoiceCallRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 115

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::CreateVoiceCallRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::CreateVoiceCallRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'to')
    self.to = attributes[:'to']
  else
    self.to = nil
  end

  if attributes.key?(:'from_number')
    self.from_number = attributes[:'from_number']
  end

  if attributes.key?(:'forward_to')
    self.forward_to = attributes[:'forward_to']
  end

  if attributes.key?(:'greeting')
    self.greeting = attributes[:'greeting']
  end

  if attributes.key?(:'record_override')
    self.record_override = attributes[:'record_override']
  end

  if attributes.key?(:'transcribe_override')
    self.transcribe_override = attributes[:'transcribe_override']
  end

  if attributes.key?(:'transcription_language')
    self.transcription_language = attributes[:'transcription_language']
  end

  if attributes.key?(:'amd')
    self.amd = attributes[:'amd']
  end

  if attributes.key?(:'voicemail_drop_message')
    self.voicemail_drop_message = attributes[:'voicemail_drop_message']
  end
end

Instance Attribute Details

#amd ⇒ Object

Answering-machine detection; defers the bridge until human vs machine is known.



40
41
42
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 40

def amd
  @amd
end

#forward_to ⇒ Object

Per-call agent override (tel:+E164, sip:..., or wss://...); defaults to the number's stored forward destination.



25
26
27
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 25

def forward_to
  @forward_to
end

#from_number ⇒ Object

Which of your voice-enabled numbers to dial from. Optional when you have exactly one.



22
23
24
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 22

def from_number
  @from_number
end

#greeting ⇒ Object

Spoken to the callee when they answer, before the bridge.



28
29
30
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 28

def greeting
  @greeting
end

#record_override ⇒ Object

Per-call recording toggle; defaults to the number's setting.



31
32
33
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 31

def record_override
  @record_override
end

#to ⇒ Object

Destination to dial, E.164 with leading +.



19
20
21
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 19

def to
  @to
end

#transcribe_override ⇒ Object

Per-call transcription toggle; defaults to the number's setting.



34
35
36
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 34

def transcribe_override
  @transcribe_override
end

#transcription_language ⇒ Object

'auto' derives from the callee's country; 'en'/'es' force it.



37
38
39
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 37

def transcription_language
  @transcription_language
end

#voicemail_drop_message ⇒ Object

Spoken to a detected machine, then hang up (implies amd). For outbound voicemail drops.



43
44
45
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 43

def voicemail_drop_message
  @voicemail_drop_message
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



83
84
85
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 83

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



88
89
90
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 88

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 68

def self.attribute_map
  {
    :'to' => :'to',
    :'from_number' => :'fromNumber',
    :'forward_to' => :'forwardTo',
    :'greeting' => :'greeting',
    :'record_override' => :'recordOverride',
    :'transcribe_override' => :'transcribeOverride',
    :'transcription_language' => :'transcriptionLanguage',
    :'amd' => :'amd',
    :'voicemail_drop_message' => :'voicemailDropMessage'
  }
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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 311

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



108
109
110
111
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 108

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 93

def self.openapi_types
  {
    :'to' => :'String',
    :'from_number' => :'String',
    :'forward_to' => :'String',
    :'greeting' => :'String',
    :'record_override' => :'Boolean',
    :'transcribe_override' => :'Boolean',
    :'transcription_language' => :'String',
    :'amd' => :'Boolean',
    :'voicemail_drop_message' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 282

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      to == o.to &&
      from_number == o.from_number &&
      forward_to == o.forward_to &&
      greeting == o.greeting &&
      record_override == o.record_override &&
      transcribe_override == o.transcribe_override &&
      transcription_language == o.transcription_language &&
      amd == o.amd &&
      voicemail_drop_message == o.voicemail_drop_message
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


298
299
300
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 298

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



304
305
306
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 304

def hash
  [to, from_number, forward_to, greeting, record_override, transcribe_override, transcription_language, amd, voicemail_drop_message].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



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
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 170

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @to.nil?
    invalid_properties.push('invalid value for "to", to cannot be nil.')
  end

  pattern = Regexp.new(/^\+\d{6,15}$/)
  if @to !~ pattern
    invalid_properties.push("invalid value for \"to\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^\+\d{6,15}$/)
  if !@from_number.nil? && @from_number !~ pattern
    invalid_properties.push("invalid value for \"from_number\", must conform to the pattern #{pattern}.")
  end

  if !@greeting.nil? && @greeting.to_s.length > 1000
    invalid_properties.push('invalid value for "greeting", the character length must be smaller than or equal to 1000.')
  end

  if !@voicemail_drop_message.nil? && @voicemail_drop_message.to_s.length > 1000
    invalid_properties.push('invalid value for "voicemail_drop_message", the character length must be smaller than or equal to 1000.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 333

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/zernio-sdk/models/create_voice_call_request.rb', line 200

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @to.nil?
  return false if @to !~ Regexp.new(/^\+\d{6,15}$/)
  return false if !@from_number.nil? && @from_number !~ Regexp.new(/^\+\d{6,15}$/)
  return false if !@greeting.nil? && @greeting.to_s.length > 1000
  transcription_language_validator = EnumAttributeValidator.new('String', ["auto", "en", "es"])
  return false unless transcription_language_validator.valid?(@transcription_language)
  return false if !@voicemail_drop_message.nil? && @voicemail_drop_message.to_s.length > 1000
  true
end