StripeAPI.Operations.GetFiles

Contains the different functions to run the operation getFiles

Documentation

getFiles

Arguments

:: forall m. MonadHTTP m

=> GetFilesParameters

Contains all available parameters of this operation (query and path parameters)

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

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

Constructors

GetFilesParameters

Fields

• 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

Instances

Eq GetFilesParameters

Defined in StripeAPI.Operations.GetFiles

Methods

(==) :: GetFilesParameters -> GetFilesParameters -> Bool

(/=) :: GetFilesParameters -> GetFilesParameters -> Bool

Show GetFilesParameters

Defined in StripeAPI.Operations.GetFiles

Methods

showsPrec :: Int -> GetFilesParameters -> ShowS

show :: GetFilesParameters -> String

showList :: [GetFilesParameters] -> ShowS

ToJSON GetFilesParameters

Defined in StripeAPI.Operations.GetFiles

Methods

toJSON :: GetFilesParameters -> Value

toEncoding :: GetFilesParameters -> Encoding

toJSONList :: [GetFilesParameters] -> Value

toEncodingList :: [GetFilesParameters] -> Encoding

FromJSON GetFilesParameters

Defined in StripeAPI.Operations.GetFiles

Methods

parseJSON :: Value -> Parser GetFilesParameters

parseJSONList :: Value -> Parser [GetFilesParameters]

mkGetFilesParameters :: GetFilesParameters

Create a new GetFilesParameters with all required fields.

data GetFilesParametersQueryCreated'OneOf1

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

Constructors

GetFilesParametersQueryCreated'OneOf1

Fields

• getFilesParametersQueryCreated'OneOf1Gt :: Maybe Int

  gt

• getFilesParametersQueryCreated'OneOf1Gte :: Maybe Int

  gte

• getFilesParametersQueryCreated'OneOf1Lt :: Maybe Int

  lt

• getFilesParametersQueryCreated'OneOf1Lte :: Maybe Int

  lte

Instances

Eq GetFilesParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetFiles

Methods

(==) :: GetFilesParametersQueryCreated'OneOf1 -> GetFilesParametersQueryCreated'OneOf1 -> Bool

(/=) :: GetFilesParametersQueryCreated'OneOf1 -> GetFilesParametersQueryCreated'OneOf1 -> Bool

Show GetFilesParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetFiles

Methods

showsPrec :: Int -> GetFilesParametersQueryCreated'OneOf1 -> ShowS

show :: GetFilesParametersQueryCreated'OneOf1 -> String

