Viewing file:  BucketContext.php (2.95 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
namespace Twilio\Rest\Verify\V2\Service\RateLimit;
use Twilio\Exceptions\TwilioException;
use Twilio\InstanceContext;
use Twilio\Options;
use Twilio\Values;
use Twilio\Version;
class BucketContext extends InstanceContext {
/**
* Initialize the BucketContext
*
* @param Version $version Version that contains the resource
* @param string $serviceSid The SID of the Service that the resource is
* associated with
* @param string $rateLimitSid Rate Limit Sid.
* @param string $sid A string that uniquely identifies this Bucket.
*/
public function __construct(Version $version, $serviceSid, $rateLimitSid, $sid) {
parent::__construct($version);
// Path Solution
$this->solution = ['serviceSid' => $serviceSid, 'rateLimitSid' => $rateLimitSid, 'sid' => $sid, ];
$this->uri = '/Services/' . \rawurlencode($serviceSid) . '/RateLimits/' . \rawurlencode($rateLimitSid) . '/Buckets/' . \rawurlencode($sid) . '';
}
/**
* Update the BucketInstance
*
* @param array|Options $options Optional Arguments
* @return BucketInstance Updated BucketInstance
* @throws TwilioException When an HTTP error occurs.
*/
public function update(array $options = []): BucketInstance {
$options = new Values($options);
$data = Values::of(['Max' => $options['max'], 'Interval' => $options['interval'], ]);
$payload = $this->version->update('POST', $this->uri, [], $data);
return new BucketInstance(
$this->version,
$payload,
$this->solution['serviceSid'],
$this->solution['rateLimitSid'],
$this->solution['sid']
);
}
/**
* Fetch the BucketInstance
*
* @return BucketInstance Fetched BucketInstance
* @throws TwilioException When an HTTP error occurs.
*/
public function fetch(): BucketInstance {
$payload = $this->version->fetch('GET', $this->uri);
return new BucketInstance(
$this->version,
$payload,
$this->solution['serviceSid'],
$this->solution['rateLimitSid'],
$this->solution['sid']
);
}
/**
* Delete the BucketInstance
*
* @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);
}
/**
* 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.Verify.V2.BucketContext ' . \implode(' ', $context) . ']';
}
}
|