Class: XeroRuby::Accounting::Report
- Inherits:
-
Object
- Object
- XeroRuby::Accounting::Report
- Defined in:
- lib/xero-ruby/models/accounting/report.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#contacts ⇒ Object
Returns the value of attribute contacts.
-
#report_date ⇒ Object
Date of report.
-
#report_id ⇒ Object
See Prepayment Types.
-
#report_name ⇒ Object
See Prepayment Types.
-
#report_title ⇒ Object
See Prepayment Types.
-
#report_type ⇒ Object
See Prepayment Types.
-
#updated_date_utc ⇒ Object
Updated Date.
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) ⇒ 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 = {}) ⇒ Report
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#parse_date(datestring) ⇒ Object
customized data_parser.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ 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 = {}) ⇒ Report
Initializes the object
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 120 121 122 123 124 125 126 127 128 129 130 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 88 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::Report` 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::Report`. 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?(:'report_id') self.report_id = attributes[:'report_id'] end if attributes.key?(:'report_name') self.report_name = attributes[:'report_name'] end if attributes.key?(:'report_type') self.report_type = attributes[:'report_type'] end if attributes.key?(:'report_title') self.report_title = attributes[:'report_title'] end if attributes.key?(:'report_date') self.report_date = attributes[:'report_date'] end if attributes.key?(:'updated_date_utc') self.updated_date_utc = attributes[:'updated_date_utc'] end if attributes.key?(:'contacts') if (value = attributes[:'contacts']).is_a?(Array) self.contacts = value end end end |
Instance Attribute Details
#contacts ⇒ Object
Returns the value of attribute contacts.
36 37 38 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 36 def contacts @contacts end |
#report_date ⇒ Object
Date of report
31 32 33 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 31 def report_date @report_date end |
#report_id ⇒ Object
See Prepayment Types
19 20 21 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 19 def report_id @report_id end |
#report_name ⇒ Object
See Prepayment Types
22 23 24 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 22 def report_name @report_name end |
#report_title ⇒ Object
See Prepayment Types
28 29 30 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 28 def report_title @report_title end |
#report_type ⇒ Object
See Prepayment Types
25 26 27 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 25 def report_type @report_type end |
#updated_date_utc ⇒ Object
Updated Date
34 35 36 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 34 def updated_date_utc @updated_date_utc end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
61 62 63 64 65 66 67 68 69 70 71 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 61 def self.attribute_map { :'report_id' => :'ReportID', :'report_name' => :'ReportName', :'report_type' => :'ReportType', :'report_title' => :'ReportTitle', :'report_date' => :'ReportDate', :'updated_date_utc' => :'UpdatedDateUTC', :'contacts' => :'Contacts' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
186 187 188 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 186 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 74 def self.openapi_types { :'report_id' => :'String', :'report_name' => :'String', :'report_type' => :'String', :'report_title' => :'String', :'report_date' => :'String', :'updated_date_utc' => :'DateTime', :'contacts' => :'Array<TenNinteyNineContact>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
159 160 161 162 163 164 165 166 167 168 169 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 159 def ==(o) return true if self.equal?(o) self.class == o.class && report_id == o.report_id && report_name == o.report_name && report_type == o.report_type && report_title == o.report_title && report_date == o.report_date && updated_date_utc == o.updated_date_utc && contacts == o.contacts end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 245 246 247 248 249 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 214 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 :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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
279 280 281 282 283 284 285 286 287 288 289 290 291 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 279 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 193 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
173 174 175 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 173 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
179 180 181 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 179 def hash [report_id, report_name, report_type, report_title, report_date, updated_date_utc, contacts].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
134 135 136 137 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 134 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#parse_date(datestring) ⇒ Object
customized data_parser
294 295 296 297 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 294 def parse_date(datestring) seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0 return Time.at(seconds_since_epoch).to_s end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
259 260 261 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 259 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
265 266 267 268 269 270 271 272 273 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 265 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 |
#to_s ⇒ String
Returns the string representation of the object
253 254 255 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 253 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
141 142 143 144 145 |
# File 'lib/xero-ruby/models/accounting/report.rb', line 141 def valid? report_type_validator = EnumAttributeValidator.new('String', ["AgedPayablesByContact"]) return false unless report_type_validator.valid?(@report_type) true end |