File models/Endpoints.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

<?php
/**
 * @model Endpoints
 *
 * http://ap.bandwidth.com/docs/rest-api/endpoints-2/
 *
 * Provides endpoints functionality
 */ 

namespace Catapult;
  
final class Endpoints extends GenericResource {

  /**
   * construct the endpoint as initiated
   * or a new one. endpoints take domains
   * as a dependancy so we need one on init
   *
   * init forms
   *
   * GET:
   * Endpoints('domain-id', 'endpoints-id')
   * Endpoints()
   *
   * POST: 
   * Endpoints('domain-id', array)
   * Endpoints(array)
   */
  public function __construct() {
    $data = Ensure::Input(func_get_args());
    return parent::_init($data, new DependsResource(array(
         array("term" => "domains", "plural" => TRUE)
      )), 
      new LoadsResource(
         array("parent" => false, "primary" => "create", "init" => array("domainId"), "id" => "id", "silent"=> TRUE)
      ), 
      new SchemaResource(array(
        "fields" => array('id', 'name', 'description', 'applicationId', 'domainId', 'sipUri', 'enabled', 'credentials'), 
        "needs" => array('name', 'domainId', 'credentials')
      ))
     );
  }

  /**
   * Endpoints overloads the load/1
   * function we need to rebuild its
   * path resource
   * we need: 
   * domains/{domain-id}/endpoints/{endpoint-id}
   *
   * Implementors note:
   * this was added to get around CollectionObject's
   * listAll function which will need to
   * set up this without having to do another RESTful get
   */
  public function load() {
    $data = Ensure::Input(func_get_args());
    $data = $data->get();
    $Endpoint = parent::load($data);
    $Endpoint->path = new PathResource($this,array(
        "domains" => $data['domainId'],
        "endpoints" => ""
      ));

    return $Endpoint;
  }
 
  /**
   * Create musn't preserve the domainId
   * as this will be our path. We will pass
   * it in the parameter, use PathResource
   * then remove it
   *
   * @param: args Endpoint create data
   */ 
  public function create() {
    $data = Ensure::Input(func_get_args());
    $data = $data->get();

    if (isset($data['domainId'])) {
      new PathResource($this, array(
         "domains" => $data['domainId'],
         "endpoints" => ""
          )
      );
    }

    return parent::create($data);
  }

  /** 
   * get the credentials
   * as a EndpointsCredentials
   * object more on this in types
   *
   * @returns EndpointsCredentials
   */
  public function getCredentials() {
    return new EndpointsCredentials($this->credentials);
  }

  /**
   * create an auth token
   * and return it as a EndpointsToken
   * object more on this in types
   *
   * @returns EndpointsToken
   */
  public function createAuthToken() {
    $url = URIResource::Make($this->path, array($this->id, 'tokens'));
    $token = $this->client->post($url, null);
    return new EndpointsToken($token);
  }

  /**
   * delete an auth token
   * given as a EndpointsToken
   * object more on this in types
   *
   * @returns boolean
   */
  public function deleteAuthToken(EndpointsToken $Token) {
    $url = URIResource::Make($this->path, array($this->id, 'tokens', $Token->token));
    return $this->client->delete($url);
  }
}

Namespaces

Classes

Interfaces

Exceptions

Functions