Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation postSubscriptionSchedulesScheduleCancel
Synopsis
- postSubscriptionSchedulesScheduleCancel :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostSubscriptionSchedulesScheduleCancelRequestBody -> m (Either HttpException (Response PostSubscriptionSchedulesScheduleCancelResponse))
- postSubscriptionSchedulesScheduleCancelRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostSubscriptionSchedulesScheduleCancelRequestBody -> m (Either HttpException (Response ByteString))
- postSubscriptionSchedulesScheduleCancelM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostSubscriptionSchedulesScheduleCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostSubscriptionSchedulesScheduleCancelResponse))
- postSubscriptionSchedulesScheduleCancelRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostSubscriptionSchedulesScheduleCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostSubscriptionSchedulesScheduleCancelRequestBody = PostSubscriptionSchedulesScheduleCancelRequestBody {}
- data PostSubscriptionSchedulesScheduleCancelResponse
Documentation
postSubscriptionSchedulesScheduleCancel Source #
:: (MonadHTTP m, SecurityScheme s) | |
=> Configuration s | The configuration to use in the request |
-> String | schedule | Constraints: Maximum length of 5000 |
-> PostSubscriptionSchedulesScheduleCancelRequestBody | The request body to send |
-> m (Either HttpException (Response PostSubscriptionSchedulesScheduleCancelResponse)) | Monad containing the result of the operation |
POST /v1/subscription_schedules/{schedule}/cancel
<p>Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is <code>not_started</code> or <code>active</code>.</p>
postSubscriptionSchedulesScheduleCancelRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostSubscriptionSchedulesScheduleCancelRequestBody -> m (Either HttpException (Response ByteString)) Source #
POST /v1/subscription_schedules/{schedule}/cancel
The same as postSubscriptionSchedulesScheduleCancel
but returns the raw ByteString
postSubscriptionSchedulesScheduleCancelM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostSubscriptionSchedulesScheduleCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostSubscriptionSchedulesScheduleCancelResponse)) Source #
POST /v1/subscription_schedules/{schedule}/cancel
Monadic version of postSubscriptionSchedulesScheduleCancel
(use with runWithConfiguration
)
postSubscriptionSchedulesScheduleCancelRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostSubscriptionSchedulesScheduleCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/subscription_schedules/{schedule}/cancel
Monadic version of postSubscriptionSchedulesScheduleCancelRaw
(use with runWithConfiguration
)
data PostSubscriptionSchedulesScheduleCancelRequestBody Source #
Defines the data type for the schema postSubscriptionSchedulesScheduleCancelRequestBody
PostSubscriptionSchedulesScheduleCancelRequestBody | |
|
Instances
data PostSubscriptionSchedulesScheduleCancelResponse Source #
Represents a response of the operation postSubscriptionSchedulesScheduleCancel
.
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), PostSubscriptionSchedulesScheduleCancelResponseError
is used.
PostSubscriptionSchedulesScheduleCancelResponseError String | Means either no matching case available or a parse error |
PostSubscriptionSchedulesScheduleCancelResponse200 SubscriptionSchedule | Successful response. |
PostSubscriptionSchedulesScheduleCancelResponseDefault Error | Error response. |