class YNAB::ScheduledTransactionDetail
Attributes
The scheduled transaction amount in milliunits format
The first date for which the Scheduled Transaction was scheduled.
The next date for which the Scheduled Transaction is scheduled.
Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests.
The scheduled transaction flag
If a split scheduled transaction, the subtransactions.
If a transfer, the account_id
which the scheduled transaction transfers to
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/ynab/models/scheduled_transaction_detail.rb, line 79 def self.attribute_map { :'id' => :'id', :'date_first' => :'date_first', :'date_next' => :'date_next', :'frequency' => :'frequency', :'amount' => :'amount', :'memo' => :'memo', :'flag_color' => :'flag_color', :'account_id' => :'account_id', :'payee_id' => :'payee_id', :'category_id' => :'category_id', :'transfer_account_id' => :'transfer_account_id', :'deleted' => :'deleted', :'account_name' => :'account_name', :'payee_name' => :'payee_name', :'category_name' => :'category_name', :'subtransactions' => :'subtransactions' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/ynab/models/scheduled_transaction_detail.rb, line 124 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'date_first') self.date_first = attributes[:'date_first'] end if attributes.has_key?(:'date_next') self.date_next = attributes[:'date_next'] end if attributes.has_key?(:'frequency') self.frequency = attributes[:'frequency'] end if attributes.has_key?(:'amount') self.amount = attributes[:'amount'] end if attributes.has_key?(:'memo') self.memo = attributes[:'memo'] end if attributes.has_key?(:'flag_color') self.flag_color = attributes[:'flag_color'] end if attributes.has_key?(:'account_id') self.account_id = attributes[:'account_id'] end if attributes.has_key?(:'payee_id') self.payee_id = attributes[:'payee_id'] end if attributes.has_key?(:'category_id') self.category_id = attributes[:'category_id'] end if attributes.has_key?(:'transfer_account_id') self.transfer_account_id = attributes[:'transfer_account_id'] end if attributes.has_key?(:'deleted') self.deleted = attributes[:'deleted'] end if attributes.has_key?(:'account_name') self.account_name = attributes[:'account_name'] end if attributes.has_key?(:'payee_name') self.payee_name = attributes[:'payee_name'] end if attributes.has_key?(:'category_name') self.category_name = attributes[:'category_name'] end if attributes.has_key?(:'subtransactions') if (value = attributes[:'subtransactions']).is_a?(Array) self.subtransactions = value end end end
Attribute type mapping.
# File lib/ynab/models/scheduled_transaction_detail.rb, line 101 def self.swagger_types { :'id' => :'String', :'date_first' => :'Date', :'date_next' => :'Date', :'frequency' => :'String', :'amount' => :'Integer', :'memo' => :'String', :'flag_color' => :'String', :'account_id' => :'String', :'payee_id' => :'String', :'category_id' => :'String', :'transfer_account_id' => :'String', :'deleted' => :'BOOLEAN', :'account_name' => :'String', :'payee_name' => :'String', :'category_name' => :'String', :'subtransactions' => :'Array<ScheduledSubTransaction>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/ynab/models/scheduled_transaction_detail.rb, line 273 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && date_first == o.date_first && date_next == o.date_next && frequency == o.frequency && amount == o.amount && memo == o.memo && flag_color == o.flag_color && account_id == o.account_id && payee_id == o.payee_id && category_id == o.category_id && transfer_account_id == o.transfer_account_id && deleted == o.deleted && account_name == o.account_name && payee_name == o.payee_name && category_name == o.category_name && subtransactions == o.subtransactions end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/ynab/models/scheduled_transaction_detail.rb, line 329 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.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 temp_model = YNAB.const_get(type).new temp_model.build_from_hash(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
# File lib/ynab/models/scheduled_transaction_detail.rb, line 395 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/ynab/models/scheduled_transaction_detail.rb, line 308 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if 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 # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] Object to be compared
# File lib/ynab/models/scheduled_transaction_detail.rb, line 296 def eql?(o) self == o end
Custom attribute writer method checking allowed values (enum). @param [Object] flag_color
Object to be assigned
# File lib/ynab/models/scheduled_transaction_detail.rb, line 267 def flag_color=(flag_color) @flag_color = flag_color end
Custom attribute writer method checking allowed values (enum). @param [Object] frequency Object to be assigned
# File lib/ynab/models/scheduled_transaction_detail.rb, line 261 def frequency=(frequency) @frequency = frequency end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/ynab/models/scheduled_transaction_detail.rb, line 302 def hash [id, date_first, date_next, frequency, amount, memo, flag_color, account_id, payee_id, category_id, transfer_account_id, deleted, account_name, payee_name, category_name, subtransactions].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/ynab/models/scheduled_transaction_detail.rb, line 199 def list_invalid_properties invalid_properties = Array.new if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @date_first.nil? invalid_properties.push('invalid value for "date_first", date_first cannot be nil.') end if @date_next.nil? invalid_properties.push('invalid value for "date_next", date_next cannot be nil.') end if @frequency.nil? invalid_properties.push('invalid value for "frequency", frequency cannot be nil.') end if @amount.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') end if @account_id.nil? invalid_properties.push('invalid value for "account_id", account_id cannot be nil.') end if @deleted.nil? invalid_properties.push('invalid value for "deleted", deleted cannot be nil.') end if @account_name.nil? invalid_properties.push('invalid value for "account_name", account_name cannot be nil.') end if @subtransactions.nil? invalid_properties.push('invalid value for "subtransactions", subtransactions cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/ynab/models/scheduled_transaction_detail.rb, line 381 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/ynab/models/scheduled_transaction_detail.rb, line 369 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/ynab/models/scheduled_transaction_detail.rb, line 242 def valid? return false if @id.nil? return false if @date_first.nil? return false if @date_next.nil? return false if @frequency.nil? frequency_validator = EnumAttributeValidator.new('String', ['never', 'daily', 'weekly', 'everyOtherWeek', 'twiceAMonth', 'every4Weeks', 'monthly', 'everyOtherMonth', 'every3Months', 'every4Months', 'twiceAYear', 'yearly', 'everyOtherYear']) return false unless frequency_validator.valid?(@frequency) return false if @amount.nil? flag_color_validator = EnumAttributeValidator.new('String', ['red', 'orange', 'yellow', 'green', 'blue', 'purple']) return false unless flag_color_validator.valid?(@flag_color) return false if @account_id.nil? return false if @deleted.nil? return false if @account_name.nil? return false if @subtransactions.nil? true end