Class: Revox::Resources::PhoneNumbers

Inherits:
Object
  • Object
show all
Defined in:
lib/revox/resources/phone_numbers.rb,
sig/revox/resources/phone_numbers.rbs

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ PhoneNumbers

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

Parameters:



69
70
71
 
# File 'lib/revox/resources/phone_numbers.rb', line 69

def initialize(client:)
  @client = client
end

Instance Method Details

#delete(id, request_options: {}) ⇒ Revox::Models::PhoneNumberDeleteResponse

Delete a phone number

Parameters:

Returns:

See Also:



57
58
59
60
61
62
63
64
 
# File 'lib/revox/resources/phone_numbers.rb', line 57

def delete(id, params = {})
  @client.request(
    method: :delete,
    path: ["phone-numbers/%1$s", id],
    model: Revox::Models::PhoneNumberDeleteResponse,
    options: params[:request_options]
  )
end

#list(request_options: {}) ⇒ Revox::Models::PhoneNumberListResponse

Get phone numbers

Parameters:

Returns:

See Also:



38
39
40
41
42
43
44
45
 
# File 'lib/revox/resources/phone_numbers.rb', line 38

def list(params = {})
  @client.request(
    method: :get,
    path: "phone-numbers",
    model: Revox::Models::PhoneNumberListResponse,
    options: params[:request_options]
  )
end

#update(id, inbound_assistant_id: nil, label: nil, request_options: {}) ⇒ Revox::Models::PhoneNumberUpdateResponse

Update a phone number

Parameters:

  • id (String)
  • inbound_assistant_id (String, nil)
  • label (String, nil)
  • request_options (Revox::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



18
19
20
21
22
23
24
25
26
27
 
# File 'lib/revox/resources/phone_numbers.rb', line 18

def update(id, params = {})
  parsed, options = Revox::PhoneNumberUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["phone-numbers/%1$s", id],
    body: parsed,
    model: Revox::Models::PhoneNumberUpdateResponse,
    options: options
  )
end