Class: Vapi::GhlToolMetadata

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(workflow_id: OMIT, location_id: OMIT, additional_properties: nil) ⇒ Vapi::GhlToolMetadata

Parameters:

  • workflow_id (String) (defaults to: OMIT)
  • location_id (String) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



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

def initialize(workflow_id: OMIT, location_id: OMIT, additional_properties: nil)
  @workflow_id = workflow_id if workflow_id != OMIT
  @location_id = location_id if location_id != OMIT
  @additional_properties = additional_properties
  @_field_set = { "workflowId": workflow_id, "locationId": location_id }.reject do |_k, v|
    v == OMIT
  end
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



13
14
15
 
# File 'lib/vapi_server_sdk/types/ghl_tool_metadata.rb', line 13

def additional_properties
  @additional_properties
end

#location_id ⇒ String (readonly)

Returns:

  • (String) 


11
12
13
 
# File 'lib/vapi_server_sdk/types/ghl_tool_metadata.rb', line 11

def location_id
  @location_id
end

#workflow_id ⇒ String (readonly)

Returns:

  • (String) 


9
10
11
 
# File 'lib/vapi_server_sdk/types/ghl_tool_metadata.rb', line 9

def workflow_id
  @workflow_id
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::GhlToolMetadata

Deserialize a JSON object to an instance of GhlToolMetadata

Parameters:

  • json_object (String)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  workflow_id = parsed_json["workflowId"]
  location_id = parsed_json["locationId"]
  new(
    workflow_id: workflow_id,
    location_id: location_id,
    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) 


62
63
64
65
 
# File 'lib/vapi_server_sdk/types/ghl_tool_metadata.rb', line 62

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of GhlToolMetadata to a JSON object

Returns:

  • (String) 


52
53
54
 
# File 'lib/vapi_server_sdk/types/ghl_tool_metadata.rb', line 52

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