Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostTerminalLocations

Description

Contains the different functions to run the operation postTerminalLocations

Synopsis

postTerminalLocations :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostTerminalLocationsRequestBody -> m (Either HttpException (Response PostTerminalLocationsResponse))
postTerminalLocationsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostTerminalLocationsRequestBody -> m (Either HttpException (Response ByteString))
postTerminalLocationsM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostTerminalLocationsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostTerminalLocationsResponse))
postTerminalLocationsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostTerminalLocationsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostTerminalLocationsRequestBody = PostTerminalLocationsRequestBody {
}
data PostTerminalLocationsRequestBodyAddress' = PostTerminalLocationsRequestBodyAddress' {
}
data PostTerminalLocationsRequestBodyMetadata' = PostTerminalLocationsRequestBodyMetadata' {
}
data PostTerminalLocationsResponse

Documentation

postTerminalLocations Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> PostTerminalLocationsRequestBody	The request body to send
-> m (Either HttpException (Response PostTerminalLocationsResponse))	Monad containing the result of the operation

POST /v1/terminal/locations

<p>Creates a new <code>Location</code> object.</p>

postTerminalLocationsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostTerminalLocationsRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/terminal/locations

The same as postTerminalLocations but returns the raw ByteString

postTerminalLocationsM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostTerminalLocationsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostTerminalLocationsResponse)) Source #

POST /v1/terminal/locations

Monadic version of postTerminalLocations (use with runWithConfiguration)

postTerminalLocationsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostTerminalLocationsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/terminal/locations

Monadic version of postTerminalLocationsRaw (use with runWithConfiguration)

data PostTerminalLocationsRequestBody Source #

Defines the data type for the schema postTerminalLocationsRequestBody

Constructors

PostTerminalLocationsRequestBody

Fields

postTerminalLocationsRequestBodyAddress :: PostTerminalLocationsRequestBodyAddress'
address: The full address of the location.
postTerminalLocationsRequestBodyDisplayName :: Text
display_name: A name for the location.
Constraints:
- Maximum length of 5000
postTerminalLocationsRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
postTerminalLocationsRequestBodyMetadata :: Maybe PostTerminalLocationsRequestBodyMetadata'
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

Instances

Eq PostTerminalLocationsRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostTerminalLocations Methods (==) :: PostTerminalLocationsRequestBody -> PostTerminalLocationsRequestBody -> Bool # (/=) :: PostTerminalLocationsRequestBody -> PostTerminalLocationsRequestBody -> Bool #
Show PostTerminalLocationsRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostTerminalLocations Methods showsPrec :: Int -> PostTerminalLocationsRequestBody -> ShowS # show :: PostTerminalLocationsRequestBody -> String # showList :: [PostTerminalLocationsRequestBody] -> ShowS #
ToJSON PostTerminalLocationsRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostTerminalLocations Methods toJSON :: PostTerminalLocationsRequestBody -> Value # toEncoding :: PostTerminalLocationsRequestBody -> Encoding # toJSONList :: [PostTerminalLocationsRequestBody] -> Value # toEncodingList :: [PostTerminalLocationsRequestBody] -> Encoding #
FromJSON PostTerminalLocationsRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostTerminalLocations Methods parseJSON :: Value -> Parser PostTerminalLocationsRequestBody # parseJSONList :: Value -> Parser [PostTerminalLocationsRequestBody] #

data PostTerminalLocationsRequestBodyAddress' Source #

Defines the data type for the schema postTerminalLocationsRequestBodyAddress'

The full address of the location.

Constructors

PostTerminalLocationsRequestBodyAddress'

Fields

postTerminalLocationsRequestBodyAddress'City :: Maybe Text
city
Constraints:
- Maximum length of 5000
postTerminalLocationsRequestBodyAddress'Country :: Text
country
Constraints:
- Maximum length of 5000
postTerminalLocationsRequestBodyAddress'Line1 :: Maybe Text
line1
Constraints:
- Maximum length of 5000
postTerminalLocationsRequestBodyAddress'Line2 :: Maybe Text
line2
Constraints:
- Maximum length of 5000
postTerminalLocationsRequestBodyAddress'PostalCode :: Maybe Text
postal_code
Constraints:
- Maximum length of 5000
postTerminalLocationsRequestBodyAddress'State :: Maybe Text
state
Constraints:
- Maximum length of 5000

