Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetFiles

Contains the different functions to run the operation getFiles

6 types
4 values

Packagestripeapi-3.0.0.0
Exports10
LanguageHaskell2010
LicenceMIT
SourceGetFiles.hs

valuegetFiles

:: 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>

datadata GetFilesParameters

Defines the object schema located at paths./v1/files.GET.parameters in the specification.

Constructors

GetFilesParameters
- getFilesParametersQueryCreated :: Maybe GetFilesParametersQueryCreated'Variants
  queryCreated: Represents the parameter named 'created'
- getFilesParametersQueryEndingBefore :: Maybe Text
  queryEnding_before: Represents the parameter named 'ending_before'
  A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
  Constraints:
  - Maximum length of 5000
- getFilesParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getFilesParametersQueryLimit :: Maybe Int
  queryLimit: Represents the parameter named 'limit'
  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- getFilesParametersQueryPurpose :: Maybe GetFilesParametersQueryPurpose'
  queryPurpose: Represents the parameter named 'purpose'
  The file purpose to filter queries by. If none is provided, files will not be filtered by purpose.
  Constraints:
  - Maximum length of 5000
- getFilesParametersQueryStartingAfter :: Maybe Text
  queryStarting_after: Represents the parameter named 'starting_after'
  A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetFilesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles
Show GetFilesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles
FromJSON GetFilesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles
ToJSON GetFilesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles

valuemkGetFilesParameters :: GetFilesParameters

Create a new GetFilesParameters with all required fields.

datadata GetFilesParametersQueryCreated'OneOf1

Defines the object schema located at paths./v1/files.GET.parameters.properties.queryCreated.anyOf in the specification.

Constructors

GetFilesParametersQueryCreated'OneOf1
- getFilesParametersQueryCreated'OneOf1Gt :: Maybe Int
  gt
- getFilesParametersQueryCreated'OneOf1Gte :: Maybe Int
  gte
- getFilesParametersQueryCreated'OneOf1Lt :: Maybe Int
  lt
- getFilesParametersQueryCreated'OneOf1Lte :: Maybe Int
  lte

Instances4Eq, Show, FromJSON, ToJSON

Eq GetFilesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles
Show GetFilesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles
FromJSON GetFilesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles
ToJSON GetFilesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles

valuemkGetFilesParametersQueryCreated'OneOf1 :: GetFilesParametersQueryCreated'OneOf1

Create a new GetFilesParametersQueryCreated'OneOf1 with all required fields.

datadata GetFilesParametersQueryCreated'Variants

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetFilesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles
Show GetFilesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles
FromJSON GetFilesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles
ToJSON GetFilesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles

datadata GetFilesParametersQueryPurpose'

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 "account_requirement"
GetFilesParametersQueryPurpose'EnumAdditionalVerification
Represents the JSON value "additional_verification"
GetFilesParametersQueryPurpose'EnumBusinessIcon
Represents the JSON value "business_icon"
GetFilesParametersQueryPurpose'EnumBusinessLogo
Represents the JSON value "business_logo"
GetFilesParametersQueryPurpose'EnumCustomerSignature
Represents the JSON value "customer_signature"
GetFilesParametersQueryPurpose'EnumDisputeEvidence
Represents the JSON value "dispute_evidence"
GetFilesParametersQueryPurpose'EnumDocumentProviderIdentityDocument
Represents the JSON value "document_provider_identity_document"
GetFilesParametersQueryPurpose'EnumFinanceReportRun
Represents the JSON value "finance_report_run"
GetFilesParametersQueryPurpose'EnumIdentityDocument
Represents the JSON value "identity_document"
GetFilesParametersQueryPurpose'EnumIdentityDocumentDownloadable
Represents the JSON value "identity_document_downloadable"
GetFilesParametersQueryPurpose'EnumPciDocument
Represents the JSON value "pci_document"
GetFilesParametersQueryPurpose'EnumSelfie
Represents the JSON value "selfie"
GetFilesParametersQueryPurpose'EnumSigmaScheduledQuery
Represents the JSON value "sigma_scheduled_query"
GetFilesParametersQueryPurpose'EnumTaxDocumentUserUpload
Represents the JSON value "tax_document_user_upload"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetFilesParametersQueryPurpose'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles
Show GetFilesParametersQueryPurpose'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles
FromJSON GetFilesParametersQueryPurpose'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles
ToJSON GetFilesParametersQueryPurpose'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles

datadata GetFilesResponse

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.

Instances2Eq, Show

Eq GetFilesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles
Show GetFilesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles

datadata GetFilesResponseBody200

Defines the object schema located at paths./v1/files.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetFilesResponseBody200
- getFilesResponseBody200Data :: [File]
  data
- getFilesResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getFilesResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/files'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetFilesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles
Show GetFilesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles
FromJSON GetFilesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles
ToJSON GetFilesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFiles

valuemkGetFilesResponseBody200

:: [File]
getFilesResponseBody200Data
-> Bool
getFilesResponseBody200HasMore
-> Text
getFilesResponseBody200Url
-> GetFilesResponseBody200

Create a new GetFilesResponseBody200 with all required fields.