Class: XeroRuby::Accounting::Allocation
- Inherits:
-
Object
- Object
- XeroRuby::Accounting::Allocation
- Defined in:
- lib/xero-ruby/models/accounting/allocation.rb
Instance Attribute Summary collapse
-
#amount ⇒ Object
the amount being applied to the invoice.
-
#credit_note ⇒ Object
Returns the value of attribute credit_note.
-
#date ⇒ Object
the date the allocation is applied YYYY-MM-DD.
-
#invoice ⇒ Object
Returns the value of attribute invoice.
-
#overpayment ⇒ Object
Returns the value of attribute overpayment.
-
#prepayment ⇒ Object
Returns the value of attribute prepayment.
-
#status_attribute_string ⇒ Object
A string to indicate if a invoice status.
-
#validation_errors ⇒ Object
Displays array of validation error messages from the API.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value, downcase: false) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Allocation
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
- #parse_date(datestring) ⇒ Object
-
#to_attributes ⇒ Object
Returns the object in the form of hash with snake_case.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash(downcase: false) ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Allocation
Initializes the object
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 73 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::Allocation` 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::Allocation`. 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?(:'invoice') self.invoice = attributes[:'invoice'] end if attributes.key?(:'overpayment') self.overpayment = attributes[:'overpayment'] end if attributes.key?(:'prepayment') self.prepayment = attributes[:'prepayment'] end if attributes.key?(:'credit_note') self.credit_note = attributes[:'credit_note'] end if attributes.key?(:'amount') self.amount = attributes[:'amount'] end if attributes.key?(:'date') self.date = attributes[:'date'] end if attributes.key?(:'status_attribute_string') self.status_attribute_string = attributes[:'status_attribute_string'] end if attributes.key?(:'validation_errors') if (value = attributes[:'validation_errors']).is_a?(Array) self.validation_errors = value end end end |
Instance Attribute Details
#amount ⇒ Object
the amount being applied to the invoice
32 33 34 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 32 def amount @amount end |
#credit_note ⇒ Object
Returns the value of attribute credit_note.
29 30 31 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 29 def credit_note @credit_note end |
#date ⇒ Object
the date the allocation is applied YYYY-MM-DD.
35 36 37 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 35 def date @date end |
#invoice ⇒ Object
Returns the value of attribute invoice.
20 21 22 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 20 def invoice @invoice end |
#overpayment ⇒ Object
Returns the value of attribute overpayment.
23 24 25 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 23 def overpayment @overpayment end |
#prepayment ⇒ Object
Returns the value of attribute prepayment.
26 27 28 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 26 def prepayment @prepayment end |
#status_attribute_string ⇒ Object
A string to indicate if a invoice status
38 39 40 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 38 def status_attribute_string @status_attribute_string end |
#validation_errors ⇒ Object
Displays array of validation error messages from the API
41 42 43 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 41 def validation_errors @validation_errors end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
44 45 46 47 48 49 50 51 52 53 54 55 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 44 def self.attribute_map { :'invoice' => :'Invoice', :'overpayment' => :'Overpayment', :'prepayment' => :'Prepayment', :'credit_note' => :'CreditNote', :'amount' => :'Amount', :'date' => :'Date', :'status_attribute_string' => :'StatusAttributeString', :'validation_errors' => :'ValidationErrors' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
179 180 181 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 179 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 58 def self.openapi_types { :'invoice' => :'Invoice', :'overpayment' => :'Overpayment', :'prepayment' => :'Prepayment', :'credit_note' => :'CreditNote', :'amount' => :'BigDecimal', :'date' => :'Date', :'status_attribute_string' => :'String', :'validation_errors' => :'Array<ValidationError>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 151 def ==(o) return true if self.equal?(o) self.class == o.class && invoice == o.invoice && overpayment == o.overpayment && prepayment == o.prepayment && credit_note == o.credit_note && amount == o.amount && date == o.date && status_attribute_string == o.status_attribute_string && validation_errors == o.validation_errors end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 207 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 |
#_to_hash(value, downcase: false) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 280 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 186 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 |
#eql?(o) ⇒ Boolean
166 167 168 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 166 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
172 173 174 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 172 def hash [invoice, overpayment, prepayment, credit_note, amount, date, status_attribute_string, validation_errors].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 123 def list_invalid_properties invalid_properties = Array.new if @invoice.nil? invalid_properties.push('invalid value for "invoice", invoice cannot be nil.') end if @amount.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') end if @date.nil? invalid_properties.push('invalid value for "date", date cannot be nil.') end invalid_properties end |
#parse_date(datestring) ⇒ Object
296 297 298 299 300 301 302 303 304 305 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 296 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 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 |
#to_attributes ⇒ Object
Returns the object in the form of hash with snake_case
272 273 274 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 272 def to_attributes to_hash(downcase: true) end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
254 255 256 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 254 def to_body to_hash end |
#to_hash(downcase: false) ⇒ Hash
Returns the object in the form of hash
260 261 262 263 264 265 266 267 268 269 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 260 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 |
#to_s ⇒ String
Returns the string representation of the object
248 249 250 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 248 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
142 143 144 145 146 147 |
# File 'lib/xero-ruby/models/accounting/allocation.rb', line 142 def valid? return false if @invoice.nil? return false if @amount.nil? return false if @date.nil? true end |