Safe Haskell	None
Language	Haskell2010

StripeAPI.Types.GelatoDocumentReport

Description

Contains the types generated from the schema GelatoDocumentReport

Synopsis

data GelatoDocumentReport = GelatoDocumentReport {
}
mkGelatoDocumentReport :: GelatoDocumentReportStatus' -> GelatoDocumentReport
data GelatoDocumentReportAddress' = GelatoDocumentReportAddress' {
}
mkGelatoDocumentReportAddress' :: GelatoDocumentReportAddress'
data GelatoDocumentReportDob' = GelatoDocumentReportDob' {
}
mkGelatoDocumentReportDob' :: GelatoDocumentReportDob'
data GelatoDocumentReportError' = GelatoDocumentReportError' {
- gelatoDocumentReportError'Code :: Maybe GelatoDocumentReportError'Code'
- gelatoDocumentReportError'Reason :: Maybe Text
}
mkGelatoDocumentReportError' :: GelatoDocumentReportError'
data GelatoDocumentReportError'Code'
data GelatoDocumentReportExpirationDate' = GelatoDocumentReportExpirationDate' {
}
mkGelatoDocumentReportExpirationDate' :: GelatoDocumentReportExpirationDate'
data GelatoDocumentReportIssuedDate' = GelatoDocumentReportIssuedDate' {
}
mkGelatoDocumentReportIssuedDate' :: GelatoDocumentReportIssuedDate'
data GelatoDocumentReportStatus'
data GelatoDocumentReportType'

Documentation

data GelatoDocumentReport Source #

Defines the object schema located at components.schemas.gelato_document_report in the specification.

Result from a document check

Constructors

GelatoDocumentReport

Fields

gelatoDocumentReportAddress :: Maybe GelatoDocumentReportAddress'
address: Address as it appears in the document.
gelatoDocumentReportDob :: Maybe GelatoDocumentReportDob'
dob: Date of birth as it appears in the document.
gelatoDocumentReportError :: Maybe GelatoDocumentReportError'
error: Details on the verification error. Present when status is `unverified`.
gelatoDocumentReportExpirationDate :: Maybe GelatoDocumentReportExpirationDate'
expiration_date: Expiration date of the document.
gelatoDocumentReportFiles :: Maybe [Text]
files: Array of File ids containing images for this document.
gelatoDocumentReportFirstName :: Maybe Text
first_name: First name as it appears in the document.
Constraints:
- Maximum length of 5000
gelatoDocumentReportIssuedDate :: Maybe GelatoDocumentReportIssuedDate'
issued_date: Issued date of the document.
gelatoDocumentReportIssuingCountry :: Maybe Text
issuing_country: Issuing country of the document.
Constraints:
- Maximum length of 5000
gelatoDocumentReportLastName :: Maybe Text
last_name: Last name as it appears in the document.
Constraints:
- Maximum length of 5000
gelatoDocumentReportNumber :: Maybe Text
number: Document ID number.
Constraints:
- Maximum length of 5000
gelatoDocumentReportStatus :: GelatoDocumentReportStatus'
status: Status of this `document` check.
gelatoDocumentReportType :: Maybe GelatoDocumentReportType'
type: Type of the document.

Instances

Instances details

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

mkGelatoDocumentReport Source #

Arguments

:: GelatoDocumentReportStatus'	`gelatoDocumentReportStatus`
-> GelatoDocumentReport

Create a new GelatoDocumentReport with all required fields.

data GelatoDocumentReportAddress' Source #

Defines the object schema located at components.schemas.gelato_document_report.properties.address.anyOf in the specification.

Address as it appears in the document.

Constructors

GelatoDocumentReportAddress'

Fields

gelatoDocumentReportAddress'City :: Maybe Text
city: City, district, suburb, town, or village.
Constraints:
- Maximum length of 5000
gelatoDocumentReportAddress'Country :: Maybe Text
country: Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
Constraints:
- Maximum length of 5000
gelatoDocumentReportAddress'Line1 :: Maybe Text
line1: Address line 1 (e.g., street, PO Box, or company name).
Constraints:
- Maximum length of 5000
gelatoDocumentReportAddress'Line2 :: Maybe Text
line2: Address line 2 (e.g., apartment, suite, unit, or building).
Constraints:
- Maximum length of 5000
gelatoDocumentReportAddress'PostalCode :: Maybe Text
postal_code: ZIP or postal code.
Constraints:
- Maximum length of 5000
gelatoDocumentReportAddress'State :: Maybe Text
state: State, county, province, or region.
Constraints:
- Maximum length of 5000

Instances

Instances details

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

mkGelatoDocumentReportAddress' :: GelatoDocumentReportAddress' Source #

