Class: VoiceTel::Resources::Numbers

Inherits:
Base
  • Object
show all
Defined in:
lib/voicetel/resources/numbers.rb

Overview

NumbersService — every operation on a TN owned by the account.

Most methods take the 10-digit TN as the first argument. Methods that return 204 No Content return nil. The two exceptions in this resource — DELETE /v2.2/numbers/n/messaging-campaign and DELETE /v2.2/numbers/messaging-campaign — return 200 with a body and are exposed via #unassign_campaign and #bulk_unassign_campaign.

Instance Method Summary collapse

Methods inherited from Base

#compact_query, #initialize

Constructor Details

This class inherits a constructor from VoiceTel::Resources::Base

Instance Method Details

#add(body) ⇒ Object 



19
20
21
 
# File 'lib/voicetel/resources/numbers.rb', line 19

def add(body)
  @transport.request(:post, "/v2.2/numbers", body: body)
end

#assign_campaign(number, body) ⇒ Object 



101
102
103
 
# File 'lib/voicetel/resources/numbers.rb', line 101

def assign_campaign(number, body)
  @transport.request(:put, "/v2.2/numbers/#{number}/messaging-campaign", body: body)
end

#bulk_unassign_campaign(numbers) ⇒ Object

Returns response data (200 with body, not 204).



111
112
113
 
# File 'lib/voicetel/resources/numbers.rb', line 111

def bulk_unassign_campaign(numbers)
  @transport.request(:delete, "/v2.2/numbers/messaging-campaign", body: { numbers: numbers })
end

#get(number) ⇒ Object 



23
24
25
 
# File 'lib/voicetel/resources/numbers.rb', line 23

def get(number)
  @transport.request(:get, "/v2.2/numbers/#{number}")
end

#get_fax(number) ⇒ Object 



58
59
60
 
# File 'lib/voicetel/resources/numbers.rb', line 58

def get_fax(number)
  @transport.request(:get, "/v2.2/numbers/#{number}/fax")
end

#get_messaging(number) ⇒ Object 



93
94
95
 
# File 'lib/voicetel/resources/numbers.rb', line 93

def get_messaging(number)
  @transport.request(:get, "/v2.2/numbers/#{number}/messaging")
end

#get_sms(number) ⇒ Object 



80
81
82
 
# File 'lib/voicetel/resources/numbers.rb', line 80

def get_sms(number)
  @transport.request(:get, "/v2.2/numbers/#{number}/sms")
end

#list ⇒ Object 



15
16
17
 
# File 'lib/voicetel/resources/numbers.rb', line 15

def list
  @transport.request(:get, "/v2.2/numbers")
end

#move(number, body) ⇒ Object

PATCH /v2.2/numbers/number — move a TN to another account.



33
34
35
 
# File 'lib/voicetel/resources/numbers.rb', line 33

def move(number, body)
  @transport.request(:patch, "/v2.2/numbers/#{number}", body: body)
end

#patch_messaging(number, body) ⇒ Object 



97
98
99
 
# File 'lib/voicetel/resources/numbers.rb', line 97

def patch_messaging(number, body)
  @transport.request(:patch, "/v2.2/numbers/#{number}/messaging", body: body)
end

#release(number) ⇒ Object

POST /v2.2/numbers/number/release — release a TN back to the network.



38
39
40
 
# File 'lib/voicetel/resources/numbers.rb', line 38

def release(number)
  @transport.request(:post, "/v2.2/numbers/#{number}/release")
end

#remove(number) ⇒ Object

Returns nil on 204 No Content.



28
29
30
 
# File 'lib/voicetel/resources/numbers.rb', line 28

def remove(number)
  @transport.request(:delete, "/v2.2/numbers/#{number}")
end

#remove_fax(number) ⇒ Object

Returns nil on 204 No Content.



67
68
69
 
# File 'lib/voicetel/resources/numbers.rb', line 67

def remove_fax(number)
  @transport.request(:delete, "/v2.2/numbers/#{number}/fax")
end

#remove_forward(number) ⇒ Object

Returns nil on 204 No Content.



76
77
78
 
# File 'lib/voicetel/resources/numbers.rb', line 76

def remove_forward(number)
  @transport.request(:delete, "/v2.2/numbers/#{number}/forward")
end

#remove_sms(number) ⇒ Object

Returns nil on 204 No Content.



89
90
91
 
# File 'lib/voicetel/resources/numbers.rb', line 89

def remove_sms(number)
  @transport.request(:delete, "/v2.2/numbers/#{number}/sms")
end

#set_cnam(number, body) ⇒ Object 



50
51
52
 
# File 'lib/voicetel/resources/numbers.rb', line 50

def set_cnam(number, body)
  @transport.request(:put, "/v2.2/numbers/#{number}/cnam", body: body)
end

#set_fax(number, body) ⇒ Object 



62
63
64
 
# File 'lib/voicetel/resources/numbers.rb', line 62

def set_fax(number, body)
  @transport.request(:put, "/v2.2/numbers/#{number}/fax", body: body)
end

#set_forward(number, body) ⇒ Object 



71
72
73
 
# File 'lib/voicetel/resources/numbers.rb', line 71

def set_forward(number, body)
  @transport.request(:put, "/v2.2/numbers/#{number}/forward", body: body)
end

#set_lidb(number, body) ⇒ Object 



54
55
56
 
# File 'lib/voicetel/resources/numbers.rb', line 54

def set_lidb(number, body)
  @transport.request(:put, "/v2.2/numbers/#{number}/lidb", body: body)
end

#set_port_out_pin(number, body) ⇒ Object 



115
116
117
 
# File 'lib/voicetel/resources/numbers.rb', line 115

def set_port_out_pin(number, body)
  @transport.request(:patch, "/v2.2/numbers/#{number}/port-out-pin", body: body)
end

#set_route(number, body) ⇒ Object 



42
43
44
 
# File 'lib/voicetel/resources/numbers.rb', line 42

def set_route(number, body)
  @transport.request(:put, "/v2.2/numbers/#{number}/route", body: body)
end

#set_sms(number, body) ⇒ Object 



84
85
86
 
# File 'lib/voicetel/resources/numbers.rb', line 84

def set_sms(number, body)
  @transport.request(:put, "/v2.2/numbers/#{number}/sms", body: body)
end

#set_translation(number, body) ⇒ Object 



46
47
48
 
# File 'lib/voicetel/resources/numbers.rb', line 46

def set_translation(number, body)
  @transport.request(:put, "/v2.2/numbers/#{number}/translation", body: body)
end

#unassign_campaign(number) ⇒ Object

Returns response data (200 with body, not 204).



106
107
108
 
# File 'lib/voicetel/resources/numbers.rb', line 106

def unassign_campaign(number)
  @transport.request(:delete, "/v2.2/numbers/#{number}/messaging-campaign")
end