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
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 categorye.g.
-
#tracking_option_id ⇒ Object
The Xero identifier for a tracking optione.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) ⇒ 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
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 = {}) ⇒ TrackingOption
Initializes the object
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 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 74 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 = 50)
22 23 24 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 22 def name @name end |
#status ⇒ Object
The status of a tracking option
25 26 27 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 25 def status @status end |
#tracking_category_id ⇒ Object
Filter by a tracking categorye.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9
28 29 30 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 28 def tracking_category_id @tracking_category_id end |
#tracking_option_id ⇒ Object
The Xero identifier for a tracking optione.g. ae777a87-5ef3-4fa0-a4f0-d10e1f13073a
19 20 21 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 19 def tracking_option_id @tracking_option_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
53 54 55 56 57 58 59 60 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 53 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
170 171 172 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 170 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
63 64 65 66 67 68 69 70 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 63 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.
146 147 148 149 150 151 152 153 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 146 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
198 199 200 201 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 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 198 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
263 264 265 266 267 268 269 270 271 272 273 274 275 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 263 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
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 177 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
157 158 159 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 157 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
163 164 165 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 163 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?
106 107 108 109 110 111 112 113 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 106 def list_invalid_properties invalid_properties = Array.new if !@name.nil? && @name.to_s.length > 50 invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 50.') end invalid_properties end |
#parse_date(datestring) ⇒ Object
customized data_parser
278 279 280 281 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 278 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)
243 244 245 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 243 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
249 250 251 252 253 254 255 256 257 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 249 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
237 238 239 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 237 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
117 118 119 120 121 122 |
# File 'lib/xero-ruby/models/accounting/tracking_option.rb', line 117 def valid? return false if !@name.nil? && @name.to_s.length > 50 status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "ARCHIVED", "DELETED"]) return false unless status_validator.valid?(@status) true end |