Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetTerminalReaders

Contains the different functions to run the operation getTerminalReaders

5 types
3 values

Packagestripeapi-3.0.0.0
Exports8
LanguageHaskell2010
LicenceMIT
SourceGetTerminalReaders.hs

valuegetTerminalReaders

:: 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>

datadata GetTerminalReadersParameters

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

Constructors

GetTerminalReadersParameters
- 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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTerminalReadersParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReaders
Show GetTerminalReadersParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReaders
FromJSON GetTerminalReadersParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReaders
ToJSON GetTerminalReadersParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReaders

valuemkGetTerminalReadersParameters :: GetTerminalReadersParameters

Create a new GetTerminalReadersParameters with all required fields.

datadata GetTerminalReadersParametersQueryDeviceType'

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'EnumBbposWisepad3
Represents the JSON value "bbpos_wisepad3"
GetTerminalReadersParametersQueryDeviceType'EnumBbposWiseposE
Represents the JSON value "bbpos_wisepos_e"
GetTerminalReadersParametersQueryDeviceType'EnumSimulatedWiseposE
Represents the JSON value "simulated_wisepos_e"
GetTerminalReadersParametersQueryDeviceType'EnumStripeM2
Represents the JSON value "stripe_m2"
GetTerminalReadersParametersQueryDeviceType'EnumVerifoneP400
Represents the JSON value "verifone_P400"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTerminalReadersParametersQueryDeviceType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReaders
Show GetTerminalReadersParametersQueryDeviceType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReaders
FromJSON GetTerminalReadersParametersQueryDeviceType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReaders
ToJSON GetTerminalReadersParametersQueryDeviceType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReaders

datadata GetTerminalReadersParametersQueryStatus'

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"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTerminalReadersParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReaders
Show GetTerminalReadersParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReaders
FromJSON GetTerminalReadersParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReaders
ToJSON GetTerminalReadersParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReaders

datadata GetTerminalReadersResponse

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.

Instances2Eq, Show

Eq GetTerminalReadersResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReaders
Show GetTerminalReadersResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReaders

datadata GetTerminalReadersResponseBody200

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

Constructors

GetTerminalReadersResponseBody200
- 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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTerminalReadersResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReaders
Show GetTerminalReadersResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReaders
FromJSON GetTerminalReadersResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReaders
ToJSON GetTerminalReadersResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReaders

valuemkGetTerminalReadersResponseBody200

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

Create a new GetTerminalReadersResponseBody200 with all required fields.