class XeroRuby::Accounting::ManualJournal
Constants
- ARCHIVED
- DELETED
- DRAFT
- POSTED
- VOIDED
Attributes
Displays array of attachments from the API
Date journal was posted – YYYY-MM-DD
Boolean to indicate if a manual journal has an attachment
See JournalLines
The Xero identifier for a Manual Journal
Description of journal being posted
Boolean – default is true if not specified
See Manual Journal
Status Codes
A string to indicate if a invoice status
Last modified date UTC format
Url link to a source document – shown as “Go to [appName]” in the Xero app
Displays array of validation error messages from the API
Displays array of warning messages from the API
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/xero-ruby/models/accounting/manual_journal.rb, line 89 def self.attribute_map { :'narration' => :'Narration', :'journal_lines' => :'JournalLines', :'date' => :'Date', :'line_amount_types' => :'LineAmountTypes', :'status' => :'Status', :'url' => :'Url', :'show_on_cash_basis_reports' => :'ShowOnCashBasisReports', :'has_attachments' => :'HasAttachments', :'updated_date_utc' => :'UpdatedDateUTC', :'manual_journal_id' => :'ManualJournalID', :'status_attribute_string' => :'StatusAttributeString', :'warnings' => :'Warnings', :'validation_errors' => :'ValidationErrors', :'attachments' => :'Attachments' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/xero-ruby/models/accounting/manual_journal.rb, line 276 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/xero-ruby/models/accounting/manual_journal.rb, line 130 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::ManualJournal` 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 `XeroRuby::Accounting::ManualJournal`. 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?(:'narration') self.narration = attributes[:'narration'] end if attributes.key?(:'journal_lines') if (value = attributes[:'journal_lines']).is_a?(Array) self.journal_lines = value end end if attributes.key?(:'date') self.date = attributes[:'date'] end if attributes.key?(:'line_amount_types') self.line_amount_types = attributes[:'line_amount_types'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'url') self.url = attributes[:'url'] end if attributes.key?(:'show_on_cash_basis_reports') self.show_on_cash_basis_reports = attributes[:'show_on_cash_basis_reports'] end if attributes.key?(:'has_attachments') self.has_attachments = attributes[:'has_attachments'] else self.has_attachments = false end if attributes.key?(:'updated_date_utc') self.updated_date_utc = attributes[:'updated_date_utc'] end if attributes.key?(:'manual_journal_id') self.manual_journal_id = attributes[:'manual_journal_id'] end if attributes.key?(:'status_attribute_string') self.status_attribute_string = attributes[:'status_attribute_string'] end if attributes.key?(:'warnings') if (value = attributes[:'warnings']).is_a?(Array) self.warnings = value end end if attributes.key?(:'validation_errors') if (value = attributes[:'validation_errors']).is_a?(Array) self.validation_errors = value end end if attributes.key?(:'attachments') if (value = attributes[:'attachments']).is_a?(Array) self.attachments = value end end end
Attribute type mapping.
# File lib/xero-ruby/models/accounting/manual_journal.rb, line 109 def self.openapi_types { :'narration' => :'String', :'journal_lines' => :'Array<ManualJournalLine>', :'date' => :'Date', :'line_amount_types' => :'LineAmountTypes', :'status' => :'String', :'url' => :'String', :'show_on_cash_basis_reports' => :'Boolean', :'has_attachments' => :'Boolean', :'updated_date_utc' => :'DateTime', :'manual_journal_id' => :'String', :'status_attribute_string' => :'String', :'warnings' => :'Array<ValidationError>', :'validation_errors' => :'Array<ValidationError>', :'attachments' => :'Array<Attachment>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/xero-ruby/models/accounting/manual_journal.rb, line 242 def ==(o) return true if self.equal?(o) self.class == o.class && narration == o.narration && journal_lines == o.journal_lines && date == o.date && line_amount_types == o.line_amount_types && status == o.status && url == o.url && show_on_cash_basis_reports == o.show_on_cash_basis_reports && has_attachments == o.has_attachments && updated_date_utc == o.updated_date_utc && manual_journal_id == o.manual_journal_id && status_attribute_string == o.status_attribute_string && warnings == o.warnings && validation_errors == o.validation_errors && attachments == o.attachments 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/xero-ruby/models/accounting/manual_journal.rb, line 304 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(parse_date(value)) when :Date Date.parse(parse_date(value)) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BigDecimal BigDecimal(value.to_s) 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 XeroRuby::Accounting.const_get(type).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/xero-ruby/models/accounting/manual_journal.rb, line 377 def _to_hash(value, downcase: false) if value.is_a?(Array) value.map do |v| v.to_hash(downcase: downcase) end elsif value.is_a?(Hash) {}.tap do |hash| value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) } end elsif value.respond_to? :to_hash value.to_hash(downcase: downcase) 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/xero-ruby/models/accounting/manual_journal.rb, line 283 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_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/xero-ruby/models/accounting/manual_journal.rb, line 263 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/xero-ruby/models/accounting/manual_journal.rb, line 269 def hash [narration, journal_lines, date, line_amount_types, status, url, show_on_cash_basis_reports, has_attachments, updated_date_utc, manual_journal_id, status_attribute_string, warnings, validation_errors, attachments].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/xero-ruby/models/accounting/manual_journal.rb, line 212 def list_invalid_properties invalid_properties = Array.new if @narration.nil? invalid_properties.push('invalid value for "narration", narration cannot be nil.') end invalid_properties end
# File lib/xero-ruby/models/accounting/manual_journal.rb, line 393 def parse_date(datestring) if datestring.include?('Date') date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\// original, date, timezone = *date_pattern.match(datestring) date = (date.to_i / 1000) Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s else # handle date 'types' for small subset of payroll API's Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s end end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/xero-ruby/models/accounting/manual_journal.rb, line 232 def status=(status) validator = EnumAttributeValidator.new('String', ["DRAFT", "POSTED", "DELETED", "VOIDED", "ARCHIVED"]) unless validator.valid?(status) fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}." end @status = status end
Returns the object in the form of hash with snake_case
# File lib/xero-ruby/models/accounting/manual_journal.rb, line 369 def to_attributes to_hash(downcase: true) end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/xero-ruby/models/accounting/manual_journal.rb, line 357 def to_hash(downcase: false) hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? key = downcase ? attr : param hash[key] = _to_hash(value, downcase: downcase) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/xero-ruby/models/accounting/manual_journal.rb, line 345 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/xero-ruby/models/accounting/manual_journal.rb, line 223 def valid? return false if @narration.nil? status_validator = EnumAttributeValidator.new('String', ["DRAFT", "POSTED", "DELETED", "VOIDED", "ARCHIVED"]) return false unless status_validator.valid?(@status) true end