class XeroRuby::Projects::Project

Attributes

contact_id[RW]

Identifier of the contact this project was created for.

credit_note_amount[RW]
currency_code[RW]
deadline_utc[RW]

Deadline for the project. UTC Date Time in ISO-8601 format.

deposit[RW]
deposit_applied[RW]
estimate[RW]
estimate_amount[RW]
expense_amount_invoiced[RW]
expense_amount_to_be_invoiced[RW]
minutes_logged[RW]

A total of minutes logged against all tasks on the Project.

minutes_to_be_invoiced[RW]

Minutes which have not been invoiced across all chargeable tasks in the project.

name[RW]

Name of the project.

project_amount_invoiced[RW]
project_id[RW]

Identifier of the project.

status[RW]
task_amount_invoiced[RW]
task_amount_to_be_invoiced[RW]
total_expense_amount[RW]
total_invoiced[RW]
total_task_amount[RW]
total_to_be_invoiced[RW]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/xero-ruby/models/projects/project.rb, line 86
def self.attribute_map
  {
    :'project_id' => :'projectId',
    :'contact_id' => :'contactId',
    :'name' => :'name',
    :'currency_code' => :'currencyCode',
    :'minutes_logged' => :'minutesLogged',
    :'total_task_amount' => :'totalTaskAmount',
    :'total_expense_amount' => :'totalExpenseAmount',
    :'estimate_amount' => :'estimateAmount',
    :'minutes_to_be_invoiced' => :'minutesToBeInvoiced',
    :'task_amount_to_be_invoiced' => :'taskAmountToBeInvoiced',
    :'task_amount_invoiced' => :'taskAmountInvoiced',
    :'expense_amount_to_be_invoiced' => :'expenseAmountToBeInvoiced',
    :'expense_amount_invoiced' => :'expenseAmountInvoiced',
    :'project_amount_invoiced' => :'projectAmountInvoiced',
    :'deposit' => :'deposit',
    :'deposit_applied' => :'depositApplied',
    :'credit_note_amount' => :'creditNoteAmount',
    :'deadline_utc' => :'deadlineUtc',
    :'total_invoiced' => :'totalInvoiced',
    :'total_to_be_invoiced' => :'totalToBeInvoiced',
    :'estimate' => :'estimate',
    :'status' => :'status'
  }
end
build_from_hash(attributes) click to toggle source

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/project.rb, line 307
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/xero-ruby/models/projects/project.rb, line 143
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Projects::Project` 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::Project`. 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?(:'project_id')
    self.project_id = attributes[:'project_id']
  end

  if attributes.key?(:'contact_id')
    self.contact_id = attributes[:'contact_id']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'currency_code')
    self.currency_code = attributes[:'currency_code']
  end

  if attributes.key?(:'minutes_logged')
    self.minutes_logged = attributes[:'minutes_logged']
  end

  if attributes.key?(:'total_task_amount')
    self.total_task_amount = attributes[:'total_task_amount']
  end

  if attributes.key?(:'total_expense_amount')
    self.total_expense_amount = attributes[:'total_expense_amount']
  end

  if attributes.key?(:'estimate_amount')
    self.estimate_amount = attributes[:'estimate_amount']
  end

  if attributes.key?(:'minutes_to_be_invoiced')
    self.minutes_to_be_invoiced = attributes[:'minutes_to_be_invoiced']
  end

  if attributes.key?(:'task_amount_to_be_invoiced')
    self.task_amount_to_be_invoiced = attributes[:'task_amount_to_be_invoiced']
  end

  if attributes.key?(:'task_amount_invoiced')
    self.task_amount_invoiced = attributes[:'task_amount_invoiced']
  end

  if attributes.key?(:'expense_amount_to_be_invoiced')
    self.expense_amount_to_be_invoiced = attributes[:'expense_amount_to_be_invoiced']
  end

  if attributes.key?(:'expense_amount_invoiced')
    self.expense_amount_invoiced = attributes[:'expense_amount_invoiced']
  end

  if attributes.key?(:'project_amount_invoiced')
    self.project_amount_invoiced = attributes[:'project_amount_invoiced']
  end

  if attributes.key?(:'deposit')
    self.deposit = attributes[:'deposit']
  end

  if attributes.key?(:'deposit_applied')
    self.deposit_applied = attributes[:'deposit_applied']
  end

  if attributes.key?(:'credit_note_amount')
    self.credit_note_amount = attributes[:'credit_note_amount']
  end

  if attributes.key?(:'deadline_utc')
    self.deadline_utc = attributes[:'deadline_utc']
  end

  if attributes.key?(:'total_invoiced')
    self.total_invoiced = attributes[:'total_invoiced']
  end

  if attributes.key?(:'total_to_be_invoiced')
    self.total_to_be_invoiced = attributes[:'total_to_be_invoiced']
  end

  if attributes.key?(:'estimate')
    self.estimate = attributes[:'estimate']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/xero-ruby/models/projects/project.rb, line 114
