Class: ConnectWise::WorkType

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/models/work_type.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkType

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 117

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#_info ⇒ Object

Metadata of the entity



43
44
45
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 43

def _info
  @_info
end

#accrual_type ⇒ Object

Returns the value of attribute accrual_type.



25
26
27
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 25

def accrual_type
  @accrual_type
end

#activity_default_flag ⇒ Object

Returns the value of attribute activity_default_flag.



31
32
33
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 31

def activity_default_flag
  @activity_default_flag
end

#add_all_agreement_exclusions ⇒ Object

Used only on create to add the work type to all agreement and agreement type exclusion lists



40
41
42
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 40

def add_all_agreement_exclusions
  @add_all_agreement_exclusions
end

#bill_time ⇒ Object

Returns the value of attribute bill_time.



11
12
13
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 11

def bill_time
  @bill_time
end

#cost_multiplier ⇒ Object

Returns the value of attribute cost_multiplier.



35
36
37
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 35

def cost_multiplier
  @cost_multiplier
end

#external_integration_x_ref ⇒ Object

Returns the value of attribute external_integration_x_ref.



23
24
25
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 23

def external_integration_x_ref
  @external_integration_x_ref
end

#hours_max ⇒ Object

Returns the value of attribute hours_max.



19
20
21
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 19

def hours_max
  @hours_max
end

#hours_min ⇒ Object

Returns the value of attribute hours_min.



17
18
19
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 17

def hours_min
  @hours_min
end

#id ⇒ Object

Returns the value of attribute id.



7
8
9
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 7

def id
  @id
end

#inactive_flag ⇒ Object

Returns the value of attribute inactive_flag.



27
28
29
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 27

def inactive_flag
  @inactive_flag
end

#integration_x_ref ⇒ Object

Returns the value of attribute integration_x_ref.



37
38
39
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 37

def integration_x_ref
  @integration_x_ref
end

#name ⇒ Object

Returns the value of attribute name.



9
10
11
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 9

def name
  @name
end

#overall_default_flag ⇒ Object

Returns the value of attribute overall_default_flag.



29
30
31
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 29

def overall_default_flag
  @overall_default_flag
end

#rate ⇒ Object

Returns the value of attribute rate.



15
16
17
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 15

def rate
  @rate
end

#rate_type ⇒ Object

Returns the value of attribute rate_type.



13
14
15
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 13

def rate_type
  @rate_type
end

#round_bill_hours_to ⇒ Object

Returns the value of attribute round_bill_hours_to.



21
22
23
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 21

def round_bill_hours_to
  @round_bill_hours_to
end

#utilization_flag ⇒ Object

Returns the value of attribute utilization_flag.



33
34
35
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 33

def utilization_flag
  @utilization_flag
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 68

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'bill_time' => :'billTime',
    :'rate_type' => :'rateType',
    :'rate' => :'rate',
    :'hours_min' => :'hoursMin',
    :'hours_max' => :'hoursMax',
    :'round_bill_hours_to' => :'roundBillHoursTo',
    :'external_integration_x_ref' => :'externalIntegrationXRef',
    :'accrual_type' => :'accrualType',
    :'inactive_flag' => :'inactiveFlag',
    :'overall_default_flag' => :'overallDefaultFlag',
    :'activity_default_flag' => :'activityDefaultFlag',
    :'utilization_flag' => :'utilizationFlag',
    :'cost_multiplier' => :'costMultiplier',
    :'integration_x_ref' => :'integrationXRef',
    :'add_all_agreement_exclusions' => :'addAllAgreementExclusions',
    :'_info' => :'_info'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 92

def self.swagger_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'bill_time' => :'String',
    :'rate_type' => :'String',
    :'rate' => :'Float',
    :'hours_min' => :'Float',
    :'hours_max' => :'Float',
    :'round_bill_hours_to' => :'Float',
    :'external_integration_x_ref' => :'ExternalWorkTypeIntegrationReference',
    :'accrual_type' => :'String',
    :'inactive_flag' => :'BOOLEAN',
    :'overall_default_flag' => :'BOOLEAN',
    :'activity_default_flag' => :'BOOLEAN',
    :'utilization_flag' => :'BOOLEAN',
    :'cost_multiplier' => :'Float',
    :'integration_x_ref' => :'String',
    :'add_all_agreement_exclusions' => :'BOOLEAN',
    :'_info' => :'Metadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 303

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      bill_time == o.bill_time &&
      rate_type == o.rate_type &&
      rate == o.rate &&
      hours_min == o.hours_min &&
      hours_max == o.hours_max &&
      round_bill_hours_to == o.round_bill_hours_to &&
      external_integration_x_ref == o.external_integration_x_ref &&
      accrual_type == o.accrual_type &&
      inactive_flag == o.inactive_flag &&
      overall_default_flag == o.overall_default_flag &&
      activity_default_flag == o.activity_default_flag &&
      utilization_flag == o.utilization_flag &&
      cost_multiplier == o.cost_multiplier &&
      integration_x_ref == o.integration_x_ref &&
      add_all_agreement_exclusions == o.add_all_agreement_exclusions &&
      _info == o._info
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



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 362

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



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 428

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



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 341

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


328
329
330
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 328

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



334
335
336
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 334

def hash
  [id, name, bill_time, rate_type, rate, hours_min, hours_max, round_bill_hours_to, external_integration_x_ref, accrual_type, inactive_flag, overall_default_flag, activity_default_flag, utilization_flag, cost_multiplier, integration_x_ref, add_all_agreement_exclusions, _info].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



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
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 199

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 > 50
    invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 50.")
  end

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

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

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

  if !@integration_x_ref.nil? && @integration_x_ref.to_s.length > 50
    invalid_properties.push("invalid value for 'integration_x_ref', the character length must be smaller than or equal to 50.")
  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



408
409
410
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 408

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



414
415
416
417
418
419
420
421
422
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 414

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



402
403
404
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 402

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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/connectwise-ruby-sdk/models/work_type.rb', line 230

def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 50
  return false if @bill_time.nil?
  bill_time_validator = EnumAttributeValidator.new('String', ["Billable", "DoNotBill", "NoCharge"])
  return false unless bill_time_validator.valid?(@bill_time)
  return false if @rate_type.nil?
  rate_type_validator = EnumAttributeValidator.new('String', ["AdjAmount", "Custom", "Multiplier"])
  return false unless rate_type_validator.valid?(@rate_type)
  return false if @rate.nil?
  accrual_type_validator = EnumAttributeValidator.new('String', ["Holiday", "PTO", "Sick", "Vacation"])
  return false unless accrual_type_validator.valid?(@accrual_type)
  return false if !@integration_x_ref.nil? && @integration_x_ref.to_s.length > 50
  return true
end