Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostFileLinksLink

Description

Contains the different functions to run the operation postFileLinksLink

Synopsis

postFileLinksLink :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostFileLinksLinkRequestBody -> m (Either HttpException (Response PostFileLinksLinkResponse))
postFileLinksLinkRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostFileLinksLinkRequestBody -> m (Either HttpException (Response ByteString))
postFileLinksLinkM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostFileLinksLinkRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostFileLinksLinkResponse))
postFileLinksLinkRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostFileLinksLinkRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostFileLinksLinkRequestBody = PostFileLinksLinkRequestBody {
}
data PostFileLinksLinkRequestBodyExpiresAt'OneOf1
data PostFileLinksLinkRequestBodyExpiresAt'OneOf2
data PostFileLinksLinkRequestBodyExpiresAt'Variants
data PostFileLinksLinkRequestBodyMetadata' = PostFileLinksLinkRequestBodyMetadata' {
}
data PostFileLinksLinkResponse

Documentation

postFileLinksLink Source #

Arguments

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

POST /v1/file_links/{link}

<p>Updates an existing file link object. Expired links can no longer be updated.</p>

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

POST /v1/file_links/{link}

The same as postFileLinksLink but returns the raw ByteString

postFileLinksLinkM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostFileLinksLinkRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostFileLinksLinkResponse)) Source #

POST /v1/file_links/{link}

Monadic version of postFileLinksLink (use with runWithConfiguration)

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

POST /v1/file_links/{link}

Monadic version of postFileLinksLinkRaw (use with runWithConfiguration)

data PostFileLinksLinkRequestBody Source #

Defines the data type for the schema postFileLinksLinkRequestBody

Constructors

PostFileLinksLinkRequestBody

Fields

postFileLinksLinkRequestBodyExpand :: Maybe ([] String)
expand: Specifies which fields in the response should be expanded.
postFileLinksLinkRequestBodyExpiresAt :: Maybe PostFileLinksLinkRequestBodyExpiresAt'Variants
expires_at: A future timestamp after which the link will no longer be usable, or `now` to expire the link immediately.
postFileLinksLinkRequestBodyMetadata :: Maybe PostFileLinksLinkRequestBodyMetadata'
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 PostFileLinksLinkRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostFileLinksLink Methods (==) :: PostFileLinksLinkRequestBody -> PostFileLinksLinkRequestBody -> Bool # (/=) :: PostFileLinksLinkRequestBody -> PostFileLinksLinkRequestBody -> Bool #
Show PostFileLinksLinkRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostFileLinksLink Methods showsPrec :: Int -> PostFileLinksLinkRequestBody -> ShowS # show :: PostFileLinksLinkRequestBody -> String # showList :: [PostFileLinksLinkRequestBody] -> ShowS #
ToJSON PostFileLinksLinkRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostFileLinksLink Methods toJSON :: PostFileLinksLinkRequestBody -> Value # toEncoding :: PostFileLinksLinkRequestBody -> Encoding # toJSONList :: [PostFileLinksLinkRequestBody] -> Value # toEncodingList :: [PostFileLinksLinkRequestBody] -> Encoding #
FromJSON PostFileLinksLinkRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostFileLinksLink Methods parseJSON :: Value -> Parser PostFileLinksLinkRequestBody # parseJSONList :: Value -> Parser [PostFileLinksLinkRequestBody] #

data PostFileLinksLinkRequestBodyExpiresAt'OneOf1 Source #

Defines the enum schema postFileLinksLinkRequestBodyExpires_at'OneOf1

Constructors

PostFileLinksLinkRequestBodyExpiresAt'OneOf1EnumOther Value
PostFileLinksLinkRequestBodyExpiresAt'OneOf1EnumTyped String
PostFileLinksLinkRequestBodyExpiresAt'OneOf1EnumString_

Instances

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

data PostFileLinksLinkRequestBodyExpiresAt'OneOf2 Source #

Defines the enum schema postFileLinksLinkRequestBodyExpires_at'OneOf2

Constructors

PostFileLinksLinkRequestBodyExpiresAt'OneOf2EnumOther Value
PostFileLinksLinkRequestBodyExpiresAt'OneOf2EnumTyped String
PostFileLinksLinkRequestBodyExpiresAt'OneOf2EnumStringNow

Instances

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

data PostFileLinksLinkRequestBodyExpiresAt'Variants Source #

Define the one-of schema postFileLinksLinkRequestBodyExpires_at'

A future timestamp after which the link will no longer be usable, or `now` to expire the link immediately.

Constructors

