class

Stripe::TestHelpersTestClock

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

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.

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [test_helpers.test_clock]."

ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [advancing, internal_failure, ready]."

MAX_LENGTH_FOR_ID = 5000

MAX_LENGTH_FOR_NAME = 5000

VALID_VALUES_FOR_OBJECT = String.static_array("test_helpers.test_clock")

VALID_VALUES_FOR_STATUS = String.static_array("advancing", "internal_failure", "ready")

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, created : Int64 | Nil = nil, deletes_after : Int64 | Nil = nil, frozen_time : Int64 | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, name : String | Nil = nil, object : String | Nil = nil, status : String | Nil = nil, status_details : Stripe::BillingClocksResourceStatusDetailsStatusDetails | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

created

Time at which the object was created. Measured in seconds since the Unix epoch.

created=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned

deletes_after

Time at which this clock is scheduled to auto delete.

deletes_after=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] deletes_after Object to be assigned

frozen_time

Time at which all objects belonging to this clock are frozen.

frozen_time=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] frozen_time Object to be assigned

hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

id

Unique identifier for the object.

id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

livemode

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

livemode=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned

name

The custom name supplied at creation.

name=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] name Object to be assigned

object

String representing the object's type. Objects of the same type share the same value.

object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

status

The status of the Test Clock.

status=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

status_details

status_details=(new_value : Stripe::BillingClocksResourceStatusDetailsStatusDetails | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status_details Object to be assigned

valid?

Check to see if the all the properties in the model are valid @return true if the model is valid