Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetTerminalReaders

Description

Contains the different functions to run the operation getTerminalReaders

Synopsis

getTerminalReaders :: forall m. MonadHTTP m => GetTerminalReadersParameters -> ClientT m (Response GetTerminalReadersResponse)
data GetTerminalReadersParameters = GetTerminalReadersParameters {
}
mkGetTerminalReadersParameters :: GetTerminalReadersParameters
data GetTerminalReadersParametersQueryDeviceType'
data GetTerminalReadersParametersQueryStatus'
data GetTerminalReadersResponse
data GetTerminalReadersResponseBody200 = GetTerminalReadersResponseBody200 {
}
mkGetTerminalReadersResponseBody200 :: [Terminal'reader] -> Bool -> Text -> GetTerminalReadersResponseBody200

Documentation

getTerminalReaders Source #

Arguments

:: forall m. MonadHTTP m
=> GetTerminalReadersParameters	Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetTerminalReadersResponse)	Monadic computation which returns the result of the operation

GET /v1/terminal/readers

<p>Returns a list of <code>Reader</code> objects.</p>

data GetTerminalReadersParameters Source #

Defines the object schema located at paths./v1/terminal/readers.GET.parameters in the specification.

Constructors

GetTerminalReadersParameters

Fields

getTerminalReadersParametersQueryDeviceType :: Maybe GetTerminalReadersParametersQueryDeviceType'
queryDevice_type: Represents the parameter named 'device_type'
Filters readers by device type
getTerminalReadersParametersQueryEndingBefore :: Maybe Text
queryEnding_before: Represents the parameter named 'ending_before'
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
Constraints:
- Maximum length of 5000
getTerminalReadersParametersQueryExpand :: Maybe [Text]
queryExpand: Represents the parameter named 'expand'
Specifies which fields in the response should be expanded.
getTerminalReadersParametersQueryLimit :: Maybe Int
queryLimit: Represents the parameter named 'limit'
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
getTerminalReadersParametersQueryLocation :: Maybe Text
queryLocation: Represents the parameter named 'location'
A location ID to filter the response list to only readers at the specific location
Constraints:
- Maximum length of 5000
getTerminalReadersParametersQueryStartingAfter :: Maybe Text
queryStarting_after: Represents the parameter named 'starting_after'
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
Constraints:
- Maximum length of 5000
getTerminalReadersParametersQueryStatus :: Maybe GetTerminalReadersParametersQueryStatus'
queryStatus: Represents the parameter named 'status'
A status filter to filter readers to only offline or online readers

Instances

Instances details

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

mkGetTerminalReadersParameters :: GetTerminalReadersParameters Source #

Create a new GetTerminalReadersParameters with all required fields.

data GetTerminalReadersParametersQueryDeviceType' Source #

Defines the enum schema located at paths./v1/terminal/readers.GET.parameters.properties.queryDevice_type in the specification.

Represents the parameter named 'device_type'

Filters readers by device type

Constructors

GetTerminalReadersParametersQueryDeviceType'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetTerminalReadersParametersQueryDeviceType'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
GetTerminalReadersParametersQueryDeviceType'EnumBbposChipper2x	Represents the JSON value `"bbpos_chipper2x"`
GetTerminalReadersParametersQueryDeviceType'EnumVerifoneP400	Represents the JSON value `"verifone_P400"`

Instances

Instances details

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

data GetTerminalReadersParametersQueryStatus' Source #

Defines the enum schema located at paths./v1/terminal/readers.GET.parameters.properties.queryStatus in the specification.

Represents the parameter named 'status'

A status filter to filter readers to only offline or online readers

Constructors

GetTerminalReadersParametersQueryStatus'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetTerminalReadersParametersQueryStatus'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
GetTerminalReadersParametersQueryStatus'EnumOffline	Represents the JSON value `"offline"`
GetTerminalReadersParametersQueryStatus'EnumOnline	Represents the JSON value `"online"`

Instances

Instances details

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

data GetTerminalReadersResponse Source #

Represents a response of the operation getTerminalReaders.

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

Constructors

GetTerminalReadersResponseError String	Means either no matching case available or a parse error
GetTerminalReadersResponse200 GetTerminalReadersResponseBody200	Successful response.
GetTerminalReadersResponseDefault Error	Error response.

Instances

Instances details

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

data GetTerminalReadersResponseBody200 Source #

Defines the object schema located at paths./v1/terminal/readers.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetTerminalReadersResponseBody200
Fields getTerminalReadersResponseBody200Data :: [Terminal'reader] data: A list of readers getTerminalReadersResponseBody200HasMore :: Bool has_more: True if this list has another page of items after this one that can be fetched. getTerminalReadersResponseBody200Url :: Text url: The URL where this list can be accessed. Constraints: Maximum length of 5000

Instances

Instances details

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

mkGetTerminalReadersResponseBody200 Source #

Arguments

:: [Terminal'reader]	`getTerminalReadersResponseBody200Data`
-> Bool	`getTerminalReadersResponseBody200HasMore`
-> Text	`getTerminalReadersResponseBody200Url`
-> GetTerminalReadersResponseBody200

Create a new GetTerminalReadersResponseBody200 with all required fields.