Class: Inttegro::FinancialAccount::Compact

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/financial_account/compact.rb

Overview

Typed representation of the compact object in the Inttegro API.

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Instance Attribute Summary collapse

Instance Attribute Details

#created_at ⇒ Time (readonly)

Value of the created_at field in the Inttegro API payload.

Required in the API payload. Wire name: created_at.

Returns:

  • (Time)


67
68
69
70
71
72
73
74
75
76
# File 'lib/inttegro/financial_account/compact.rb', line 67

class Compact < T::Struct
  const :created_at, Time
  const :currency, String
  const :description, T.nilable(String), default: nil
  const :disconnected_at, T.nilable(Time), default: nil
  const :fingerprint, String
  const :id, String
  const :label, T.nilable(String), default: nil
  const :type, Inttegro::FinancialAccount::Type
end

#currency ⇒ String (readonly)

Value of the currency field in the Inttegro API payload.

Required in the API payload. Wire name: currency.

Returns:

  • (String)


67
68
69
70
71
72
73
74
75
76
# File 'lib/inttegro/financial_account/compact.rb', line 67

class Compact < T::Struct
  const :created_at, Time
  const :currency, String
  const :description, T.nilable(String), default: nil
  const :disconnected_at, T.nilable(Time), default: nil
  const :fingerprint, String
  const :id, String
  const :label, T.nilable(String), default: nil
  const :type, Inttegro::FinancialAccount::Type
end

#description ⇒ String? (readonly)

Value of the description field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: description.

Returns:

  • (String, nil)


67
68
69
70
71
72
73
74
75
76
# File 'lib/inttegro/financial_account/compact.rb', line 67

class Compact < T::Struct
  const :created_at, Time
  const :currency, String
  const :description, T.nilable(String), default: nil
  const :disconnected_at, T.nilable(Time), default: nil
  const :fingerprint, String
  const :id, String
  const :label, T.nilable(String), default: nil
  const :type, Inttegro::FinancialAccount::Type
end

#disconnected_at ⇒ Time? (readonly)

Value of the disconnected_at field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: disconnected_at.

Returns:

  • (Time, nil)


67
68
69
70
71
72
73
74
75
76
# File 'lib/inttegro/financial_account/compact.rb', line 67

class Compact < T::Struct
  const :created_at, Time
  const :currency, String
  const :description, T.nilable(String), default: nil
  const :disconnected_at, T.nilable(Time), default: nil
  const :fingerprint, String
  const :id, String
  const :label, T.nilable(String), default: nil
  const :type, Inttegro::FinancialAccount::Type
end

#fingerprint ⇒ String (readonly)

A stable identifier for the underlying financial account within your application. Use it to recognize when the same account has been connected more than once.

Required in the API payload. Wire name: fingerprint.

Returns:

  • (String)


67
68
69
70
71
72
73
74
75
76
# File 'lib/inttegro/financial_account/compact.rb', line 67

class Compact < T::Struct
  const :created_at, Time
  const :currency, String
  const :description, T.nilable(String), default: nil
  const :disconnected_at, T.nilable(Time), default: nil
  const :fingerprint, String
  const :id, String
  const :label, T.nilable(String), default: nil
  const :type, Inttegro::FinancialAccount::Type
end

#id ⇒ String (readonly)

Value of the id field in the Inttegro API payload.

Required in the API payload. Wire name: id.

Returns:

  • (String)


67
68
69
70
71
72
73
74
75
76
# File 'lib/inttegro/financial_account/compact.rb', line 67

class Compact < T::Struct
  const :created_at, Time
  const :currency, String
  const :description, T.nilable(String), default: nil
  const :disconnected_at, T.nilable(Time), default: nil
  const :fingerprint, String
  const :id, String
  const :label, T.nilable(String), default: nil
  const :type, Inttegro::FinancialAccount::Type
end

#label ⇒ String? (readonly)

Value of the label field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: label.

Returns:

  • (String, nil)


67
68
69
70
71
72
73
74
75
76
# File 'lib/inttegro/financial_account/compact.rb', line 67

class Compact < T::Struct
  const :created_at, Time
  const :currency, String
  const :description, T.nilable(String), default: nil
  const :disconnected_at, T.nilable(Time), default: nil
  const :fingerprint, String
  const :id, String
  const :label, T.nilable(String), default: nil
  const :type, Inttegro::FinancialAccount::Type
end

#type ⇒ Inttegro::FinancialAccount::Type (readonly)

Value of the type field in the Inttegro API payload.

Required in the API payload. Wire name: type.



67
68
69
70
71
72
73
74
75
76
# File 'lib/inttegro/financial_account/compact.rb', line 67

class Compact < T::Struct
  const :created_at, Time
  const :currency, String
  const :description, T.nilable(String), default: nil
  const :disconnected_at, T.nilable(Time), default: nil
  const :fingerprint, String
  const :id, String
  const :label, T.nilable(String), default: nil
  const :type, Inttegro::FinancialAccount::Type
end