<?php
/**
* This code was generated by
* ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
* | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
* | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
*
* Twilio - Sync
* This is the public Twilio REST API.
*
* NOTE: This class is auto generated by OpenAPI Generator.
* https://openapi-generator.tech
* Do not edit the class manually.
*/
namespace Twilio\Rest\Sync\V1\Service\Document;
use Twilio\Exceptions\TwilioException;
use Twilio\Values;
use Twilio\Version;
use Twilio\InstanceContext;
use Twilio\Serialize;
class DocumentPermissionContext extends InstanceContext
{
/**
* Initialize the DocumentPermissionContext
*
* @param Version $version Version that contains the resource
* @param string $serviceSid The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Document Permission resource to delete.
* @param string $documentSid The SID of the Sync Document with the Document Permission resource to delete. Can be the Document resource's `sid` or its `unique_name`.
* @param string $identity The application-defined string that uniquely identifies the User's Document Permission resource to delete.
*/
public function __construct(
Version $version,
$serviceSid,
$documentSid,
$identity
) {
parent::__construct($version);
// Path Solution
$this->solution = [
'serviceSid' =>
$serviceSid,
'documentSid' =>
$documentSid,
'identity' =>
$identity,
];
$this->uri = '/Services/' . \rawurlencode($serviceSid)
.'/Documents/' . \rawurlencode($documentSid)
.'/Permissions/' . \rawurlencode($identity)
.'';
}
/**
* Delete the DocumentPermissionInstance
*
* @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);
}
/**
* Fetch the DocumentPermissionInstance
*
* @return DocumentPermissionInstance Fetched DocumentPermissionInstance
* @throws TwilioException When an HTTP error occurs.
*/
public function fetch(): DocumentPermissionInstance
{
$payload = $this->version->fetch('GET', $this->uri, [], []);
return new DocumentPermissionInstance(
$this->version,
$payload,
$this->solution['serviceSid'],
$this->solution['documentSid'],
$this->solution['identity']
);
}
/**
* Update the DocumentPermissionInstance
*
* @param bool $read Whether the identity can read the Sync Document. Default value is `false`.
* @param bool $write Whether the identity can update the Sync Document. Default value is `false`.
* @param bool $manage Whether the identity can delete the Sync Document. Default value is `false`.
* @return DocumentPermissionInstance Updated DocumentPermissionInstance
* @throws TwilioException When an HTTP error occurs.
*/
public function update(bool $read, bool $write, bool $manage): DocumentPermissionInstance
{
$data = Values::of([
'Read' =>
Serialize::booleanToString($read),
'Write' =>
Serialize::booleanToString($write),
'Manage' =>
Serialize::booleanToString($manage),
]);
$payload = $this->version->update('POST', $this->uri, [], $data);
return new DocumentPermissionInstance(
$this->version,
$payload,
$this->solution['serviceSid'],
$this->solution['documentSid'],
$this->solution['identity']
);
}
/**
* 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.Sync.V1.DocumentPermissionContext ' . \implode(' ', $context) . ']';
}
}