<?php
/**
* This code was generated by
* ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
* | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
* | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
*
* Twilio - Api
* This is the public Twilio REST API.
*
* NOTE: This class is auto generated by OpenAPI Generator.
* https://openapi-generator.tech
* Do not edit the class manually.
*/
namespace Twilio\Rest\Api\V2010\Account\Usage;
use Twilio\Exceptions\TwilioException;
use Twilio\ListResource;
use Twilio\Options;
use Twilio\Stream;
use Twilio\Values;
use Twilio\Version;
use Twilio\InstanceContext;
use Twilio\Serialize;
use Twilio\Rest\Api\V2010\Account\Usage\Record\LastMonthList;
use Twilio\Rest\Api\V2010\Account\Usage\Record\TodayList;
use Twilio\Rest\Api\V2010\Account\Usage\Record\YearlyList;
use Twilio\Rest\Api\V2010\Account\Usage\Record\ThisMonthList;
use Twilio\Rest\Api\V2010\Account\Usage\Record\DailyList;
use Twilio\Rest\Api\V2010\Account\Usage\Record\AllTimeList;
use Twilio\Rest\Api\V2010\Account\Usage\Record\YesterdayList;
use Twilio\Rest\Api\V2010\Account\Usage\Record\MonthlyList;
/**
* @property LastMonthList $lastMonth
* @property TodayList $today
* @property YearlyList $yearly
* @property ThisMonthList $thisMonth
* @property DailyList $daily
* @property AllTimeList $allTime
* @property YesterdayList $yesterday
* @property MonthlyList $monthly
*/
class RecordList extends ListResource
{
protected $_lastMonth = null;
protected $_today = null;
protected $_yearly = null;
protected $_thisMonth = null;
protected $_daily = null;
protected $_allTime = null;
protected $_yesterday = null;
protected $_monthly = null;
/**
* Construct the RecordList
*
* @param Version $version Version that contains the resource
* @param string $accountSid The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read.
*/
public function __construct(
Version $version,
string $accountSid
) {
parent::__construct($version);
// Path Solution
$this->solution = [
'accountSid' =>
$accountSid,
];
$this->uri = '/Accounts/' . \rawurlencode($accountSid)
.'/Usage/Records.json';
}
/**
* Reads RecordInstance records from the API as a list.
* Unlike stream(), this operation is eager and will load `limit` records into
* memory before returning.
*
* @param array|Options $options Optional Arguments
* @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 RecordInstance[] Array of results
*/
public function read(array $options = [], int $limit = null, $pageSize = null): array
{
return \iterator_to_array($this->stream($options, $limit, $pageSize), false);
}
/**
* Streams RecordInstance 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 array|Options $options Optional Arguments
* @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(array $options = [], int $limit = null, $pageSize = null): Stream
{
$limits = $this->version->readLimits($limit, $pageSize);
$page = $this->page($options, $limits['pageSize']);
return $this->version->stream($page, $limits['limit'], $limits['pageLimit']);
}
/**
* Retrieve a single page of RecordInstance 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 RecordPage Page of RecordInstance
*/
public function page(
array $options = [],
$pageSize = Values::NONE,
string $pageToken = Values::NONE,
$pageNumber = Values::NONE
): RecordPage
{
$options = new Values($options);
$params = Values::of([
'Category' =>
$options['category'],
'StartDate' =>
Serialize::iso8601Date($options['startDate']),
'EndDate' =>
Serialize::iso8601Date($options['endDate']),
'IncludeSubaccounts' =>
Serialize::booleanToString($options['includeSubaccounts']),
'PageToken' => $pageToken,
'Page' => $pageNumber,
'PageSize' => $pageSize,
]);
$response = $this->version->page('GET', $this->uri, $params);
return new RecordPage($this->version, $response, $this->solution);
}
/**
* Retrieve a specific page of RecordInstance records from the API.
* Request is executed immediately
*
* @param string $targetUrl API-generated URL for the requested results page
* @return RecordPage Page of RecordInstance
*/
public function getPage(string $targetUrl): RecordPage
{
$response = $this->version->getDomain()->getClient()->request(
'GET',
$targetUrl
);
return new RecordPage($this->version, $response, $this->solution);
}
/**
* Access the lastMonth
*/
protected function getLastMonth(): LastMonthList
{
if (!$this->_lastMonth) {
$this->_lastMonth = new LastMonthList(
$this->version,
$this->solution['accountSid']
);
}
return $this->_lastMonth;
}
/**
* Access the today
*/
protected function getToday(): TodayList
{
if (!$this->_today) {
$this->_today = new TodayList(
$this->version,
$this->solution['accountSid']
);
}
return $this->_today;
}
/**
* Access the yearly
*/
protected function getYearly(): YearlyList
{
if (!$this->_yearly) {
$this->_yearly = new YearlyList(
$this->version,
$this->solution['accountSid']
);
}
return $this->_yearly;
}
/**
* Access the thisMonth
*/
protected function getThisMonth(): ThisMonthList
{
if (!$this->_thisMonth) {
$this->_thisMonth = new ThisMonthList(
$this->version,
$this->solution['accountSid']
);
}
return $this->_thisMonth;
}
/**
* Access the daily
*/
protected function getDaily(): DailyList
{
if (!$this->_daily) {
$this->_daily = new DailyList(
$this->version,
$this->solution['accountSid']
);
}
return $this->_daily;
}
/**
* Access the allTime
*/
protected function getAllTime(): AllTimeList
{
if (!$this->_allTime) {
$this->_allTime = new AllTimeList(
$this->version,
$this->solution['accountSid']
);
}
return $this->_allTime;
}
/**
* Access the yesterday
*/
protected function getYesterday(): YesterdayList
{
if (!$this->_yesterday) {
$this->_yesterday = new YesterdayList(
$this->version,
$this->solution['accountSid']
);
}
return $this->_yesterday;
}
/**
* Access the monthly
*/
protected function getMonthly(): MonthlyList
{
if (!$this->_monthly) {
$this->_monthly = new MonthlyList(
$this->version,
$this->solution['accountSid']
);
}
return $this->_monthly;
}
/**
* Magic getter to lazy load subresources
*
* @param string $name Subresource to return
* @return \Twilio\ListResource The requested subresource
* @throws TwilioException For unknown subresources
*/
public function __get(string $name)
{
if (\property_exists($this, '_' . $name)) {
$method = 'get' . \ucfirst($name);
return $this->$method();
}
throw new TwilioException('Unknown subresource ' . $name);
}
/**
* Magic caller to get resource contexts
*
* @param string $name Resource to return
* @param array $arguments Context parameters
* @return InstanceContext The requested resource context
* @throws TwilioException For unknown resource
*/
public function __call(string $name, array $arguments): InstanceContext
{
$property = $this->$name;
if (\method_exists($property, 'getContext')) {
return \call_user_func_array(array($property, 'getContext'), $arguments);
}
throw new TwilioException('Resource does not have a context');
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString(): string
{
return '[Twilio.Api.V2010.RecordList]';
}
}