Class: Plaid::PayStubPayPeriodDetails

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

Overview

Details about the pay period.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PayStubPayPeriodDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
168
169
170
171
172
173
174
175
176
 
# File 'lib/plaid/models/pay_stub_pay_period_details.rb', line 122

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#distribution_breakdown ⇒ Object

Returns the value of attribute distribution_breakdown.



22
23
24
 
# File 'lib/plaid/models/pay_stub_pay_period_details.rb', line 22

def distribution_breakdown
  @distribution_breakdown
end

#end_date ⇒ Object

The date on which the pay period ended, in [ISO 8601](wikipedia.org/wiki/ISO_8601) format ("yyyy-mm-dd").



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

def end_date
  @end_date
end

#gross_earnings ⇒ Object

Total earnings before tax/deductions.



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

def gross_earnings
  @gross_earnings
end

#iso_currency_code ⇒ Object

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



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

def iso_currency_code
  @iso_currency_code
end

#pay_amount ⇒ Object

The amount of the paycheck.



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

def pay_amount
  @pay_amount
end

#pay_basis ⇒ Object

Returns the value of attribute pay_basis.



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

def pay_basis
  @pay_basis
end

#pay_date ⇒ Object

The date on which the pay stub was issued, in [ISO 8601](wikipedia.org/wiki/ISO_8601) format ("yyyy-mm-dd").



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

def pay_date
  @pay_date
end

#pay_frequency ⇒ Object

The frequency at which an individual is paid.



37
38
39
 
# File 'lib/plaid/models/pay_stub_pay_period_details.rb', line 37

def pay_frequency
  @pay_frequency
end

#start_date ⇒ Object

The date on which the pay period started, in [ISO 8601](wikipedia.org/wiki/ISO_8601) format ("yyyy-mm-dd").



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

def start_date
  @start_date
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.



45
46
47
 
# File 'lib/plaid/models/pay_stub_pay_period_details.rb', line 45

def unofficial_currency_code
  @unofficial_currency_code
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



86
87
88
 
# File 'lib/plaid/models/pay_stub_pay_period_details.rb', line 86

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'pay_amount' => :'pay_amount',
    :'distribution_breakdown' => :'distribution_breakdown',
    :'end_date' => :'end_date',
    :'gross_earnings' => :'gross_earnings',
    :'iso_currency_code' => :'iso_currency_code',
    :'pay_date' => :'pay_date',
    :'pay_frequency' => :'pay_frequency',
    :'pay_basis' => :'pay_basis',
    :'start_date' => :'start_date',
    :'unofficial_currency_code' => :'unofficial_currency_code'
  }
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



228
229
230
 
# File 'lib/plaid/models/pay_stub_pay_period_details.rb', line 228

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/plaid/models/pay_stub_pay_period_details.rb', line 107

def self.openapi_nullable
  Set.new([
    :'pay_amount',
    :'end_date',
    :'gross_earnings',
    :'iso_currency_code',
    :'pay_date',
    :'pay_frequency',
    :'start_date',
    :'unofficial_currency_code'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'pay_amount' => :'Float',
    :'distribution_breakdown' => :'Array<PayStubDistributionBreakdown>',
    :'end_date' => :'Date',
    :'gross_earnings' => :'Float',
    :'iso_currency_code' => :'String',
    :'pay_date' => :'Date',
    :'pay_frequency' => :'String',
    :'pay_basis' => :'CreditPayStubPayBasisType',
    :'start_date' => :'Date',
    :'unofficial_currency_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/plaid/models/pay_stub_pay_period_details.rb', line 198

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pay_amount == o.pay_amount &&
      distribution_breakdown == o.distribution_breakdown &&
      end_date == o.end_date &&
      gross_earnings == o.gross_earnings &&
      iso_currency_code == o.iso_currency_code &&
      pay_date == o.pay_date &&
      pay_frequency == o.pay_frequency &&
      pay_basis == o.pay_basis &&
      start_date == o.start_date &&
      unofficial_currency_code == o.unofficial_currency_code
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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/plaid/models/pay_stub_pay_period_details.rb', line 259

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



330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/plaid/models/pay_stub_pay_period_details.rb', line 330

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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/plaid/models/pay_stub_pay_period_details.rb', line 235

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


215
216
217
 
# File 'lib/plaid/models/pay_stub_pay_period_details.rb', line 215

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



221
222
223
 
# File 'lib/plaid/models/pay_stub_pay_period_details.rb', line 221

def hash
  [pay_amount, distribution_breakdown, end_date, gross_earnings, iso_currency_code, pay_date, pay_frequency, pay_basis, start_date, unofficial_currency_code].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



180
181
182
183
184
185
186
187
 
# File 'lib/plaid/models/pay_stub_pay_period_details.rb', line 180

def list_invalid_properties
  invalid_properties = Array.new
  if @distribution_breakdown.nil?
    invalid_properties.push('invalid value for "distribution_breakdown", distribution_breakdown cannot be nil.')
  end

  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



306
307
308
 
# File 'lib/plaid/models/pay_stub_pay_period_details.rb', line 306

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



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/plaid/models/pay_stub_pay_period_details.rb', line 312

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



300
301
302
 
# File 'lib/plaid/models/pay_stub_pay_period_details.rb', line 300

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



191
192
193
194
 
# File 'lib/plaid/models/pay_stub_pay_period_details.rb', line 191

def valid?
  return false if @distribution_breakdown.nil?
  true
end