Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetTerminalReadersReader

Contains the different functions to run the operation getTerminalReadersReader

10 types
4 values

Packagestripeapi-3.0.0.0
Exports14
LanguageHaskell2010
LicenceMIT
SourceGetTerminalReadersReader.hs

valuegetTerminalReadersReader

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

GET /v1/terminal/readers/{reader}

<p>Retrieves a <code>Reader</code> object.</p>

datadata GetTerminalReadersReaderParameters

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

Constructors

GetTerminalReadersReaderParameters
- getTerminalReadersReaderParametersPathReader :: Text
  pathReader: Represents the parameter named 'reader'
  Constraints:
  - Maximum length of 5000
- getTerminalReadersReaderParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTerminalReadersReaderParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
Show GetTerminalReadersReaderParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
FromJSON GetTerminalReadersReaderParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
ToJSON GetTerminalReadersReaderParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader

valuemkGetTerminalReadersReaderParameters

:: Text
getTerminalReadersReaderParametersPathReader
-> GetTerminalReadersReaderParameters

Create a new GetTerminalReadersReaderParameters with all required fields.

datadata GetTerminalReadersReaderResponse

Represents a response of the operation getTerminalReadersReader.

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

Constructors

GetTerminalReadersReaderResponseError String
Means either no matching case available or a parse error
GetTerminalReadersReaderResponse200 GetTerminalReadersReaderResponseBody200
Successful response.
GetTerminalReadersReaderResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetTerminalReadersReaderResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
Show GetTerminalReadersReaderResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader

datadata GetTerminalReadersReaderResponseBody200

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

Constructors

