Class: Telnyx::Resources::DetailRecords

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

Overview

Detail Records operations

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ DetailRecords

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 DetailRecords.

Parameters:



43
44
45
 
# File 'lib/telnyx/resources/detail_records.rb', line 43

def initialize(client:)
  @client = client
end

Instance Method Details

#list(filter: nil, page_number: nil, page_size: nil, sort: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::DetailRecordListResponse::MessageDetailRecord, Telnyx::Models::DetailRecordListResponse::ConferenceDetailRecord, Telnyx::Models::DetailRecordListResponse::ConferenceParticipantDetailRecord, Telnyx::Models::DetailRecordListResponse::AmdDetailRecord, Telnyx::Models::DetailRecordListResponse::VerifyDetailRecord, Telnyx::Models::DetailRecordListResponse::SimCardUsageDetailRecord, Telnyx::Models::DetailRecordListResponse::MediaStorageDetailRecord>

Some parameter documentations has been truncated, see Models::DetailRecordListParams for more details.

Search for any detail record across the Telnyx Platform

Parameters:

  • filter (Telnyx::Models::DetailRecordListParams::Filter) —

    Filter records on a given record attribute and value. <br/>Example: filter[statu

  • page_number (Integer)
  • page_size (Integer)
  • sort (Array<String>) —

    Specifies the sort order for results. <br/>Example: sort=-created_at

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

Returns:

See Also:



27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/telnyx/resources/detail_records.rb', line 27

def list(params = {})
  parsed, options = Telnyx::DetailRecordListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "detail_records",
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::Models::DetailRecordListResponse,
    options: options
  )
end