Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostTerminalLocationsLocation

Description

Contains the different functions to run the operation postTerminalLocationsLocation

Synopsis

postTerminalLocationsLocation :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostTerminalLocationsLocationRequestBody -> m (Either HttpException (Response PostTerminalLocationsLocationResponse))
postTerminalLocationsLocationRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostTerminalLocationsLocationRequestBody -> m (Either HttpException (Response ByteString))
postTerminalLocationsLocationM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostTerminalLocationsLocationRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostTerminalLocationsLocationResponse))
postTerminalLocationsLocationRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostTerminalLocationsLocationRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostTerminalLocationsLocationRequestBody = PostTerminalLocationsLocationRequestBody {
}
data PostTerminalLocationsLocationRequestBodyAddress' = PostTerminalLocationsLocationRequestBodyAddress' {
}
data PostTerminalLocationsLocationRequestBodyMetadata' = PostTerminalLocationsLocationRequestBodyMetadata' {
}
data PostTerminalLocationsLocationResponse

Documentation

postTerminalLocationsLocation Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> String	location \| Constraints: Maximum length of 5000
-> PostTerminalLocationsLocationRequestBody	The request body to send
-> m (Either HttpException (Response PostTerminalLocationsLocationResponse))	Monad containing the result of the operation

POST /v1/terminal/locations/{location}

<p>Updates a <code>Location</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

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

POST /v1/terminal/locations/{location}

The same as postTerminalLocationsLocation but returns the raw ByteString

postTerminalLocationsLocationM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostTerminalLocationsLocationRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostTerminalLocationsLocationResponse)) Source #

POST /v1/terminal/locations/{location}

Monadic version of postTerminalLocationsLocation (use with runWithConfiguration)

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

POST /v1/terminal/locations/{location}

Monadic version of postTerminalLocationsLocationRaw (use with runWithConfiguration)

data PostTerminalLocationsLocationRequestBody Source #

Defines the data type for the schema postTerminalLocationsLocationRequestBody

Constructors

PostTerminalLocationsLocationRequestBody

Fields

postTerminalLocationsLocationRequestBodyAddress :: Maybe PostTerminalLocationsLocationRequestBodyAddress'
address: The full address of the location.
postTerminalLocationsLocationRequestBodyDisplayName :: Maybe String
display_name: A name for the location.
Constraints:
- Maximum length of 5000
postTerminalLocationsLocationRequestBodyExpand :: Maybe ([] String)
expand: Specifies which fields in the response should be expanded.
postTerminalLocationsLocationRequestBodyMetadata :: Maybe PostTerminalLocationsLocationRequestBodyMetadata'
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 PostTerminalLocationsLocationRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostTerminalLocationsLocation Methods (==) :: PostTerminalLocationsLocationRequestBody -> PostTerminalLocationsLocationRequestBody -> Bool # (/=) :: PostTerminalLocationsLocationRequestBody -> PostTerminalLocationsLocationRequestBody -> Bool #
Show PostTerminalLocationsLocationRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostTerminalLocationsLocation Methods showsPrec :: Int -> PostTerminalLocationsLocationRequestBody -> ShowS # show :: PostTerminalLocationsLocationRequestBody -> String # showList :: [PostTerminalLocationsLocationRequestBody] -> ShowS #
ToJSON PostTerminalLocationsLocationRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostTerminalLocationsLocation Methods toJSON :: PostTerminalLocationsLocationRequestBody -> Value # toEncoding :: PostTerminalLocationsLocationRequestBody -> Encoding # toJSONList :: [PostTerminalLocationsLocationRequestBody] -> Value # toEncodingList :: [PostTerminalLocationsLocationRequestBody] -> Encoding #
FromJSON PostTerminalLocationsLocationRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostTerminalLocationsLocation Methods parseJSON :: Value -> Parser PostTerminalLocationsLocationRequestBody # parseJSONList :: Value -> Parser [PostTerminalLocationsLocationRequestBody] #

data PostTerminalLocationsLocationRequestBodyAddress' Source #

Defines the data type for the schema postTerminalLocationsLocationRequestBodyAddress'

The full address of the location.

Constructors

PostTerminalLocationsLocationRequestBodyAddress'

Fields

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

Instances

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

data PostTerminalLocationsLocationRequestBodyMetadata' Source #

Defines the data type for the schema postTerminalLocationsLocationRequestBodyMetadata'

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

PostTerminalLocationsLocationRequestBodyMetadata'

Instances

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

data PostTerminalLocationsLocationResponse Source #

Represents a response of the operation postTerminalLocationsLocation.

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

Constructors

PostTerminalLocationsLocationResponseError String	Means either no matching case available or a parse error
PostTerminalLocationsLocationResponse200 Terminal'location	Successful response.
PostTerminalLocationsLocationResponseDefault Error	Error response.

Instances

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