Class: TripletexRubyClient::ProjectTemplate

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/models/project_template.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProjectTemplate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 181

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?(:'name')
    self.name = attributes[:'name']
  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?(:'isInternal')
    self.is_internal = attributes[:'isInternal']
  end

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

  if attributes.has_key?(:'displayNameFormat')
    self.display_name_format = attributes[:'displayNameFormat']
  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?(:'projectCategory')
    self.project_category = attributes[:'projectCategory']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#attention ⇒ Object

Customer in attention of person



45
46
47
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 45

def attention
  @attention
end

#contact ⇒ Object

Customer contact person.



48
49
50
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 48

def contact
  @contact
end

#currency ⇒ Object

Returns the value of attribute currency.



58
59
60
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 58

def currency
  @currency
end

#customer ⇒ Object

The project’s customer



51
52
53
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 51

def customer
  @customer
end

#delivery_address ⇒ Object

Returns the value of attribute delivery_address.



53
54
55
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 53

def delivery_address
  @delivery_address
end

#department ⇒ Object

Returns the value of attribute department.



29
30
31
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 29

def department
  @department
end

#description ⇒ Object

Returns the value of attribute description.



39
40
41
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 39

def description
  @description
end

#display_name_format ⇒ Object

Returns the value of attribute display_name_format.



25
26
27
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 25

def display_name_format
  @display_name_format
end

#end_date ⇒ Object

Returns the value of attribute end_date.



19
20
21
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 19

def end_date
  @end_date
end

#external_accounts_number ⇒ Object

Returns the value of attribute external_accounts_number.



37
38
39
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 37

def external_accounts_number
  @external_accounts_number
end

#fixedprice ⇒ Object

Fixed price amount, in the project’s currency.



70
71
72
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 70

def fixedprice
  @fixedprice
end

#for_participants_only ⇒ Object

Set to true if only project participants can register information on the project



82
83
84
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 82

def for_participants_only
  @for_participants_only
end

#general_project_activities_per_project_only ⇒ Object

Set to true if a general project activity must be linked to project to allow time tracking.



79
80
81
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 79

def general_project_activities_per_project_only
  @general_project_activities_per_project_only
end

#invoice_comment ⇒ Object

Comment for project invoices



42
43
44
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 42

def invoice_comment
  @invoice_comment
end

#is_fixed_price ⇒ Object

Project is fixed price if set to true, hourly rate if set to false.



67
68
69
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 67

def is_fixed_price
  @is_fixed_price
end

#is_internal ⇒ Object

Returns the value of attribute is_internal.



21
22
23
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 21

def is_internal
  @is_internal
end

#is_price_ceiling ⇒ Object

Set to true if an hourly rate project has a price ceiling.



73
74
75
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 73

def is_price_ceiling
  @is_price_ceiling
end

#main_project ⇒ Object

Returns the value of attribute main_project.



31
32
33
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 31

def main_project
  @main_project
end

#mark_up_fees_earned ⇒ Object

Set mark-up (%) for fees earned.



64
65
66
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 64

def mark_up_fees_earned
  @mark_up_fees_earned
end

#mark_up_order_lines ⇒ Object

Set mark-up (%) for order lines.



61
62
63
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 61

def mark_up_order_lines
  @mark_up_order_lines
end

#name ⇒ Object

Returns the value of attribute name.



15
16
17
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 15

def name
  @name
end

#number ⇒ Object

Returns the value of attribute number.



23
24
25
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 23

def number
  @number
end

#price_ceiling_amount ⇒ Object

Price ceiling amount, in the project’s currency.



76
77
78
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 76

def price_ceiling_amount
  @price_ceiling_amount
end

#project_category ⇒ Object

Returns the value of attribute project_category.



33
34
35
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 33

def project_category
  @project_category
end

#project_hourly_rates ⇒ Object

Project Rate Types tied to the project.



85
86
87
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 85

def project_hourly_rates
  @project_hourly_rates
end

#project_manager ⇒ Object

Returns the value of attribute project_manager.



27
28
29
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 27

def project_manager
  @project_manager
end

#reference ⇒ Object

Returns the value of attribute reference.



35
36
37
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 35

def reference
  @reference
end

#start_date ⇒ Object

Returns the value of attribute start_date.



17
18
19
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 17

def start_date
  @start_date
end

#vat_type ⇒ Object

The default vat type for this project.



56
57
58
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 56

def vat_type
  @vat_type
end

Class Method Details

.attribute_map ⇒ Object

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



110
111
112
113
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
140
141
142
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 110

