Class: Privy::Models::KrakenEmbedResidence

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/privy/models/kraken_embed_residence.rb,
sig/privy/models/kraken_embed_residence.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

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(city:, country:, line1:, postal_code:, line2: nil, province: nil) ⇒ Object

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

Parameters:

  • city (String)
  • country (Symbol, Privy::Models::KrakenEmbedCountryCode) —

    ISO 3166-1 alpha-2 country codes supported by Kraken Embed.

  • line1 (String)
  • postal_code (String)
  • line2 (String, nil) (defaults to: nil)
  • province (String, nil) (defaults to: nil) 



# File 'lib/privy/models/kraken_embed_residence.rb', line 37

Instance Attribute Details

#city ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


9
 
# File 'lib/privy/models/kraken_embed_residence.rb', line 9

required :city, String

#country ⇒ Symbol, Privy::Models::KrakenEmbedCountryCode

ISO 3166-1 alpha-2 country codes supported by Kraken Embed.

Parameters:

  • value (Privy::Models::kraken_embed_country_code)

Returns:



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

required :country, enum: -> { Privy::KrakenEmbedCountryCode }

#line1 ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


20
 
# File 'lib/privy/models/kraken_embed_residence.rb', line 20

required :line1, String

#line2 ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


30
 
# File 'lib/privy/models/kraken_embed_residence.rb', line 30

optional :line2, String, nil?: true

#postal_code ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


25
 
# File 'lib/privy/models/kraken_embed_residence.rb', line 25

required :postal_code, String

#province ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


35
 
# File 'lib/privy/models/kraken_embed_residence.rb', line 35

optional :province, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


35
 
# File 'sig/privy/models/kraken_embed_residence.rbs', line 35

def to_hash: -> {