PostFileLinksLinkRequestBodyExpiresAt'PostFileLinksLinkRequestBodyExpiresAt'OneOf1 PostFileLinksLinkRequestBodyExpiresAt'OneOf1
PostFileLinksLinkRequestBodyExpiresAt'PostFileLinksLinkRequestBodyExpiresAt'OneOf2 PostFileLinksLinkRequestBodyExpiresAt'OneOf2
PostFileLinksLinkRequestBodyExpiresAt'Integer Integer

Instances

Eq PostFileLinksLinkRequestBodyExpiresAt'Variants Source #
Instance details Defined in StripeAPI.Operations.PostFileLinksLink Methods (==) :: PostFileLinksLinkRequestBodyExpiresAt'Variants -> PostFileLinksLinkRequestBodyExpiresAt'Variants -> Bool # (/=) :: PostFileLinksLinkRequestBodyExpiresAt'Variants -> PostFileLinksLinkRequestBodyExpiresAt'Variants -> Bool #
Show PostFileLinksLinkRequestBodyExpiresAt'Variants Source #
Instance details Defined in StripeAPI.Operations.PostFileLinksLink Methods showsPrec :: Int -> PostFileLinksLinkRequestBodyExpiresAt'Variants -> ShowS # show :: PostFileLinksLinkRequestBodyExpiresAt'Variants -> String # showList :: [PostFileLinksLinkRequestBodyExpiresAt'Variants] -> ShowS #
Generic PostFileLinksLinkRequestBodyExpiresAt'Variants Source #
Instance details Defined in StripeAPI.Operations.PostFileLinksLink Associated Types type Rep PostFileLinksLinkRequestBodyExpiresAt'Variants :: Type -> Type # Methods from :: PostFileLinksLinkRequestBodyExpiresAt'Variants -> Rep PostFileLinksLinkRequestBodyExpiresAt'Variants x # to :: Rep PostFileLinksLinkRequestBodyExpiresAt'Variants x -> PostFileLinksLinkRequestBodyExpiresAt'Variants #
ToJSON PostFileLinksLinkRequestBodyExpiresAt'Variants Source #
Instance details Defined in StripeAPI.Operations.PostFileLinksLink Methods toJSON :: PostFileLinksLinkRequestBodyExpiresAt'Variants -> Value # toEncoding :: PostFileLinksLinkRequestBodyExpiresAt'Variants -> Encoding # toJSONList :: [PostFileLinksLinkRequestBodyExpiresAt'Variants] -> Value # toEncodingList :: [PostFileLinksLinkRequestBodyExpiresAt'Variants] -> Encoding #
FromJSON PostFileLinksLinkRequestBodyExpiresAt'Variants Source #
Instance details Defined in StripeAPI.Operations.PostFileLinksLink Methods parseJSON :: Value -> Parser PostFileLinksLinkRequestBodyExpiresAt'Variants # parseJSONList :: Value -> Parser [PostFileLinksLinkRequestBodyExpiresAt'Variants] #
type Rep PostFileLinksLinkRequestBodyExpiresAt'Variants Source #
Instance details Defined in StripeAPI.Operations.PostFileLinksLink type Rep PostFileLinksLinkRequestBodyExpiresAt'Variants = D1 (MetaData "PostFileLinksLinkRequestBodyExpiresAt'Variants" "StripeAPI.Operations.PostFileLinksLink" "stripeapi-0.1.0.0-A3hJyYFbMZN6w4qjBpK6b6" False) (C1 (MetaCons "PostFileLinksLinkRequestBodyExpiresAt'PostFileLinksLinkRequestBodyExpiresAt'OneOf1" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostFileLinksLinkRequestBodyExpiresAt'OneOf1)) :+: (C1 (MetaCons "PostFileLinksLinkRequestBodyExpiresAt'PostFileLinksLinkRequestBodyExpiresAt'OneOf2" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostFileLinksLinkRequestBodyExpiresAt'OneOf2)) :+: C1 (MetaCons "PostFileLinksLinkRequestBodyExpiresAt'Integer" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer))))

data PostFileLinksLinkRequestBodyMetadata' Source #

Defines the data type for the schema postFileLinksLinkRequestBodyMetadata'

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

PostFileLinksLinkRequestBodyMetadata'

Instances

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

data PostFileLinksLinkResponse Source #

Represents a response of the operation postFileLinksLink.

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

Constructors

PostFileLinksLinkResponseError String	Means either no matching case available or a parse error
PostFileLinksLinkResponse200 FileLink	Successful response.
PostFileLinksLinkResponseDefault Error	Error response.

Instances

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