Class: TripletexApi::Project

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_api/models/project.rb

Defined Under Namespace

Classes: EnumAttributeValidator

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



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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/tripletex_api/models/project.rb', line 160

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'version')
    self.version = attributes[:'version']
  end

  if attributes.has_key?(:'changes')
    if (value = attributes[:'changes']).is_a?(Array)
      self.changes = value
    end
  end

  if attributes.has_key?(:'url')
    self.url = attributes[:'url']
  end

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

  if attributes.has_key?(:'number')
    self.number = attributes[:'number']
  end

  if attributes.has_key?(:'displayName')
    self.display_name = attributes[:'displayName']
  end

  if attributes.has_key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.has_key?(:'projectManager')
    self.project_manager = attributes[:'projectManager']
  end

  if attributes.has_key?(:'department')
    self.department = attributes[:'department']
  end

  if attributes.has_key?(:'mainProject')
    self.main_project = attributes[:'mainProject']
  end

  if attributes.has_key?(:'startDate')
    self.start_date = attributes[:'startDate']
  end

  if attributes.has_key?(:'endDate')
    self.end_date = attributes[:'endDate']
  end

  if attributes.has_key?(:'customer')
    self.customer = attributes[:'customer']
  end

  if attributes.has_key?(:'isClosed')
    self.is_closed = attributes[:'isClosed']
  else
    self.is_closed = false
  end

  if attributes.has_key?(:'isReadyForInvoicing')
    self.is_ready_for_invoicing = attributes[:'isReadyForInvoicing']
  else
    self.is_ready_for_invoicing = false
  end

  if attributes.has_key?(:'isInternal')
    self.is_internal = attributes[:'isInternal']
  else
    self.is_internal = false
  end

  if attributes.has_key?(:'isOffer')
    self.is_offer = attributes[:'isOffer']
  else
    self.is_offer = false
  end

  if attributes.has_key?(:'projectCategory')
    self.project_category = attributes[:'projectCategory']
  end

  if attributes.has_key?(:'deliveryAddress')
    self.delivery_address = attributes[:'deliveryAddress']
  end

  if attributes.has_key?(:'displayNameFormat')
    self.display_name_format = attributes[:'displayNameFormat']
  end

  if attributes.has_key?(:'externalAccountsNumber')
    self.external_accounts_number = attributes[:'externalAccountsNumber']
  end

  if attributes.has_key?(:'discountPercentage')
    self.discount_percentage = attributes[:'discountPercentage']
  end

  if attributes.has_key?(:'orderLines')
    if (value = attributes[:'orderLines']).is_a?(Array)
      self.order_lines = value
    end
  end

  if attributes.has_key?(:'participants')
    if (value = attributes[:'participants']).is_a?(Array)
      self.participants = value
    end
  end

end

Instance Attribute Details

#changes ⇒ Object

Returns the value of attribute changes.



22
23
24
 
# File 'lib/tripletex_api/models/project.rb', line 22

def changes
  @changes
end

#customer ⇒ Object

The project’s customer



45
46
47
 
# File 'lib/tripletex_api/models/project.rb', line 45

def customer
  @customer
end

#delivery_address ⇒ Object

Returns the value of attribute delivery_address.



58
59
60
 
# File 'lib/tripletex_api/models/project.rb', line 58

def delivery_address
  @delivery_address
end

#department ⇒ Object

Returns the value of attribute department.



36
37
38
 
# File 'lib/tripletex_api/models/project.rb', line 36

def department
  @department
end

#description ⇒ Object

Returns the value of attribute description.



32
33
34
 
# File 'lib/tripletex_api/models/project.rb', line 32

def description
  @description
end

#discount_percentage ⇒ Object

Project discount percentage.



66
67
68
 
# File 'lib/tripletex_api/models/project.rb', line 66

def discount_percentage
  @discount_percentage
end

#display_name ⇒ Object

Returns the value of attribute display_name.



30
31
32
 
# File 'lib/tripletex_api/models/project.rb', line 30

def display_name
  @display_name
end

#display_name_format ⇒ Object

Defines project name presentation in overviews.



61
62
63
 
# File 'lib/tripletex_api/models/project.rb', line 61

