Viewing file:  InsightsAssessmentsCommentList.php (6.95 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
namespace Twilio\Rest\FlexApi\V1;
use Twilio\Exceptions\TwilioException;
use Twilio\ListResource;
use Twilio\Options;
use Twilio\Stream;
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 InsightsAssessmentsCommentList extends ListResource {
/**
* Construct the InsightsAssessmentsCommentList
*
* @param Version $version Version that contains the resource
*/
public function __construct(Version $version) {
parent::__construct($version);
// Path Solution
$this->solution = [];
$this->uri = '/Insights/QM/Assessments/Comments';
}
/**
* Create the InsightsAssessmentsCommentInstance
*
* @param string $categoryId Category ID
* @param string $categoryName Category name
* @param string $comment The comment.
* @param string $segmentId Segment Id.
* @param string $userName The user name.
* @param string $userEmail The user email id.
* @param string $agentId Agent Id.
* @param string $offset Offset.
* @param array|Options $options Optional Arguments
* @return InsightsAssessmentsCommentInstance Created
* InsightsAssessmentsCommentInstance
* @throws TwilioException When an HTTP error occurs.
*/
public function create(string $categoryId, string $categoryName, string $comment, string $segmentId, string $userName, string $userEmail, string $agentId, string $offset, array $options = []): InsightsAssessmentsCommentInstance {
$options = new Values($options);
$data = Values::of([
'CategoryId' => $categoryId,
'CategoryName' => $categoryName,
'Comment' => $comment,
'SegmentId' => $segmentId,
'UserName' => $userName,
'UserEmail' => $userEmail,
'AgentId' => $agentId,
'Offset' => $offset,
]);
$headers = Values::of(['Token' => $options['token'], ]);
$payload = $this->version->create('POST', $this->uri, [], $data, $headers);
return new InsightsAssessmentsCommentInstance($this->version, $payload);
}
/**
* Streams InsightsAssessmentsCommentInstance 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 InsightsAssessmentsCommentInstance 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 InsightsAssessmentsCommentInstance[] 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 InsightsAssessmentsCommentInstance 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 InsightsAssessmentsCommentPage Page of
* InsightsAssessmentsCommentInstance
*/
public function page(array $options = [], $pageSize = Values::NONE, string $pageToken = Values::NONE, $pageNumber = Values::NONE): InsightsAssessmentsCommentPage {
$options = new Values($options);
$params = Values::of([
'SegmentId' => $options['segmentId'],
'AgentId' => $options['agentId'],
'PageToken' => $pageToken,
'Page' => $pageNumber,
'PageSize' => $pageSize,
]);
$headers = Values::of(['Token' => $options['token'], ]);
$response = $this->version->page('GET', $this->uri, $params, [], $headers);
return new InsightsAssessmentsCommentPage($this->version, $response, $this->solution);
}
/**
* Retrieve a specific page of InsightsAssessmentsCommentInstance records from
* the API.
* Request is executed immediately
*
* @param string $targetUrl API-generated URL for the requested results page
* @return InsightsAssessmentsCommentPage Page of
* InsightsAssessmentsCommentInstance
*/
public function getPage(string $targetUrl): InsightsAssessmentsCommentPage {
$response = $this->version->getDomain()->getClient()->request(
'GET',
$targetUrl
);
return new InsightsAssessmentsCommentPage($this->version, $response, $this->solution);
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString(): string {
return '[Twilio.FlexApi.V1.InsightsAssessmentsCommentList]';
}
}
|