Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostTerminalReaders

Description

Contains the different functions to run the operation postTerminalReaders

Synopsis

postTerminalReaders :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostTerminalReadersRequestBody -> m (Either HttpException (Response PostTerminalReadersResponse))
postTerminalReadersRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostTerminalReadersRequestBody -> m (Either HttpException (Response ByteString))
postTerminalReadersM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostTerminalReadersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostTerminalReadersResponse))
postTerminalReadersRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostTerminalReadersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostTerminalReadersRequestBody = PostTerminalReadersRequestBody {
}
data PostTerminalReadersRequestBodyMetadata' = PostTerminalReadersRequestBodyMetadata' {
}
data PostTerminalReadersResponse

Documentation

postTerminalReaders Source #

Arguments

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

POST /v1/terminal/readers

<p>Creates a new <code>Reader</code> object.</p>

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

POST /v1/terminal/readers

The same as postTerminalReaders but returns the raw ByteString

postTerminalReadersM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostTerminalReadersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostTerminalReadersResponse)) Source #

POST /v1/terminal/readers

Monadic version of postTerminalReaders (use with runWithConfiguration)

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

POST /v1/terminal/readers

Monadic version of postTerminalReadersRaw (use with runWithConfiguration)

data PostTerminalReadersRequestBody Source #

Defines the data type for the schema postTerminalReadersRequestBody

Constructors

PostTerminalReadersRequestBody

Fields

postTerminalReadersRequestBodyExpand :: Maybe ([] String)
expand: Specifies which fields in the response should be expanded.
postTerminalReadersRequestBodyLabel :: Maybe String
label: Custom label given to the reader for easier identification. If no label is specified, the registration code will be used.
Constraints:
- Maximum length of 5000
postTerminalReadersRequestBodyLocation :: Maybe String
location: The location to assign the reader to. If no location is specified, the reader will be assigned to the account's default location.
Constraints:
- Maximum length of 5000
postTerminalReadersRequestBodyMetadata :: Maybe PostTerminalReadersRequestBodyMetadata'
metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
postTerminalReadersRequestBodyRegistrationCode :: String
registration_code: A code generated by the reader used for registering to an account.
Constraints:
- Maximum length of 5000

Instances

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

data PostTerminalReadersRequestBodyMetadata' Source #

Defines the data type for the schema postTerminalReadersRequestBodyMetadata'

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

Constructors

PostTerminalReadersRequestBodyMetadata'

Instances

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

data PostTerminalReadersResponse Source #

Represents a response of the operation postTerminalReaders.

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

Constructors

PostTerminalReadersResponseError String	Means either no matching case available or a parse error
PostTerminalReadersResponse200 Terminal'reader	Successful response.
PostTerminalReadersResponseDefault Error	Error response.

Instances

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