class XeroRuby::Projects::TimeEntry
Constants
- ACTIVE
- INVOICED
- LOCKED
Attributes
The date time that time entry is created. UTC Date Time in ISO-8601 format. By default it is set to server time.
The date time that time entry is logged on. UTC Date Time in ISO-8601 format.
A description of the time entry.
The duration of logged minutes.
Identifier of the project, that the task (which the time entry is logged against) belongs to.
Status of the time entry. By default a time entry is created with status of `ACTIVE`. A `LOCKED` state indicates that the time entry is currently changing state (for example being invoiced). Updates are not allowed when in this state. It will have a status of INVOICED
once it is invoiced.
Identifier of the task that time entry is logged against.
Identifier of the time entry.
The xero user identifier of the person who logged time.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/xero-ruby/models/projects/time_entry.rb, line 72 def self.attribute_map { :'time_entry_id' => :'timeEntryId', :'user_id' => :'userId', :'project_id' => :'projectId', :'task_id' => :'taskId', :'date_utc' => :'dateUtc', :'date_entered_utc' => :'dateEnteredUtc', :'duration' => :'duration', :'description' => :'description', :'status' => :'status' } 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/projects/time_entry.rb, line 209 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/projects/time_entry.rb, line 103 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Projects::TimeEntry` 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::Projects::TimeEntry`. 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?(:'time_entry_id') self.time_entry_id = attributes[:'time_entry_id'] end if attributes.key?(:'user_id') self.user_id = attributes[:'user_id'] end if attributes.key?(:'project_id') self.project_id = attributes[:'project_id'] end if attributes.key?(:'task_id') self.task_id = attributes[:'task_id'] end if attributes.key?(:'date_utc') self.date_utc = attributes[:'date_utc'] end if attributes.key?(:'date_entered_utc') self.date_entered_utc = attributes[:'date_entered_utc'] end if attributes.key?(:'duration') self.duration = attributes[:'duration'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'status') self.status = attributes[:'status'] end end
Attribute type mapping.
# File lib/xero-ruby/models/projects/time_entry.rb, line 87 def self.openapi_types { :'time_entry_id' => :'String', :'user_id' => :'String', :'project_id' => :'String', :'task_id' => :'String', :'date_utc' => :'DateTime', :'date_entered_utc' => :'DateTime', :'duration' => :'Integer', :'description' => :'String', :'status' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/xero-ruby/models/projects/time_entry.rb, line 180 def ==(o) return true if self.equal?(o) self.class == o.class && time_entry_id == o.time_entry_id && user_id == o.user_id && project_id == o.project_id && task_id == o.task_id && date_utc == o.date_utc && date_entered_utc == o.date_entered_utc && duration == o.duration && description == o.description && status == o.status 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/projects/time_entry.rb, line 237 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::Projects.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/projects/time_entry.rb, line 310 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/projects/time_entry.rb, line 216 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
@see the `==` method @param [Object] Object to be compared
# File lib/xero-ruby/models/projects/time_entry.rb, line 196 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/xero-ruby/models/projects/time_entry.rb, line 202 def hash [time_entry_id, user_id, project_id, task_id, date_utc, date_entered_utc, duration, description, status].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/projects/time_entry.rb, line 155 def list_invalid_properties invalid_properties = Array.new invalid_properties end
# File lib/xero-ruby/models/projects/time_entry.rb, line 326 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 checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/xero-ruby/models/projects/time_entry.rb, line 170 def status=(status) validator = EnumAttributeValidator.new('String', ["ACTIVE", "LOCKED", "INVOICED"]) unless validator.valid?(status) fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}." end @status = status end
Returns the object in the form of hash with snake_case
# File lib/xero-ruby/models/projects/time_entry.rb, line 302 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/projects/time_entry.rb, line 290 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/projects/time_entry.rb, line 278 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/projects/time_entry.rb, line 162 def valid? status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "LOCKED", "INVOICED"]) return false unless status_validator.valid?(@status) true end