Viewing file:  FlowContext.php (5.07 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
namespace Twilio\Rest\Studio\V2;
use Twilio\Exceptions\TwilioException;
use Twilio\InstanceContext;
use Twilio\ListResource;
use Twilio\Options;
use Twilio\Rest\Studio\V2\Flow\ExecutionList;
use Twilio\Rest\Studio\V2\Flow\FlowRevisionList;
use Twilio\Rest\Studio\V2\Flow\FlowTestUserList;
use Twilio\Serialize;
use Twilio\Values;
use Twilio\Version;
/**
* @property FlowRevisionList $revisions
* @property FlowTestUserList $testUsers
* @property ExecutionList $executions
* @method \Twilio\Rest\Studio\V2\Flow\FlowRevisionContext revisions(string $revision)
* @method \Twilio\Rest\Studio\V2\Flow\FlowTestUserContext testUsers()
* @method \Twilio\Rest\Studio\V2\Flow\ExecutionContext executions(string $sid)
*/
class FlowContext extends InstanceContext {
protected $_revisions;
protected $_testUsers;
protected $_executions;
/**
* Initialize the FlowContext
*
* @param Version $version Version that contains the resource
* @param string $sid The SID that identifies the resource to fetch
*/
public function __construct(Version $version, $sid) {
parent::__construct($version);
// Path Solution
$this->solution = ['sid' => $sid, ];
$this->uri = '/Flows/' . \rawurlencode($sid) . '';
}
/**
* Update the FlowInstance
*
* @param string $status The status of the Flow
* @param array|Options $options Optional Arguments
* @return FlowInstance Updated FlowInstance
* @throws TwilioException When an HTTP error occurs.
*/
public function update(string $status, array $options = []): FlowInstance {
$options = new Values($options);
$data = Values::of([
'Status' => $status,
'FriendlyName' => $options['friendlyName'],
'Definition' => Serialize::jsonObject($options['definition']),
'CommitMessage' => $options['commitMessage'],
]);
$payload = $this->version->update('POST', $this->uri, [], $data);
return new FlowInstance($this->version, $payload, $this->solution['sid']);
}
/**
* Fetch the FlowInstance
*
* @return FlowInstance Fetched FlowInstance
* @throws TwilioException When an HTTP error occurs.
*/
public function fetch(): FlowInstance {
$payload = $this->version->fetch('GET', $this->uri);
return new FlowInstance($this->version, $payload, $this->solution['sid']);
}
/**
* Delete the FlowInstance
*
* @return bool True if delete succeeds, false otherwise
* @throws TwilioException When an HTTP error occurs.
*/
public function delete(): bool {
return $this->version->delete('DELETE', $this->uri);
}
/**
* Access the revisions
*/
protected function getRevisions(): FlowRevisionList {
if (!$this->_revisions) {
$this->_revisions = new FlowRevisionList($this->version, $this->solution['sid']);
}
return $this->_revisions;
}
/**
* Access the testUsers
*/
protected function getTestUsers(): FlowTestUserList {
if (!$this->_testUsers) {
$this->_testUsers = new FlowTestUserList($this->version, $this->solution['sid']);
}
return $this->_testUsers;
}
/**
* Access the executions
*/
protected function getExecutions(): ExecutionList {
if (!$this->_executions) {
$this->_executions = new ExecutionList($this->version, $this->solution['sid']);
}
return $this->_executions;
}
/**
* Magic getter to lazy load subresources
*
* @param string $name Subresource to return
* @return ListResource The requested subresource
* @throws TwilioException For unknown subresources
*/
public function __get(string $name): ListResource {
if (\property_exists($this, '_' . $name)) {
$method = 'get' . \ucfirst($name);
return $this->$method();
}
throw new TwilioException('Unknown subresource ' . $name);
}
/**
* Magic caller to get resource contexts
*
* @param string $name Resource to return
* @param array $arguments Context parameters
* @return InstanceContext The requested resource context
* @throws TwilioException For unknown resource
*/
public function __call(string $name, array $arguments): InstanceContext {
$property = $this->$name;
if (\method_exists($property, 'getContext')) {
return \call_user_func_array(array($property, 'getContext'), $arguments);
}
throw new TwilioException('Resource does not have a context');
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString(): string {
$context = [];
foreach ($this->solution as $key => $value) {
$context[] = "$key=$value";
}
return '[Twilio.Studio.V2.FlowContext ' . \implode(' ', $context) . ']';
}
}
|