<?php
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
namespace Twilio\Rest\Api\V2010\Account;
use Twilio\Exceptions\TwilioException;
use Twilio\ListResource;
use Twilio\Options;
use Twilio\Serialize;
use Twilio\Stream;
use Twilio\Values;
use Twilio\Version;
class MessageList extends ListResource {
/**
* Construct the MessageList
*
* @param Version $version Version that contains the resource
* @param string $accountSid The SID of the Account that created the resource
*/
public function __construct(Version $version, string $accountSid) {
parent::__construct($version);
// Path Solution
$this->solution = ['accountSid' => $accountSid, ];
$this->uri = '/Accounts/' . \rawurlencode($accountSid) . '/Messages.json';
}
/**
* Create the MessageInstance
*
* @param string $to The destination phone number
* @param array|Options $options Optional Arguments
* @return MessageInstance Created MessageInstance
* @throws TwilioException When an HTTP error occurs.
*/
public function create(string $to, array $options = []): MessageInstance {
$options = new Values($options);
$data = Values::of([
'To' => $to,
'From' => $options['from'],
'MessagingServiceSid' => $options['messagingServiceSid'],
'Body' => $options['body'],
'MediaUrl' => Serialize::map($options['mediaUrl'], function($e) { return $e; }),
'StatusCallback' => $options['statusCallback'],
'ApplicationSid' => $options['applicationSid'],
'MaxPrice' => $options['maxPrice'],
'ProvideFeedback' => Serialize::booleanToString($options['provideFeedback']),
'Attempt' => $options['attempt'],
'ValidityPeriod' => $options['validityPeriod'],
'ForceDelivery' => Serialize::booleanToString($options['forceDelivery']),
'ContentRetention' => $options['contentRetention'],
'AddressRetention' => $options['addressRetention'],
'SmartEncoded' => Serialize::booleanToString($options['smartEncoded']),
'PersistentAction' => Serialize::map($options['persistentAction'], function($e) { return $e; }),
'ShortenUrls' => Serialize::booleanToString($options['shortenUrls']),
'ScheduleType' => $options['scheduleType'],
'SendAt' => Serialize::iso8601DateTime($options['sendAt']),
'SendAsMms' => Serialize::booleanToString($options['sendAsMms']),
'ContentSid' => $options['contentSid'],
'ContentVariables' => $options['contentVariables'],
]);
$payload = $this->version->create('POST', $this->uri, [], $data);
return new MessageInstance($this->version, $payload, $this->solution['accountSid']);
}
/**
* Streams MessageInstance 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']);
}
/**
* Reads MessageInstance 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 MessageInstance[] Array of results
*/
public function read(array $options = [], int $limit = null, $pageSize = null): array {
return \iterator_to_array($this->stream($options, $limit, $pageSize), false);
}
/**
* Retrieve a single page of MessageInstance 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 MessagePage Page of MessageInstance
*/
public function page(array $options = [], $pageSize = Values::NONE, string $pageToken = Values::NONE, $pageNumber = Values::NONE): MessagePage {
$options = new Values($options);
$params = Values::of([
'To' => $options['to'],
'From' => $options['from'],
'DateSent<' => Serialize::iso8601DateTime($options['dateSentBefore']),
'DateSent' => Serialize::iso8601DateTime($options['dateSent']),
'DateSent>' => Serialize::iso8601DateTime($options['dateSentAfter']),
'PageToken' => $pageToken,
'Page' => $pageNumber,
'PageSize' => $pageSize,
]);
$response = $this->version->page('GET', $this->uri, $params);
return new MessagePage($this->version, $response, $this->solution);
}
/**
* Retrieve a specific page of MessageInstance records from the API.
* Request is executed immediately
*
* @param string $targetUrl API-generated URL for the requested results page
* @return MessagePage Page of MessageInstance
*/
public function getPage(string $targetUrl): MessagePage {
$response = $this->version->getDomain()->getClient()->request(
'GET',
$targetUrl
);
return new MessagePage($this->version, $response, $this->solution);
}
/**
* Constructs a MessageContext
*
* @param string $sid The unique string that identifies the resource
*/
public function getContext(string $sid): MessageContext {
return new MessageContext($this->version, $this->solution['accountSid'], $sid);
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString(): string {
return '[Twilio.Api.V2010.MessageList]';
}
} |