Class: ModernTreasury::Models::Address

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/modern_treasury/models/address.rb

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(id: , country: , created_at: , line1: , line2: , live_mode: , locality: , object: , postal_code: , region: , updated_at: ) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::Address for more details.

Parameters:

  • id (String) (defaults to: )
  • country (String, nil) (defaults to: )

    Country code conforms to [ISO 3166-1 alpha-2]

  • created_at (Time) (defaults to: )
  • line1 (String, nil) (defaults to: )
  • line2 (String, nil) (defaults to: )
  • live_mode (Boolean) (defaults to: )

    This field will be true if this object exists in the live environment or false i

  • locality (String, nil) (defaults to: )

    Locality or City.

  • object (String) (defaults to: )
  • postal_code (String, nil) (defaults to: )

    The postal code of the address.

  • region (String, nil) (defaults to: )

    Region or State.

  • updated_at (Time) (defaults to: )


# File 'lib/modern_treasury/models/address.rb', line 67


Instance Attribute Details

#countryString?

Country code conforms to [ISO 3166-1 alpha-2]

Returns:

  • (String, nil)


15
# File 'lib/modern_treasury/models/address.rb', line 15

required :country, String, nil?: true

#created_atTime

Returns:

  • (Time)


20
# File 'lib/modern_treasury/models/address.rb', line 20

required :created_at, Time

#idString

Returns:

  • (String)


9
# File 'lib/modern_treasury/models/address.rb', line 9

required :id, String

#line1String?

Returns:

  • (String, nil)


25
# File 'lib/modern_treasury/models/address.rb', line 25

required :line1, String, nil?: true

#line2String?

Returns:

  • (String, nil)


30
# File 'lib/modern_treasury/models/address.rb', line 30

required :line2, String, nil?: true

#live_modeBoolean

This field will be true if this object exists in the live environment or false if it exists in the test environment.

Returns:

  • (Boolean)


37
# File 'lib/modern_treasury/models/address.rb', line 37

required :live_mode, ModernTreasury::Internal::Type::Boolean

#localityString?

Locality or City.

Returns:

  • (String, nil)


43
# File 'lib/modern_treasury/models/address.rb', line 43

required :locality, String, nil?: true

#objectString

Returns:

  • (String)


48
# File 'lib/modern_treasury/models/address.rb', line 48

required :object, String

#postal_codeString?

The postal code of the address.

Returns:

  • (String, nil)


54
# File 'lib/modern_treasury/models/address.rb', line 54

required :postal_code, String, nil?: true

#regionString?

Region or State.

Returns:

  • (String, nil)


60
# File 'lib/modern_treasury/models/address.rb', line 60

required :region, String, nil?: true

#updated_atTime

Returns:

  • (Time)


65
# File 'lib/modern_treasury/models/address.rb', line 65

required :updated_at, Time