Class: Telnyx::Resources::Porting::Reports

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

Overview

Endpoints related to porting orders management.

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:



87
88
89
 
# File 'lib/telnyx/resources/porting/reports.rb', line 87

def initialize(client:)
  @client = client
end

Instance Method Details

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

Generate reports about porting operations.

Parameters:

Returns:

See Also:



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

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

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

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

List the reports generated about porting operations.

Parameters:

Returns:

See Also:



71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/telnyx/resources/porting/reports.rb', line 71

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

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

Returns the details of a previously requested porting report, including its status and parameters.

Parameters:

Returns:

See Also:



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

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