class Plaid::PayStubPayPeriodDetails
Details about the pay period.
Attributes
The date on which the pay period ended, in [ISO 8601](wikipedia.org/wiki/ISO_8601) format ("yyyy-mm-dd").
Total
earnings before tax/deductions.
The ISO-4217 currency code of the net pay. Always ‘null` if `unofficial_currency_code` is non-null.
The amount of the paycheck.
The date on which the pay stub was issued, in [ISO 8601](wikipedia.org/wiki/ISO_8601) format ("yyyy-mm-dd").
The frequency at which an individual is paid.
The date on which the pay period started, in [ISO 8601](wikipedia.org/wiki/ISO_8601) format ("yyyy-mm-dd").
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.
Public Class Methods
Source
# File lib/plaid/models/pay_stub_pay_period_details.rb, line 86 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# 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
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/pay_stub_pay_period_details.rb, line 228 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# 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
List of attributes with nullable: true
Source
# 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
Attribute type mapping.
Public Instance Methods
Source
# 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
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
Source
# 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/pay_stub_pay_period_details.rb, line 215 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# 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
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
Source
# 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/plaid/models/pay_stub_pay_period_details.rb, line 300 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/plaid/models/pay_stub_pay_period_details.rb, line 191 def valid? return false if @distribution_breakdown.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid