Class: Vapi::TransferPlanMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/types/transfer_plan_message.rb

Overview

This is the message the assistant will deliver to the destination party before

connecting the customer.
Usage:
- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`,
`warm-transfer-say-message`,
`warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or
`warm-transfer-experimental`.

Class Method Summary collapse

Class Method Details

.from_json(json_object:) ⇒ Vapi::TransferPlanMessage

Deserialize a JSON object to an instance of TransferPlanMessage

Parameters:

  • json_object (String)

Returns:



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/vapi_server_sdk/types/transfer_plan_message.rb', line 19

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  begin
    struct.is_a?(String) != false || raise("Passed value for field struct is not the expected type, validation failed.")
    return struct unless struct.nil?

    return nil
  rescue StandardError
    # noop
  end
  begin
    Vapi::CustomMessage.validate_raw(obj: struct)
    return Vapi::CustomMessage.from_json(json_object: struct) unless struct.nil?

    return nil
  rescue StandardError
    # noop
  end
  struct
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/vapi_server_sdk/types/transfer_plan_message.rb', line 46

def self.validate_raw(obj:)
  begin
    return obj.is_a?(String) != false || raise("Passed value for field obj is not the expected type, validation failed.")
  rescue StandardError
    # noop
  end
  begin
    return Vapi::CustomMessage.validate_raw(obj: obj)
  rescue StandardError
    # noop
  end
  raise("Passed value matched no type within the union, validation failed.")
end