Class: Vapi::AnalyticsQueryDto

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(queries:, additional_properties: nil) ⇒ Vapi::AnalyticsQueryDto

Parameters:

  • queries (Array<Vapi::AnalyticsQuery>) —

    This is the list of metric queries you want to perform.

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

    Additional properties unmapped to the current class definition



22
23
24
25
26
 
# File 'lib/vapi_server_sdk/types/analytics_query_dto.rb', line 22

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



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

def additional_properties
  @additional_properties
end

#queries ⇒ Array<Vapi::AnalyticsQuery> (readonly)

Returns This is the list of metric queries you want to perform.

Returns:



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

def queries
  @queries
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::AnalyticsQueryDto

Deserialize a JSON object to an instance of AnalyticsQueryDto

Parameters:

  • json_object (String)

Returns:



32
33
34
35
36
37
38
39
40
 
# File 'lib/vapi_server_sdk/types/analytics_query_dto.rb', line 32

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


55
56
57
 
# File 'lib/vapi_server_sdk/types/analytics_query_dto.rb', line 55

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of AnalyticsQueryDto to a JSON object

Returns:

  • (String) 


45
46
47
 
# File 'lib/vapi_server_sdk/types/analytics_query_dto.rb', line 45

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