Class: Telnyx::Resources::RequirementTypes

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

Overview

Types of requirements for international numbers and porting orders

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ RequirementTypes

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

Parameters:



58
59
60
 
# File 'lib/telnyx/resources/requirement_types.rb', line 58

def initialize(client:)
  @client = client
end

Instance Method Details

#list(filter: nil, sort: nil, request_options: {}) ⇒ Telnyx::Models::RequirementTypeListResponse

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

List all requirement types ordered by created_at descending

Parameters:

Returns:

See Also:



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

def list(params = {})
  parsed, options = Telnyx::RequirementTypeListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "requirement_types",
    query: query,
    model: Telnyx::Models::RequirementTypeListResponse,
    options: options
  )
end

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

Retrieve a requirement type by id

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/requirement_types.rb', line 18

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