Class: XeroRuby::Accounting::TrackingOption
- Inherits:
-
Object
- Object
- XeroRuby::Accounting::TrackingOption
- Defined in:
- lib/xero-ruby/models/accounting/tracking_option.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Constant Summary collapse
- ACTIVE =
"ACTIVE".freeze
- ARCHIVED =
"ARCHIVED".freeze
- DELETED =
"DELETED".freeze
Instance Attribute Summary collapse
-
#name ⇒ Object
The name of the tracking option e.g.
-
#status ⇒ Object
The status of a tracking option.
-
#tracking_category_id ⇒ Object
Filter by a tracking category e.g.
-
#tracking_option_id ⇒ Object
The Xero identifier for a tracking option e.g.
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 = {}) ⇒ TrackingOption
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 = {}) ⇒ TrackingOption
Initializes the object
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 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 78 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::TrackingOption` 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::TrackingOption`. 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?(:'tracking_option_id') self.tracking_option_id = attributes[:'tracking_option_id'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'tracking_category_id') self.tracking_category_id = attributes[:'tracking_category_id'] end end |
Instance Attribute Details
#name ⇒ Object
The name of the tracking option e.g. Marketing, East (max length = 100)
23 24 25 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 23 def name @name end |
#status ⇒ Object
The status of a tracking option
26 27 28 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 26 def status @status end |
#tracking_category_id ⇒ Object
Filter by a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9
32 33 34 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 32 def tracking_category_id @tracking_category_id end |
#tracking_option_id ⇒ Object
The Xero identifier for a tracking option e.g. ae777a87-5ef3-4fa0-a4f0-d10e1f13073a
20 21 22 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 20 def tracking_option_id @tracking_option_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
57 58 59 60 61 62 63 64 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 57 def self.attribute_map { :'tracking_option_id' => :'TrackingOptionID', :'name' => :'Name', :'status' => :'Status', :'tracking_category_id' => :'TrackingCategoryID' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
174 175 176 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 174 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
67 68 69 70 71 72 73 74 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 67 def self.openapi_types { :'tracking_option_id' => :'String', :'name' => :'String', :'status' => :'String', :'tracking_category_id' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
150 151 152 153 154 155 156 157 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 150 def ==(o) return true if self.equal?(o) self.class == o.class && tracking_option_id == o.tracking_option_id && name == o.name && status == o.status && tracking_category_id == o.tracking_category_id end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
202 203 204 205 206 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 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 202 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
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 275 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
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 181 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
161 162 163 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 161 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
167 168 169 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 167 def hash [tracking_option_id, name, status, tracking_category_id].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
110 111 112 113 114 115 116 117 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 110 def list_invalid_properties invalid_properties = Array.new if !@name.nil? && @name.to_s.length > 100 invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.') end invalid_properties end |
#parse_date(datestring) ⇒ Object
291 292 293 294 295 296 297 298 299 300 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 291 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
267 268 269 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 267 def to_attributes to_hash(downcase: true) end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
249 250 251 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 249 def to_body to_hash end |
#to_hash(downcase: false) ⇒ Hash
Returns the object in the form of hash
255 256 257 258 259 260 261 262 263 264 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 255 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
243 244 245 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 243 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
121 122 123 124 125 126 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 121 def valid? return false if !@name.nil? && @name.to_s.length > 100 status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "ARCHIVED", "DELETED"]) return false unless status_validator.valid?(@status) true end |