Class: TripletexRubyClient::Activity

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Activity

Initializes the object

Parameters:

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

    Model attributes in the form of hash



119
120
121
122
123
124
125
126
127
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
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
# File 'lib/tripletex_ruby_client/models/activity.rb', line 119

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#activity_typeObject

PROJECT_SPECIFIC_ACTIVITY are made via project/projectactivity, as they must be part of a project.



30
31
32
# File 'lib/tripletex_ruby_client/models/activity.rb', line 30

def activity_type
  @activity_type
end

#changesObject

Returns the value of attribute changes.



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

def changes
  @changes
end

#cost_percentageObject

Returns the value of attribute cost_percentage.



47
48
49
# File 'lib/tripletex_ruby_client/models/activity.rb', line 47

def cost_percentage
  @cost_percentage
end

#descriptionObject

Returns the value of attribute description.



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

def description
  @description
end

#display_nameObject

Returns the value of attribute display_name.



49
50
51
# File 'lib/tripletex_ruby_client/models/activity.rb', line 49

def display_name
  @display_name
end

#idObject

Returns the value of attribute id.



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

def id
  @id
end

#is_chargeableObject

Returns the value of attribute is_chargeable.



43
44
45
# File 'lib/tripletex_ruby_client/models/activity.rb', line 43

def is_chargeable
  @is_chargeable
end

#is_disabledObject

Returns the value of attribute is_disabled.



41
42
43
# File 'lib/tripletex_ruby_client/models/activity.rb', line 41

def is_disabled
  @is_disabled
end

#is_generalObject

Manipulate these with ActivityType



36
37
38
# File 'lib/tripletex_ruby_client/models/activity.rb', line 36

def is_general
  @is_general
end

#is_project_activityObject

Manipulate these with ActivityType



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

def is_project_activity
  @is_project_activity
end

#is_taskObject

Manipulate these with ActivityType



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

def is_task
  @is_task
end

#nameObject

Returns the value of attribute name.



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

def name
  @name
end

#numberObject

Returns the value of attribute number.



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

def number
  @number
end

#rateObject

Returns the value of attribute rate.



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

def rate
  @rate
end

#urlObject

Returns the value of attribute url.



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

def url
  @url
end

#versionObject

Returns the value of attribute version.



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

def version
  @version
end

Class Method Details

.attribute_mapObject

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# File 'lib/tripletex_ruby_client/models/activity.rb', line 74

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'name' => :'name',
    :'number' => :'number',
    :'description' => :'description',
    :'activity_type' => :'activityType',
    :'is_project_activity' => :'isProjectActivity',
    :'is_general' => :'isGeneral',
    :'is_task' => :'isTask',
    :'is_disabled' => :'isDisabled',
    :'is_chargeable' => :'isChargeable',
    :'rate' => :'rate',
    :'cost_percentage' => :'costPercentage',
    :'display_name' => :'displayName'
  }
end

.swagger_typesObject

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# File 'lib/tripletex_ruby_client/models/activity.rb', line 96

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'name' => :'String',
    :'number' => :'String',
    :'description' => :'String',
    :'activity_type' => :'String',
    :'is_project_activity' => :'BOOLEAN',
    :'is_general' => :'BOOLEAN',
    :'is_task' => :'BOOLEAN',
    :'is_disabled' => :'BOOLEAN',
    :'is_chargeable' => :'BOOLEAN',
    :'rate' => :'Float',
    :'cost_percentage' => :'Float',
    :'display_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
# File 'lib/tripletex_ruby_client/models/activity.rb', line 249

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 &&
      description == o.description &&
      activity_type == o.activity_type &&
      is_project_activity == o.is_project_activity &&
      is_general == o.is_general &&
      is_task == o.is_task &&
      is_disabled == o.is_disabled &&
      is_chargeable == o.is_chargeable &&
      rate == o.rate &&
      cost_percentage == o.cost_percentage &&
      display_name == o.display_name
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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
# File 'lib/tripletex_ruby_client/models/activity.rb', line 306

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



372
373
374
375
376
377
378
379
380
381
382
383
384
# File 'lib/tripletex_ruby_client/models/activity.rb', line 372

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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'lib/tripletex_ruby_client/models/activity.rb', line 285

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


272
273
274
# File 'lib/tripletex_ruby_client/models/activity.rb', line 272

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



278
279
280
# File 'lib/tripletex_ruby_client/models/activity.rb', line 278

def hash
  [id, version, changes, url, name, number, description, activity_type, is_project_activity, is_general, is_task, is_disabled, is_chargeable, rate, cost_percentage, display_name].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



194
195
196
197
198
199
200
201
202
203
204
205
# File 'lib/tripletex_ruby_client/models/activity.rb', line 194

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



352
353
354
# File 'lib/tripletex_ruby_client/models/activity.rb', line 352

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



358
359
360
361
362
363
364
365
366
# File 'lib/tripletex_ruby_client/models/activity.rb', line 358

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



346
347
348
# File 'lib/tripletex_ruby_client/models/activity.rb', line 346

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



209
210
211
212
213
214
215
# File 'lib/tripletex_ruby_client/models/activity.rb', line 209

def valid?
  return false if !@name.nil? && @name.to_s.length > 255
  return false if !@number.nil? && @number.to_s.length > 100
  activity_type_validator = EnumAttributeValidator.new('String', ['GENERAL_ACTIVITY', 'PROJECT_GENERAL_ACTIVITY', 'PROJECT_SPECIFIC_ACTIVITY', 'TASK'])
  return false unless activity_type_validator.valid?(@activity_type)
  true
end