Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostEphemeralKeys

Description

Contains the different functions to run the operation postEphemeralKeys

Synopsis

postEphemeralKeys :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostEphemeralKeysRequestBody -> m (Either HttpException (Response PostEphemeralKeysResponse))
postEphemeralKeysRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostEphemeralKeysRequestBody -> m (Either HttpException (Response ByteString))
postEphemeralKeysM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostEphemeralKeysRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostEphemeralKeysResponse))
postEphemeralKeysRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostEphemeralKeysRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostEphemeralKeysRequestBody = PostEphemeralKeysRequestBody {
}
data PostEphemeralKeysResponse

Documentation

postEphemeralKeys Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> PostEphemeralKeysRequestBody	The request body to send
-> m (Either HttpException (Response PostEphemeralKeysResponse))	Monad containing the result of the operation

POST /v1/ephemeral_keys

<p>Creates a short-lived API key for a given resource.</p>

postEphemeralKeysRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostEphemeralKeysRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/ephemeral_keys

The same as postEphemeralKeys but returns the raw ByteString

postEphemeralKeysM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostEphemeralKeysRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostEphemeralKeysResponse)) Source #

POST /v1/ephemeral_keys

Monadic version of postEphemeralKeys (use with runWithConfiguration)

postEphemeralKeysRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostEphemeralKeysRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/ephemeral_keys

Monadic version of postEphemeralKeysRaw (use with runWithConfiguration)

data PostEphemeralKeysRequestBody Source #

Defines the data type for the schema postEphemeralKeysRequestBody

Constructors

PostEphemeralKeysRequestBody

Fields

postEphemeralKeysRequestBodyCustomer :: Maybe String
customer: The ID of the Customer you'd like to modify using the resulting ephemeral key.
Constraints:
- Maximum length of 5000
postEphemeralKeysRequestBodyExpand :: Maybe ([] String)
expand: Specifies which fields in the response should be expanded.
postEphemeralKeysRequestBodyIssuingCard :: Maybe String
issuing_card: The ID of the Issuing Card you'd like to access using the resulting ephemeral key.
Constraints:
- Maximum length of 5000

Instances

Eq PostEphemeralKeysRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostEphemeralKeys Methods (==) :: PostEphemeralKeysRequestBody -> PostEphemeralKeysRequestBody -> Bool # (/=) :: PostEphemeralKeysRequestBody -> PostEphemeralKeysRequestBody -> Bool #
Show PostEphemeralKeysRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostEphemeralKeys Methods showsPrec :: Int -> PostEphemeralKeysRequestBody -> ShowS # show :: PostEphemeralKeysRequestBody -> String # showList :: [PostEphemeralKeysRequestBody] -> ShowS #
ToJSON PostEphemeralKeysRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostEphemeralKeys Methods toJSON :: PostEphemeralKeysRequestBody -> Value # toEncoding :: PostEphemeralKeysRequestBody -> Encoding # toJSONList :: [PostEphemeralKeysRequestBody] -> Value # toEncodingList :: [PostEphemeralKeysRequestBody] -> Encoding #
FromJSON PostEphemeralKeysRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostEphemeralKeys Methods parseJSON :: Value -> Parser PostEphemeralKeysRequestBody # parseJSONList :: Value -> Parser [PostEphemeralKeysRequestBody] #

data PostEphemeralKeysResponse Source #

Represents a response of the operation postEphemeralKeys.

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), PostEphemeralKeysResponseError is used.

Constructors

PostEphemeralKeysResponseError String	Means either no matching case available or a parse error
PostEphemeralKeysResponse200 EphemeralKey	Successful response.
PostEphemeralKeysResponseDefault Error	Error response.

Instances

Eq PostEphemeralKeysResponse Source #
Instance details Defined in StripeAPI.Operations.PostEphemeralKeys Methods (==) :: PostEphemeralKeysResponse -> PostEphemeralKeysResponse -> Bool # (/=) :: PostEphemeralKeysResponse -> PostEphemeralKeysResponse -> Bool #
Show PostEphemeralKeysResponse Source #
Instance details Defined in StripeAPI.Operations.PostEphemeralKeys Methods showsPrec :: Int -> PostEphemeralKeysResponse -> ShowS # show :: PostEphemeralKeysResponse -> String # showList :: [PostEphemeralKeysResponse] -> ShowS #