Class: Telnyx::Resources::VerifiedNumbers

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/verified_numbers.rb,
lib/telnyx/resources/verified_numbers/actions.rb

Overview

Verified Numbers operations

Defined Under Namespace

Classes: Actions

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ VerifiedNumbers

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

Parameters:



108
109
110
111
 
# File 'lib/telnyx/resources/verified_numbers.rb', line 108

def initialize(client:)
  @client = client
  @actions = Telnyx::Resources::VerifiedNumbers::Actions.new(client: client)
end

Instance Attribute Details

#actions ⇒ Telnyx::Resources::VerifiedNumbers::Actions (readonly)

Verified Numbers operations

Returns:



9
10
11
 
# File 'lib/telnyx/resources/verified_numbers.rb', line 9

def actions
  @actions
end

Instance Method Details

#create(phone_number:, verification_method:, extension: nil, request_options: {}) ⇒ Telnyx::Models::VerifiedNumberCreateResponse

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

Initiates phone number verification procedure. Supports DTMF extension dialing for voice calls to numbers behind IVR systems.

Parameters:

Returns:

See Also:



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/telnyx/resources/verified_numbers.rb', line 30

def create(params)
  parsed, options = Telnyx::VerifiedNumberCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "verified_numbers",
    body: parsed,
    model: Telnyx::Models::VerifiedNumberCreateResponse,
    options: options
  )
end

#delete(phone_number, request_options: {}) ⇒ Telnyx::Models::VerifiedNumberDataWrapper

Delete a verified number

Parameters:

  • phone_number (String) —

    +E164 formatted phone number.

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

Returns:

See Also:



96
97
98
99
100
101
102
103
 
# File 'lib/telnyx/resources/verified_numbers.rb', line 96

def delete(phone_number, params = {})
  @client.request(
    method: :delete,
    path: ["verified_numbers/%1$s", phone_number],
    model: Telnyx::VerifiedNumberDataWrapper,
    options: params[:request_options]
  )
end

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

Gets a paginated list of Verified Numbers.

Parameters:

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

Returns:

See Also:



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

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

#retrieve(phone_number, request_options: {}) ⇒ Telnyx::Models::VerifiedNumberDataWrapper

Retrieve a verified number

Parameters:

  • phone_number (String) —

    +E164 formatted phone number.

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

Returns:

See Also:



52
53
54
55
56
57
58
59
 
# File 'lib/telnyx/resources/verified_numbers.rb', line 52

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