mobilebackend/Twilio/Rest/Studio/V1/FlowInstance.php

144 lines
4.1 KiB
PHP

<?php
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
namespace Twilio\Rest\Studio\V1;
use Twilio\Deserialize;
use Twilio\Exceptions\TwilioException;
use Twilio\InstanceResource;
use Twilio\Values;
use Twilio\Version;
/**
* @property string sid
* @property string accountSid
* @property string friendlyName
* @property string status
* @property integer version
* @property \DateTime dateCreated
* @property \DateTime dateUpdated
* @property string url
* @property array links
*/
class FlowInstance extends InstanceResource {
protected $_engagements = null;
protected $_executions = null;
/**
* Initialize the FlowInstance
*
* @param \Twilio\Version $version Version that contains the resource
* @param mixed[] $payload The response payload
* @param string $sid A string that uniquely identifies this Flow.
* @return \Twilio\Rest\Studio\V1\FlowInstance
*/
public function __construct(Version $version, array $payload, $sid = null) {
parent::__construct($version);
// Marshaled Properties
$this->properties = array(
'sid' => Values::array_get($payload, 'sid'),
'accountSid' => Values::array_get($payload, 'account_sid'),
'friendlyName' => Values::array_get($payload, 'friendly_name'),
'status' => Values::array_get($payload, 'status'),
'version' => Values::array_get($payload, 'version'),
'dateCreated' => Deserialize::dateTime(Values::array_get($payload, 'date_created')),
'dateUpdated' => Deserialize::dateTime(Values::array_get($payload, 'date_updated')),
'url' => Values::array_get($payload, 'url'),
'links' => Values::array_get($payload, 'links'),
);
$this->solution = array('sid' => $sid ?: $this->properties['sid'], );
}
/**
* Generate an instance context for the instance, the context is capable of
* performing various actions. All instance actions are proxied to the context
*
* @return \Twilio\Rest\Studio\V1\FlowContext Context for this FlowInstance
*/
protected function proxy() {
if (!$this->context) {
$this->context = new FlowContext($this->version, $this->solution['sid']);
}
return $this->context;
}
/**
* Fetch a FlowInstance
*
* @return FlowInstance Fetched FlowInstance
* @throws TwilioException When an HTTP error occurs.
*/
public function fetch() {
return $this->proxy()->fetch();
}
/**
* Deletes the FlowInstance
*
* @return boolean True if delete succeeds, false otherwise
* @throws TwilioException When an HTTP error occurs.
*/
public function delete() {
return $this->proxy()->delete();
}
/**
* Access the engagements
*
* @return \Twilio\Rest\Studio\V1\Flow\EngagementList
*/
protected function getEngagements() {
return $this->proxy()->engagements;
}
/**
* Access the executions
*
* @return \Twilio\Rest\Studio\V1\Flow\ExecutionList
*/
protected function getExecutions() {
return $this->proxy()->executions;
}
/**
* Magic getter to access properties
*
* @param string $name Property to access
* @return mixed The requested property
* @throws TwilioException For unknown properties
*/
public function __get($name) {
if (array_key_exists($name, $this->properties)) {
return $this->properties[$name];
}
if (property_exists($this, '_' . $name)) {
$method = 'get' . ucfirst($name);
return $this->$method();
}
throw new TwilioException('Unknown property: ' . $name);
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString() {
$context = array();
foreach ($this->solution as $key => $value) {
$context[] = "$key=$value";
}
return '[Twilio.Studio.V1.FlowInstance ' . implode(' ', $context) . ']';
}
}