StripeAPI.Operations.GetTerminalLocations

Contains the different functions to run the operation getTerminalLocations

Documentation

getTerminalLocations

Arguments

:: forall m. MonadHTTP m

=> GetTerminalLocationsParameters

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

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

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

Instances

Eq GetTerminalLocationsParameters

Defined in StripeAPI.Operations.GetTerminalLocations

Methods

(==) :: GetTerminalLocationsParameters -> GetTerminalLocationsParameters -> Bool

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

Show GetTerminalLocationsParameters

Defined in StripeAPI.Operations.GetTerminalLocations

Methods

showsPrec :: Int -> GetTerminalLocationsParameters -> ShowS

show :: GetTerminalLocationsParameters -> String

showList :: [GetTerminalLocationsParameters] -> ShowS

ToJSON GetTerminalLocationsParameters

Defined in StripeAPI.Operations.GetTerminalLocations

Methods

toJSON :: GetTerminalLocationsParameters -> Value

toEncoding :: GetTerminalLocationsParameters -> Encoding

toJSONList :: [GetTerminalLocationsParameters] -> Value

toEncodingList :: [GetTerminalLocationsParameters] -> Encoding

FromJSON GetTerminalLocationsParameters

Defined in StripeAPI.Operations.GetTerminalLocations

Methods

parseJSON :: Value -> Parser GetTerminalLocationsParameters

parseJSONList :: Value -> Parser [GetTerminalLocationsParameters]

mkGetTerminalLocationsParameters :: GetTerminalLocationsParameters

Create a new GetTerminalLocationsParameters with all required fields.

data GetTerminalLocationsResponse

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

Defined in StripeAPI.Operations.GetTerminalLocations

Methods

(==) :: GetTerminalLocationsResponse -> GetTerminalLocationsResponse -> Bool

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

Show GetTerminalLocationsResponse

Defined in StripeAPI.Operations.GetTerminalLocations

Methods

showsPrec :: Int -> GetTerminalLocationsResponse -> ShowS

show :: GetTerminalLocationsResponse -> String

showList :: [GetTerminalLocationsResponse] -> ShowS

data GetTerminalLocationsResponseBody200

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

Constructors

GetTerminalLocationsResponseBody200

Fields

• getTerminalLocationsResponseBody200Data :: [Terminal'location]

  data

• getTerminalLocationsResponseBody200HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• getTerminalLocationsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000
  • Must match pattern '^/v1/terminal/locations'

Instances

Eq GetTerminalLocationsResponseBody200

Defined in StripeAPI.Operations.GetTerminalLocations

Methods

(==) :: GetTerminalLocationsResponseBody200 -> GetTerminalLocationsResponseBody200 -> Bool

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

Show GetTerminalLocationsResponseBody200

Defined in StripeAPI.Operations.GetTerminalLocations

Methods

showsPrec :: Int -> GetTerminalLocationsResponseBody200 -> ShowS

show :: GetTerminalLocationsResponseBody200 -> String

showList :: [GetTerminalLocationsResponseBody200] -> ShowS

ToJSON GetTerminalLocationsResponseBody200

Defined in StripeAPI.Operations.GetTerminalLocations

Methods

toJSON :: GetTerminalLocationsResponseBody200 -> Value

toEncoding :: GetTerminalLocationsResponseBody200 -> Encoding

toJSONList :: [GetTerminalLocationsResponseBody200] -> Value

toEncodingList :: [GetTerminalLocationsResponseBody200] -> Encoding

FromJSON GetTerminalLocationsResponseBody200

Defined in StripeAPI.Operations.GetTerminalLocations

Methods

parseJSON :: Value -> Parser GetTerminalLocationsResponseBody200

parseJSONList :: Value -> Parser [GetTerminalLocationsResponseBody200]

mkGetTerminalLocationsResponseBody200

Arguments

:: [Terminal'location]

getTerminalLocationsResponseBody200Data

-> Bool

getTerminalLocationsResponseBody200HasMore

-> Text

getTerminalLocationsResponseBody200Url

-> GetTerminalLocationsResponseBody200

Create a new GetTerminalLocationsResponseBody200 with all required fields.