Class PhoneNumbers

GenericResource is the class every model should use for initialization. It provides the functions to check the mandatory, optional arguments provided

Catapult\GenericResource

Extended by

Catapult\PhoneNumbers

Final
Namespace: Catapult
Located at models/PhoneNumbers.php

Methods summary

`public`	# `__construct( )` CTor for phone numbers use PhoneNumbers path primary, availableNumbers secondary CTor for phone numbers use PhoneNumbers path primary, availableNumbers secondary Init Forms GET PhoneNumbers('number-id') PhoneNumbers POST PhoneNumbers(array)
`public`	# `getNumberInfo( valid $number )` Get the information for a given number Get the information for a given number Parameters `$number` number
`public`	# `patch( data: $data )` Make the needed changes to the PhoneNumber. Where set of params can be: applicationId, fallback_number, Make the needed changes to the PhoneNumber. Where set of params can be: applicationId, fallback_number, Parameters `$data` of valid patching options
`public`	# `delete( id $data = null )` delete a media file delete a media file TODO: this should not keep the object's information. This will not be useful anymore! Parameters `$data` model Overrides `Catapult\GenericResource::delete`
`public`	# `create( )` stub for allocate get new numbers stub for allocate get new numbers Overrides `Catapult\GenericResource::create`
`public`	# `allocate( args $args )` allocate a new number number must be available or warning will be thrown allocate a new number number must be available or warning will be thrown Parameters `$args` application (one you want to associate this number with) fallback a fallback option if this isnt available
`public`	# `validateSearchQuery( args: $args )` validate params for availabe local number search. Rules: 1) state, zip and areaCode are mutually exclusive use only one of them per request 2) localNumber and inLocalCallingArea only applies for searching and order numbers in specific areaCode validate params for availabe local number search. Rules: 1) state, zip and areaCode are mutually exclusive use only one of them per request 2) localNumber and inLocalCallingArea only applies for searching and order numbers in specific areaCode Parameters `$args` of arguments with above constraints
`public`	# `listLocal( params $params )` List the local numbers according to the provided numbers List the local numbers according to the provided numbers Parameters `$params`
`public`	# `listTollFree( set $params )` List toll free numbers according to the provided parameters List toll free numbers according to the provided parameters Parameters `$params` toll free parameters
`public`	# `batchAllocateLocal( params $params )` Allocate numbers in batch where numbers must be local Allocate numbers in batch where numbers must be local notes: 1. state, zip and area_code are mutually exclusive, you may use only one of them per calling list_local. 2. local_number and in_local_calling_area only applies for searching numbers in specific area_code. Parameters `$params`
`public`	# `batchAllocateTollFree( params $params )` TollFree version batch allocation TollFree version batch allocation Parameters `$params`

Methods inherited from Catapult\GenericResource

__call(), __toString(), _init(), _list(), check(), get(), getAudioUrl(), getObjClass(), getPath(), getSchemaString(), get_sub_function(), load(), reload(), toArray(), update()

Properties summary

Properties inherited from Catapult\GenericResource

$lastUpdate, $paths