Class: XeroRuby::Accounting::Item
- Inherits:
-
Object
- Object
- XeroRuby::Accounting::Item
- Defined in:
- lib/xero-ruby/models/accounting/item.rb
Instance Attribute Summary collapse
-
#code ⇒ Object
User defined item code (max length = 30).
-
#description ⇒ Object
The sales description of the item (max length = 4000).
-
#inventory_asset_account_code ⇒ Object
The inventory asset account for the item.
-
#is_purchased ⇒ Object
Boolean value, defaults to true.
-
#is_sold ⇒ Object
Boolean value, defaults to true.
-
#is_tracked_as_inventory ⇒ Object
True for items that are tracked as inventory.
-
#item_id ⇒ Object
The Xero identifier for an Item.
-
#name ⇒ Object
The name of the item (max length = 50).
-
#purchase_description ⇒ Object
The purchase description of the item (max length = 4000).
-
#purchase_details ⇒ Object
Returns the value of attribute purchase_details.
-
#quantity_on_hand ⇒ Object
The quantity of the item on hand.
-
#sales_details ⇒ Object
Returns the value of attribute sales_details.
-
#status_attribute_string ⇒ Object
Status of object.
-
#total_cost_pool ⇒ Object
The value of the item on hand.
-
#updated_date_utc ⇒ Object
Last modified date in UTC format.
-
#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) ⇒ 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 = {}) ⇒ Item
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 = {}) ⇒ Item
Initializes the object
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 114 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::Item` 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::Item`. 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?(:'code') self.code = attributes[:'code'] end if attributes.key?(:'inventory_asset_account_code') self.inventory_asset_account_code = attributes[:'inventory_asset_account_code'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'is_sold') self.is_sold = attributes[:'is_sold'] end if attributes.key?(:'is_purchased') self.is_purchased = attributes[:'is_purchased'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'purchase_description') self.purchase_description = attributes[:'purchase_description'] end if attributes.key?(:'purchase_details') self.purchase_details = attributes[:'purchase_details'] end if attributes.key?(:'sales_details') self.sales_details = attributes[:'sales_details'] end if attributes.key?(:'is_tracked_as_inventory') self.is_tracked_as_inventory = attributes[:'is_tracked_as_inventory'] end if attributes.key?(:'total_cost_pool') self.total_cost_pool = attributes[:'total_cost_pool'] end if attributes.key?(:'quantity_on_hand') self.quantity_on_hand = attributes[:'quantity_on_hand'] end if attributes.key?(:'updated_date_utc') self.updated_date_utc = attributes[:'updated_date_utc'] end if attributes.key?(:'item_id') self.item_id = attributes[:'item_id'] 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
#code ⇒ Object
User defined item code (max length = 30)
21 22 23 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 21 def code @code end |
#description ⇒ Object
The sales description of the item (max length = 4000)
36 37 38 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 36 def description @description end |
#inventory_asset_account_code ⇒ Object
The inventory asset account for the item. The account must be of type INVENTORY. The COGSAccountCode in PurchaseDetails is also required to create a tracked item
24 25 26 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 24 def inventory_asset_account_code @inventory_asset_account_code end |
#is_purchased ⇒ Object
Boolean value, defaults to true. When IsPurchased is true the item is available for purchase transactions in the Xero UI. If IsPurchased is updated to false then PurchaseDescription and PurchaseDetails values will be nulled.
33 34 35 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 33 def is_purchased @is_purchased end |
#is_sold ⇒ Object
Boolean value, defaults to true. When IsSold is true the item will be available on sales transactions in the Xero UI. If IsSold is updated to false then Description and SalesDetails values will be nulled.
30 31 32 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 30 def is_sold @is_sold end |
#is_tracked_as_inventory ⇒ Object
True for items that are tracked as inventory. An item will be tracked as inventory if the InventoryAssetAccountCode and COGSAccountCode are set.
48 49 50 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 48 def is_tracked_as_inventory @is_tracked_as_inventory end |
#item_id ⇒ Object
The Xero identifier for an Item
60 61 62 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 60 def item_id @item_id end |
#name ⇒ Object
The name of the item (max length = 50)
27 28 29 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 27 def name @name end |
#purchase_description ⇒ Object
The purchase description of the item (max length = 4000)
39 40 41 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 39 def purchase_description @purchase_description end |
#purchase_details ⇒ Object
Returns the value of attribute purchase_details.
42 43 44 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 42 def purchase_details @purchase_details end |
#quantity_on_hand ⇒ Object
The quantity of the item on hand
54 55 56 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 54 def quantity_on_hand @quantity_on_hand end |
#sales_details ⇒ Object
Returns the value of attribute sales_details.
45 46 47 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 45 def sales_details @sales_details end |
#status_attribute_string ⇒ Object
Status of object
63 64 65 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 63 def status_attribute_string @status_attribute_string end |
#total_cost_pool ⇒ Object
The value of the item on hand. Calculated using average cost accounting.
51 52 53 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 51 def total_cost_pool @total_cost_pool end |
#updated_date_utc ⇒ Object
Last modified date in UTC format
57 58 59 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 57 def updated_date_utc @updated_date_utc end |
#validation_errors ⇒ Object
Displays array of validation error messages from the API
66 67 68 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 66 def validation_errors @validation_errors end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 69 def self.attribute_map { :'code' => :'Code', :'inventory_asset_account_code' => :'InventoryAssetAccountCode', :'name' => :'Name', :'is_sold' => :'IsSold', :'is_purchased' => :'IsPurchased', :'description' => :'Description', :'purchase_description' => :'PurchaseDescription', :'purchase_details' => :'PurchaseDetails', :'sales_details' => :'SalesDetails', :'is_tracked_as_inventory' => :'IsTrackedAsInventory', :'total_cost_pool' => :'TotalCostPool', :'quantity_on_hand' => :'QuantityOnHand', :'updated_date_utc' => :'UpdatedDateUTC', :'item_id' => :'ItemID', :'status_attribute_string' => :'StatusAttributeString', :'validation_errors' => :'ValidationErrors' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
314 315 316 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 314 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 91 def self.openapi_types { :'code' => :'String', :'inventory_asset_account_code' => :'String', :'name' => :'String', :'is_sold' => :'Boolean', :'is_purchased' => :'Boolean', :'description' => :'String', :'purchase_description' => :'String', :'purchase_details' => :'Purchase', :'sales_details' => :'Purchase', :'is_tracked_as_inventory' => :'Boolean', :'total_cost_pool' => :'BigDecimal', :'quantity_on_hand' => :'BigDecimal', :'updated_date_utc' => :'DateTime', :'item_id' => :'String', :'status_attribute_string' => :'String', :'validation_errors' => :'Array<ValidationError>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 278 def ==(o) return true if self.equal?(o) self.class == o.class && code == o.code && inventory_asset_account_code == o.inventory_asset_account_code && name == o.name && is_sold == o.is_sold && is_purchased == o.is_purchased && description == o.description && purchase_description == o.purchase_description && purchase_details == o.purchase_details && sales_details == o.sales_details && is_tracked_as_inventory == o.is_tracked_as_inventory && total_cost_pool == o.total_cost_pool && quantity_on_hand == o.quantity_on_hand && updated_date_utc == o.updated_date_utc && item_id == o.item_id && status_attribute_string == o.status_attribute_string && validation_errors == o.validation_errors end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 342 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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
409 410 411 412 413 414 415 416 417 418 419 420 421 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 409 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
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 321 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
301 302 303 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 301 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
307 308 309 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 307 def hash [code, inventory_asset_account_code, name, is_sold, is_purchased, description, purchase_description, purchase_details, sales_details, is_tracked_as_inventory, total_cost_pool, quantity_on_hand, updated_date_utc, item_id, status_attribute_string, validation_errors].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 196 def list_invalid_properties invalid_properties = Array.new if @code.nil? invalid_properties.push('invalid value for "code", code cannot be nil.') end if @code.to_s.length > 30 invalid_properties.push('invalid value for "code", the character length must be smaller than or equal to 30.') end 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 if !@description.nil? && @description.to_s.length > 4000 invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 4000.') end if !@purchase_description.nil? && @purchase_description.to_s.length > 4000 invalid_properties.push('invalid value for "purchase_description", the character length must be smaller than or equal to 4000.') end invalid_properties end |
#parse_date(datestring) ⇒ Object
customized data_parser
424 425 426 427 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 424 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)
389 390 391 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 389 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
395 396 397 398 399 400 401 402 403 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 395 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
383 384 385 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 383 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
223 224 225 226 227 228 229 230 |
# File 'lib/xero-ruby/models/accounting/item.rb', line 223 def valid? return false if @code.nil? return false if @code.to_s.length > 30 return false if !@name.nil? && @name.to_s.length > 50 return false if !@description.nil? && @description.to_s.length > 4000 return false if !@purchase_description.nil? && @purchase_description.to_s.length > 4000 true end |