def display_name_format
  @display_name_format
end

#end_date ⇒ Object

Returns the value of attribute end_date.



42
43
44
 
# File 'lib/tripletex_api/models/project.rb', line 42

def end_date
  @end_date
end

#external_accounts_number ⇒ Object

Returns the value of attribute external_accounts_number.



63
64
65
 
# File 'lib/tripletex_api/models/project.rb', line 63

def external_accounts_number
  @external_accounts_number
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/tripletex_api/models/project.rb', line 18

def id
  @id
end

#is_closed ⇒ Object

Returns the value of attribute is_closed.



47
48
49
 
# File 'lib/tripletex_api/models/project.rb', line 47

def is_closed
  @is_closed
end

#is_internal ⇒ Object

Must be set to true.



52
53
54
 
# File 'lib/tripletex_api/models/project.rb', line 52

def is_internal
  @is_internal
end

#is_offer ⇒ Object

Returns the value of attribute is_offer.



54
55
56
 
# File 'lib/tripletex_api/models/project.rb', line 54

def is_offer
  @is_offer
end

#is_ready_for_invoicing ⇒ Object

Returns the value of attribute is_ready_for_invoicing.



49
50
51
 
# File 'lib/tripletex_api/models/project.rb', line 49

def is_ready_for_invoicing
  @is_ready_for_invoicing
end

#main_project ⇒ Object

Returns the value of attribute main_project.



38
39
40
 
# File 'lib/tripletex_api/models/project.rb', line 38

def main_project
  @main_project
end

#name ⇒ Object

Returns the value of attribute name.



26
27
28
 
# File 'lib/tripletex_api/models/project.rb', line 26

def name
  @name
end

#number ⇒ Object

Returns the value of attribute number.



28
29
30
 
# File 'lib/tripletex_api/models/project.rb', line 28

def number
  @number
end

#order_lines ⇒ Object

Order lines tied to the order



69
70
71
 
# File 'lib/tripletex_api/models/project.rb', line 69

def order_lines
  @order_lines
end

#participants ⇒ Object

Link to individual project participants.



72
73
74
 
# File 'lib/tripletex_api/models/project.rb', line 72

def participants
  @participants
end

#project_category ⇒ Object

Returns the value of attribute project_category.



56
57
58
 
# File 'lib/tripletex_api/models/project.rb', line 56

def project_category
  @project_category
end

#project_manager ⇒ Object

Returns the value of attribute project_manager.



34
35
36
 
# File 'lib/tripletex_api/models/project.rb', line 34

def project_manager
  @project_manager
end

#start_date ⇒ Object

Returns the value of attribute start_date.



40
41
42
 
# File 'lib/tripletex_api/models/project.rb', line 40

def start_date
  @start_date
end

#url ⇒ Object

Returns the value of attribute url.



24
25
26
 
# File 'lib/tripletex_api/models/project.rb', line 24

def url
  @url
end

#version ⇒ Object

Returns the value of attribute version.



20
21
22
 