GetTerminalReadersReaderResponseBody200
- getTerminalReadersReaderResponseBody200Action :: Maybe (Nullable GetTerminalReadersReaderResponseBody200Action'NonNullable)
  action: The most recent action performed by the reader.
- getTerminalReadersReaderResponseBody200Deleted :: Maybe GetTerminalReadersReaderResponseBody200Deleted'
  deleted: Always true for a deleted object
- getTerminalReadersReaderResponseBody200DeviceSwVersion :: Maybe (Nullable Text)
  device_sw_version: The current software version of the reader.
  Constraints:
  - Maximum length of 5000
- getTerminalReadersReaderResponseBody200DeviceType :: Maybe GetTerminalReadersReaderResponseBody200DeviceType'
  device_type: Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, or `simulated_wisepos_e`.
- getTerminalReadersReaderResponseBody200Id :: Maybe Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- getTerminalReadersReaderResponseBody200IpAddress :: Maybe (Nullable Text)
  ip_address: The local IP address of the reader.
  Constraints:
  - Maximum length of 5000
- getTerminalReadersReaderResponseBody200Label :: Maybe Text
  label: Custom label given to the reader for easier identification.
  Constraints:
  - Maximum length of 5000
- getTerminalReadersReaderResponseBody200Livemode :: Maybe Bool
  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
- getTerminalReadersReaderResponseBody200Location :: Maybe (Nullable GetTerminalReadersReaderResponseBody200Location'NonNullableVariants)
  location: The location identifier of the reader.
- getTerminalReadersReaderResponseBody200Metadata :: Maybe Object
  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.
- getTerminalReadersReaderResponseBody200Object :: Maybe GetTerminalReadersReaderResponseBody200Object'
  object: String representing the object's type. Objects of the same type share the same value.
- getTerminalReadersReaderResponseBody200SerialNumber :: Maybe Text
  serial_number: Serial number of the reader.
  Constraints:
  - Maximum length of 5000
- getTerminalReadersReaderResponseBody200Status :: Maybe (Nullable Text)
  status: The networking status of the reader.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTerminalReadersReaderResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
Show GetTerminalReadersReaderResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
FromJSON GetTerminalReadersReaderResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
ToJSON GetTerminalReadersReaderResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader

valuemkGetTerminalReadersReaderResponseBody200 :: GetTerminalReadersReaderResponseBody200

Create a new GetTerminalReadersReaderResponseBody200 with all required fields.

datadata GetTerminalReadersReaderResponseBody200Action'NonNullable

Defines the object schema located at paths./v1/terminal/readers/{reader}.GET.responses.200.content.application/json.schema.anyOf.properties.action.anyOf in the specification.

The most recent action performed by the reader.

Constructors

GetTerminalReadersReaderResponseBody200Action'NonNullable
- getTerminalReadersReaderResponseBody200Action'NonNullableFailureCode :: Maybe (Nullable Text)
  failure_code: Failure code, only set if status is `failed`.
  Constraints:
  - Maximum length of 5000
- getTerminalReadersReaderResponseBody200Action'NonNullableFailureMessage :: Maybe (Nullable Text)
  failure_message: Detailed failure message, only set if status is `failed`.
  Constraints:
  - Maximum length of 5000
- getTerminalReadersReaderResponseBody200Action'NonNullableProcessPaymentIntent :: Maybe TerminalReaderReaderResourceProcessPaymentIntentAction
  process_payment_intent: Represents a reader action to process a payment intent
- getTerminalReadersReaderResponseBody200Action'NonNullableProcessSetupIntent :: Maybe TerminalReaderReaderResourceProcessSetupIntentAction
  process_setup_intent: Represents a reader action to process a setup intent
- getTerminalReadersReaderResponseBody200Action'NonNullableSetReaderDisplay :: Maybe TerminalReaderReaderResourceSetReaderDisplayAction
  set_reader_display: Represents a reader action to set the reader display
- getTerminalReadersReaderResponseBody200Action'NonNullableStatus :: Maybe GetTerminalReadersReaderResponseBody200Action'NonNullableStatus'
  status: Status of the action performed by the reader.
- getTerminalReadersReaderResponseBody200Action'NonNullableType :: Maybe GetTerminalReadersReaderResponseBody200Action'NonNullableType'
  type: Type of action performed by the reader.

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTerminalReadersReaderResponseBody200Action'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
Show GetTerminalReadersReaderResponseBody200Action'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
FromJSON GetTerminalReadersReaderResponseBody200Action'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
ToJSON GetTerminalReadersReaderResponseBody200Action'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader

valuemkGetTerminalReadersReaderResponseBody200Action'NonNullable :: GetTerminalReadersReaderResponseBody200Action'NonNullable

Create a new GetTerminalReadersReaderResponseBody200Action'NonNullable with all required fields.

datadata GetTerminalReadersReaderResponseBody200Action'NonNullableStatus'

Defines the enum schema located at paths./v1/terminal/readers/{reader}.GET.responses.200.content.application/json.schema.anyOf.properties.action.anyOf.properties.status in the specification.

Status of the action performed by the reader.

Constructors

GetTerminalReadersReaderResponseBody200Action'NonNullableStatus'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetTerminalReadersReaderResponseBody200Action'NonNullableStatus'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetTerminalReadersReaderResponseBody200Action'NonNullableStatus'EnumFailed
Represents the JSON value "failed"
GetTerminalReadersReaderResponseBody200Action'NonNullableStatus'EnumInProgress
Represents the JSON value "in_progress"
GetTerminalReadersReaderResponseBody200Action'NonNullableStatus'EnumSucceeded
Represents the JSON value "succeeded"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTerminalReadersReaderResponseBody200Action'NonNullableStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
Show GetTerminalReadersReaderResponseBody200Action'NonNullableStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
FromJSON GetTerminalReadersReaderResponseBody200Action'NonNullableStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
ToJSON GetTerminalReadersReaderResponseBody200Action'NonNullableStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader

datadata GetTerminalReadersReaderResponseBody200Action'NonNullableType'

Defines the enum schema located at paths./v1/terminal/readers/{reader}.GET.responses.200.content.application/json.schema.anyOf.properties.action.anyOf.properties.type in the specification.

Type of action performed by the reader.

Constructors

GetTerminalReadersReaderResponseBody200Action'NonNullableType'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetTerminalReadersReaderResponseBody200Action'NonNullableType'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetTerminalReadersReaderResponseBody200Action'NonNullableType'EnumProcessPaymentIntent
Represents the JSON value "process_payment_intent"
GetTerminalReadersReaderResponseBody200Action'NonNullableType'EnumProcessSetupIntent
Represents the JSON value "process_setup_intent"
GetTerminalReadersReaderResponseBody200Action'NonNullableType'EnumSetReaderDisplay
Represents the JSON value "set_reader_display"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTerminalReadersReaderResponseBody200Action'NonNullableType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
Show GetTerminalReadersReaderResponseBody200Action'NonNullableType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
FromJSON GetTerminalReadersReaderResponseBody200Action'NonNullableType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
ToJSON GetTerminalReadersReaderResponseBody200Action'NonNullableType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader

datadata GetTerminalReadersReaderResponseBody200Deleted'

Defines the enum schema located at paths./v1/terminal/readers/{reader}.GET.responses.200.content.application/json.schema.anyOf.properties.deleted in the specification.

Always true for a deleted object

Constructors

GetTerminalReadersReaderResponseBody200Deleted'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetTerminalReadersReaderResponseBody200Deleted'Typed Bool
This constructor can be used to send values to the server which are not present in the specification yet.
GetTerminalReadersReaderResponseBody200Deleted'EnumTrue
Represents the JSON value true

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTerminalReadersReaderResponseBody200Deleted'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
Show GetTerminalReadersReaderResponseBody200Deleted'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
FromJSON GetTerminalReadersReaderResponseBody200Deleted'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
ToJSON GetTerminalReadersReaderResponseBody200Deleted'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader

datadata GetTerminalReadersReaderResponseBody200DeviceType'

Defines the enum schema located at paths./v1/terminal/readers/{reader}.GET.responses.200.content.application/json.schema.anyOf.properties.device_type in the specification.

Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, or `simulated_wisepos_e`.

Constructors

GetTerminalReadersReaderResponseBody200DeviceType'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetTerminalReadersReaderResponseBody200DeviceType'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetTerminalReadersReaderResponseBody200DeviceType'EnumBbposChipper2x
Represents the JSON value "bbpos_chipper2x"
GetTerminalReadersReaderResponseBody200DeviceType'EnumBbposWisepad3
Represents the JSON value "bbpos_wisepad3"
GetTerminalReadersReaderResponseBody200DeviceType'EnumBbposWiseposE
Represents the JSON value "bbpos_wisepos_e"
GetTerminalReadersReaderResponseBody200DeviceType'EnumSimulatedWiseposE
Represents the JSON value "simulated_wisepos_e"
GetTerminalReadersReaderResponseBody200DeviceType'EnumStripeM2
Represents the JSON value "stripe_m2"
GetTerminalReadersReaderResponseBody200DeviceType'EnumVerifoneP400
Represents the JSON value "verifone_P400"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTerminalReadersReaderResponseBody200DeviceType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
Show GetTerminalReadersReaderResponseBody200DeviceType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
FromJSON GetTerminalReadersReaderResponseBody200DeviceType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
ToJSON GetTerminalReadersReaderResponseBody200DeviceType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader

datadata GetTerminalReadersReaderResponseBody200Location'NonNullableVariants

Defines the oneOf schema located at paths./v1/terminal/readers/{reader}.GET.responses.200.content.application/json.schema.anyOf.properties.location.anyOf in the specification.

The location identifier of the reader.

Constructors

GetTerminalReadersReaderResponseBody200Location'NonNullableText Text
GetTerminalReadersReaderResponseBody200Location'NonNullableTerminal'location Terminal'location

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTerminalReadersReaderResponseBody200Location'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
Show GetTerminalReadersReaderResponseBody200Location'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
FromJSON GetTerminalReadersReaderResponseBody200Location'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
ToJSON GetTerminalReadersReaderResponseBody200Location'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader

datadata GetTerminalReadersReaderResponseBody200Object'

Defines the enum schema located at paths./v1/terminal/readers/{reader}.GET.responses.200.content.application/json.schema.anyOf.properties.object in the specification.

String representing the object's type. Objects of the same type share the same value.

Constructors

GetTerminalReadersReaderResponseBody200Object'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetTerminalReadersReaderResponseBody200Object'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetTerminalReadersReaderResponseBody200Object'EnumTerminal'reader
Represents the JSON value "terminal.reader"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTerminalReadersReaderResponseBody200Object'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
Show GetTerminalReadersReaderResponseBody200Object'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
FromJSON GetTerminalReadersReaderResponseBody200Object'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader
ToJSON GetTerminalReadersReaderResponseBody200Object'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTerminalReadersReader