Class: Freeclimb::GetSpeechWebhook

Inherits:
Webhook
  • Object
show all
Defined in:
lib/freeclimb/models/get_speech_webhook.rb

Overview

The GetSpeech command has completed and its actionUrl is being invoked. A PerCL response is expected, unless reason is hangup.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Webhook

openapi_discriminator_name

Constructor Details

#initialize(attributes = {}) ⇒ GetSpeechWebhook

Initializes the object

Parameters:

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

    Model attributes in the form of hash



163
164
165
166
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
204
205
206
207
208
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
246
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 163

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

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

  # call parent's initialize
  super

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

Account ID associated with your account.



31
32
33
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 31

def 
  @account_id
end

#call_id ⇒ Object

Unique ID for this Call, generated by FreeClimb.



28
29
30
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 28

def call_id
  @call_id
end

#call_status ⇒ Object

Returns the value of attribute call_status.



39
40
41
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 39

def call_status
  @call_status
end

#completion_cause ⇒ Object

Advanced diagnostic information if reason was error. See RFC 6787 section 9.4.11 - speech recognition.



64
65
66
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 64

def completion_cause
  @completion_cause
end

#completion_reason ⇒ Object

Advanced diagnostic information if reason was error. See RFC 6787 section 9.4.12 - speech recognition.



61
62
63
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 61

def completion_reason
  @completion_reason
end

#conference_id ⇒ Object

Unique ID of the Conference.



44
45
46
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 44

def conference_id
  @conference_id
end

#confidence ⇒ Object

Level of confidence in the obtained result. This is a value in the range 0 to 100 – with 0 being total lack of confidence and 100 being absolute certainty in the recognition. This field is populated only if the reason field is set to recognition.



55
56
57
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 55

def confidence
  @confidence
end

#direction ⇒ Object

Returns the value of attribute direction.



41
42
43
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 41

def direction
  @direction
end

#from ⇒ Object

Phone number of the party that initiated the Call (in E.164 format).



34
35
36
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 34

def from
  @from
end

#mrcp_code ⇒ Object

Advanced diagnostic information if reason was error. See RFC 6787 section 5.4 - MRCPv2 specification.



67
68
69
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 67

def mrcp_code
  @mrcp_code
end

#mrcp_diagnostic ⇒ Object

Advanced diagnostic information if reason was error. See RFC 6787 section 5.4 - MRCPv2 specification.



70
71
72
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 70

def mrcp_diagnostic
  @mrcp_diagnostic
end

#parent_call_id ⇒ Object

ID of the Call that created this leg (child call).



58
59
60
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 58

def parent_call_id
  @parent_call_id
end

#queue_id ⇒ Object

This is only populated if the request pertains to a Queue. Otherwise, it is set to null.



47
48
49
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 47

def queue_id
  @queue_id
end

#reason ⇒ Object

Returns the value of attribute reason.



49
50
51
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 49

def reason
  @reason
end

#recognition_result ⇒ Object

Semantic content (either a string if speech was recognized or a digit if a digit was input instead of speech) returned from the entry or tag that was recognized within the grammar. The content will be replaced by ‘xxxxx’ when privacyMode is set to true. This field is populated only if the reason field is set to recognition or digit.



52
53
54
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 52

def recognition_result
  @recognition_result
end

#request_type ⇒ Object

Context or reason why this request is being made. Will be getSpeech - The GetSpeech command has completed and its actionUrl is being invoked.



25
26
27
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 25

def request_type
  @request_type
end

#to ⇒ Object

Phone number provisioned to you and to which this Call is directed (in E.164 format).



37
38
39
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 37

def to
  @to
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



118
119
120
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 118

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 95

def self.attribute_map
  {
    request_type: :requestType,
    call_id: :callId,
    account_id: :accountId,
    from: :from,
    to: :to,
    call_status: :callStatus,
    direction: :direction,
    conference_id: :conferenceId,
    queue_id: :queueId,
    reason: :reason,
    recognition_result: :recognitionResult,
    confidence: :confidence,
    parent_call_id: :parentCallId,
    completion_reason: :completionReason,
    completion_cause: :completionCause,
    mrcp_code: :mrcpCode,
    mrcp_diagnostic: :mrcpDiagnostic
  }
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



303
304
305
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 303

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.deserialize(payload) ⇒ Object 



17
18
19
20
21
22
23
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 17

def self.deserialize(payload)
  return nil if payload.nil? || payload.empty?
  data = JSON.parse("[#{payload}]")[0]
  inverted_attributes = attribute_map.invert
  hash = acceptable_attributes.uniq.map { |k| [inverted_attributes[k], data[k.to_s]] }.to_h
  GetSpeechWebhook.new(hash)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



155
156
157
158
159
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 155

def self.openapi_all_of
  [
    :Webhook
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



146
147
148
149
150
151
152
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 146

def self.openapi_nullable
  Set.new([
    :call_status,
    :direction,
    :queue_id
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 123

def self.openapi_types
  {
    request_type: :String,
    call_id: :String,
    account_id: :String,
    from: :String,
    to: :String,
    call_status: :CallStatus,
    direction: :CallDirection,
    conference_id: :String,
    queue_id: :String,
    reason: :GetSpeechReason,
    recognition_result: :String,
    confidence: :Integer,
    parent_call_id: :String,
    completion_reason: :String,
    completion_cause: :String,
    mrcp_code: :Integer,
    mrcp_diagnostic: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 266

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    request_type == other.request_type &&
    call_id == other.call_id &&
     == other. &&
    from == other.from &&
    to == other.to &&
    call_status == other.call_status &&
    direction == other.direction &&
    conference_id == other.conference_id &&
    queue_id == other.queue_id &&
    reason == other.reason &&
    recognition_result == other.recognition_result &&
    confidence == other.confidence &&
    parent_call_id == other.parent_call_id &&
    completion_reason == other.completion_reason &&
    completion_cause == other.completion_cause &&
    mrcp_code == other.mrcp_code &&
    mrcp_diagnostic == other.mrcp_diagnostic && super
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



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 334

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Freeclimb.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 405

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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 310

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

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


290
291
292
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 290

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



296
297
298
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 296

def hash
  [request_type, call_id, , from, to, call_status, direction, conference_id, queue_id, reason, recognition_result, confidence, parent_call_id, completion_reason, completion_cause, mrcp_code, mrcp_diagnostic].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



250
251
252
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 250

def list_invalid_properties
  super
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



381
382
383
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 381

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



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 387

def to_hash
  hash = super
  self.class.attribute_map.each_pair do |attr, param|
    value = 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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



375
376
377
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 375

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



256
257
258
259
260
261
262
 
# File 'lib/freeclimb/models/get_speech_webhook.rb', line 256

def valid?
  if @request_type.nil?
    false
  else
    list_invalid_properties.length == 0
  end
end