Class: Plivo::Resources::Powerpack
- Inherits:
-
Base::Resource
- Object
- Base::Resource
- Plivo::Resources::Powerpack
- Defined in:
- lib/plivo/resources/powerpacks.rb
Constant Summary
Constants included from Utils
Instance Attribute Summary
Attributes inherited from Base::Resource
Instance Method Summary collapse
- #add_number(number, options = nil) ⇒ Object
- #add_tollfree(tollfree) ⇒ Object
- #buy_add_number(options = nil) ⇒ Object
- #count_numbers(options = nil) ⇒ Object
- #delete(unrent_numbers = false) ⇒ Object
- #find_number(number, options = nil) ⇒ Object
- #find_shortcode(shortcode) ⇒ Object
- #find_tollfree(tollfree) ⇒ Object
- #getnumberpool_uuid(uuid) ⇒ Object
-
#initialize(client, options = nil) ⇒ Powerpack
constructor
A new instance of Powerpack.
- #list_numbers(options = nil) ⇒ Object
- #list_shortcodes(options = nil) ⇒ Object
- #list_tollfree(options = nil) ⇒ Object
- #numberpool ⇒ Object
- #remove_number(number, unrent = false) ⇒ Object
- #remove_shortcode(number) ⇒ Object
- #remove_tollfree(number, unrent = false) ⇒ Object
- #to_s ⇒ Object
- #update(options = nil) ⇒ Object
Methods included from Utils
GetSortedQueryParamString?, compute_signatureV3?, expected_type?, expected_value?, generate_url?, getMapFromQueryString?, raise_invalid_request, valid_account?, valid_mainaccount?, valid_param?, valid_signature?, valid_signatureV3?, valid_subaccount?
Constructor Details
#initialize(client, options = nil) ⇒ Powerpack
Returns a new instance of Powerpack.
6 7 8 9 10 |
# File 'lib/plivo/resources/powerpacks.rb', line 6 def initialize(client, = nil) @_name = 'Powerpack' @_identifier_string = 'uuid' super end |
Instance Method Details
#add_number(number, options = nil) ⇒ Object
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 |
# File 'lib/plivo/resources/powerpacks.rb', line 168 def add_number(number, = nil) number_pool_uuid = getnumberpool_uuid(uuid) if .nil? return perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Number/' + number.to_s , 'POST') return end params = {} if .key?(:service) && valid_param?(:service, [:service], String, true) params[:service] = [:service] end perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Number/' + number.to_s , 'POST', params) end |
#add_tollfree(tollfree) ⇒ Object
184 185 186 187 188 |
# File 'lib/plivo/resources/powerpacks.rb', line 184 def add_tollfree(tollfree) number_pool_uuid = getnumberpool_uuid(uuid) perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Tollfree/' + tollfree.to_s , 'POST') end |
#buy_add_number(options = nil) ⇒ Object
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 |
# File 'lib/plivo/resources/powerpacks.rb', line 268 def buy_add_number( = nil) number_pool_uuid = getnumberpool_uuid(uuid) params = {} params[:rent] = true if .key?(:service) && valid_param?(:service, [:service], String, true) params[:service] = [:service] end if .key?(:number) return perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Number/' + [:number].to_s , 'POST', params) end if .key?(:country_iso2).nil? raise_invalid_request('country_iso is cannot be empty') end %i[offset limit].each do |param| if .key?(param) && valid_param?(param, [param], [Integer, Integer], true) params[param] = [param] end end if .key?(:limit) && ([:limit] > 20 || [:limit] <= 0) raise_invalid_request('The maximum number of results that can be '\ "fetched is 20. limit can't be more than 20 or less than 1") end if .key?(:offset) && [:offset] < 0 raise_invalid_request("Offset can't be negative") end if .key?(:pattern) && valid_param?(:pattern, [:pattern], String, true) params[:starts_with] = [:pattern] end if .key?(:country_iso2) && valid_param?(:country_iso2, [:country_iso2], String, true) params[:country_iso] = [:country_iso2] end if .key?(:type) && valid_param?(:type, [:type], String, true) params[:type] = [:type] end response = perform_custom_action_apiresponse('PhoneNumber', 'GET', params, true) numbers = response['objects'][0]['number'] perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Number/' + numbers.to_s, 'POST', params) end |
#count_numbers(options = nil) ⇒ Object
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'lib/plivo/resources/powerpacks.rb', line 104 def count_numbers( = nil) number_pool_uuid = getnumberpool_uuid(uuid) if .nil? response = perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Number', 'GET') = response['meta'] return ['total_count'] end params = {} %i[offset limit].each do |param| if .key?(param) && valid_param?(param, [param], [Integer, Integer], true) params[param] = [param] end end if .key?(:limit) && ([:limit] > 20 || [:limit] <= 0) raise_invalid_request('The maximum number of results that can be '\ "fetched is 20. limit can't be more than 20 or less than 1") end if .key?(:offset) && [:offset] < 0 raise_invalid_request("Offset can't be negative") end if .key?(:starts_with) && valid_param?(:starts_with, [:starts_with], String, true) params[:starts_with] = [:starts_with] end if .key?(:country_iso2) && valid_param?(:country_iso2, [:country_iso2], String, true) params[:country_iso2] = [:country_iso2] end if .key?(:type) && valid_param?(:type, [:type], String, true) params[:type] = [:type] end if .key?(:service) && valid_param?(:service, [:service], String, true) params[:service] = [:service] end response = perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Number', 'GET', param, true) = response['meta'] return ['total_count'] end |
#delete(unrent_numbers = false) ⇒ Object
18 19 20 21 22 23 24 25 26 27 |
# File 'lib/plivo/resources/powerpacks.rb', line 18 def delete(unrent_numbers = false) valid_param?(:unrent_numbers, unrent_numbers, [TrueClass, FalseClass], false, [true, false]) params = { :unrent_numbers => unrent_numbers } perform_action_apiresponse('', 'DELETE', params) # perform_delete(params) end |
#find_number(number, options = nil) ⇒ Object
153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
# File 'lib/plivo/resources/powerpacks.rb', line 153 def find_number(number, = nil) number_pool_uuid = getnumberpool_uuid(uuid) if .nil? return perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Number/' + number.to_s , 'GET') end params = {} if .key?(:service) && valid_param?(:service, [:service], String, true) params[:service] = [:service] end perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Number/' + number.to_s , 'GET', params) end |
#find_shortcode(shortcode) ⇒ Object
256 257 258 259 260 |
# File 'lib/plivo/resources/powerpacks.rb', line 256 def find_shortcode(shortcode) number_pool_uuid = getnumberpool_uuid(uuid) perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Shortcode/' + shortcode.to_s , 'GET') end |
#find_tollfree(tollfree) ⇒ Object
262 263 264 265 266 |
# File 'lib/plivo/resources/powerpacks.rb', line 262 def find_tollfree(tollfree) number_pool_uuid = getnumberpool_uuid(uuid) perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Tollfree/' + tollfree.to_s , 'GET') end |
#getnumberpool_uuid(uuid) ⇒ Object
96 97 98 99 100 101 102 |
# File 'lib/plivo/resources/powerpacks.rb', line 96 def getnumberpool_uuid(uuid) valid_param?(:uuid, uuid, [String, Symbol], true) response = perform_action() numberpool_path = response.number_pool numberpool_array = numberpool_path.split("/") numberpool_array[5] end |
#list_numbers(options = nil) ⇒ Object
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/plivo/resources/powerpacks.rb', line 53 def list_numbers( = nil) number_pool_uuid = getnumberpool_uuid(uuid) return perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Number', 'GET') if .nil? params = {} %i[offset limit].each do |param| if .key?(param) && valid_param?(param, [param], [Integer, Integer], true) params[param] = [param] end end if .key?(:limit) && ([:limit] > 20 || [:limit] <= 0) raise_invalid_request('The maximum number of results that can be '\ "fetched is 20. limit can't be more than 20 or less than 1") end if .key?(:offset) && [:offset] < 0 raise_invalid_request("Offset can't be negative") end if .key?(:starts_with) && valid_param?(:starts_with, [:starts_with], String, true) params[:starts_with] = [:starts_with] end if .key?(:country_iso2) && valid_param?(:country_iso2, [:country_iso2], String, true) params[:country_iso2] = [:country_iso2] end if .key?(:type) && valid_param?(:type, [:type], String, true) params[:type] = [:type] end if .key?(:service) && valid_param?(:service, [:service], String, true) params[:service] = [:service] end perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Number', 'GET', params, true) end |
#list_shortcodes(options = nil) ⇒ Object
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 |
# File 'lib/plivo/resources/powerpacks.rb', line 208 def list_shortcodes( = nil) number_pool_uuid = getnumberpool_uuid(uuid) return perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Shortcode', 'GET') if .nil? params = {} %i[offset limit].each do |param| if .key?(param) && valid_param?(param, [param], [Integer, Integer], true) params[param] = [param] end end if .key?(:limit) && ([:limit] > 20 || [:limit] <= 0) raise_invalid_request('The maximum number of results that can be '\ "fetched is 20. limit can't be more than 20 or less than 1") end if .key?(:offset) && [:offset] < 0 raise_invalid_request("Offset can't be negative") end perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Shortcode', 'GET', params) end |
#list_tollfree(options = nil) ⇒ Object
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 |
# File 'lib/plivo/resources/powerpacks.rb', line 232 def list_tollfree( = nil) number_pool_uuid = getnumberpool_uuid(uuid) return perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Tollfree', 'GET') if .nil? params = {} %i[offset limit].each do |param| if .key?(param) && valid_param?(param, [param], [Integer, Integer], true) params[param] = [param] end end if .key?(:limit) && ([:limit] > 20 || [:limit] <= 0) raise_invalid_request('The maximum number of results that can be '\ "fetched is 20. limit can't be more than 20 or less than 1") end if .key?(:offset) && [:offset] < 0 raise_invalid_request("Offset can't be negative") end perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Tollfree', 'GET', params) end |
#numberpool ⇒ Object
12 13 14 15 16 |
# File 'lib/plivo/resources/powerpacks.rb', line 12 def numberpool number_pool_uuid = getnumberpool_uuid(uuid) = {'number_pool_id' => number_pool_uuid} NumberPool.new(@_client, {resource_json: }) end |
#remove_number(number, unrent = false) ⇒ Object
190 191 192 193 194 |
# File 'lib/plivo/resources/powerpacks.rb', line 190 def remove_number(number, unrent= false) number_pool_uuid = getnumberpool_uuid(uuid) perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Number/' + number.to_s , 'DELETE', { unrent: unrent }, false) end |
#remove_shortcode(number) ⇒ Object
202 203 204 205 206 |
# File 'lib/plivo/resources/powerpacks.rb', line 202 def remove_shortcode(number) number_pool_uuid = getnumberpool_uuid(uuid) perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Shortcode/' + number.to_s , 'DELETE', { unrent: false }, false) end |
#remove_tollfree(number, unrent = false) ⇒ Object
196 197 198 199 200 |
# File 'lib/plivo/resources/powerpacks.rb', line 196 def remove_tollfree(number, unrent= false) number_pool_uuid = getnumberpool_uuid(uuid) perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Tollfree/' + number.to_s , 'DELETE', { unrent: unrent }, false) end |
#to_s ⇒ Object
320 321 322 323 324 325 326 327 328 329 330 331 |
# File 'lib/plivo/resources/powerpacks.rb', line 320 def to_s { name: @name, application_type: @application_type, application_id: @application_id, sticky_sender: @sticky_sender, local_connect: @local_connect, uuid: @uuid, number_pool:@number_pool, created_on:@created_on }.to_s end |
#update(options = nil) ⇒ Object
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
# File 'lib/plivo/resources/powerpacks.rb', line 29 def update( = nil) valid_param?(:options, , Hash, true) params = {} if .key?(:application_type) params[:application_type] = [:application_type] end if .key?(:application_id) params[:application_id] = [:application_id] end if .key?(:sticky_sender) params[:sticky_sender] = [:sticky_sender] end if .key?(:local_connect) params[:local_connect] = [:local_connect] end if .key?(:name) params[:name] = [:name] end perform_action_apiresponse('', 'POST', params) end |