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/Chat/V2/Service/Channel/ |
<?php
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
namespace Twilio\Rest\Chat\V2\Service\Channel;
use Twilio\Exceptions\TwilioException;
use Twilio\ListResource;
use Twilio\Options;
use Twilio\Serialize;
use Twilio\Values;
use Twilio\Version;
class InviteList extends ListResource {
/**
* Construct the InviteList
*
* @param Version $version Version that contains the resource
* @param string $serviceSid The SID of the Service that the resource is
* associated with
* @param string $channelSid The SID of the Channel the new resource belongs to
* @return \Twilio\Rest\Chat\V2\Service\Channel\InviteList
*/
public function __construct(Version $version, $serviceSid, $channelSid) {
parent::__construct($version);
// Path Solution
$this->solution = array('serviceSid' => $serviceSid, 'channelSid' => $channelSid, );
$this->uri = '/Services/' . \rawurlencode($serviceSid) . '/Channels/' . \rawurlencode($channelSid) . '/Invites';
}
/**
* Create a new InviteInstance
*
* @param string $identity The `identity` value that identifies the new
* resource's User
* @param array|Options $options Optional Arguments
* @return InviteInstance Newly created InviteInstance
* @throws TwilioException When an HTTP error occurs.
*/
public function create($identity, $options = array()) {
$options = new Values($options);
$data = Values::of(array('Identity' => $identity, 'RoleSid' => $options['roleSid'], ));
$payload = $this->version->create(
'POST',
$this->uri,
array(),
$data
);
return new InviteInstance(
$this->version,
$payload,
$this->solution['serviceSid'],
$this->solution['channelSid']
);
}
/**
* Streams InviteInstance 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 InviteInstance 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 InviteInstance[] 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 InviteInstance 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 InviteInstance
*/
public function page($options = array(), $pageSize = Values::NONE, $pageToken = Values::NONE, $pageNumber = Values::NONE) {
$options = new Values($options);
$params = Values::of(array(
'Identity' => Serialize::map($options['identity'], function($e) { return $e; }),
'PageToken' => $pageToken,
'Page' => $pageNumber,
'PageSize' => $pageSize,
));
$response = $this->version->page(
'GET',
$this->uri,
$params
);
return new InvitePage($this->version, $response, $this->solution);
}
/**
* Retrieve a specific page of InviteInstance records from the API.
* Request is executed immediately
*
* @param string $targetUrl API-generated URL for the requested results page
* @return \Twilio\Page Page of InviteInstance
*/
public function getPage($targetUrl) {
$response = $this->version->getDomain()->getClient()->request(
'GET',
$targetUrl
);
return new InvitePage($this->version, $response, $this->solution);
}
/**
* Constructs a InviteContext
*
* @param string $sid The SID of the Invite resource to fetch
* @return \Twilio\Rest\Chat\V2\Service\Channel\InviteContext
*/
public function getContext($sid) {
return new InviteContext(
$this->version,
$this->solution['serviceSid'],
$this->solution['channelSid'],
$sid
);
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString() {
return '[Twilio.Chat.V2.InviteList]';
}
}