Test ClocksTest helper
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.
The Test Clock objectTest helper
Attributes
- idstring
Unique identifier for the object.
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.
- deletes_
aftertimestamp Time at which this clock is scheduled to auto delete.
- frozen_
timetimestamp Time at which all objects belonging to this clock are frozen.
- livemodeboolean
Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - namenullable string
The custom name supplied at creation.
- statusenum
The status of the Test Clock.
Create a test clockTest helper
Creates a new test clock that can be attached to new customers and quotes.
Parameters
- frozen_
timetimestampRequired The initial frozen time for this test clock.
- namestring
The name for this test clock.
Returns
The newly created TestClock object is returned upon success. Otherwise, this call raises an error.
Retrieve a test clockTest helper
Retrieves a test clock.
Parameters
No parameters.
Returns
Returns the TestClock object. Otherwise, this call raises an error.
List all test clocksTest helper
Returns a list of your test clocks.
Parameters
No parameters.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data property that contains an array of up to limit test clocks, starting after starting_after. Each entry in the array is a separate test clock object. If no more test clocks are available, the resulting array will be empty.