telegram-bot-api-6.5: Easy to use library for building Telegram bots. Exports Telegram Bot API.
Safe HaskellSafe-Inferred
LanguageHaskell2010

Telegram.Bot.API.Types.EncryptedPassportElement

Synopsis

EncryptedPassportElement

data EncryptedPassportElement Source #

Contains information about documents or other Telegram Passport elements shared with the bot by the user.

Constructors

EncryptedPassportElement 

Fields

  • encryptedPassportElementType :: PassportElementType

    One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “email”.

  • encryptedPassportElementData :: Maybe Text

    Base64-encoded encrypted Telegram Passport element data provided by the user, available for “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport” and “address” types. Can be decrypted and verified using the accompanying EncryptedCredentials.

  • encryptedPassportElementPhoneNumber :: Maybe Text

    User's verified phone number, available only for “phone_number” type.

  • encryptedPassportElementEmail :: Maybe Text

    User's verified email address, available only for “email” type.

  • encryptedPassportElementFiles :: Maybe [PassportFile]

    Array of encrypted files with documents provided by the user, available for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.

  • encryptedPassportElementFrontSide :: Maybe PassportFile

    Encrypted file with the front side of the document, provided by the user. Available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.

  • encryptedPassportElementReverseSide :: Maybe PassportFile

    Encrypted file with the reverse side of the document, provided by the user. Available for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying EncryptedCredentials.

  • encryptedPassportElementSelfie :: Maybe PassportFile

    Encrypted file with the selfie of the user holding a document, provided by the user; available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.

  • encryptedPassportElementTranslation :: Maybe [PassportFile]

    Array of encrypted files with translated versions of documents provided by the user. Available if requested for “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.

  • encryptedPassportElementHash :: Text

    Base64-encoded element hash for using in PassportElementErrorUnspecified.

Instances

Instances details
FromJSON EncryptedPassportElement Source # 
Instance details

Defined in Telegram.Bot.API.Types.EncryptedPassportElement

ToJSON EncryptedPassportElement Source # 
Instance details

Defined in Telegram.Bot.API.Types.EncryptedPassportElement

Generic EncryptedPassportElement Source # 
Instance details

Defined in Telegram.Bot.API.Types.EncryptedPassportElement

Associated Types

type Rep EncryptedPassportElement :: Type -> Type #

Show EncryptedPassportElement Source # 
Instance details

Defined in Telegram.Bot.API.Types.EncryptedPassportElement

type Rep EncryptedPassportElement Source # 
Instance details

Defined in Telegram.Bot.API.Types.EncryptedPassportElement

type Rep EncryptedPassportElement = D1 ('MetaData "EncryptedPassportElement" "Telegram.Bot.API.Types.EncryptedPassportElement" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "EncryptedPassportElement" 'PrefixI 'True) (((S1 ('MetaSel ('Just "encryptedPassportElementType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PassportElementType) :*: S1 ('MetaSel ('Just "encryptedPassportElementData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "encryptedPassportElementPhoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "encryptedPassportElementEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "encryptedPassportElementFiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [PassportFile]))))) :*: ((S1 ('MetaSel ('Just "encryptedPassportElementFrontSide") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe PassportFile)) :*: S1 ('MetaSel ('Just "encryptedPassportElementReverseSide") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe PassportFile))) :*: (S1 ('MetaSel ('Just "encryptedPassportElementSelfie") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe PassportFile)) :*: (S1 ('MetaSel ('Just "encryptedPassportElementTranslation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [PassportFile])) :*: S1 ('MetaSel ('Just "encryptedPassportElementHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))))

data PassportElementType Source #

One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “email”.

Instances

Instances details
FromJSON PassportElementType Source # 
Instance details

Defined in Telegram.Bot.API.Types.EncryptedPassportElement

ToJSON PassportElementType Source # 
Instance details

Defined in Telegram.Bot.API.Types.EncryptedPassportElement

Generic PassportElementType Source # 
Instance details

Defined in Telegram.Bot.API.Types.EncryptedPassportElement

Associated Types

type Rep PassportElementType :: Type -> Type #

Show PassportElementType Source # 
Instance details

Defined in Telegram.Bot.API.Types.EncryptedPassportElement

type Rep PassportElementType Source # 
Instance details

Defined in Telegram.Bot.API.Types.EncryptedPassportElement

type Rep PassportElementType = D1 ('MetaData "PassportElementType" "Telegram.Bot.API.Types.EncryptedPassportElement" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (((C1 ('MetaCons "PassportElementTypePersonalDetails" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PassportElementTypePassport" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PassportElementTypeDriverLicense" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "PassportElementTypeIdentityCard" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PassportElementTypeInternalPassport" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PassportElementTypeAddress" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "PassportElementTypeUtilityBill" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PassportElementTypeBankStatement" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PassportElementTypeRentalAgreement" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "PassportElementTypePassportRegistration" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PassportElementTypeTemporaryRegistration" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PassportElementTypePhoneNumber" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PassportElementTypeEmail" 'PrefixI 'False) (U1 :: Type -> Type)))))