StripeAPI.Operations.PostTerminalLocationsLocation

Contains the different functions to run the operation postTerminalLocationsLocation

Documentation

postTerminalLocationsLocation

Arguments

:: forall m. MonadHTTP m

=> Text

location | Constraints: Maximum length of 5000

-> Maybe PostTerminalLocationsLocationRequestBody

The request body to send

-> ClientT m (Response PostTerminalLocationsLocationResponse)

Monadic computation which returns 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>

data PostTerminalLocationsLocationRequestBody

Defines the object schema located at paths./v1/terminal/locations/{location}.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostTerminalLocationsLocationRequestBody

Fields

• postTerminalLocationsLocationRequestBodyAddress :: Maybe PostTerminalLocationsLocationRequestBodyAddress'

  address: The full address of the location.

• postTerminalLocationsLocationRequestBodyDisplayName :: Maybe Text

  display_name: A name for the location.

  Constraints:

  • Maximum length of 1000
• postTerminalLocationsLocationRequestBodyExpand :: Maybe [Text]

  expand: Specifies which fields in the response should be expanded.

• postTerminalLocationsLocationRequestBodyMetadata :: Maybe PostTerminalLocationsLocationRequestBodyMetadata'Variants

  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

Defined in StripeAPI.Operations.PostTerminalLocationsLocation

Methods

(==) :: PostTerminalLocationsLocationRequestBody -> PostTerminalLocationsLocationRequestBody -> Bool

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

Show PostTerminalLocationsLocationRequestBody

Defined in StripeAPI.Operations.PostTerminalLocationsLocation

Methods

showsPrec :: Int -> PostTerminalLocationsLocationRequestBody -> ShowS

show :: PostTerminalLocationsLocationRequestBody -> String

showList :: [PostTerminalLocationsLocationRequestBody] -> ShowS

ToJSON PostTerminalLocationsLocationRequestBody

Defined in StripeAPI.Operations.PostTerminalLocationsLocation

Methods

toJSON :: PostTerminalLocationsLocationRequestBody -> Value

toEncoding :: PostTerminalLocationsLocationRequestBody -> Encoding

toJSONList :: [PostTerminalLocationsLocationRequestBody] -> Value

toEncodingList :: [PostTerminalLocationsLocationRequestBody] -> Encoding

FromJSON PostTerminalLocationsLocationRequestBody

Defined in StripeAPI.Operations.PostTerminalLocationsLocation

Methods

parseJSON :: Value -> Parser PostTerminalLocationsLocationRequestBody

parseJSONList :: Value -> Parser [PostTerminalLocationsLocationRequestBody]

mkPostTerminalLocationsLocationRequestBody :: PostTerminalLocationsLocationRequestBody

Create a new PostTerminalLocationsLocationRequestBody with all required fields.

data PostTerminalLocationsLocationRequestBodyAddress'

Defines the object schema located at paths./v1/terminal/locations/{location}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.address in the specification.

The full address of the location.

Constructors

PostTerminalLocationsLocationRequestBodyAddress'

Fields

• postTerminalLocationsLocationRequestBodyAddress'City :: Maybe Text

  city

  Constraints:

  • Maximum length of 5000
• postTerminalLocationsLocationRequestBodyAddress'Country :: Maybe Text

  country

  Constraints:

  • Maximum length of 5000
• postTerminalLocationsLocationRequestBodyAddress'Line1 :: Maybe Text

  line1

  Constraints:

  • Maximum length of 5000
• postTerminalLocationsLocationRequestBodyAddress'Line2 :: Maybe Text

  line2

  Constraints:

  • Maximum length of 5000
• postTerminalLocationsLocationRequestBodyAddress'PostalCode :: Maybe Text

  postal_code

  Constraints:

  • Maximum length of 5000
• postTerminalLocationsLocationRequestBodyAddress'State :: Maybe Text

  state

  Constraints:

  • Maximum length of 5000

Instances

Eq PostTerminalLocationsLocationRequestBodyAddress'

Defined in StripeAPI.Operations.PostTerminalLocationsLocation

Methods

(==) :: PostTerminalLocationsLocationRequestBodyAddress' -> PostTerminalLocationsLocationRequestBodyAddress' -> Bool