Instances

Eq PostTerminalLocationsRequestBodyAddress' Source #
Instance details Defined in StripeAPI.Operations.PostTerminalLocations Methods (==) :: PostTerminalLocationsRequestBodyAddress' -> PostTerminalLocationsRequestBodyAddress' -> Bool # (/=) :: PostTerminalLocationsRequestBodyAddress' -> PostTerminalLocationsRequestBodyAddress' -> Bool #
Show PostTerminalLocationsRequestBodyAddress' Source #
Instance details Defined in StripeAPI.Operations.PostTerminalLocations Methods showsPrec :: Int -> PostTerminalLocationsRequestBodyAddress' -> ShowS # show :: PostTerminalLocationsRequestBodyAddress' -> String # showList :: [PostTerminalLocationsRequestBodyAddress'] -> ShowS #
ToJSON PostTerminalLocationsRequestBodyAddress' Source #
Instance details Defined in StripeAPI.Operations.PostTerminalLocations Methods toJSON :: PostTerminalLocationsRequestBodyAddress' -> Value # toEncoding :: PostTerminalLocationsRequestBodyAddress' -> Encoding # toJSONList :: [PostTerminalLocationsRequestBodyAddress'] -> Value # toEncodingList :: [PostTerminalLocationsRequestBodyAddress'] -> Encoding #
FromJSON PostTerminalLocationsRequestBodyAddress' Source #
Instance details Defined in StripeAPI.Operations.PostTerminalLocations Methods parseJSON :: Value -> Parser PostTerminalLocationsRequestBodyAddress' # parseJSONList :: Value -> Parser [PostTerminalLocationsRequestBodyAddress'] #

data PostTerminalLocationsRequestBodyMetadata' Source #

Defines the data type for the schema postTerminalLocationsRequestBodyMetadata'

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

Constructors

PostTerminalLocationsRequestBodyMetadata'

Instances

Eq PostTerminalLocationsRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostTerminalLocations Methods (==) :: PostTerminalLocationsRequestBodyMetadata' -> PostTerminalLocationsRequestBodyMetadata' -> Bool # (/=) :: PostTerminalLocationsRequestBodyMetadata' -> PostTerminalLocationsRequestBodyMetadata' -> Bool #
Show PostTerminalLocationsRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostTerminalLocations Methods showsPrec :: Int -> PostTerminalLocationsRequestBodyMetadata' -> ShowS # show :: PostTerminalLocationsRequestBodyMetadata' -> String # showList :: [PostTerminalLocationsRequestBodyMetadata'] -> ShowS #
ToJSON PostTerminalLocationsRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostTerminalLocations Methods toJSON :: PostTerminalLocationsRequestBodyMetadata' -> Value # toEncoding :: PostTerminalLocationsRequestBodyMetadata' -> Encoding # toJSONList :: [PostTerminalLocationsRequestBodyMetadata'] -> Value # toEncodingList :: [PostTerminalLocationsRequestBodyMetadata'] -> Encoding #
FromJSON PostTerminalLocationsRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostTerminalLocations Methods parseJSON :: Value -> Parser PostTerminalLocationsRequestBodyMetadata' # parseJSONList :: Value -> Parser [PostTerminalLocationsRequestBodyMetadata'] #

data PostTerminalLocationsResponse Source #

Represents a response of the operation postTerminalLocations.

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

Constructors

PostTerminalLocationsResponseError String	Means either no matching case available or a parse error
PostTerminalLocationsResponse200 Terminal'location	Successful response.
PostTerminalLocationsResponseDefault Error	Error response.

Instances

Eq PostTerminalLocationsResponse Source #
Instance details Defined in StripeAPI.Operations.PostTerminalLocations Methods (==) :: PostTerminalLocationsResponse -> PostTerminalLocationsResponse -> Bool # (/=) :: PostTerminalLocationsResponse -> PostTerminalLocationsResponse -> Bool #
Show PostTerminalLocationsResponse Source #
Instance details Defined in StripeAPI.Operations.PostTerminalLocations Methods showsPrec :: Int -> PostTerminalLocationsResponse -> ShowS # show :: PostTerminalLocationsResponse -> String # showList :: [PostTerminalLocationsResponse] -> ShowS #