class XeroRuby::Accounting::Item
Attributes
User
defined item code (max length = 30)
The sales description of the item (max length = 4000)
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
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.
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.
True for items that are tracked as inventory. An item will be tracked as inventory if the InventoryAssetAccountCode and COGSAccountCode are set.
The Xero identifier for an Item
The name of the item (max length = 50)
The purchase description of the item (max length = 4000)
The quantity of the item on hand
Status of object
The value of the item on hand. Calculated using average cost accounting.
Last modified date in UTC format
Displays array of validation error messages from the API
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/xero-ruby/models/accounting/item.rb, line 68 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/xero-ruby/models/accounting/item.rb, line 313 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/xero-ruby/models/accounting/item.rb, line 113 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
Attribute type mapping.
# File lib/xero-ruby/models/accounting/item.rb, line 90 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/xero-ruby/models/accounting/item.rb, line 277 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/xero-ruby/models/accounting/item.rb, line 341 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/xero-ruby/models/accounting/item.rb, line 414 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/xero-ruby/models/accounting/item.rb, line 320 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
Custom attribute writer method with validation @param [Object] code Value to be assigned
# File lib/xero-ruby/models/accounting/item.rb, line 233 def code=(code) if code.nil? fail ArgumentError, 'code cannot be nil' end if code.to_s.length > 30 fail ArgumentError, 'invalid value for "code", the character length must be smaller than or equal to 30.' end @code = code end
Custom attribute writer method with validation @param [Object] description Value to be assigned
# File lib/xero-ruby/models/accounting/item.rb, line 257 def description=(description) if !description.nil? && description.to_s.length > 4000 fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 4000.' end @description = description end
@see the `==` method @param [Object] Object to be compared
# File lib/xero-ruby/models/accounting/item.rb, line 300 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/xero-ruby/models/accounting/item.rb, line 306 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/xero-ruby/models/accounting/item.rb, line 195 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
Custom attribute writer method with validation @param [Object] name Value to be assigned
# File lib/xero-ruby/models/accounting/item.rb, line 247 def name=(name) if !name.nil? && name.to_s.length > 50 fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 50.' end @name = name end
# File lib/xero-ruby/models/accounting/item.rb, line 430 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 elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').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
Custom attribute writer method with validation @param [Object] purchase_description
Value to be assigned
# File lib/xero-ruby/models/accounting/item.rb, line 267 def purchase_description=(purchase_description) if !purchase_description.nil? && purchase_description.to_s.length > 4000 fail ArgumentError, 'invalid value for "purchase_description", the character length must be smaller than or equal to 4000.' end @purchase_description = purchase_description end
Returns the object in the form of hash with snake_case
# File lib/xero-ruby/models/accounting/item.rb, line 406 def to_attributes to_hash(downcase: true) end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/xero-ruby/models/accounting/item.rb, line 394 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/xero-ruby/models/accounting/item.rb, line 382 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/xero-ruby/models/accounting/item.rb, line 222 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