/src/Twilio/Rest/Conversations/V1/Conversation/WebhookList.php
PHP | 159 lines | 56 code | 21 blank | 82 comment | 0 complexity | 5c1584218c3eae448d43d383a298e837 MD5 | raw file
Possible License(s): MIT
- <?php
- /**
- * This code was generated by
- * \ / _ _ _| _ _
- * | (_)\/(_)(_|\/| |(/_ v1.0.0
- * / /
- */
- namespace Twilio\Rest\Conversations\V1\Conversation;
- use Twilio\Exceptions\TwilioException;
- use Twilio\ListResource;
- use Twilio\Options;
- use Twilio\Serialize;
- use Twilio\Stream;
- use Twilio\Values;
- use Twilio\Version;
- class WebhookList extends ListResource {
- /**
- * Construct the WebhookList
- *
- * @param Version $version Version that contains the resource
- * @param string $conversationSid The unique ID of the Conversation for this
- * webhook.
- */
- public function __construct(Version $version, string $conversationSid) {
- parent::__construct($version);
- // Path Solution
- $this->solution = ['conversationSid' => $conversationSid, ];
- $this->uri = '/Conversations/' . \rawurlencode($conversationSid) . '/Webhooks';
- }
- /**
- * Streams WebhookInstance 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 WebhookInstance 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 WebhookInstance[] 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 WebhookInstance 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 WebhookPage Page of WebhookInstance
- */
- public function page($pageSize = Values::NONE, string $pageToken = Values::NONE, $pageNumber = Values::NONE): WebhookPage {
- $params = Values::of(['PageToken' => $pageToken, 'Page' => $pageNumber, 'PageSize' => $pageSize, ]);
- $response = $this->version->page('GET', $this->uri, $params);
- return new WebhookPage($this->version, $response, $this->solution);
- }
- /**
- * Retrieve a specific page of WebhookInstance records from the API.
- * Request is executed immediately
- *
- * @param string $targetUrl API-generated URL for the requested results page
- * @return WebhookPage Page of WebhookInstance
- */
- public function getPage(string $targetUrl): WebhookPage {
- $response = $this->version->getDomain()->getClient()->request(
- 'GET',
- $targetUrl
- );
- return new WebhookPage($this->version, $response, $this->solution);
- }
- /**
- * Create the WebhookInstance
- *
- * @param string $target The target of this webhook.
- * @param array|Options $options Optional Arguments
- * @return WebhookInstance Created WebhookInstance
- * @throws TwilioException When an HTTP error occurs.
- */
- public function create(string $target, array $options = []): WebhookInstance {
- $options = new Values($options);
- $data = Values::of([
- 'Target' => $target,
- 'Configuration.Url' => $options['configurationUrl'],
- 'Configuration.Method' => $options['configurationMethod'],
- 'Configuration.Filters' => Serialize::map($options['configurationFilters'], function($e) { return $e; }),
- 'Configuration.Triggers' => Serialize::map($options['configurationTriggers'], function($e) { return $e; }),
- 'Configuration.FlowSid' => $options['configurationFlowSid'],
- 'Configuration.ReplayAfter' => $options['configurationReplayAfter'],
- ]);
- $payload = $this->version->create('POST', $this->uri, [], $data);
- return new WebhookInstance($this->version, $payload, $this->solution['conversationSid']);
- }
- /**
- * Constructs a WebhookContext
- *
- * @param string $sid A 34 character string that uniquely identifies this
- * resource.
- */
- public function getContext(string $sid): WebhookContext {
- return new WebhookContext($this->version, $this->solution['conversationSid'], $sid);
- }
- /**
- * Provide a friendly representation
- *
- * @return string Machine friendly representation
- */
- public function __toString(): string {
- return '[Twilio.Conversations.V1.WebhookList]';
- }
- }