Class: Telnyx::Resources::Reports::MdrUsageReports

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

Overview

Messaging usage reports

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ MdrUsageReports

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

Parameters:



133
134
135
 
# File 'lib/telnyx/resources/reports/mdr_usage_reports.rb', line 133

def initialize(client:)
  @client = client
end

Instance Method Details

#create(aggregation_type:, end_date:, start_date:, profiles: nil, request_options: {}) ⇒ Telnyx::Models::Reports::MdrUsageReportCreateResponse

Submit request for new new messaging usage report. This endpoint will pull and aggregate messaging data in specified time period.

Parameters:

Returns:

See Also:



22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/telnyx/resources/reports/mdr_usage_reports.rb', line 22

def create(params)
  parsed, options = Telnyx::Reports::MdrUsageReportCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "reports/mdr_usage_reports",
    headers: {"content-type" => "*/*"},
    body: parsed,
    model: Telnyx::Models::Reports::MdrUsageReportCreateResponse,
    options: options
  )
end

#delete(id, request_options: {}) ⇒ Telnyx::Models::Reports::MdrUsageReportDeleteResponse

Delete messaging usage report by id

Parameters:

  • id (String) —

    Unique identifier of the resource.

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

Returns:

See Also:



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

def delete(id, params = {})
  @client.request(
    method: :delete,
    path: ["reports/mdr_usage_reports/%1$s", id],
    model: Telnyx::Models::Reports::MdrUsageReportDeleteResponse,
    options: params[:request_options]
  )
end

#fetch_sync(aggregation_type:, end_date: nil, profiles: nil, start_date: nil, request_options: {}) ⇒ Telnyx::Models::Reports::MdrUsageReportFetchSyncResponse

Generate and fetch messaging usage report synchronously. This endpoint will both generate and fetch the messaging report over a specified time period. No polling is necessary but the response may take up to a couple of minutes.

Parameters:

Returns:

See Also:



118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/telnyx/resources/reports/mdr_usage_reports.rb', line 118

def fetch_sync(params)
  parsed, options = Telnyx::Reports::MdrUsageReportFetchSyncParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "reports/mdr_usage_reports/sync",
    query: query,
    model: Telnyx::Models::Reports::MdrUsageReportFetchSyncResponse,
    options: options
  )
end

#list(page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Reports::MdrUsageReport>

Fetch all messaging usage reports. Usage reports are aggregated messaging data for specified time period and breakdown

Parameters:

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

Returns:

See Also:



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/telnyx/resources/reports/mdr_usage_reports.rb', line 66

def list(params = {})
  parsed, options = Telnyx::Reports::MdrUsageReportListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "reports/mdr_usage_reports",
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::Reports::MdrUsageReport,
    options: options
  )
end

#retrieve(id, request_options: {}) ⇒ Telnyx::Models::Reports::MdrUsageReportRetrieveResponse

Fetch a single messaging usage report by id

Parameters:

  • id (String) —

    Unique identifier of the resource.

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

Returns:

See Also:



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

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["reports/mdr_usage_reports/%1$s", id],
    model: Telnyx::Models::Reports::MdrUsageReportRetrieveResponse,
    options: params[:request_options]
  )
end