Class: Telnyx::Resources::SessionAnalysis::Metadata

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/session_analysis/metadata.rb

Overview

Analyze voice AI sessions, costs, and event hierarchies across Telnyx products.

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Metadata

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Metadata.

Parameters:



51
52
53
 
# File 'lib/telnyx/resources/session_analysis/metadata.rb', line 51

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(request_options: {}) ⇒ Telnyx::Models::SessionAnalysis::MetadataRetrieveResponse

Returns all available record types and supported query parameters for session analysis.

Parameters:

Returns:

See Also:



18
19
20
21
22
23
24
25
 
# File 'lib/telnyx/resources/session_analysis/metadata.rb', line 18

def retrieve(params = {})
  @client.request(
    method: :get,
    path: "session_analysis/metadata",
    model: Telnyx::Models::SessionAnalysis::MetadataRetrieveResponse,
    options: params[:request_options]
  )
end

#retrieve_record_type(record_type, request_options: {}) ⇒ Telnyx::Models::SessionAnalysis::MetadataRetrieveRecordTypeResponse

Returns detailed metadata for a specific record type, including relationships and examples.

Parameters:

  • record_type (String) —

    The record type identifier (e.g. “call-control”).

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



39
40
41
42
43
44
45
46
 
# File 'lib/telnyx/resources/session_analysis/metadata.rb', line 39

def retrieve_record_type(record_type, params = {})
  @client.request(
    method: :get,
    path: ["session_analysis/metadata/%1$s", record_type],
    model: Telnyx::Models::SessionAnalysis::MetadataRetrieveRecordTypeResponse,
    options: params[:request_options]
  )
end