stripeapi-1.0.0.0: Stripe-Library
Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetTerminalLocations

Description

Contains the different functions to run the operation getTerminalLocations

Synopsis

Documentation

getTerminalLocations Source #

Arguments

:: forall m. MonadHTTP m 
=> GetTerminalLocationsParameters

Contains all available parameters of this operation (query and path parameters)

-> StripeT m (Response GetTerminalLocationsResponse)

Monadic computation which returns the result of the operation

GET /v1/terminal/locations

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

data GetTerminalLocationsParameters Source #

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

Constructors

GetTerminalLocationsParameters 

Fields

  • getTerminalLocationsParametersQueryEndingBefore :: 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
  • getTerminalLocationsParametersQueryExpand :: Maybe [Text]

    queryExpand: Represents the parameter named 'expand'

    Specifies which fields in the response should be expanded.

  • getTerminalLocationsParametersQueryLimit :: 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.

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

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.

data GetTerminalLocationsResponseBody200 Source #

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

Constructors

GetTerminalLocationsResponseBody200 

Fields