File models/PhoneNumbers.php | Bandwidth PHP SDK

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  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  95  96  97  98  99 100 101 102 103 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 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205

<?php

/**
 * @model PhoneNumbers
 * http://ap.bandwidth.com/docs/rest-api/phonenumbers/
 *
 * Interface to manage account numbers.
 *
 * provides:
 * getNumberInfo
 * batchAllocateLocal 
 * batchAllocateTollFree
 * validateSearchQuery
 *
 */
namespace Catapult;

final class PhoneNumbers extends GenericResource {
    private $availablePath = "availableNumbers";

    /**
     * CTor for phone numbers 
     * use PhoneNumbers path primary,
     * availableNumbers secondary 
     *
     * Init Forms
     * GET 
     * PhoneNumbers('number-id')
     * PhoneNumbers
     *
     * POST
     * PhoneNumbers(array)
     */
    public function __construct() {
        $data = Ensure::Input(func_get_args());
        parent::_init($data, new DependsResource,
          new LoadsResource(array("primary" => "GET", "id" => "number", "init" => array(), "silent" => true)),
          new SchemaResource(array("fields" => array(
            'id', 'application', 'number', 'nationalNumber',
            'name', 'createdTime', 'city', 'state', 'price',
            'numberState', 'fallbackNumber', 'patternMatch', 'lata', 'rateCenter'
             ), "needs" => array("id", "number", "name"),
         )));
    }

    /**
     * Get the information
     * for a given number
     * @param valid number
     */
    public function getNumberInfo($number)
    {
        return $this->get($number);
    }
    /**
     * Make the needed changes to 
     * the PhoneNumber. Where
     * set of params can be:
     * applicationId, 
     * fallback_number,
     *  
     * @param data: set of valid patching options
     */
    public function patch($data)
    {
        $app = $data['applicationId'];
        if ($app instanceof Application)
            $data['applicationId'] = $app->id; 
        $data = Ensure::Input($data);
        $url = URIResource::Make($this->path, array($this->id));
    
        $this->client->post($url, $data->get());    
        return Constructor::Make($this, $data->get());
    }
    /* Deletes an allocated
     * number. this cannot be undone
     * 
     * update: make arguments compatable with
     * genericResource
     * @param id in place of initialized
     */
    public function delete($data=null)
    {
        $url = URIResource::Make($this->path, array($this->id)); 
        return $this->client->delete($url);
    }
    /**
     * stub for allocate 
     * get new numbers
     * @param args: see allocate
     */
    public function create()
    {
        $input = Ensure::Input(func_get_args());
        return $this->allocate($input->get());
    }
    /**
     * allocate a new number
     * number must be available
     * or warning will be thrown
     * @param args
     *   number, 
     *   application (one you want to associate this number with)
     *   fallback a fallback option if this isnt available
     */
    public function allocate($args)
    {
        $data = Ensure::Input($args);
        $url = URIResource::Make($this->path);
        $id = Locator::Find($this->client->post($url, $data->get()));
    
        $data->add("id", $id);
        return Constructor::Make($this, $data->get());
    }
    /** 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
     *
     * @param args: set of arguments with above constraints
     */
    public function validateSearchQuery($args)
    {
        if (array_key_exists("zip", $args) && !(array_key_exists("state", $args) || array_key_exists("areaCode", $args)))
            return;
        if (array_key_exists("state", $args) && !(array_key_exists("zip", $args) || array_key_exists("areaCode", $args)))
            return;
        if (array_key_exists("areaCode", $args) && !(array_key_exists("zip", $args) || array_key_exists("state", $args)))
            return;
        if (!(array_key_exists("areaCode", $args) && array_key_exists("zip", $args) && array_key_exists("state", $args)))
            throw new \CatapultApiException("state, zip and areaCode are mutually exclusive, you may use only one of them per request");
        if (!(array_key_exists("areaCode")))
            throw new \CatapultApiException("localNumber and inLocalCallingArea only applies '
                             'for searching numbers in specific areaCode'");
    }
    /**
     * List the local numbers
     * according to the provided numbers
     * 
     * @param params
     */
    public function listLocal($params)
    {
        $data = Ensure::Input($params);
        if (!($data->has("size")))
            $data->add("size", DEFAULTS::SIZE);
        if (!($data->has("page")))
            $data->add("page", DEFAULTS::PAGE);
        $url = URIResource::Make($this->availablePath, array("local"));
        $data = $this->client->get($url, $data->get(), true, false);
        return new PhoneNumbersCollection(new DataPacketCollection($data));
    }
    /**
     * List toll free numbers
     * according to the provided parameters
     *
     * @param set of toll free parameters
     */
    public function listTollFree($params)
    {
        $data = Ensure::Input($params);
        if (!($data->has("size")))
            $data->add("size", DEFAULTS::SIZE);
        if (!($data->has("page")))
            $data->add("page", DEFAULTS::PAGE);
        $url = URIResource::Make($this->availablePath, array("tollFree"));
        $data = $this->client->get($url, $data->get(), true, false);
        return new PhoneNumbersCollection(new DataPacketCollection($data));
    }
    /**
     * 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.
     * @param params
     */
    public function batchAllocateLocal($params)
    {
        $this->validate_search_query($params);
        $args = Ensure::Input($params);
        $url = URIResource::Make($this->availablePath, array("local"));
        $data = $this->client->post($url, $args->get(), true, false, true /* mixed uses GET parameters */);
        return new PhoneNumbersCollection(new DataPacketCollection($data));
    }
    /**
     * TollFree version batch allocation
     *
     * @param params
     */
    public function batchAllocateTollFree($params)
    {
        $url = URIResource::Make($this->availablePath, array("tollFree"));  
        
        $args = Ensure::Input($params);
        $data = $this->client->post($url, $args->get(), true, false, true /* mixed use GET parameters */);
        return new PhoneNumbersCollection(new DataPacketCollection($data));
    }
}

Namespaces

Classes

Interfaces

Exceptions

Functions