Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.TestHelpers_TestClock

Contains the types generated from the schema TestHelpers_TestClock

2 types
1 value

Packagestripeapi-3.0.0.0
Exports3
LanguageHaskell2010
LicenceMIT
SourceTestHelpers_TestClock.hs

datadata TestHelpers'testClock

Defines the object schema located at components.schemas.test_helpers.test_clock in the specification.

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.

Constructors

TestHelpers'testClock
- testHelpers'testClockCreated :: Int
  created: Time at which the object was created. Measured in seconds since the Unix epoch.
- testHelpers'testClockDeletesAfter :: Int
  deletes_after: Time at which this clock is scheduled to auto delete.
- testHelpers'testClockFrozenTime :: Int
  frozen_time: Time at which all objects belonging to this clock are frozen.
- testHelpers'testClockId :: Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- testHelpers'testClockLivemode :: Bool
  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
- testHelpers'testClockName :: Maybe (Nullable Text)
  name: The custom name supplied at creation.
  Constraints:
  - Maximum length of 5000
- testHelpers'testClockStatus :: TestHelpers'testClockStatus'
  status: The status of the Test Clock.

Instances4Eq, Show, FromJSON, ToJSON

Eq TestHelpers'testClockDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TestHelpers_TestClock
Show TestHelpers'testClockDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TestHelpers_TestClock
FromJSON TestHelpers'testClockDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TestHelpers_TestClock
ToJSON TestHelpers'testClockDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TestHelpers_TestClock

valuemkTestHelpers'testClock

:: Int
testHelpers'testClockCreated
-> Int
testHelpers'testClockDeletesAfter
-> Int
testHelpers'testClockFrozenTime
-> Text
testHelpers'testClockId
-> Bool
testHelpers'testClockLivemode
-> TestHelpers'testClockStatus'
testHelpers'testClockStatus
-> TestHelpers'testClock

Create a new TestHelpers'testClock with all required fields.

datadata TestHelpers'testClockStatus'

Defines the enum schema located at components.schemas.test_helpers.test_clock.properties.status in the specification.

The status of the Test Clock.

Constructors

TestHelpers'testClockStatus'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
TestHelpers'testClockStatus'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
TestHelpers'testClockStatus'EnumAdvancing
Represents the JSON value "advancing"
TestHelpers'testClockStatus'EnumInternalFailure
Represents the JSON value "internal_failure"
TestHelpers'testClockStatus'EnumReady
Represents the JSON value "ready"

Instances4Eq, Show, FromJSON, ToJSON

Eq TestHelpers'testClockStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.TestHelpers_TestClock
Show TestHelpers'testClockStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.TestHelpers_TestClock
FromJSON TestHelpers'testClockStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.TestHelpers_TestClock
ToJSON TestHelpers'testClockStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.TestHelpers_TestClock