Class: Plaid::PayPeriodDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/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 = {}) ⇒ PayPeriodDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



111
112
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
 
# File 'lib/plaid/models/pay_period_details.rb', line 111

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

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

Instance Attribute Details

#check_amount ⇒ Object

The amount of the paycheck.



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

def check_amount
  @check_amount
end

#distribution_breakdown ⇒ Object

Returns the value of attribute distribution_breakdown.



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

def distribution_breakdown
  @distribution_breakdown
end

#end_date ⇒ Object

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



25
26
27
 
# File 'lib/plaid/models/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_period_details.rb', line 28

def gross_earnings
  @gross_earnings
end

#pay_date ⇒ Object

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



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

def pay_date
  @pay_date
end

#pay_day ⇒ Object

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



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

def pay_day
  @pay_day
end

#pay_frequency ⇒ Object

Returns the value of attribute pay_frequency.



33
34
35
 
# File 'lib/plaid/models/pay_period_details.rb', line 33

def pay_frequency
  @pay_frequency
end

#start_date ⇒ Object

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



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

def start_date
  @start_date
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



78
79
80
 
# File 'lib/plaid/models/pay_period_details.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/plaid/models/pay_period_details.rb', line 64

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



202
203
204
 
# File 'lib/plaid/models/pay_period_details.rb', line 202

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/plaid/models/pay_period_details.rb', line 97

def self.openapi_nullable
  Set.new([
    :'check_amount',
    :'end_date',
    :'gross_earnings',
    :'pay_date',
    :'pay_frequency',
    :'pay_day',
    :'start_date'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/plaid/models/pay_period_details.rb', line 83

def self.openapi_types
  {
    :'check_amount' => :'Float',
    :'distribution_breakdown' => :'Array<DistributionBreakdown>',
    :'end_date' => :'Date',
    :'gross_earnings' => :'Float',
    :'pay_date' => :'Date',
    :'pay_frequency' => :'PayPeriodDetailsPayFrequency',
    :'pay_day' => :'Date',
    :'start_date' => :'Date'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/plaid/models/pay_period_details.rb', line 174

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



233
234
235
236
237
238
239
240
241
242
243
244
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
 
# File 'lib/plaid/models/pay_period_details.rb', line 233

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



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/plaid/models/pay_period_details.rb', line 304

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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/plaid/models/pay_period_details.rb', line 209

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


189
190
191
 
# File 'lib/plaid/models/pay_period_details.rb', line 189

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



195
196
197
 
# File 'lib/plaid/models/pay_period_details.rb', line 195

def hash
  [check_amount, distribution_breakdown, end_date, gross_earnings, pay_date, pay_frequency, pay_day, start_date].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



161
162
163
164
 
# File 'lib/plaid/models/pay_period_details.rb', line 161

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



280
281
282
 
# File 'lib/plaid/models/pay_period_details.rb', line 280

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



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/plaid/models/pay_period_details.rb', line 286

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



274
275
276
 
# File 'lib/plaid/models/pay_period_details.rb', line 274

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



168
169
170
 
# File 'lib/plaid/models/pay_period_details.rb', line 168

def valid?
  true
end