Class: Plaid::DistributionBreakdown

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

Overview

Information about the accounts that the payment was distributed to.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DistributionBreakdown

Initializes the object

Parameters:

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

    Model attributes in the form of hash



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 90

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::DistributionBreakdown` 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::DistributionBreakdown`. 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?(:'account_name')
    self. = attributes[:'account_name']
  end

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

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

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

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

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

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

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

Instance Attribute Details

#account_name ⇒ Object

Name of the account for the given distribution.



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

def 
  @account_name
end

#bank_name ⇒ Object

The name of the bank that the payment is being deposited to.



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

def bank_name
  @bank_name
end

#current_amount ⇒ Object

The amount distributed to this account.



26
27
28
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 26

def current_amount
  @current_amount
end

#current_pay ⇒ Object

Returns the value of attribute current_pay.



40
41
42
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 40

def current_pay
  @current_pay
end

#iso_currency_code ⇒ Object

The ISO-4217 currency code of the net pay. Always ‘null` if `unofficial_currency_code` is non-null.



29
30
31
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 29

def iso_currency_code
  @iso_currency_code
end

#mask ⇒ Object

The last 2-4 alphanumeric characters of an account’s official account number.



32
33
34
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 32

def mask
  @mask
end

#type ⇒ Object

Type of the account that the paystub was sent to (e.g. ‘checking’).



35
36
37
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 35

def type
  @type
end

#unofficial_currency_code ⇒ Object

The unofficial currency code associated with the net pay. Always ‘null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.



38
39
40
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 38

def unofficial_currency_code
  @unofficial_currency_code
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



57
58
59
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 57

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 43

def self.attribute_map
  {
    :'account_name' => :'account_name',
    :'bank_name' => :'bank_name',
    :'current_amount' => :'current_amount',
    :'iso_currency_code' => :'iso_currency_code',
    :'mask' => :'mask',
    :'type' => :'type',
    :'unofficial_currency_code' => :'unofficial_currency_code',
    :'current_pay' => :'current_pay'
  }
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



179
180
181
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 179

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 76

def self.openapi_nullable
  Set.new([
    :'account_name',
    :'bank_name',
    :'current_amount',
    :'iso_currency_code',
    :'mask',
    :'type',
    :'unofficial_currency_code',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 62

def self.openapi_types
  {
    :'account_name' => :'String',
    :'bank_name' => :'String',
    :'current_amount' => :'Float',
    :'iso_currency_code' => :'String',
    :'mask' => :'String',
    :'type' => :'String',
    :'unofficial_currency_code' => :'String',
    :'current_pay' => :'Pay'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 151

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      bank_name == o.bank_name &&
      current_amount == o.current_amount &&
      iso_currency_code == o.iso_currency_code &&
      mask == o.mask &&
      type == o.type &&
      unofficial_currency_code == o.unofficial_currency_code &&
      current_pay == o.current_pay
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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 210

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



281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 281

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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 186

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


166
167
168
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 166

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [, bank_name, current_amount, iso_currency_code, mask, type, unofficial_currency_code, current_pay].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



138
139
140
141
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 138

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



257
258
259
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 257

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



263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 263

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



251
252
253
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 251

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



145
146
147
 
# File 'lib/plaid/models/distribution_breakdown.rb', line 145

def valid?
  true
end