Class: Plaid::CreditBankIncomeSource

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/credit_bank_income_source.rb

Overview

Detailed information for the income source.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreditBankIncomeSource

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 113

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::CreditBankIncomeSource` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::CreditBankIncomeSource`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'income_source_id')
    self.income_source_id = attributes[:'income_source_id']
  end

  if attributes.key?(:'income_description')
    self.income_description = attributes[:'income_description']
  end

  if attributes.key?(:'income_category')
    self.income_category = attributes[:'income_category']
  end

  if attributes.key?(:'account_id')
    self. = attributes[:'account_id']
  end

  if attributes.key?(:'start_date')
    self.start_date = attributes[:'start_date']
  end

  if attributes.key?(:'end_date')
    self.end_date = attributes[:'end_date']
  end

  if attributes.key?(:'pay_frequency')
    self.pay_frequency = attributes[:'pay_frequency']
  end

  if attributes.key?(:'total_amount')
    self.total_amount = attributes[:'total_amount']
  end

  if attributes.key?(:'transaction_count')
    self.transaction_count = attributes[:'transaction_count']
  end

  if attributes.key?(:'historical_summary')
    if (value = attributes[:'historical_summary']).is_a?(Array)
      self.historical_summary = value
    end
  end
end

Instance Attribute Details

#account_id ⇒ Object

Plaid’s unique identifier for the account.



28
29
30
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 28

def 
  @account_id
end

#end_date ⇒ Object

Maximum of all dates within the specific income sources in the user’s bank account for days requested by the client. The date will be returned in an ISO 8601 format (YYYY-MM-DD).



34
35
36
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 34

def end_date
  @end_date
end

#historical_summary ⇒ Object

Returns the value of attribute historical_summary.



44
45
46
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 44

def historical_summary
  @historical_summary
end

#income_category ⇒ Object

Returns the value of attribute income_category.



25
26
27
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 25

def income_category
  @income_category
end

#income_description ⇒ Object

The most common name or original description for the underlying income transactions.



23
24
25
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 23

def income_description
  @income_description
end

#income_source_id ⇒ Object

A unique identifier for an income source.



20
21
22
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 20

def income_source_id
  @income_source_id
end

#pay_frequency ⇒ Object

Returns the value of attribute pay_frequency.



36
37
38
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 36

def pay_frequency
  @pay_frequency
end

#start_date ⇒ Object

Minimum of all dates within the specific income sources in the user’s bank account for days requested by the client. The date will be returned in an ISO 8601 format (YYYY-MM-DD).



31
32
33
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 31

def start_date
  @start_date
end

#total_amount ⇒ Object

Total amount of earnings in the user’s bank account for the specific income source for days requested by the client.



39
40
41
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 39

def total_amount
  @total_amount
end

#transaction_count ⇒ Object

Number of transactions for the income source within the start and end date.



42
43
44
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 42

def transaction_count
  @transaction_count
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



85
86
87
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 85

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 69

def self.attribute_map
  {
    :'income_source_id' => :'income_source_id',
    :'income_description' => :'income_description',
    :'income_category' => :'income_category',
    :'account_id' => :'account_id',
    :'start_date' => :'start_date',
    :'end_date' => :'end_date',
    :'pay_frequency' => :'pay_frequency',
    :'total_amount' => :'total_amount',
    :'transaction_count' => :'transaction_count',
    :'historical_summary' => :'historical_summary'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



214
215
216
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 214

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



106
107
108
109
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 106

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 90

def self.openapi_types
  {
    :'income_source_id' => :'String',
    :'income_description' => :'String',
    :'income_category' => :'CreditBankIncomeCategory',
    :'account_id' => :'String',
    :'start_date' => :'Date',
    :'end_date' => :'Date',
    :'pay_frequency' => :'CreditBankIncomePayFrequency',
    :'total_amount' => :'Float',
    :'transaction_count' => :'Integer',
    :'historical_summary' => :'Array<CreditBankIncomeHistoricalSummary>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 184

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      income_source_id == o.income_source_id &&
      income_description == o.income_description &&
      income_category == o.income_category &&
       == o. &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      pay_frequency == o.pay_frequency &&
      total_amount == o.total_amount &&
      transaction_count == o.transaction_count &&
      historical_summary == o.historical_summary
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 245

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 316

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 221

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


201
202
203
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 201

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



207
208
209
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 207

def hash
  [income_source_id, income_description, income_category, , start_date, end_date, pay_frequency, total_amount, transaction_count, historical_summary].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



171
172
173
174
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 171

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



292
293
294
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 292

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 298

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



286
287
288
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 286

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



178
179
180
 
# File 'lib/plaid/models/credit_bank_income_source.rb', line 178

def valid?
  true
end