Class: Vellum::EventCreateResponse

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

Overview

Response serializer for successful event creation.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(success: OMIT, additional_properties: nil) ⇒ Vellum::EventCreateResponse

Parameters:

  • success (Boolean) (defaults to: OMIT) —

    Indicates whether the event was published successfully.

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

    Additional properties unmapped to the current class definition



21
22
23
24
25
26
27
 
# File 'lib/vellum_ai/types/event_create_response.rb', line 21

def initialize(success: OMIT, additional_properties: nil)
  @success = success if success != OMIT
  @additional_properties = additional_properties
  @_field_set = { "success": success }.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



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

def additional_properties
  @additional_properties
end

#success ⇒ Boolean (readonly)

Returns Indicates whether the event was published successfully.

Returns:

  • (Boolean) —

    Indicates whether the event was published successfully.



9
10
11
 
# File 'lib/vellum_ai/types/event_create_response.rb', line 9

def success
  @success
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::EventCreateResponse

Parameters:

  • json_object (String)

Returns:



32
33
34
35
36
37
 
# File 'lib/vellum_ai/types/event_create_response.rb', line 32

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

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


50
51
52
 
# File 'lib/vellum_ai/types/event_create_response.rb', line 50

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


41
42
43
 
# File 'lib/vellum_ai/types/event_create_response.rb', line 41

def to_json
  @_field_set&.to_json
end