(/=) :: PostTerminalLocationsLocationRequestBodyAddress' -> PostTerminalLocationsLocationRequestBodyAddress' -> Bool

Show PostTerminalLocationsLocationRequestBodyAddress'

Defined in StripeAPI.Operations.PostTerminalLocationsLocation

Methods

showsPrec :: Int -> PostTerminalLocationsLocationRequestBodyAddress' -> ShowS

show :: PostTerminalLocationsLocationRequestBodyAddress' -> String

showList :: [PostTerminalLocationsLocationRequestBodyAddress'] -> ShowS

ToJSON PostTerminalLocationsLocationRequestBodyAddress'

Defined in StripeAPI.Operations.PostTerminalLocationsLocation

Methods

toJSON :: PostTerminalLocationsLocationRequestBodyAddress' -> Value

toEncoding :: PostTerminalLocationsLocationRequestBodyAddress' -> Encoding

toJSONList :: [PostTerminalLocationsLocationRequestBodyAddress'] -> Value

toEncodingList :: [PostTerminalLocationsLocationRequestBodyAddress'] -> Encoding

FromJSON PostTerminalLocationsLocationRequestBodyAddress'

Defined in StripeAPI.Operations.PostTerminalLocationsLocation

Methods

parseJSON :: Value -> Parser PostTerminalLocationsLocationRequestBodyAddress'

parseJSONList :: Value -> Parser [PostTerminalLocationsLocationRequestBodyAddress']

mkPostTerminalLocationsLocationRequestBodyAddress' :: PostTerminalLocationsLocationRequestBodyAddress'

Create a new PostTerminalLocationsLocationRequestBodyAddress' with all required fields.

data PostTerminalLocationsLocationRequestBodyMetadata'Variants

Defines the oneOf schema located at paths./v1/terminal/locations/{location}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.

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'EmptyString

Represents the JSON value ""

PostTerminalLocationsLocationRequestBodyMetadata'Object Object

Instances

Eq PostTerminalLocationsLocationRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostTerminalLocationsLocation

Methods

(==) :: PostTerminalLocationsLocationRequestBodyMetadata'Variants -> PostTerminalLocationsLocationRequestBodyMetadata'Variants -> Bool

(/=) :: PostTerminalLocationsLocationRequestBodyMetadata'Variants -> PostTerminalLocationsLocationRequestBodyMetadata'Variants -> Bool

Show PostTerminalLocationsLocationRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostTerminalLocationsLocation

Methods

showsPrec :: Int -> PostTerminalLocationsLocationRequestBodyMetadata'Variants -> ShowS

show :: PostTerminalLocationsLocationRequestBodyMetadata'Variants -> String

showList :: [PostTerminalLocationsLocationRequestBodyMetadata'Variants] -> ShowS

ToJSON PostTerminalLocationsLocationRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostTerminalLocationsLocation

Methods

toJSON :: PostTerminalLocationsLocationRequestBodyMetadata'Variants -> Value

toEncoding :: PostTerminalLocationsLocationRequestBodyMetadata'Variants -> Encoding

toJSONList :: [PostTerminalLocationsLocationRequestBodyMetadata'Variants] -> Value

toEncodingList :: [PostTerminalLocationsLocationRequestBodyMetadata'Variants] -> Encoding

FromJSON PostTerminalLocationsLocationRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostTerminalLocationsLocation

Methods

parseJSON :: Value -> Parser PostTerminalLocationsLocationRequestBodyMetadata'Variants

parseJSONList :: Value -> Parser [PostTerminalLocationsLocationRequestBodyMetadata'Variants]

data PostTerminalLocationsLocationResponse

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

Defined in StripeAPI.Operations.PostTerminalLocationsLocation

Methods

(==) :: PostTerminalLocationsLocationResponse -> PostTerminalLocationsLocationResponse -> Bool

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

Show PostTerminalLocationsLocationResponse

Defined in StripeAPI.Operations.PostTerminalLocationsLocation

Methods

showsPrec :: Int -> PostTerminalLocationsLocationResponse -> ShowS

show :: PostTerminalLocationsLocationResponse -> String

showList :: [PostTerminalLocationsLocationResponse] -> ShowS