# File 'lib/tripletex_api/models/project.rb', line 20

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/tripletex_api/models/project.rb', line 97

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'name' => :'name',
    :'number' => :'number',
    :'display_name' => :'displayName',
    :'description' => :'description',
    :'project_manager' => :'projectManager',
    :'department' => :'department',
    :'main_project' => :'mainProject',
    :'start_date' => :'startDate',
    :'end_date' => :'endDate',
    :'customer' => :'customer',
    :'is_closed' => :'isClosed',
    :'is_ready_for_invoicing' => :'isReadyForInvoicing',
    :'is_internal' => :'isInternal',
    :'is_offer' => :'isOffer',
    :'project_category' => :'projectCategory',
    :'delivery_address' => :'deliveryAddress',
    :'display_name_format' => :'displayNameFormat',
    :'external_accounts_number' => :'externalAccountsNumber',
    :'discount_percentage' => :'discountPercentage',
    :'order_lines' => :'orderLines',
    :'participants' => :'participants'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/tripletex_api/models/project.rb', line 128

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'name' => :'String',
    :'number' => :'String',
    :'display_name' => :'String',
    :'description' => :'String',
    :'project_manager' => :'Employee',
    :'department' => :'Department',
    :'main_project' => :'Project',
    :'start_date' => :'String',
    :'end_date' => :'String',
    :'customer' => :'Customer',
    :'is_closed' => :'BOOLEAN',
    :'is_ready_for_invoicing' => :'BOOLEAN',
    :'is_internal' => :'BOOLEAN',
    :'is_offer' => :'BOOLEAN',
    :'project_category' => :'ProjectCategory',
    :'delivery_address' => :'Address',
    :'display_name_format' => :'String',
    :'external_accounts_number' => :'String',
    :'discount_percentage' => :'Float',
    :'order_lines' => :'Array<ProjectOrderLine>',
    :'participants' => :'Array<ProjectParticipant>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/tripletex_api/models/project.rb', line 380

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      changes == o.changes &&
      url == o.url &&
      name == o.name &&
      number == o.number &&
      display_name == o.display_name &&
      description == o.description &&
      project_manager == o.project_manager &&
      department == o.department &&
      main_project == o.main_project &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      customer == o.customer &&
      is_closed == o.is_closed &&
      is_ready_for_invoicing == o.is_ready_for_invoicing &&
      is_internal == o.is_internal &&
      is_offer == o.is_offer &&
      project_category == o.project_category &&
      delivery_address == o.delivery_address &&
      display_name_format == o.display_name_format &&
      external_accounts_number == o.external_accounts_number &&
      discount_percentage == o.discount_percentage &&
      order_lines == o.order_lines &&
      participants == o.participants
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



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/tripletex_api/models/project.rb', line 446

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  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
    temp_model = TripletexApi.const_get(type).new
    temp_model.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/tripletex_api/models/project.rb', line 512

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/tripletex_api/models/project.rb', line 425

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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


412
413
414
 
# File 'lib/tripletex_api/models/project.rb', line 412

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



418
419
420
 
# File 'lib/tripletex_api/models/project.rb', line 418

def hash
  [id, version, changes, url, name, number, display_name, description, project_manager, department, main_project, start_date, end_date, customer, is_closed, is_ready_for_invoicing, is_internal, is_offer, project_category, delivery_address, display_name_format, external_accounts_number, discount_percentage, order_lines, participants].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/tripletex_api/models/project.rb', line 284

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push("invalid value for 'name', name cannot be nil.")
  end

  if @name.to_s.length > 255
    invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 255.")
  end

  if !@number.nil? && @number.to_s.length > 100
    invalid_properties.push("invalid value for 'number', the character length must be smaller than or equal to 100.")
  end

  if @project_manager.nil?
    invalid_properties.push("invalid value for 'project_manager', project_manager cannot be nil.")
  end

  if @start_date.nil?
    invalid_properties.push("invalid value for 'start_date', start_date cannot be nil.")
  end

  if @is_internal.nil?
    invalid_properties.push("invalid value for 'is_internal', is_internal cannot be nil.")
  end

  if !@external_accounts_number.nil? && @external_accounts_number.to_s.length > 100
    invalid_properties.push("invalid value for 'external_accounts_number', the character length must be smaller than or equal to 100.")
  end

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



492
493
494
 
# File 'lib/tripletex_api/models/project.rb', line 492

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



498
499
500
501
502
503
504
505
506
 
# File 'lib/tripletex_api/models/project.rb', line 498

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

Returns:

  • (String) —

    String presentation of the object



486
487
488
 
# File 'lib/tripletex_api/models/project.rb', line 486

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



319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/tripletex_api/models/project.rb', line 319

def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 255
  return false if !@number.nil? && @number.to_s.length > 100
  return false if @project_manager.nil?
  return false if @start_date.nil?
  return false if @is_internal.nil?
  display_name_format_validator = EnumAttributeValidator.new('String', ["NAME_STANDARD", "NAME_INCL_CUSTOMER_NAME", "NAME_INCL_PARENT_NAME", "NAME_INCL_PARENT_NUMBER", "NAME_INCL_PARENT_NAME_AND_NUMBER"])
  return false unless display_name_format_validator.valid?(@display_name_format)
  return false if !@external_accounts_number.nil? && @external_accounts_number.to_s.length > 100
  return true
end