<?php
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
namespace Twilio\Rest\Api\V2010\Account\AvailablePhoneNumberCountry;
use Twilio\ListResource;
use Twilio\Options;
use Twilio\Serialize;
use Twilio\Values;
use Twilio\Version;
class MachineToMachineList extends ListResource {
/**
* Construct the MachineToMachineList
*
* @param Version $version Version that contains the resource
* @param string $accountSid The account_sid
* @param string $countryCode The ISO-3166-1 country code of the country.
* @return \Twilio\Rest\Api\V2010\Account\AvailablePhoneNumberCountry\MachineToMachineList
*/
public function __construct(Version $version, $accountSid, $countryCode) {
parent::__construct($version);
// Path Solution
$this->solution = array('accountSid' => $accountSid, 'countryCode' => $countryCode, );
$this->uri = '/Accounts/' . rawurlencode($accountSid) . '/AvailablePhoneNumbers/' . rawurlencode($countryCode) . '/MachineToMachine.json';
}
/**
* Streams MachineToMachineInstance 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 \Twilio\Stream stream of results
*/
public function stream($options = array(), $limit = null, $pageSize = null) {
$limits = $this->version->readLimits($limit, $pageSize);
$page = $this->page($options, $limits['pageSize']);
return $this->version->stream($page, $limits['limit'], $limits['pageLimit']);
}
/**
* Reads MachineToMachineInstance 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 MachineToMachineInstance[] Array of results
*/
public function read($options = array(), $limit = null, $pageSize = null) {
return iterator_to_array($this->stream($options, $limit, $pageSize), false);
}
/**
* Retrieve a single page of MachineToMachineInstance records from the API.
* Request is executed immediately
*
* @param array|Options $options Optional Arguments
* @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 \Twilio\Page Page of MachineToMachineInstance
*/
public function page($options = array(), $pageSize = Values::NONE, $pageToken = Values::NONE, $pageNumber = Values::NONE) {
$options = new Values($options);
$params = Values::of(array(
'AreaCode' => $options['areaCode'],
'Contains' => $options['contains'],
'SmsEnabled' => Serialize::booleanToString($options['smsEnabled']),
'MmsEnabled' => Serialize::booleanToString($options['mmsEnabled']),
'VoiceEnabled' => Serialize::booleanToString($options['voiceEnabled']),
'ExcludeAllAddressRequired' => Serialize::booleanToString($options['excludeAllAddressRequired']),
'ExcludeLocalAddressRequired' => Serialize::booleanToString($options['excludeLocalAddressRequired']),
'ExcludeForeignAddressRequired' => Serialize::booleanToString($options['excludeForeignAddressRequired']),
'Beta' => Serialize::booleanToString($options['beta']),
'NearNumber' => $options['nearNumber'],
'NearLatLong' => $options['nearLatLong'],
'Distance' => $options['distance'],
'InPostalCode' => $options['inPostalCode'],
'InRegion' => $options['inRegion'],
'InRateCenter' => $options['inRateCenter'],
'InLata' => $options['inLata'],
'InLocality' => $options['inLocality'],
'FaxEnabled' => Serialize::booleanToString($options['faxEnabled']),
'PageToken' => $pageToken,
'Page' => $pageNumber,
'PageSize' => $pageSize,
));
$response = $this->version->page(
'GET',
$this->uri,
$params
);
return new MachineToMachinePage($this->version, $response, $this->solution);
}
/**
* Retrieve a specific page of MachineToMachineInstance records from the API.
* Request is executed immediately
*
* @param string $targetUrl API-generated URL for the requested results page
* @return \Twilio\Page Page of MachineToMachineInstance
*/
public function getPage($targetUrl) {
$response = $this->version->getDomain()->getClient()->request(
'GET',
$targetUrl
);
return new MachineToMachinePage($this->version, $response, $this->solution);
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString() {
return '[Twilio.Api.V2010.MachineToMachineList]';
}
}