def self.openapi_types
  {
    :'project_id' => :'String',
    :'contact_id' => :'String',
    :'name' => :'String',
    :'currency_code' => :'CurrencyCode',
    :'minutes_logged' => :'Integer',
    :'total_task_amount' => :'Amount',
    :'total_expense_amount' => :'Amount',
    :'estimate_amount' => :'Amount',
    :'minutes_to_be_invoiced' => :'Integer',
    :'task_amount_to_be_invoiced' => :'Amount',
    :'task_amount_invoiced' => :'Amount',
    :'expense_amount_to_be_invoiced' => :'Amount',
    :'expense_amount_invoiced' => :'Amount',
    :'project_amount_invoiced' => :'Amount',
    :'deposit' => :'Amount',
    :'deposit_applied' => :'Amount',
    :'credit_note_amount' => :'Amount',
    :'deadline_utc' => :'DateTime',
    :'total_invoiced' => :'Amount',
    :'total_to_be_invoiced' => :'Amount',
    :'estimate' => :'Amount',
    :'status' => :'ProjectStatus'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/xero-ruby/models/projects/project.rb, line 265
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      project_id == o.project_id &&
      contact_id == o.contact_id &&
      name == o.name &&
      currency_code == o.currency_code &&
      minutes_logged == o.minutes_logged &&
      total_task_amount == o.total_task_amount &&
      total_expense_amount == o.total_expense_amount &&
      estimate_amount == o.estimate_amount &&
      minutes_to_be_invoiced == o.minutes_to_be_invoiced &&
      task_amount_to_be_invoiced == o.task_amount_to_be_invoiced &&
      task_amount_invoiced == o.task_amount_invoiced &&
      expense_amount_to_be_invoiced == o.expense_amount_to_be_invoiced &&
      expense_amount_invoiced == o.expense_amount_invoiced &&
      project_amount_invoiced == o.project_amount_invoiced &&
      deposit == o.deposit &&
      deposit_applied == o.deposit_applied &&
      credit_note_amount == o.credit_note_amount &&
      deadline_utc == o.deadline_utc &&
      total_invoiced == o.total_invoiced &&
      total_to_be_invoiced == o.total_to_be_invoiced &&
      estimate == o.estimate &&
      status == o.status
end
_deserialize(type, value) click to toggle source

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/project.rb, line 335
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
_to_hash(value, downcase: false) click to toggle source

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/project.rb, line 408
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) click to toggle source

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/project.rb, line 314
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/xero-ruby/models/projects/project.rb, line 294
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/xero-ruby/models/projects/project.rb, line 300
def hash
  [project_id, contact_id, name, currency_code, minutes_logged, total_task_amount, total_expense_amount, estimate_amount, minutes_to_be_invoiced, task_amount_to_be_invoiced, task_amount_invoiced, expense_amount_to_be_invoiced, expense_amount_invoiced, project_amount_invoiced, deposit, deposit_applied, credit_note_amount, deadline_utc, total_invoiced, total_to_be_invoiced, estimate, status].hash
end
list_invalid_properties() click to toggle source

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/project.rb, line 247
def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  invalid_properties
end
parse_date(datestring) click to toggle source
# File lib/xero-ruby/models/projects/project.rb, line 424
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
to_attributes() click to toggle source

Returns the object in the form of hash with snake_case

# File lib/xero-ruby/models/projects/project.rb, line 400
def to_attributes
  to_hash(downcase: true)
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/xero-ruby/models/projects/project.rb, line 382
def to_body
  to_hash
end
to_hash(downcase: false) click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/xero-ruby/models/projects/project.rb, line 388
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/xero-ruby/models/projects/project.rb, line 376
def to_s
  to_hash.to_s
end
valid?() click to toggle source

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/project.rb, line 258
def valid?
  return false if @name.nil?
  true
end