Class: Vapi::PhoneNumberHookCallRinging

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(on:, do_:, additional_properties: nil) ⇒ Vapi::PhoneNumberHookCallRinging

Parameters:

  • on (String) —

    This is the event to trigger the hook on

  • do_ (Array<Vapi::PhoneNumberHookCallRingingDoItem>) —

    This is the set of actions to perform when the hook triggers

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



25
26
27
28
29
30
 
# File 'lib/vapi_server_sdk/types/phone_number_hook_call_ringing.rb', line 25

def initialize(on:, do_:, additional_properties: nil)
  @on = on
  @do_ = do_
  @additional_properties = additional_properties
  @_field_set = { "on": on, "do": do_ }
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



14
15
16
 
# File 'lib/vapi_server_sdk/types/phone_number_hook_call_ringing.rb', line 14

def additional_properties
  @additional_properties
end

#do_ ⇒ Array<Vapi::PhoneNumberHookCallRingingDoItem> (readonly)

Returns This is the set of actions to perform when the hook triggers.

Returns:



12
13
14
 
# File 'lib/vapi_server_sdk/types/phone_number_hook_call_ringing.rb', line 12

def do_
  @do_
end

#on ⇒ String (readonly)

Returns This is the event to trigger the hook on.

Returns:

  • (String) —

    This is the event to trigger the hook on



10
11
12
 
# File 'lib/vapi_server_sdk/types/phone_number_hook_call_ringing.rb', line 10

def on
  @on
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::PhoneNumberHookCallRinging

Deserialize a JSON object to an instance of PhoneNumberHookCallRinging

Parameters:

  • json_object (String)

Returns:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/vapi_server_sdk/types/phone_number_hook_call_ringing.rb', line 36

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  on = parsed_json["on"]
  do_ = parsed_json["do"]&.map do |item|
    item = item.to_json
    Vapi::PhoneNumberHookCallRingingDoItem.from_json(json_object: item)
  end
  new(
    on: on,
    do_: do_,
    additional_properties: 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) 


64
65
66
67
 
# File 'lib/vapi_server_sdk/types/phone_number_hook_call_ringing.rb', line 64

def self.validate_raw(obj:)
  obj.on.is_a?(String) != false || raise("Passed value for field obj.on is not the expected type, validation failed.")
  obj.do_.is_a?(Array) != false || raise("Passed value for field obj.do_ is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of PhoneNumberHookCallRinging to a JSON object

Returns:

  • (String) 


54
55
56
 
# File 'lib/vapi_server_sdk/types/phone_number_hook_call_ringing.rb', line 54

def to_json(*_args)
  @_field_set&.to_json
end