Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostTerminalReaders

Description

Contains the different functions to run the operation postTerminalReaders

Synopsis

postTerminalReaders :: forall m. MonadHTTP m => PostTerminalReadersRequestBody -> StripeT m (Response PostTerminalReadersResponse)
data PostTerminalReadersRequestBody = PostTerminalReadersRequestBody {
}
mkPostTerminalReadersRequestBody :: Text -> PostTerminalReadersRequestBody
data PostTerminalReadersRequestBodyMetadata'Variants
- = PostTerminalReadersRequestBodyMetadata'EmptyString
- | PostTerminalReadersRequestBodyMetadata'Object Object
data PostTerminalReadersResponse

Documentation

postTerminalReaders Source #

Arguments

:: forall m. MonadHTTP m
=> PostTerminalReadersRequestBody	The request body to send
-> StripeT m (Response PostTerminalReadersResponse)	Monadic computation which returns the result of the operation

POST /v1/terminal/readers

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

data PostTerminalReadersRequestBody Source #

Defines the object schema located at paths./v1/terminal/readers.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostTerminalReadersRequestBody

Fields

postTerminalReadersRequestBodyExpand :: Maybe [Text]
expand: Specifies which fields in the response should be expanded.
postTerminalReadersRequestBodyLabel :: Maybe Text
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 Text
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'Variants
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 :: Text
registration_code: A code generated by the reader used for registering to an account.
Constraints:
- Maximum length of 5000

Instances

Instances details

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] #

mkPostTerminalReadersRequestBody Source #

Arguments

:: Text	`postTerminalReadersRequestBodyRegistrationCode`
-> PostTerminalReadersRequestBody

Create a new PostTerminalReadersRequestBody with all required fields.

data PostTerminalReadersRequestBodyMetadata'Variants Source #

Defines the oneOf schema located at paths./v1/terminal/readers.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.

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'EmptyString	Represents the JSON value `""`
PostTerminalReadersRequestBodyMetadata'Object Object

Instances

Instances details

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

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

Instances details

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 #