stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetTerminalReaders

Description

Contains the different functions to run the operation getTerminalReaders

Synopsis

Documentation

getTerminalReaders Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> Maybe String

device_type: Filters readers by device type

-> Maybe String

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 String

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 String

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

-> Maybe String

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 String

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

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

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.

data GetTerminalReadersResponseBody200 Source #

Defines the data type for the schema GetTerminalReadersResponseBody200

Constructors

GetTerminalReadersResponseBody200 

Fields

data GetTerminalReadersResponseBody200Object' Source #

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