Class: ConnectWise::ChargeCode

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChargeCode

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#_info ⇒ Object

Metadata of the entity



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

def _info
  @_info
end

#allow_all_expense_type_flag ⇒ Object

Returns the value of attribute allow_all_expense_type_flag.



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

def allow_all_expense_type_flag
  @allow_all_expense_type_flag
end

#bill_time ⇒ Object

Returns the value of attribute bill_time.



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

def bill_time
  @bill_time
end

#company ⇒ Object

Returns the value of attribute company.



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

def company
  @company
end

#department ⇒ Object

Returns the value of attribute department.



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

def department
  @department
end

#expense_entry_flag ⇒ Object

Returns the value of attribute expense_entry_flag.



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

def expense_entry_flag
  @expense_entry_flag
end

#expense_type_ids ⇒ Object

Returns the value of attribute expense_type_ids.



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

def expense_type_ids
  @expense_type_ids
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#integration_xref ⇒ Object

Returns the value of attribute integration_xref.



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

def integration_xref
  @integration_xref
end

#location ⇒ Object

Returns the value of attribute location.



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

def location
  @location
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#time_entry_flag ⇒ Object

Returns the value of attribute time_entry_flag.



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

def time_entry_flag
  @time_entry_flag
end

#work_role ⇒ Object

Returns the value of attribute work_role.



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

def work_role
  @work_role
end

#work_type ⇒ Object

on UPDATE, if timeEntryFlag is set to true, workType will be required.



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

def work_type
  @work_type
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/connectwise-ruby-sdk/models/charge_code.rb', line 60

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'company' => :'company',
    :'location' => :'location',
    :'department' => :'department',
    :'bill_time' => :'billTime',
    :'expense_entry_flag' => :'expenseEntryFlag',
    :'allow_all_expense_type_flag' => :'allowAllExpenseTypeFlag',
    :'time_entry_flag' => :'timeEntryFlag',
    :'work_type' => :'workType',
    :'work_role' => :'workRole',
    :'integration_xref' => :'integrationXref',
    :'expense_type_ids' => :'expenseTypeIds',
    :'_info' => :'_info'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/connectwise-ruby-sdk/models/charge_code.rb', line 80

def self.swagger_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'company' => :'CompanyReference',
    :'location' => :'SystemLocationReference',
    :'department' => :'SystemDepartmentReference',
    :'bill_time' => :'String',
    :'expense_entry_flag' => :'BOOLEAN',
    :'allow_all_expense_type_flag' => :'BOOLEAN',
    :'time_entry_flag' => :'BOOLEAN',
    :'work_type' => :'WorkTypeReference',
    :'work_role' => :'WorkRoleReference',
    :'integration_xref' => :'String',
    :'expense_type_ids' => :'Array<Integer>',
    :'_info' => :'Metadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/connectwise-ruby-sdk/models/charge_code.rb', line 239

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      company == o.company &&
      location == o.location &&
      department == o.department &&
      bill_time == o.bill_time &&
      expense_entry_flag == o.expense_entry_flag &&
      allow_all_expense_type_flag == o.allow_all_expense_type_flag &&
      time_entry_flag == o.time_entry_flag &&
      work_type == o.work_type &&
      work_role == o.work_role &&
      integration_xref == o.integration_xref &&
      expense_type_ids == o.expense_type_ids &&
      _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



294
295
296
297
298
299
300
301
302
303
304
305
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
 
# File 'lib/connectwise-ruby-sdk/models/charge_code.rb', line 294

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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/connectwise-ruby-sdk/models/charge_code.rb', line 360

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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/connectwise-ruby-sdk/models/charge_code.rb', line 273

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


260
261
262
 
# File 'lib/connectwise-ruby-sdk/models/charge_code.rb', line 260

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



266
267
268
 
# File 'lib/connectwise-ruby-sdk/models/charge_code.rb', line 266

def hash
  [id, name, company, location, department, bill_time, expense_entry_flag, allow_all_expense_type_flag, time_entry_flag, work_type, work_role, integration_xref, expense_type_ids, _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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/connectwise-ruby-sdk/models/charge_code.rb', line 169

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 @company.nil?
    invalid_properties.push("invalid value for 'company', company cannot be nil.")
  end

  if !@integration_xref.nil? && @integration_xref.to_s.length > 50
    invalid_properties.push("invalid value for 'integration_xref', 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



340
341
342
 
# File 'lib/connectwise-ruby-sdk/models/charge_code.rb', line 340

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



346
347
348
349
350
351
352
353
354
 
# File 'lib/connectwise-ruby-sdk/models/charge_code.rb', line 346

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



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

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



192
193
194
195
196
197
198
199
200
 
# File 'lib/connectwise-ruby-sdk/models/charge_code.rb', line 192

def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 50
  return false if @company.nil?
  bill_time_validator = EnumAttributeValidator.new('String', ["Billable", "DoNotBill", "NoCharge", "NoDefault"])
  return false unless bill_time_validator.valid?(@bill_time)
  return false if !@integration_xref.nil? && @integration_xref.to_s.length > 50
  return true
end