Create a new GelatoDocumentReportAddress' with all required fields.

data GelatoDocumentReportDob' Source #

Defines the object schema located at components.schemas.gelato_document_report.properties.dob.anyOf in the specification.

Date of birth as it appears in the document.

Constructors

GelatoDocumentReportDob'
Fields gelatoDocumentReportDob'Day :: Maybe Int day: Numerical day between 1 and 31. gelatoDocumentReportDob'Month :: Maybe Int month: Numerical month between 1 and 12. gelatoDocumentReportDob'Year :: Maybe Int year: The four-digit year.

Instances

Instances details

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

mkGelatoDocumentReportDob' :: GelatoDocumentReportDob' Source #

Create a new GelatoDocumentReportDob' with all required fields.

data GelatoDocumentReportError' Source #

Defines the object schema located at components.schemas.gelato_document_report.properties.error.anyOf in the specification.

Details on the verification error. Present when status is \`unverified\`.

Constructors

GelatoDocumentReportError'
Fields gelatoDocumentReportError'Code :: Maybe GelatoDocumentReportError'Code' code: A short machine-readable string giving the reason for the verification failure. gelatoDocumentReportError'Reason :: Maybe Text reason: A human-readable message giving the reason for the failure. These messages can be shown to your users. Constraints: Maximum length of 5000

Instances

Instances details

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

mkGelatoDocumentReportError' :: GelatoDocumentReportError' Source #

Create a new GelatoDocumentReportError' with all required fields.

data GelatoDocumentReportError'Code' Source #

Defines the enum schema located at components.schemas.gelato_document_report.properties.error.anyOf.properties.code in the specification.

A short machine-readable string giving the reason for the verification failure.

Constructors

GelatoDocumentReportError'Code'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GelatoDocumentReportError'Code'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
GelatoDocumentReportError'Code'EnumDocumentExpired	Represents the JSON value `"document_expired"`
GelatoDocumentReportError'Code'EnumDocumentTypeNotSupported	Represents the JSON value `"document_type_not_supported"`
GelatoDocumentReportError'Code'EnumDocumentUnverifiedOther	Represents the JSON value `"document_unverified_other"`

Instances

Instances details

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

data GelatoDocumentReportExpirationDate' Source #

Defines the object schema located at components.schemas.gelato_document_report.properties.expiration_date.anyOf in the specification.

Expiration date of the document.

Constructors

GelatoDocumentReportExpirationDate'
Fields gelatoDocumentReportExpirationDate'Day :: Maybe Int day: Numerical day between 1 and 31. gelatoDocumentReportExpirationDate'Month :: Maybe Int month: Numerical month between 1 and 12. gelatoDocumentReportExpirationDate'Year :: Maybe Int year: The four-digit year.

Instances

Instances details

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

mkGelatoDocumentReportExpirationDate' :: GelatoDocumentReportExpirationDate' Source #

Create a new GelatoDocumentReportExpirationDate' with all required fields.

data GelatoDocumentReportIssuedDate' Source #

Defines the object schema located at components.schemas.gelato_document_report.properties.issued_date.anyOf in the specification.

Issued date of the document.

Constructors

GelatoDocumentReportIssuedDate'
Fields gelatoDocumentReportIssuedDate'Day :: Maybe Int day: Numerical day between 1 and 31. gelatoDocumentReportIssuedDate'Month :: Maybe Int month: Numerical month between 1 and 12. gelatoDocumentReportIssuedDate'Year :: Maybe Int year: The four-digit year.

Instances

Instances details

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

mkGelatoDocumentReportIssuedDate' :: GelatoDocumentReportIssuedDate' Source #

Create a new GelatoDocumentReportIssuedDate' with all required fields.

data GelatoDocumentReportStatus' Source #

Defines the enum schema located at components.schemas.gelato_document_report.properties.status in the specification.

Status of this `document` check.

Constructors

GelatoDocumentReportStatus'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GelatoDocumentReportStatus'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
GelatoDocumentReportStatus'EnumUnverified	Represents the JSON value `"unverified"`
GelatoDocumentReportStatus'EnumVerified	Represents the JSON value `"verified"`

Instances

Instances details

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

data GelatoDocumentReportType' Source #

Defines the enum schema located at components.schemas.gelato_document_report.properties.type in the specification.

Type of the document.

Constructors

GelatoDocumentReportType'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GelatoDocumentReportType'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
GelatoDocumentReportType'EnumDrivingLicense	Represents the JSON value `"driving_license"`
GelatoDocumentReportType'EnumIdCard	Represents the JSON value `"id_card"`
GelatoDocumentReportType'EnumPassport	Represents the JSON value `"passport"`

Instances

Instances details

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