You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
53 lines
2.2 KiB
53 lines
2.2 KiB
<?php
|
|
|
|
// File generated from our OpenAPI spec
|
|
|
|
namespace Stripe\TestHelpers;
|
|
|
|
/**
|
|
* A test clock enables deterministic control over objects in testmode. With a test
|
|
* clock, you can create objects at a frozen time in the past or future, and
|
|
* advance to a specific future time to observe webhooks and state changes. After
|
|
* the clock advances, you can either validate the current state of your scenario
|
|
* (and test your assumptions), change the current state of your scenario (and test
|
|
* more complex scenarios), or keep advancing forward in time.
|
|
*
|
|
* @property string $id Unique identifier for the object.
|
|
* @property string $object String representing the object's type. Objects of the same type share the same value.
|
|
* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
|
|
* @property int $deletes_after Time at which this clock is scheduled to auto delete.
|
|
* @property int $frozen_time Time at which all objects belonging to this clock are frozen.
|
|
* @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
|
|
* @property null|string $name The custom name supplied at creation.
|
|
* @property string $status The status of the Test Clock.
|
|
*/
|
|
class TestClock extends \Stripe\ApiResource
|
|
{
|
|
const OBJECT_NAME = 'test_helpers.test_clock';
|
|
|
|
use \Stripe\ApiOperations\All;
|
|
use \Stripe\ApiOperations\Create;
|
|
use \Stripe\ApiOperations\Delete;
|
|
use \Stripe\ApiOperations\Retrieve;
|
|
|
|
const STATUS_ADVANCING = 'advancing';
|
|
const STATUS_INTERNAL_FAILURE = 'internal_failure';
|
|
const STATUS_READY = 'ready';
|
|
|
|
/**
|
|
* @param null|array $params
|
|
* @param null|array|string $opts
|
|
*
|
|
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
|
*
|
|
* @return \Stripe\TestHelpers\TestClock the advanced test clock
|
|
*/
|
|
public function advance($params = null, $opts = null)
|
|
{
|
|
$url = $this->instanceUrl() . '/advance';
|
|
list($response, $opts) = $this->_request('post', $url, $params, $opts);
|
|
$this->refreshFrom($response, $opts);
|
|
|
|
return $this;
|
|
}
|
|
}
|
|
|