Server : Apache/2.4.62 (Unix) OpenSSL/1.0.2k-fips System : Linux server1.richineiserver.com 3.10.0-1160.119.1.el7.x86_64 #1 SMP Tue Jun 4 14:43:51 UTC 2024 x86_64 User : fdshops ( 1003) PHP Version : 8.2.21 Disable Function : NONE Directory : /home/fdshops/public_html/vendor/twilio/sdk/src/Twilio/Rest/Autopilot/V1/Assistant/ |
<?php
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
namespace Twilio\Rest\Autopilot\V1\Assistant;
use Twilio\Exceptions\TwilioException;
use Twilio\ListResource;
use Twilio\Options;
use Twilio\Values;
use Twilio\Version;
/**
* PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
*/
class WebhookList extends ListResource {
/**
* Construct the WebhookList
*
* @param Version $version Version that contains the resource
* @param string $assistantSid The SID of the Assistant that is the parent of
* the resource
* @return \Twilio\Rest\Autopilot\V1\Assistant\WebhookList
*/
public function __construct(Version $version, $assistantSid) {
parent::__construct($version);
// Path Solution
$this->solution = array('assistantSid' => $assistantSid, );
$this->uri = '/Assistants/' . \rawurlencode($assistantSid) . '/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 \Twilio\Stream stream of results
*/
public function stream($limit = null, $pageSize = null) {
$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($limit = null, $pageSize = null) {
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 \Twilio\Page Page of WebhookInstance
*/
public function page($pageSize = Values::NONE, $pageToken = Values::NONE, $pageNumber = Values::NONE) {
$params = Values::of(array(
'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 \Twilio\Page Page of WebhookInstance
*/
public function getPage($targetUrl) {
$response = $this->version->getDomain()->getClient()->request(
'GET',
$targetUrl
);
return new WebhookPage($this->version, $response, $this->solution);
}
/**
* Create a new WebhookInstance
*
* @param string $uniqueName An application-defined string that uniquely
* identifies the resource
* @param string $events The list of space-separated events that this Webhook
* will subscribe to.
* @param string $webhookUrl The URL associated with this Webhook.
* @param array|Options $options Optional Arguments
* @return WebhookInstance Newly created WebhookInstance
* @throws TwilioException When an HTTP error occurs.
*/
public function create($uniqueName, $events, $webhookUrl, $options = array()) {
$options = new Values($options);
$data = Values::of(array(
'UniqueName' => $uniqueName,
'Events' => $events,
'WebhookUrl' => $webhookUrl,
'WebhookMethod' => $options['webhookMethod'],
));
$payload = $this->version->create(
'POST',
$this->uri,
array(),
$data
);
return new WebhookInstance($this->version, $payload, $this->solution['assistantSid']);
}
/**
* Constructs a WebhookContext
*
* @param string $sid The unique string that identifies the resource to fetch
* @return \Twilio\Rest\Autopilot\V1\Assistant\WebhookContext
*/
public function getContext($sid) {
return new WebhookContext($this->version, $this->solution['assistantSid'], $sid);
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString() {
return '[Twilio.Autopilot.V1.WebhookList]';
}
}