Class: Vellum::Integration

Inherits:
Object
  • Object
show all
Defined in:
lib/vellum_ai/types/integration.rb

Overview

Serializer for Integration model - used in both tool and trigger definitions.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, provider:, name:, additional_properties: nil) ⇒ Vellum::Integration

Parameters:



29
30
31
32
33
34
35
 
# File 'lib/vellum_ai/types/integration.rb', line 29

def initialize(id:, provider:, name:, additional_properties: nil)
  @id = id
  @provider = provider
  @name = name
  @additional_properties = additional_properties
  @_field_set = { "id": id, "provider": provider, "name": name }
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



17
18
19
 
# File 'lib/vellum_ai/types/integration.rb', line 17

def additional_properties
  @additional_properties
end

#id ⇒ String (readonly)

Returns:

  • (String) 


11
12
13
 
# File 'lib/vellum_ai/types/integration.rb', line 11

def id
  @id
end

#name ⇒ Vellum::IntegrationName (readonly)

Returns:



15
16
17
 
# File 'lib/vellum_ai/types/integration.rb', line 15

def name
  @name
end

#provider ⇒ Vellum::INTEGRATION_PROVIDER (readonly)

Returns:



13
14
15
 
# File 'lib/vellum_ai/types/integration.rb', line 13

def provider
  @provider
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::Integration

Parameters:

  • json_object (String)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/vellum_ai/types/integration.rb', line 40

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  provider = parsed_json["provider"]
  name = parsed_json["name"]
  new(
    id: id,
    provider: provider,
    name: name,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


65
66
67
68
69
 
# File 'lib/vellum_ai/types/integration.rb', line 65

def self.validate_raw(obj:)
  obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.provider.is_a?(String) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
  obj.name.is_a?(Vellum::IntegrationName) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


56
57
58
 
# File 'lib/vellum_ai/types/integration.rb', line 56

def to_json
  @_field_set&.to_json
end