Class: XeroRuby::Projects::Project

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/models/projects/project.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Project

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash


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
193
194
195
196
197
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
234
235
236
237
238
239
240
241
242
243
# 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

Instance Attribute Details

#contact_idObject

Identifier of the contact this project was created for.


23
24
25
# File 'lib/xero-ruby/models/projects/project.rb', line 23

def contact_id
  @contact_id
end

#credit_note_amountObject

Returns the value of attribute credit_note_amount


68
69
70
# File 'lib/xero-ruby/models/projects/project.rb', line 68

def credit_note_amount
  @credit_note_amount
end

#currency_codeObject

Returns the value of attribute currency_code


29
30
31
# File 'lib/xero-ruby/models/projects/project.rb', line 29

def currency_code
  @currency_code
end

#deadline_utcObject

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


71
72
73
# File 'lib/xero-ruby/models/projects/project.rb', line 71

def deadline_utc
  @deadline_utc
end

#depositObject

Returns the value of attribute deposit


62
63
64
# File 'lib/xero-ruby/models/projects/project.rb', line 62

def deposit
  @deposit
end

#deposit_appliedObject

Returns the value of attribute deposit_applied


65
66
67
# File 'lib/xero-ruby/models/projects/project.rb', line 65

def deposit_applied
  @deposit_applied
end

#estimateObject

Returns the value of attribute estimate


80
81
82
# File 'lib/xero-ruby/models/projects/project.rb', line 80

def estimate
  @estimate
end

#estimate_amountObject

Returns the value of attribute estimate_amount


41
42
43
# File 'lib/xero-ruby/models/projects/project.rb', line 41

def estimate_amount
  @estimate_amount
end

#expense_amount_invoicedObject

Returns the value of attribute expense_amount_invoiced


56
57
58
# File 'lib/xero-ruby/models/projects/project.rb', line 56

def expense_amount_invoiced
  @expense_amount_invoiced
end

#expense_amount_to_be_invoicedObject

Returns the value of attribute expense_amount_to_be_invoiced


53
54
55
# File 'lib/xero-ruby/models/projects/project.rb', line 53

def expense_amount_to_be_invoiced
  @expense_amount_to_be_invoiced
end

#minutes_loggedObject

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


32
33
34
# File 'lib/xero-ruby/models/projects/project.rb', line 32

def minutes_logged
  @minutes_logged
end

#minutes_to_be_invoicedObject

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


44
45
46
# File 'lib/xero-ruby/models/projects/project.rb', line 44

def minutes_to_be_invoiced
  @minutes_to_be_invoiced
end

#nameObject

Name of the project.


26
27
28
# File 'lib/xero-ruby/models/projects/project.rb', line 26

def name
  @name
end

#project_amount_invoicedObject

Returns the value of attribute project_amount_invoiced


59
60
61
# File 'lib/xero-ruby/models/projects/project.rb', line 59

def project_amount_invoiced
  @project_amount_invoiced
end

#project_idObject

Identifier of the project.


20
21
22
# File 'lib/xero-ruby/models/projects/project.rb', line 20

def project_id
  @project_id
end

#statusObject

Returns the value of attribute status


83
84
85
# File 'lib/xero-ruby/models/projects/project.rb', line 83

def status
  @status
end

#task_amount_invoicedObject

Returns the value of attribute task_amount_invoiced


50
51
52
# File 'lib/xero-ruby/models/projects/project.rb', line 50

def task_amount_invoiced
  @task_amount_invoiced
end

#task_amount_to_be_invoicedObject

Returns the value of attribute task_amount_to_be_invoiced


47
48
49
# File 'lib/xero-ruby/models/projects/project.rb', line 47

def task_amount_to_be_invoiced
  @task_amount_to_be_invoiced
end

#total_expense_amountObject

Returns the value of attribute total_expense_amount


38
39
40
# File 'lib/xero-ruby/models/projects/project.rb', line 38

def total_expense_amount
  @total_expense_amount
end

#total_invoicedObject

Returns the value of attribute total_invoiced


74
75
76
# File 'lib/xero-ruby/models/projects/project.rb', line 74

def total_invoiced
  @total_invoiced
end

#total_task_amountObject

Returns the value of attribute total_task_amount


35
36
37
# File 'lib/xero-ruby/models/projects/project.rb', line 35

def total_task_amount
  @total_task_amount
end

#total_to_be_invoicedObject

Returns the value of attribute total_to_be_invoiced


77
78
79
# File 'lib/xero-ruby/models/projects/project.rb', line 77

def total_to_be_invoiced
  @total_to_be_invoiced
end

Class Method Details

.attribute_mapObject

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


86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


307
308
309
# File 'lib/xero-ruby/models/projects/project.rb', line 307

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_typesObject

Attribute type mapping.


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
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
# 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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data


335
336
337
338
339
340
341
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
# 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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash


408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# 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) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

294
295
296
# File 'lib/xero-ruby/models/projects/project.rb', line 294

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


300
301
302
# 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_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons


247
248
249
250
251
252
253
254
# 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) ⇒ Object


424
425
426
427
428
429
430
431
432
433
# 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
  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_attributesObject

Returns the object in the form of hash with snake_case


400
401
402
# File 'lib/xero-ruby/models/projects/project.rb', line 400

def to_attributes
  to_hash(downcase: true)
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


382
383
384
# File 'lib/xero-ruby/models/projects/project.rb', line 382

def to_body
  to_hash
end

#to_hash(downcase: false) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


388
389
390
391
392
393
394
395
396
397
# 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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


376
377
378
# File 'lib/xero-ruby/models/projects/project.rb', line 376

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid


258
259
260
261
# File 'lib/xero-ruby/models/projects/project.rb', line 258

def valid?
  return false if @name.nil?
  true
end