Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostTestHelpersTestClocksTestClockAdvance

Contains the different functions to run the operation postTestHelpersTestClocksTestClockAdvance

2 types
2 values

Packagestripeapi-3.0.0.0
Exports4
LanguageHaskell2010
LicenceMIT
SourcePostTestHelpersTestClocksTestClockAdvance.hs

valuepostTestHelpersTestClocksTestClockAdvance

:: MonadHTTP m
=> Text
test_clock | Constraints: Maximum length of 5000
-> PostTestHelpersTestClocksTestClockAdvanceRequestBody
The request body to send
-> ClientT m (Response PostTestHelpersTestClocksTestClockAdvanceResponse)
Monadic computation which returns the result of the operation

POST /v1/test_helpers/test_clocks/{test_clock}/advance

<p>Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to <code>Ready</code>.</p>

datadata PostTestHelpersTestClocksTestClockAdvanceRequestBody

Defines the object schema located at paths./v1/test_helpers/test_clocks/{test_clock}/advance.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostTestHelpersTestClocksTestClockAdvanceRequestBody
- postTestHelpersTestClocksTestClockAdvanceRequestBodyExpand :: Maybe [Text]
  expand: Specifies which fields in the response should be expanded.
- postTestHelpersTestClocksTestClockAdvanceRequestBodyFrozenTime :: Int
  frozen_time: The time to advance the test clock. Must be after the test clock's current frozen time. Cannot be more than two intervals in the future from the shortest subscription in this test clock. If there are no subscriptions in this test clock, it cannot be more than two years in the future.

Instances4Eq, Show, FromJSON, ToJSON

Eq PostTestHelpersTestClocksTestClockAdvanceRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTestHelpersTestClocksTestClockAdvance
Show PostTestHelpersTestClocksTestClockAdvanceRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTestHelpersTestClocksTestClockAdvance
FromJSON PostTestHelpersTestClocksTestClockAdvanceRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTestHelpersTestClocksTestClockAdvance
ToJSON PostTestHelpersTestClocksTestClockAdvanceRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTestHelpersTestClocksTestClockAdvance

valuemkPostTestHelpersTestClocksTestClockAdvanceRequestBody

:: Int
postTestHelpersTestClocksTestClockAdvanceRequestBodyFrozenTime
-> PostTestHelpersTestClocksTestClockAdvanceRequestBody

Create a new PostTestHelpersTestClocksTestClockAdvanceRequestBody with all required fields.

datadata PostTestHelpersTestClocksTestClockAdvanceResponse

Represents a response of the operation postTestHelpersTestClocksTestClockAdvance.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), PostTestHelpersTestClocksTestClockAdvanceResponseError is used.

Constructors

PostTestHelpersTestClocksTestClockAdvanceResponseError String
Means either no matching case available or a parse error
PostTestHelpersTestClocksTestClockAdvanceResponse200 TestHelpers'testClock
Successful response.
PostTestHelpersTestClocksTestClockAdvanceResponseDefault Error
Error response.

Instances2Eq, Show

Eq PostTestHelpersTestClocksTestClockAdvanceResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTestHelpersTestClocksTestClockAdvance
Show PostTestHelpersTestClocksTestClockAdvanceResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTestHelpersTestClocksTestClockAdvance