Файл: sngine-v2.8/Script/includes/libs/Twilio/Rest/Trunking/V1/Trunk/OriginationUrlList.php
Строк: 278
<?php
/**
* This code was generated by
* / _ _ _| _ _
* | (_)/(_)(_|/| |(/_ v1.0.0
* / /
*/
namespace TwilioRestTrunkingV1Trunk;
use TwilioExceptionsTwilioException;
use TwilioListResource;
use TwilioSerialize;
use TwilioStream;
use TwilioValues;
use TwilioVersion;
class OriginationUrlList extends ListResource {
/**
* Construct the OriginationUrlList
*
* @param Version $version Version that contains the resource
* @param string $trunkSid The SID of the Trunk that owns the Origination URL
*/
public function __construct(Version $version, string $trunkSid) {
parent::__construct($version);
// Path Solution
$this->solution = ['trunkSid' => $trunkSid, ];
$this->uri = '/Trunks/' . rawurlencode($trunkSid) . '/OriginationUrls';
}
/**
* Create the OriginationUrlInstance
*
* @param int $weight The value that determines the relative load the URI
* should receive compared to others with the same priority
* @param int $priority The relative importance of the URI
* @param bool $enabled Whether the URL is enabled
* @param string $friendlyName A string to describe the resource
* @param string $sipUrl The SIP address you want Twilio to route your
* Origination calls to
* @return OriginationUrlInstance Created OriginationUrlInstance
* @throws TwilioException When an HTTP error occurs.
*/
public function create(int $weight, int $priority, bool $enabled, string $friendlyName, string $sipUrl): OriginationUrlInstance {
$data = Values::of([
'Weight' => $weight,
'Priority' => $priority,
'Enabled' => Serialize::booleanToString($enabled),
'FriendlyName' => $friendlyName,
'SipUrl' => $sipUrl,
]);
$payload = $this->version->create('POST', $this->uri, [], $data);
return new OriginationUrlInstance($this->version, $payload, $this->solution['trunkSid']);
}
/**
* Streams OriginationUrlInstance records from the API as a generator stream.
* This operation lazily loads records as efficiently as possible until the
* limit
* is reached.
* The results are returned as a generator, so this operation is memory
* efficient.
*
* @param int $limit Upper limit for the number of records to return. stream()
* guarantees to never return more than limit. Default is no
* limit
* @param mixed $pageSize Number of records to fetch per request, when not set
* will use the default value of 50 records. If no
* page_size is defined but a limit is defined, stream()
* will attempt to read the limit with the most
* efficient page size, i.e. min(limit, 1000)
* @return Stream stream of results
*/
public function stream(int $limit = null, $pageSize = null): Stream {
$limits = $this->version->readLimits($limit, $pageSize);
$page = $this->page($limits['pageSize']);
return $this->version->stream($page, $limits['limit'], $limits['pageLimit']);
}
/**
* Reads OriginationUrlInstance records from the API as a list.
* Unlike stream(), this operation is eager and will load `limit` records into
* memory before returning.
*
* @param int $limit Upper limit for the number of records to return. read()
* guarantees to never return more than limit. Default is no
* limit
* @param mixed $pageSize Number of records to fetch per request, when not set
* will use the default value of 50 records. If no
* page_size is defined but a limit is defined, read()
* will attempt to read the limit with the most
* efficient page size, i.e. min(limit, 1000)
* @return OriginationUrlInstance[] Array of results
*/
public function read(int $limit = null, $pageSize = null): array {
return iterator_to_array($this->stream($limit, $pageSize), false);
}
/**
* Retrieve a single page of OriginationUrlInstance records from the API.
* Request is executed immediately
*
* @param mixed $pageSize Number of records to return, defaults to 50
* @param string $pageToken PageToken provided by the API
* @param mixed $pageNumber Page Number, this value is simply for client state
* @return OriginationUrlPage Page of OriginationUrlInstance
*/
public function page($pageSize = Values::NONE, string $pageToken = Values::NONE, $pageNumber = Values::NONE): OriginationUrlPage {
$params = Values::of(['PageToken' => $pageToken, 'Page' => $pageNumber, 'PageSize' => $pageSize, ]);
$response = $this->version->page('GET', $this->uri, $params);
return new OriginationUrlPage($this->version, $response, $this->solution);
}
/**
* Retrieve a specific page of OriginationUrlInstance records from the API.
* Request is executed immediately
*
* @param string $targetUrl API-generated URL for the requested results page
* @return OriginationUrlPage Page of OriginationUrlInstance
*/
public function getPage(string $targetUrl): OriginationUrlPage {
$response = $this->version->getDomain()->getClient()->request(
'GET',
$targetUrl
);
return new OriginationUrlPage($this->version, $response, $this->solution);
}
/**
* Constructs a OriginationUrlContext
*
* @param string $sid The unique string that identifies the resource
*/
public function getContext(string $sid): OriginationUrlContext {
return new OriginationUrlContext($this->version, $this->solution['trunkSid'], $sid);
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString(): string {
return '[Twilio.Trunking.V1.OriginationUrlList]';
}
}