def self.attribute_map
  {
    :'name' => :'name',
    :'start_date' => :'startDate',
    :'end_date' => :'endDate',
    :'is_internal' => :'isInternal',
    :'number' => :'number',
    :'display_name_format' => :'displayNameFormat',
    :'project_manager' => :'projectManager',
    :'department' => :'department',
    :'main_project' => :'mainProject',
    :'project_category' => :'projectCategory',
    :'reference' => :'reference',
    :'external_accounts_number' => :'externalAccountsNumber',
    :'description' => :'description',
    :'invoice_comment' => :'invoiceComment',
    :'attention' => :'attention',
    :'contact' => :'contact',
    :'customer' => :'customer',
    :'delivery_address' => :'deliveryAddress',
    :'vat_type' => :'vatType',
    :'currency' => :'currency',
    :'mark_up_order_lines' => :'markUpOrderLines',
    :'mark_up_fees_earned' => :'markUpFeesEarned',
    :'is_fixed_price' => :'isFixedPrice',
    :'fixedprice' => :'fixedprice',
    :'is_price_ceiling' => :'isPriceCeiling',
    :'price_ceiling_amount' => :'priceCeilingAmount',
    :'general_project_activities_per_project_only' => :'generalProjectActivitiesPerProjectOnly',
    :'for_participants_only' => :'forParticipantsOnly',
    :'project_hourly_rates' => :'projectHourlyRates'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 145

def self.swagger_types
  {
    :'name' => :'String',
    :'start_date' => :'String',
    :'end_date' => :'String',
    :'is_internal' => :'BOOLEAN',
    :'number' => :'String',
    :'display_name_format' => :'String',
    :'project_manager' => :'Employee',
    :'department' => :'Department',
    :'main_project' => :'Project',
    :'project_category' => :'ProjectCategory',
    :'reference' => :'String',
    :'external_accounts_number' => :'String',
    :'description' => :'String',
    :'invoice_comment' => :'String',
    :'attention' => :'Contact',
    :'contact' => :'Contact',
    :'customer' => :'Customer',
    :'delivery_address' => :'DeliveryAddress',
    :'vat_type' => :'VatType',
    :'currency' => :'Currency',
    :'mark_up_order_lines' => :'Float',
    :'mark_up_fees_earned' => :'Float',
    :'is_fixed_price' => :'BOOLEAN',
    :'fixedprice' => :'Float',
    :'is_price_ceiling' => :'BOOLEAN',
    :'price_ceiling_amount' => :'Float',
    :'general_project_activities_per_project_only' => :'BOOLEAN',
    :'for_participants_only' => :'BOOLEAN',
    :'project_hourly_rates' => :'Array<ProjectHourlyRateTemplate>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 393

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      is_internal == o.is_internal &&
      number == o.number &&
      display_name_format == o.display_name_format &&
      project_manager == o.project_manager &&
      department == o.department &&
      main_project == o.main_project &&
      project_category == o.project_category &&
      reference == o.reference &&
      external_accounts_number == o.external_accounts_number &&
      description == o.description &&
      invoice_comment == o.invoice_comment &&
      attention == o.attention &&
      contact == o.contact &&
      customer == o.customer &&
      delivery_address == o.delivery_address &&
      vat_type == o.vat_type &&
      currency == o.currency &&
      mark_up_order_lines == o.mark_up_order_lines &&
      mark_up_fees_earned == o.mark_up_fees_earned &&
      is_fixed_price == o.is_fixed_price &&
      fixedprice == o.fixedprice &&
      is_price_ceiling == o.is_price_ceiling &&
      price_ceiling_amount == o.price_ceiling_amount &&
      general_project_activities_per_project_only == o.general_project_activities_per_project_only &&
      for_participants_only == o.for_participants_only &&
      project_hourly_rates == o.project_hourly_rates
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



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 463

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 = TripletexRubyClient.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



529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 529

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



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 442

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


429
430
431
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 429

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



435
436
437
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 435

def hash
  [name, start_date, end_date, is_internal, number, display_name_format, project_manager, department, main_project, project_category, reference, external_accounts_number, description, invoice_comment, attention, contact, customer, delivery_address, vat_type, currency, mark_up_order_lines, mark_up_fees_earned, is_fixed_price, fixedprice, is_price_ceiling, price_ceiling_amount, general_project_activities_per_project_only, for_participants_only, project_hourly_rates].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



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 308

def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @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 !@reference.nil? && @reference.to_s.length > 255
    invalid_properties.push('invalid value for "reference", the character length must be smaller than or equal to 255.')
  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

  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



509
510
511
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 509

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



515
516
517
518
519
520
521
522
523
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 515

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



503
504
505
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 503

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



331
332
333
334
335
336
337
338
339
 
# File 'lib/tripletex_ruby_client/models/project_template.rb', line 331

def valid?
  return false if !@name.nil? && @name.to_s.length > 255
  return false if !@number.nil? && @number.to_s.length > 100
  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 !@reference.nil? && @reference.to_s.length > 255
  return false if !@external_accounts_number.nil? && @external_accounts_number.to_s.length > 100
  true
end