class Plaid::Paystub

Overview

An object representing data extracted from the end user's paystub.

Included Modules

Defined in:

plaid/models/paystub.cr

Constructors

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, deductions : Deductions | Nil = nil, doc_id : String | Nil = nil, earnings : Earnings | Nil = nil, employee : Employee | Nil = nil, employer : PaystubEmployer | Nil = nil, net_pay : NetPay | Nil = nil, pay_period_details : PayPeriodDetails | Nil = nil, employment_details : EmploymentDetails | Nil = nil, paystub_details : PaystubDetails | Nil = nil, income_breakdown : Array(IncomeBreakdown) | Nil = nil, ytd_earnings : PaystubYTDDetails | Nil = nil) #

Initializes the object @param [Hash] attributes Model attributes in the form of hash


[View source]

Instance Method Detail

def ==(other : self) #

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code


def deductions : Deductions | Nil #

[View source]
def deductions=(new_value : Deductions | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] deductions Object to be assigned


[View source]
def doc_id : String | Nil #

[View source]
def doc_id=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] doc_id Object to be assigned


[View source]
def earnings : Earnings | Nil #

[View source]
def earnings=(new_value : Earnings | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] earnings Object to be assigned


[View source]
def employee : Employee | Nil #

[View source]
def employee=(new_value : Employee | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] employee Object to be assigned


[View source]
def employer : PaystubEmployer | Nil #

[View source]
def employer=(new_value : PaystubEmployer | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] employer Object to be assigned


[View source]
def employment_details : EmploymentDetails | Nil #

[View source]
def employment_details=(new_value : EmploymentDetails | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] employment_details Object to be assigned


[View source]
def hash(hasher) #

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code


def income_breakdown : Array(IncomeBreakdown) | Nil #

[View source]
def income_breakdown=(new_value : Array(IncomeBreakdown) | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] income_breakdown Object to be assigned


[View source]
def list_invalid_properties : Array(String) #

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons


[View source]
def net_pay : NetPay | Nil #

[View source]
def net_pay=(new_value : NetPay | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] net_pay Object to be assigned


[View source]
def pay_period_details : PayPeriodDetails | Nil #

[View source]
def pay_period_details=(new_value : PayPeriodDetails | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] pay_period_details Object to be assigned


[View source]
def paystub_details : PaystubDetails | Nil #

[View source]
def paystub_details=(new_value : PaystubDetails | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] paystub_details Object to be assigned


[View source]
def valid? : Bool #

Check to see if the all the properties in the model are valid @return true if the model is valid


[View source]
def ytd_earnings : PaystubYTDDetails | Nil #

[View source]
def ytd_earnings=(new_value : PaystubYTDDetails | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] ytd_earnings Object to be assigned


[View source]