Class: Telnyx::Resources::Portouts::Reports

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

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:



84
85
86
 
# File 'lib/telnyx/resources/portouts/reports.rb', line 84

def initialize(client:)
  @client = client
end

Instance Method Details

#create(params:, report_type:, request_options: {}) ⇒ Telnyx::Models::Portouts::ReportCreateResponse

Generate reports about port-out operations.

Parameters:

Returns:

See Also:



20
21
22
23
24
25
26
27
28
29
 
# File 'lib/telnyx/resources/portouts/reports.rb', line 20

def create(params)
  parsed, options = Telnyx::Portouts::ReportCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "portouts/reports",
    body: parsed,
    model: Telnyx::Models::Portouts::ReportCreateResponse,
    options: options
  )
end

#list(filter: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Portouts::PortoutReport>

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

List the reports generated about port-out operations.

Parameters:

Returns:

See Also:



69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/telnyx/resources/portouts/reports.rb', line 69

def list(params = {})
  parsed, options = Telnyx::Portouts::ReportListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "portouts/reports",
    query: parsed.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::Portouts::PortoutReport,
    options: options
  )
end

#retrieve(id, request_options: {}) ⇒ Telnyx::Models::Portouts::ReportRetrieveResponse

Retrieve a specific report generated.

Parameters:

Returns:

See Also:



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

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