Файл: sngine-v2.8/Script/includes/libs/Twilio/Rest/Preview/Understand/Assistant/Task/FieldList.php
Строк: 237
<?php
/**
* This code was generated by
* / _ _ _| _ _
* | (_)/(_)(_|/| |(/_ v1.0.0
* / /
*/
namespace TwilioRestPreviewUnderstandAssistantTask;
use TwilioExceptionsTwilioException;
use TwilioListResource;
use TwilioStream;
use TwilioValues;
use TwilioVersion;
/**
* 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 FieldList extends ListResource {
/**
* Construct the FieldList
*
* @param Version $version Version that contains the resource
* @param string $assistantSid The unique ID of the parent Assistant.
* @param string $taskSid The unique ID of the Task associated with this Field.
*/
public function __construct(Version $version, string $assistantSid, string $taskSid) {
parent::__construct($version);
// Path Solution
$this->solution = ['assistantSid' => $assistantSid, 'taskSid' => $taskSid, ];
$this->uri = '/Assistants/' . rawurlencode($assistantSid) . '/Tasks/' . rawurlencode($taskSid) . '/Fields';
}
/**
* Streams FieldInstance 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 FieldInstance 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 FieldInstance[] 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 FieldInstance 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 FieldPage Page of FieldInstance
*/
public function page($pageSize = Values::NONE, string $pageToken = Values::NONE, $pageNumber = Values::NONE): FieldPage {
$params = Values::of(['PageToken' => $pageToken, 'Page' => $pageNumber, 'PageSize' => $pageSize, ]);
$response = $this->version->page('GET', $this->uri, $params);
return new FieldPage($this->version, $response, $this->solution);
}
/**
* Retrieve a specific page of FieldInstance records from the API.
* Request is executed immediately
*
* @param string $targetUrl API-generated URL for the requested results page
* @return FieldPage Page of FieldInstance
*/
public function getPage(string $targetUrl): FieldPage {
$response = $this->version->getDomain()->getClient()->request(
'GET',
$targetUrl
);
return new FieldPage($this->version, $response, $this->solution);
}
/**
* Create the FieldInstance
*
* @param string $fieldType The unique name or sid of the FieldType. It can be
* any Built-in Field Type or the unique_name or sid
* of a custom Field Type.
* @param string $uniqueName A user-provided string that uniquely identifies
* this resource as an alternative to the sid. Unique
* up to 64 characters long.
* @return FieldInstance Created FieldInstance
* @throws TwilioException When an HTTP error occurs.
*/
public function create(string $fieldType, string $uniqueName): FieldInstance {
$data = Values::of(['FieldType' => $fieldType, 'UniqueName' => $uniqueName, ]);
$payload = $this->version->create('POST', $this->uri, [], $data);
return new FieldInstance(
$this->version,
$payload,
$this->solution['assistantSid'],
$this->solution['taskSid']
);
}
/**
* Constructs a FieldContext
*
* @param string $sid A 34 character string that uniquely identifies this
* resource.
*/
public function getContext(string $sid): FieldContext {
return new FieldContext(
$this->version,
$this->solution['assistantSid'],
$this->solution['taskSid'],
$sid
);
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString(): string {
return '[Twilio.Preview.Understand.FieldList]';
}
}