Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostFileLinks

Description

Contains the different functions to run the operation postFileLinks

Synopsis

postFileLinks :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostFileLinksRequestBody -> m (Either HttpException (Response PostFileLinksResponse))
postFileLinksRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostFileLinksRequestBody -> m (Either HttpException (Response ByteString))
postFileLinksM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostFileLinksRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostFileLinksResponse))
postFileLinksRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostFileLinksRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostFileLinksRequestBody = PostFileLinksRequestBody {
}
data PostFileLinksRequestBodyMetadata' = PostFileLinksRequestBodyMetadata' {
}
data PostFileLinksResponse

Documentation

postFileLinks Source #

Arguments

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

POST /v1/file_links

<p>Creates a new file link object.</p>

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

POST /v1/file_links

The same as postFileLinks but returns the raw ByteString

postFileLinksM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostFileLinksRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostFileLinksResponse)) Source #

POST /v1/file_links

Monadic version of postFileLinks (use with runWithConfiguration)

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

POST /v1/file_links

Monadic version of postFileLinksRaw (use with runWithConfiguration)

data PostFileLinksRequestBody Source #

Defines the data type for the schema postFileLinksRequestBody

Constructors

PostFileLinksRequestBody

Fields

postFileLinksRequestBodyExpand :: Maybe ([] String)
expand: Specifies which fields in the response should be expanded.
postFileLinksRequestBodyExpiresAt :: Maybe Integer
expires_at: A future timestamp after which the link will no longer be usable.
postFileLinksRequestBodyFile :: String
file: The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `pci_document`, `sigma_scheduled_query`, or `tax_document_user_upload`.
Constraints:
- Maximum length of 5000
postFileLinksRequestBodyMetadata :: Maybe PostFileLinksRequestBodyMetadata'
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 PostFileLinksRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostFileLinks Methods (==) :: PostFileLinksRequestBody -> PostFileLinksRequestBody -> Bool # (/=) :: PostFileLinksRequestBody -> PostFileLinksRequestBody -> Bool #
Show PostFileLinksRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostFileLinks Methods showsPrec :: Int -> PostFileLinksRequestBody -> ShowS # show :: PostFileLinksRequestBody -> String # showList :: [PostFileLinksRequestBody] -> ShowS #
ToJSON PostFileLinksRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostFileLinks Methods toJSON :: PostFileLinksRequestBody -> Value # toEncoding :: PostFileLinksRequestBody -> Encoding # toJSONList :: [PostFileLinksRequestBody] -> Value # toEncodingList :: [PostFileLinksRequestBody] -> Encoding #
FromJSON PostFileLinksRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostFileLinks Methods parseJSON :: Value -> Parser PostFileLinksRequestBody # parseJSONList :: Value -> Parser [PostFileLinksRequestBody] #

data PostFileLinksRequestBodyMetadata' Source #

Defines the data type for the schema postFileLinksRequestBodyMetadata'

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

PostFileLinksRequestBodyMetadata'

Instances

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

data PostFileLinksResponse Source #

Represents a response of the operation postFileLinks.

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

Constructors

PostFileLinksResponseError String	Means either no matching case available or a parse error
PostFileLinksResponse200 FileLink	Successful response.
PostFileLinksResponseDefault Error	Error response.

Instances

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