| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetTerminalLocations
Description
Contains the different functions to run the operation getTerminalLocations
Synopsis
- getTerminalLocations :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetTerminalLocationsRequestBody -> m (Either HttpException (Response GetTerminalLocationsResponse))
- getTerminalLocationsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetTerminalLocationsRequestBody -> m (Either HttpException (Response ByteString))
- getTerminalLocationsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetTerminalLocationsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetTerminalLocationsResponse))
- getTerminalLocationsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetTerminalLocationsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetTerminalLocationsRequestBody = GetTerminalLocationsRequestBody {
- data GetTerminalLocationsResponse
- data GetTerminalLocationsResponseBody200 = GetTerminalLocationsResponseBody200 {}
- data GetTerminalLocationsResponseBody200Object'
Documentation
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> 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 | 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 |
| -> GetTerminalLocationsRequestBody | The request body to send |
| -> m (Either HttpException (Response GetTerminalLocationsResponse)) | Monad containing the result of the operation |
GET /v1/terminal/locations
<p>Returns a list of <code>Location</code> objects.</p>
getTerminalLocationsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetTerminalLocationsRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/terminal/locations
The same as getTerminalLocations but returns the raw ByteString
getTerminalLocationsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetTerminalLocationsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetTerminalLocationsResponse)) Source #
GET /v1/terminal/locations
Monadic version of getTerminalLocations (use with runWithConfiguration)
getTerminalLocationsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetTerminalLocationsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/terminal/locations
Monadic version of getTerminalLocationsRaw (use with runWithConfiguration)
data GetTerminalLocationsRequestBody Source #
Defines the data type for the schema getTerminalLocationsRequestBody
Constructors
| GetTerminalLocationsRequestBody | |
Instances
data GetTerminalLocationsResponse Source #
Represents a response of the operation getTerminalLocations.
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), GetTerminalLocationsResponseError is used.
Constructors
| GetTerminalLocationsResponseError String | Means either no matching case available or a parse error |
| GetTerminalLocationsResponse200 GetTerminalLocationsResponseBody200 | Successful response. |
| GetTerminalLocationsResponseDefault Error | Error response. |
Instances
| Eq GetTerminalLocationsResponse Source # | |
Defined in StripeAPI.Operations.GetTerminalLocations Methods (==) :: GetTerminalLocationsResponse -> GetTerminalLocationsResponse -> Bool # (/=) :: GetTerminalLocationsResponse -> GetTerminalLocationsResponse -> Bool # | |
| Show GetTerminalLocationsResponse Source # | |
Defined in StripeAPI.Operations.GetTerminalLocations Methods showsPrec :: Int -> GetTerminalLocationsResponse -> ShowS # show :: GetTerminalLocationsResponse -> String # showList :: [GetTerminalLocationsResponse] -> ShowS # | |
data GetTerminalLocationsResponseBody200 Source #
Defines the data type for the schema GetTerminalLocationsResponseBody200
Constructors
| GetTerminalLocationsResponseBody200 | |
Fields
| |
Instances
data GetTerminalLocationsResponseBody200Object' Source #
Defines the enum schema GetTerminalLocationsResponseBody200Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Constructors
| GetTerminalLocationsResponseBody200Object'EnumOther Value | |
| GetTerminalLocationsResponseBody200Object'EnumTyped String | |
| GetTerminalLocationsResponseBody200Object'EnumStringList |