Safe Haskell | None |
---|---|
Language | Haskell2010 |
StripeAPI.Operations.GetFiles
Description
Contains the different functions to run the operation getFiles
Synopsis
- getFiles :: forall m. MonadHTTP m => GetFilesParameters -> ClientT m (Response GetFilesResponse)
- data GetFilesParameters = GetFilesParameters {
- getFilesParametersQueryCreated :: Maybe GetFilesParametersQueryCreated'Variants
- getFilesParametersQueryEndingBefore :: Maybe Text
- getFilesParametersQueryExpand :: Maybe [Text]
- getFilesParametersQueryLimit :: Maybe Int
- getFilesParametersQueryPurpose :: Maybe GetFilesParametersQueryPurpose'
- getFilesParametersQueryStartingAfter :: Maybe Text
- mkGetFilesParameters :: GetFilesParameters
- data GetFilesParametersQueryCreated'OneOf1 = GetFilesParametersQueryCreated'OneOf1 {}
- mkGetFilesParametersQueryCreated'OneOf1 :: GetFilesParametersQueryCreated'OneOf1
- data GetFilesParametersQueryCreated'Variants
- data GetFilesParametersQueryPurpose'
- = GetFilesParametersQueryPurpose'Other Value
- | GetFilesParametersQueryPurpose'Typed Text
- | GetFilesParametersQueryPurpose'EnumAccountRequirement
- | GetFilesParametersQueryPurpose'EnumAdditionalVerification
- | GetFilesParametersQueryPurpose'EnumBusinessIcon
- | GetFilesParametersQueryPurpose'EnumBusinessLogo
- | GetFilesParametersQueryPurpose'EnumCustomerSignature
- | GetFilesParametersQueryPurpose'EnumDisputeEvidence
- | GetFilesParametersQueryPurpose'EnumDocumentProviderIdentityDocument
- | GetFilesParametersQueryPurpose'EnumFinanceReportRun
- | GetFilesParametersQueryPurpose'EnumIdentityDocument
- | GetFilesParametersQueryPurpose'EnumIdentityDocumentDownloadable
- | GetFilesParametersQueryPurpose'EnumPciDocument
- | GetFilesParametersQueryPurpose'EnumSelfie
- | GetFilesParametersQueryPurpose'EnumSigmaScheduledQuery
- | GetFilesParametersQueryPurpose'EnumTaxDocumentUserUpload
- data GetFilesResponse
- data GetFilesResponseBody200 = GetFilesResponseBody200 {}
- mkGetFilesResponseBody200 :: [File] -> Bool -> Text -> GetFilesResponseBody200
Documentation
Arguments
:: forall m. MonadHTTP m | |
=> GetFilesParameters | Contains all available parameters of this operation (query and path parameters) |
-> ClientT m (Response GetFilesResponse) | Monadic computation which returns the result of the operation |
GET /v1/files
<p>Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.</p>
data GetFilesParameters Source #
Defines the object schema located at paths./v1/files.GET.parameters
in the specification.
Constructors
GetFilesParameters | |
Fields
|
Instances
Eq GetFilesParameters Source # | |
Defined in StripeAPI.Operations.GetFiles Methods (==) :: GetFilesParameters -> GetFilesParameters -> Bool # (/=) :: GetFilesParameters -> GetFilesParameters -> Bool # | |
Show GetFilesParameters Source # | |
Defined in StripeAPI.Operations.GetFiles Methods showsPrec :: Int -> GetFilesParameters -> ShowS # show :: GetFilesParameters -> String # showList :: [GetFilesParameters] -> ShowS # | |
ToJSON GetFilesParameters Source # | |
Defined in StripeAPI.Operations.GetFiles Methods toJSON :: GetFilesParameters -> Value # toEncoding :: GetFilesParameters -> Encoding # toJSONList :: [GetFilesParameters] -> Value # toEncodingList :: [GetFilesParameters] -> Encoding # | |
FromJSON GetFilesParameters Source # | |
Defined in StripeAPI.Operations.GetFiles Methods parseJSON :: Value -> Parser GetFilesParameters # parseJSONList :: Value -> Parser [GetFilesParameters] # |
mkGetFilesParameters :: GetFilesParameters Source #
Create a new GetFilesParameters
with all required fields.
data GetFilesParametersQueryCreated'OneOf1 Source #
Defines the object schema located at paths./v1/files.GET.parameters.properties.queryCreated.anyOf
in the specification.
Constructors
GetFilesParametersQueryCreated'OneOf1 | |
Instances
mkGetFilesParametersQueryCreated'OneOf1 :: GetFilesParametersQueryCreated'OneOf1 Source #
Create a new GetFilesParametersQueryCreated'OneOf1
with all required fields.
data GetFilesParametersQueryCreated'Variants Source #
Defines the oneOf schema located at paths./v1/files.GET.parameters.properties.queryCreated.anyOf
in the specification.
Represents the parameter named 'created'
Constructors
GetFilesParametersQueryCreated'GetFilesParametersQueryCreated'OneOf1 GetFilesParametersQueryCreated'OneOf1 | |
GetFilesParametersQueryCreated'Int Int |
Instances
data GetFilesParametersQueryPurpose' Source #
Defines the enum schema located at paths./v1/files.GET.parameters.properties.queryPurpose
in the specification.
Represents the parameter named 'purpose'
The file purpose to filter queries by. If none is provided, files will not be filtered by purpose.
Constructors
GetFilesParametersQueryPurpose'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
GetFilesParametersQueryPurpose'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
GetFilesParametersQueryPurpose'EnumAccountRequirement | Represents the JSON value |
GetFilesParametersQueryPurpose'EnumAdditionalVerification | Represents the JSON value |
GetFilesParametersQueryPurpose'EnumBusinessIcon | Represents the JSON value |
GetFilesParametersQueryPurpose'EnumBusinessLogo | Represents the JSON value |
GetFilesParametersQueryPurpose'EnumCustomerSignature | Represents the JSON value |
GetFilesParametersQueryPurpose'EnumDisputeEvidence | Represents the JSON value |
GetFilesParametersQueryPurpose'EnumDocumentProviderIdentityDocument | Represents the JSON value |
GetFilesParametersQueryPurpose'EnumFinanceReportRun | Represents the JSON value |
GetFilesParametersQueryPurpose'EnumIdentityDocument | Represents the JSON value |
GetFilesParametersQueryPurpose'EnumIdentityDocumentDownloadable | Represents the JSON value |
GetFilesParametersQueryPurpose'EnumPciDocument | Represents the JSON value |
GetFilesParametersQueryPurpose'EnumSelfie | Represents the JSON value |
GetFilesParametersQueryPurpose'EnumSigmaScheduledQuery | Represents the JSON value |
GetFilesParametersQueryPurpose'EnumTaxDocumentUserUpload | Represents the JSON value |
Instances
Eq GetFilesParametersQueryPurpose' Source # | |
Defined in StripeAPI.Operations.GetFiles | |
Show GetFilesParametersQueryPurpose' Source # | |
Defined in StripeAPI.Operations.GetFiles Methods showsPrec :: Int -> GetFilesParametersQueryPurpose' -> ShowS # | |
ToJSON GetFilesParametersQueryPurpose' Source # | |
Defined in StripeAPI.Operations.GetFiles | |
FromJSON GetFilesParametersQueryPurpose' Source # | |
Defined in StripeAPI.Operations.GetFiles Methods parseJSON :: Value -> Parser GetFilesParametersQueryPurpose' # parseJSONList :: Value -> Parser [GetFilesParametersQueryPurpose'] # |
data GetFilesResponse Source #
Represents a response of the operation getFiles
.
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), GetFilesResponseError
is used.
Constructors
GetFilesResponseError String | Means either no matching case available or a parse error |
GetFilesResponse200 GetFilesResponseBody200 | Successful response. |
GetFilesResponseDefault Error | Error response. |
Instances
Eq GetFilesResponse Source # | |
Defined in StripeAPI.Operations.GetFiles Methods (==) :: GetFilesResponse -> GetFilesResponse -> Bool # (/=) :: GetFilesResponse -> GetFilesResponse -> Bool # | |
Show GetFilesResponse Source # | |
Defined in StripeAPI.Operations.GetFiles Methods showsPrec :: Int -> GetFilesResponse -> ShowS # show :: GetFilesResponse -> String # showList :: [GetFilesResponse] -> ShowS # |
data GetFilesResponseBody200 Source #
Defines the object schema located at paths./v1/files.GET.responses.200.content.application/json.schema
in the specification.
Constructors
GetFilesResponseBody200 | |
Fields
|
Instances
Eq GetFilesResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetFiles Methods (==) :: GetFilesResponseBody200 -> GetFilesResponseBody200 -> Bool # (/=) :: GetFilesResponseBody200 -> GetFilesResponseBody200 -> Bool # | |
Show GetFilesResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetFiles Methods showsPrec :: Int -> GetFilesResponseBody200 -> ShowS # show :: GetFilesResponseBody200 -> String # showList :: [GetFilesResponseBody200] -> ShowS # | |
ToJSON GetFilesResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetFiles Methods toJSON :: GetFilesResponseBody200 -> Value # toEncoding :: GetFilesResponseBody200 -> Encoding # toJSONList :: [GetFilesResponseBody200] -> Value # | |
FromJSON GetFilesResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetFiles Methods parseJSON :: Value -> Parser GetFilesResponseBody200 # parseJSONList :: Value -> Parser [GetFilesResponseBody200] # |
mkGetFilesResponseBody200 Source #
Arguments
:: [File] | |
-> Bool | |
-> Text | |
-> GetFilesResponseBody200 |
Create a new GetFilesResponseBody200
with all required fields.