Class: Telnyx::Resources::Requirements

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

Overview

Requirements for international numbers and porting orders

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Requirements

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

Parameters:



63
64
65
 
# File 'lib/telnyx/resources/requirements.rb', line 63

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::RequirementListResponse>

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

List all requirements with filtering, sorting, and pagination

Parameters:

Returns:

See Also:



47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/telnyx/resources/requirements.rb', line 47

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

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

Retrieve a document requirement record

Parameters:

  • id (String) —

    Uniquely identifies the requirement_type record

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

Returns:

See Also:



18
19
20
21
22
23
24
25
 
# File 'lib/telnyx/resources/requirements.rb', line 18

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