showList :: [GetFilesParametersQueryCreated'OneOf1] -> ShowS

ToJSON GetFilesParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetFiles

Methods

toJSON :: GetFilesParametersQueryCreated'OneOf1 -> Value

toEncoding :: GetFilesParametersQueryCreated'OneOf1 -> Encoding

toJSONList :: [GetFilesParametersQueryCreated'OneOf1] -> Value

toEncodingList :: [GetFilesParametersQueryCreated'OneOf1] -> Encoding

FromJSON GetFilesParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetFiles

Methods

parseJSON :: Value -> Parser GetFilesParametersQueryCreated'OneOf1

parseJSONList :: Value -> Parser [GetFilesParametersQueryCreated'OneOf1]

mkGetFilesParametersQueryCreated'OneOf1 :: GetFilesParametersQueryCreated'OneOf1

Create a new GetFilesParametersQueryCreated'OneOf1 with all required fields.

data 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

Instances

Eq GetFilesParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetFiles

Methods

(==) :: GetFilesParametersQueryCreated'Variants -> GetFilesParametersQueryCreated'Variants -> Bool

(/=) :: GetFilesParametersQueryCreated'Variants -> GetFilesParametersQueryCreated'Variants -> Bool

Show GetFilesParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetFiles

Methods

showsPrec :: Int -> GetFilesParametersQueryCreated'Variants -> ShowS

show :: GetFilesParametersQueryCreated'Variants -> String

showList :: [GetFilesParametersQueryCreated'Variants] -> ShowS

ToJSON GetFilesParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetFiles

Methods

toJSON :: GetFilesParametersQueryCreated'Variants -> Value

toEncoding :: GetFilesParametersQueryCreated'Variants -> Encoding

toJSONList :: [GetFilesParametersQueryCreated'Variants] -> Value

toEncodingList :: [GetFilesParametersQueryCreated'Variants] -> Encoding

FromJSON GetFilesParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetFiles

Methods

parseJSON :: Value -> Parser GetFilesParametersQueryCreated'Variants

parseJSONList :: Value -> Parser [GetFilesParametersQueryCreated'Variants]

data 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"

Instances

Eq GetFilesParametersQueryPurpose'

Defined in StripeAPI.Operations.GetFiles

Methods

(==) :: GetFilesParametersQueryPurpose' -> GetFilesParametersQueryPurpose' -> Bool

(/=) :: GetFilesParametersQueryPurpose' -> GetFilesParametersQueryPurpose' -> Bool

Show GetFilesParametersQueryPurpose'

Defined in StripeAPI.Operations.GetFiles

Methods

showsPrec :: Int -> GetFilesParametersQueryPurpose' -> ShowS

show :: GetFilesParametersQueryPurpose' -> String

showList :: [GetFilesParametersQueryPurpose'] -> ShowS

ToJSON GetFilesParametersQueryPurpose'

Defined in StripeAPI.Operations.GetFiles

Methods

toJSON :: GetFilesParametersQueryPurpose' -> Value

toEncoding :: GetFilesParametersQueryPurpose' -> Encoding

toJSONList :: [GetFilesParametersQueryPurpose'] -> Value

toEncodingList :: [GetFilesParametersQueryPurpose'] -> Encoding

FromJSON GetFilesParametersQueryPurpose'

Defined in StripeAPI.Operations.GetFiles

Methods

parseJSON :: Value -> Parser GetFilesParametersQueryPurpose'

parseJSONList :: Value -> Parser [GetFilesParametersQueryPurpose']

data 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.

Instances

Eq GetFilesResponse

Defined in StripeAPI.Operations.GetFiles

Methods

(==) :: GetFilesResponse -> GetFilesResponse -> Bool

(/=) :: GetFilesResponse -> GetFilesResponse -> Bool

Show GetFilesResponse

Defined in StripeAPI.Operations.GetFiles

Methods

showsPrec :: Int -> GetFilesResponse -> ShowS

show :: GetFilesResponse -> String

showList :: [GetFilesResponse] -> ShowS

data GetFilesResponseBody200

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

Constructors

GetFilesResponseBody200

Fields

• 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'

Instances

Eq GetFilesResponseBody200

Defined in StripeAPI.Operations.GetFiles

Methods

(==) :: GetFilesResponseBody200 -> GetFilesResponseBody200 -> Bool

(/=) :: GetFilesResponseBody200 -> GetFilesResponseBody200 -> Bool

Show GetFilesResponseBody200

Defined in StripeAPI.Operations.GetFiles

Methods

showsPrec :: Int -> GetFilesResponseBody200 -> ShowS

show :: GetFilesResponseBody200 -> String

showList :: [GetFilesResponseBody200] -> ShowS

ToJSON GetFilesResponseBody200

Defined in StripeAPI.Operations.GetFiles

Methods

toJSON :: GetFilesResponseBody200 -> Value

toEncoding :: GetFilesResponseBody200 -> Encoding

toJSONList :: [GetFilesResponseBody200] -> Value

toEncodingList :: [GetFilesResponseBody200] -> Encoding

FromJSON GetFilesResponseBody200

Defined in StripeAPI.Operations.GetFiles

Methods

parseJSON :: Value -> Parser GetFilesResponseBody200

parseJSONList :: Value -> Parser [GetFilesResponseBody200]

mkGetFilesResponseBody200

Arguments

:: [File]

getFilesResponseBody200Data

-> Bool

getFilesResponseBody200HasMore

-> Text

getFilesResponseBody200Url

-> GetFilesResponseBody200

Create a new GetFilesResponseBody200 with all required fields.