StripeAPI.Operations.GetTerminalReaders

Contains the different functions to run the operation getTerminalReaders

Documentation

getTerminalReaders

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Text

device_type: Filters readers by device type

-> Maybe Text

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

-> Maybe Text

expand: Specifies which fields in the response should be expanded.

-> Maybe Integer

limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

-> Maybe Text

location: A location ID to filter the response list to only readers at the specific location | Constraints: Maximum length of 5000

-> Maybe Text

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

-> Maybe Text

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

-> Maybe GetTerminalReadersRequestBody

The request body to send

-> m (Either HttpException (Response GetTerminalReadersResponse))

Monad containing the result of the operation

GET /v1/terminal/readers

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

getTerminalReadersRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetTerminalReadersRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/terminal/readers

The same as getTerminalReaders but returns the raw ByteString

getTerminalReadersM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetTerminalReadersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetTerminalReadersResponse))

GET /v1/terminal/readers

Monadic version of getTerminalReaders (use with runWithConfiguration)

getTerminalReadersRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetTerminalReadersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/terminal/readers

Monadic version of getTerminalReadersRaw (use with runWithConfiguration)

data GetTerminalReadersRequestBody

Defines the data type for the schema getTerminalReadersRequestBody

Constructors

GetTerminalReadersRequestBody

Instances

Eq GetTerminalReadersRequestBody

Defined in StripeAPI.Operations.GetTerminalReaders

Methods

(==) :: GetTerminalReadersRequestBody -> GetTerminalReadersRequestBody -> Bool

(/=) :: GetTerminalReadersRequestBody -> GetTerminalReadersRequestBody -> Bool

Show GetTerminalReadersRequestBody

Defined in StripeAPI.Operations.GetTerminalReaders

Methods

showsPrec :: Int -> GetTerminalReadersRequestBody -> ShowS

show :: GetTerminalReadersRequestBody -> String

showList :: [GetTerminalReadersRequestBody] -> ShowS

ToJSON GetTerminalReadersRequestBody

Defined in StripeAPI.Operations.GetTerminalReaders

Methods

toJSON :: GetTerminalReadersRequestBody -> Value

toEncoding :: GetTerminalReadersRequestBody -> Encoding

toJSONList :: [GetTerminalReadersRequestBody] -> Value

toEncodingList :: [GetTerminalReadersRequestBody] -> Encoding

FromJSON GetTerminalReadersRequestBody

Defined in StripeAPI.Operations.GetTerminalReaders

Methods

parseJSON :: Value -> Parser GetTerminalReadersRequestBody

parseJSONList :: Value -> Parser [GetTerminalReadersRequestBody]

data 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.

Instances

Eq GetTerminalReadersResponse

Defined in StripeAPI.Operations.GetTerminalReaders

Methods

(==) :: GetTerminalReadersResponse -> GetTerminalReadersResponse -> Bool

(/=) :: GetTerminalReadersResponse -> GetTerminalReadersResponse -> Bool

Show GetTerminalReadersResponse

Defined in StripeAPI.Operations.GetTerminalReaders

Methods

showsPrec :: Int -> GetTerminalReadersResponse -> ShowS

show :: GetTerminalReadersResponse -> String

showList :: [GetTerminalReadersResponse] -> ShowS

data GetTerminalReadersResponseBody200

Defines the data type for the schema GetTerminalReadersResponseBody200

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.

• getTerminalReadersResponseBody200Object :: GetTerminalReadersResponseBody200Object'

  object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

• getTerminalReadersResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq GetTerminalReadersResponseBody200

Defined in StripeAPI.Operations.GetTerminalReaders

Methods

(==) :: GetTerminalReadersResponseBody200 -> GetTerminalReadersResponseBody200 -> Bool

(/=) :: GetTerminalReadersResponseBody200 -> GetTerminalReadersResponseBody200 -> Bool

Show GetTerminalReadersResponseBody200

Defined in StripeAPI.Operations.GetTerminalReaders

Methods

showsPrec :: Int -> GetTerminalReadersResponseBody200 -> ShowS

show :: GetTerminalReadersResponseBody200 -> String

showList :: [GetTerminalReadersResponseBody200] -> ShowS

ToJSON GetTerminalReadersResponseBody200

Defined in StripeAPI.Operations.GetTerminalReaders

Methods

toJSON :: GetTerminalReadersResponseBody200 -> Value

toEncoding :: GetTerminalReadersResponseBody200 -> Encoding

toJSONList :: [GetTerminalReadersResponseBody200] -> Value

toEncodingList :: [GetTerminalReadersResponseBody200] -> Encoding

FromJSON GetTerminalReadersResponseBody200

Defined in StripeAPI.Operations.GetTerminalReaders

Methods

parseJSON :: Value -> Parser GetTerminalReadersResponseBody200

parseJSONList :: Value -> Parser [GetTerminalReadersResponseBody200]

data GetTerminalReadersResponseBody200Object'

Defines the enum schema GetTerminalReadersResponseBody200Object'

String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

Constructors

GetTerminalReadersResponseBody200Object'EnumOther Value

GetTerminalReadersResponseBody200Object'EnumTyped Text

GetTerminalReadersResponseBody200Object'EnumStringList

Instances

Eq GetTerminalReadersResponseBody200Object'

Defined in StripeAPI.Operations.GetTerminalReaders

Methods

(==) :: GetTerminalReadersResponseBody200Object' -> GetTerminalReadersResponseBody200Object' -> Bool

(/=) :: GetTerminalReadersResponseBody200Object' -> GetTerminalReadersResponseBody200Object' -> Bool

Show GetTerminalReadersResponseBody200Object'

Defined in StripeAPI.Operations.GetTerminalReaders

Methods

showsPrec :: Int -> GetTerminalReadersResponseBody200Object' -> ShowS

show :: GetTerminalReadersResponseBody200Object' -> String

showList :: [GetTerminalReadersResponseBody200Object'] -> ShowS

ToJSON GetTerminalReadersResponseBody200Object'

Defined in StripeAPI.Operations.GetTerminalReaders

Methods

toJSON :: GetTerminalReadersResponseBody200Object' -> Value

toEncoding :: GetTerminalReadersResponseBody200Object' -> Encoding

toJSONList :: [GetTerminalReadersResponseBody200Object'] -> Value

toEncodingList :: [GetTerminalReadersResponseBody200Object'] -> Encoding

FromJSON GetTerminalReadersResponseBody200Object'

Defined in StripeAPI.Operations.GetTerminalReaders

Methods

parseJSON :: Value -> Parser GetTerminalReadersResponseBody200Object'

parseJSONList :: Value -> Parser [GetTerminalReadersResponseBody200Object']