Class: Privy::Models::KrakenEmbedStartAddressMetadata

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Privy::Models::KrakenEmbedStartAddressMetadata

Defined in:

lib/privy/models/kraken_embed_start_address_metadata.rb,
sig/privy/models/kraken_embed_start_address_metadata.rbs

Instance Attribute Summary

• #address ⇒ Privy::Models::KrakenEmbedResidence^?

  User's residential address including street, city, postal code, and country.

• #document_number ⇒ String^?
• #document_type ⇒ Symbol, ...

  Document types accepted for proof of address verification.

• #expiration_date ⇒ Date^?

Instance Method Summary

• #initialize(address: nil, document_number: nil, document_type: nil, expiration_date: nil) ⇒ Object constructor

  Optional best-effort metadata hints for proof of address verification.

• #to_hash ⇒ {

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(address: nil, document_number: nil, document_type: nil, expiration_date: nil) ⇒ Object

Optional best-effort metadata hints for proof of address verification.

Parameters:

• address (Privy::Models::KrakenEmbedResidence, nil) (defaults to: nil) —

  User's residential address including street, city, postal code, and country.

• document_number (String, nil) (defaults to: nil)
• document_type (Symbol, Privy::Models::KrakenEmbedResidenceDocumentType, nil) (defaults to: nil) —

  Document types accepted for proof of address verification.

• expiration_date (Date, nil) (defaults to: nil)

# File 'lib/privy/models/kraken_embed_start_address_metadata.rb', line 28

Instance Attribute Details

#address ⇒ Privy::Models::KrakenEmbedResidence^?

User's residential address including street, city, postal code, and country.

Parameters:

• value (Privy::KrakenEmbedResidence, nil)

Returns:

• (Privy::Models::KrakenEmbedResidence, nil)

# File 'lib/privy/models/kraken_embed_start_address_metadata.rb', line 10

optional :address, -> { Privy::KrakenEmbedResidence }, nil?: true

#document_number ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/privy/models/kraken_embed_start_address_metadata.rb', line 15

optional :document_number, String, nil?: true

#document_type ⇒ Symbol, ...

Document types accepted for proof of address verification.

Parameters:

• value (Privy::Models::kraken_embed_residence_document_type, nil)

Returns:

• (Symbol, Privy::Models::KrakenEmbedResidenceDocumentType, nil)

# File 'lib/privy/models/kraken_embed_start_address_metadata.rb', line 21

optional :document_type, enum: -> { Privy::KrakenEmbedResidenceDocumentType }, nil?: true

#expiration_date ⇒ Date^?

Parameters:

• value (Date, nil)

Returns:

• (Date, nil)

# File 'lib/privy/models/kraken_embed_start_address_metadata.rb', line 26

optional :expiration_date, Date, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/privy/models/kraken_embed_start_address_metadata.rbs', line 27

def to_hash: -> {