Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostFileLinks

Description

Contains the different functions to run the operation postFileLinks

Documentation

postFileLinks Source #

Arguments

:: forall m. MonadHTTP m
=> PostFileLinksRequestBody	The request body to send
-> ClientT m (Response PostFileLinksResponse)	Monadic computation which returns the result of the operation

POST /v1/file_links

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

data PostFileLinksRequestBody Source #

Defines the object schema located at paths./v1/file_links.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostFileLinksRequestBody

Fields

postFileLinksRequestBodyExpand :: Maybe [Text]
expand: Specifies which fields in the response should be expanded.
postFileLinksRequestBodyExpiresAt :: Maybe Int
expires_at: A future timestamp after which the link will no longer be usable.
postFileLinksRequestBodyFile :: Text
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`, `identity_document_downloadable`, `pci_document`, `selfie`, `sigma_scheduled_query`, or `tax_document_user_upload`.
Constraints:
- Maximum length of 5000
postFileLinksRequestBodyMetadata :: Maybe PostFileLinksRequestBodyMetadata'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

Instances details

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] #

mkPostFileLinksRequestBody Source #

Arguments

:: Text	`postFileLinksRequestBodyFile`
-> PostFileLinksRequestBody

Create a new PostFileLinksRequestBody with all required fields.

data PostFileLinksRequestBodyMetadata'Variants Source #

Defines the oneOf schema located at paths./v1/file_links.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

PostFileLinksRequestBodyMetadata'EmptyString	Represents the JSON value `""`
PostFileLinksRequestBodyMetadata'Object Object

Instances

Instances details

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

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

Instances details

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 #