modern-events-calendar-lite/app/api/Twilio/Rest/Proxy/V1/ServiceList.php

204 lines
6.7 KiB
PHP
Executable file

<?php
/**
* This code was generated by
* ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
* | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
* | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
*
* Twilio - Proxy
* 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\Proxy\V1;
use Twilio\Exceptions\TwilioException;
use Twilio\ListResource;
use Twilio\Options;
use Twilio\Stream;
use Twilio\Values;
use Twilio\Version;
class ServiceList extends ListResource
{
/**
* Construct the ServiceList
*
* @param Version $version Version that contains the resource
*/
public function __construct(
Version $version
) {
parent::__construct($version);
// Path Solution
$this->solution = [
];
$this->uri = '/Services';
}
/**
* Create the ServiceInstance
*
* @param string $uniqueName An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. **This value should not have PII.**
* @param array|Options $options Optional Arguments
* @return ServiceInstance Created ServiceInstance
* @throws TwilioException When an HTTP error occurs.
*/
public function create(string $uniqueName, array $options = []): ServiceInstance
{
$options = new Values($options);
$data = Values::of([
'UniqueName' =>
$uniqueName,
'DefaultTtl' =>
$options['defaultTtl'],
'CallbackUrl' =>
$options['callbackUrl'],
'GeoMatchLevel' =>
$options['geoMatchLevel'],
'NumberSelectionBehavior' =>
$options['numberSelectionBehavior'],
'InterceptCallbackUrl' =>
$options['interceptCallbackUrl'],
'OutOfSessionCallbackUrl' =>
$options['outOfSessionCallbackUrl'],
'ChatInstanceSid' =>
$options['chatInstanceSid'],
]);
$payload = $this->version->create('POST', $this->uri, [], $data);
return new ServiceInstance(
$this->version,
$payload
);
}
/**
* Reads ServiceInstance 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 ServiceInstance[] Array of results
*/
public function read(int $limit = null, $pageSize = null): array
{
return \iterator_to_array($this->stream($limit, $pageSize), false);
}
/**
* Streams ServiceInstance 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']);
}
/**
* Retrieve a single page of ServiceInstance 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 ServicePage Page of ServiceInstance
*/
public function page(
$pageSize = Values::NONE,
string $pageToken = Values::NONE,
$pageNumber = Values::NONE
): ServicePage
{
$params = Values::of([
'PageToken' => $pageToken,
'Page' => $pageNumber,
'PageSize' => $pageSize,
]);
$response = $this->version->page('GET', $this->uri, $params);
return new ServicePage($this->version, $response, $this->solution);
}
/**
* Retrieve a specific page of ServiceInstance records from the API.
* Request is executed immediately
*
* @param string $targetUrl API-generated URL for the requested results page
* @return ServicePage Page of ServiceInstance
*/
public function getPage(string $targetUrl): ServicePage
{
$response = $this->version->getDomain()->getClient()->request(
'GET',
$targetUrl
);
return new ServicePage($this->version, $response, $this->solution);
}
/**
* Constructs a ServiceContext
*
* @param string $sid The Twilio-provided string that uniquely identifies the Service resource to delete.
*/
public function getContext(
string $sid
): ServiceContext
{
return new ServiceContext(
$this->version,
$sid
);
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString(): string
{
return '[Twilio.Proxy.V1.ServiceList]';
}
}