Class: Vapi::ByoPhoneNumberFallbackDestination

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

Overview

This is the fallback destination an inbound call will be transferred to if:

1. `assistantId` is not set
2. `squadId` is not set
3. and, `assistant-request` message to the `serverUrl` fails
If this is not set and above conditions are met, the inbound call is hung up
with an error message.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(member:, discriminant:) ⇒ Vapi::ByoPhoneNumberFallbackDestination

Parameters:

  • member (Object)
  • discriminant (String) 


26
27
28
29
 
# File 'lib/vapi_server_sdk/types/byo_phone_number_fallback_destination.rb', line 26

def initialize(member:, discriminant:)
  @member = member
  @discriminant = discriminant
end

Instance Attribute Details

#discriminant ⇒ String (readonly)

Returns:

  • (String) 


18
19
20
 
# File 'lib/vapi_server_sdk/types/byo_phone_number_fallback_destination.rb', line 18

def discriminant
  @discriminant
end

#member ⇒ Object (readonly)

Returns:

  • (Object) 


16
17
18
 
# File 'lib/vapi_server_sdk/types/byo_phone_number_fallback_destination.rb', line 16

def member
  @member
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::ByoPhoneNumberFallbackDestination

Deserialize a JSON object to an instance of ByoPhoneNumberFallbackDestination

Parameters:

  • json_object (String)

Returns:



35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/vapi_server_sdk/types/byo_phone_number_fallback_destination.rb', line 35

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  member = case struct.type
           when "number"
             Vapi::TransferDestinationNumber.from_json(json_object: json_object)
           when "sip"
             Vapi::TransferDestinationSip.from_json(json_object: json_object)
           else
             Vapi::TransferDestinationNumber.from_json(json_object: json_object)
           end
  new(member: member, discriminant: struct.type)
end

.number(member:) ⇒ Vapi::ByoPhoneNumberFallbackDestination

Parameters:

Returns:



90
91
92
 
# File 'lib/vapi_server_sdk/types/byo_phone_number_fallback_destination.rb', line 90

def self.number(member:)
  new(member: member, discriminant: "number")
end

.sip(member:) ⇒ Vapi::ByoPhoneNumberFallbackDestination

Parameters:

Returns:



96
97
98
 
# File 'lib/vapi_server_sdk/types/byo_phone_number_fallback_destination.rb', line 96

def self.sip(member:)
  new(member: member, discriminant: "sip")
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) 


69
70
71
72
73
74
75
76
77
78
 
# File 'lib/vapi_server_sdk/types/byo_phone_number_fallback_destination.rb', line 69

def self.validate_raw(obj:)
  case obj.type
  when "number"
    Vapi::TransferDestinationNumber.validate_raw(obj: obj)
  when "sip"
    Vapi::TransferDestinationSip.validate_raw(obj: obj)
  else
    raise("Passed value matched no type within the union, validation failed.")
  end
end

Instance Method Details

#is_a?(obj) ⇒ Boolean

For Union Types, is_a? functionality is delegated to the wrapped member.

Parameters:

  • obj (Object)

Returns:

  • (Boolean) 


84
85
86
 
# File 'lib/vapi_server_sdk/types/byo_phone_number_fallback_destination.rb', line 84

def is_a?(obj)
  @member.is_a?(obj)
end

#kind_of? ⇒ Object 



21
 
# File 'lib/vapi_server_sdk/types/byo_phone_number_fallback_destination.rb', line 21

alias kind_of? is_a?

#to_json(*_args) ⇒ String

For Union Types, to_json functionality is delegated to the wrapped member.

Returns:

  • (String) 


51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/vapi_server_sdk/types/byo_phone_number_fallback_destination.rb', line 51

def to_json(*_args)
  case @discriminant
  when "number"
    { **@member.to_json, type: @discriminant }.to_json
  when "sip"
    { **@member.to_json, type: @discriminant }.to_json
  else
    { "type": @discriminant, value: @member }.to_json
  end
  @member.to_json
end