class Plaid::PayPeriodDetails
- Plaid::PayPeriodDetails
- Reference
- Object
Overview
Details about the pay period.
Included Modules
- JSON::Serializable
- JSON::Serializable::Unmapped
- OpenApi::Json
- OpenApi::Validatable
Defined in:
plaid/models/pay_period_details.crConstant Summary
-
ERROR_MESSAGE_FOR_PAY_FREQUENCY =
"invalid value for \"pay_frequency\", must be one of [PAY_FREQUENCY_UNKNOWN, PAY_FREQUENCY_WEEKLY, PAY_FREQUENCY_BIWEEKLY, PAY_FREQUENCY_SEMIMONTHLY, PAY_FREQUENCY_MONTHLY, null]." -
VALID_VALUES_FOR_PAY_FREQUENCY =
String.static_array("PAY_FREQUENCY_UNKNOWN", "PAY_FREQUENCY_WEEKLY", "PAY_FREQUENCY_BIWEEKLY", "PAY_FREQUENCY_SEMIMONTHLY", "PAY_FREQUENCY_MONTHLY", "null")
Constructors
- .new(pull : JSON::PullParser)
-
.new(*, check_amount : Float64 | Nil = nil, distribution_breakdown : Array(DistributionBreakdown) | Nil = nil, end_date : Time | Nil = nil, gross_earnings : Float64 | Nil = nil, pay_date : Time | Nil = nil, pay_frequency : String | Nil = nil, pay_day : Time | Nil = nil, start_date : Time | Nil = nil)
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance Method Summary
-
#==(other : self)
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.
- #check_amount : Float64 | Nil
-
#check_amount=(new_value : Float64 | Nil)
Custom attribute writer method checking allowed values (enum).
- #check_amount_present=(check_amount_present : Bool)
- #check_amount_present? : Bool
- #distribution_breakdown : Array(DistributionBreakdown) | Nil
-
#distribution_breakdown=(new_value : Array(DistributionBreakdown) | Nil)
Custom attribute writer method checking allowed values (enum).
- #end_date : Time | Nil
-
#end_date=(new_value : Time | Nil)
Custom attribute writer method checking allowed values (enum).
- #end_date_present=(end_date_present : Bool)
- #end_date_present? : Bool
- #gross_earnings : Float64 | Nil
-
#gross_earnings=(new_value : Float64 | Nil)
Custom attribute writer method checking allowed values (enum).
- #gross_earnings_present=(gross_earnings_present : Bool)
- #gross_earnings_present? : Bool
-
#hash(hasher)
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.
-
#list_invalid_properties : Array(String)
Show invalid properties with the reasons.
- #pay_date : Time | Nil
-
#pay_date=(new_value : Time | Nil)
Custom attribute writer method checking allowed values (enum).
- #pay_date_present=(pay_date_present : Bool)
- #pay_date_present? : Bool
- #pay_day : Time | Nil
-
#pay_day=(new_value : Time | Nil)
Custom attribute writer method checking allowed values (enum).
- #pay_day_present=(pay_day_present : Bool)
- #pay_day_present? : Bool
- #pay_frequency : String | Nil
-
#pay_frequency=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
- #pay_frequency_present=(pay_frequency_present : Bool)
- #pay_frequency_present? : Bool
- #start_date : Time | Nil
-
#start_date=(new_value : Time | Nil)
Custom attribute writer method checking allowed values (enum).
- #start_date_present=(start_date_present : Bool)
- #start_date_present? : Bool
-
#valid? : Bool
Check to see if the all the properties in the model are valid @return true if the model is valid
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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance Method Detail
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] check_amount Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] distribution_breakdown Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] end_date Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] gross_earnings Object to be assigned
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Custom attribute writer method checking allowed values (enum). @param [Object] pay_date Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] pay_day Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] pay_frequency Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] start_date Object to be assigned
Check to see if the all the properties in the model are valid @return true if the model is valid