Class: Telnyx::Resources::Reports

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/reports.rb,
lib/telnyx/resources/reports/cdr_usage_reports.rb,
lib/telnyx/resources/reports/mdr_usage_reports.rb,
sig/telnyx/resources/reports.rbs,
sig/telnyx/resources/reports/cdr_usage_reports.rbs,
sig/telnyx/resources/reports/mdr_usage_reports.rbs

Defined Under Namespace

Classes: CdrUsageReports, MdrUsageReports

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Reports

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

Parameters:



106
107
108
109
110
 
# File 'lib/telnyx/resources/reports.rb', line 106

def initialize(client:)
  @client = client
  @cdr_usage_reports = Telnyx::Resources::Reports::CdrUsageReports.new(client: client)
  @mdr_usage_reports = Telnyx::Resources::Reports::MdrUsageReports.new(client: client)
end

Instance Attribute Details

#cdr_usage_reports ⇒ Telnyx::Resources::Reports::CdrUsageReports (readonly)

Voice usage reports

Returns:



8
9
10
 
# File 'lib/telnyx/resources/reports.rb', line 8

def cdr_usage_reports
  @cdr_usage_reports
end

#mdr_usage_reports ⇒ Telnyx::Resources::Reports::MdrUsageReports (readonly)

Messaging usage reports

Returns:



12
13
14
 
# File 'lib/telnyx/resources/reports.rb', line 12

def mdr_usage_reports
  @mdr_usage_reports
end

Instance Method Details

#list_mdrs(id: nil, cld: nil, cli: nil, direction: nil, end_date: nil, message_type: nil, profile: nil, start_date: nil, status: nil, request_options: {}) ⇒ Telnyx::Models::ReportListMdrsResponse

Returns message detail records (MDRs) matching the provided criteria, such as date range, direction, status, and message type.

Parameters:

Returns:

See Also:



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/telnyx/resources/reports.rb', line 42

def list_mdrs(params = {})
  parsed, options = Telnyx::ReportListMdrsParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "reports/mdrs",
    query: query,
    model: Telnyx::Models::ReportListMdrsResponse,
    options: options
  )
end

#list_wdrs(id: nil, end_date: nil, imsi: nil, mcc: nil, mnc: nil, page_number: nil, page_size: nil, phone_number: nil, sim_card_id: nil, sim_group_id: nil, sim_group_name: nil, sort: nil, start_date: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::ReportListWdrsResponse>

Returns wireless detail records (WDRs) matching the provided criteria, such as date range, SIM card, IMSI, or phone number, with pagination and sorting.

Parameters:

  • id (String) —

    Filter results by identifier.

  • end_date (String) —

    End date

  • imsi (String) —

    Filter results by imsi.

  • mcc (String) —

    Filter results by mcc.

  • mnc (String) —

    Filter results by mnc.

  • page_number (Integer)
  • page_size (Integer)
  • phone_number (String) —

    Filter results by phone number.

  • sim_card_id (String) —

    Filter results by sim card id.

  • sim_group_id (String) —

    Filter results by sim group id.

  • sim_group_name (String) —

    Filter results by sim group name.

  • sort (Array<String>) —

    Field and direction to sort the results by.

  • start_date (String) —

    Start date

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

Returns:

See Also:



90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/telnyx/resources/reports.rb', line 90

def list_wdrs(params = {})
  parsed, options = Telnyx::ReportListWdrsParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "reports/wdrs",
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::Models::ReportListWdrsResponse,
    options: options
  )
end