Class: ConnectWise::ExpenseType

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExpenseType

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
166
167
168
169
170
 
# File 'lib/connectwise-ruby-sdk/models/expense_type.rb', line 104

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#_info ⇒ Object

Metadata of the entity



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

def _info
  @_info
end

#advanced_amount_flag ⇒ Object

Returns the value of attribute advanced_amount_flag.



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

def advanced_amount_flag
  @advanced_amount_flag
end

#amount_caption ⇒ Object

Returns the value of attribute amount_caption.



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

def amount_caption
  @amount_caption
end

#bill_expenses ⇒ Object

Returns the value of attribute bill_expenses.



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

def bill_expenses
  @bill_expenses
end

#external_integration_x_ref ⇒ Object

Returns the value of attribute external_integration_x_ref.



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

def external_integration_x_ref
  @external_integration_x_ref
end

#id ⇒ Object

Returns the value of attribute id.



7
8
9
 
# File 'lib/connectwise-ruby-sdk/models/expense_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/expense_type.rb', line 27

def inactive_flag
  @inactive_flag
end

#integration_x_ref ⇒ Object

Returns the value of attribute integration_x_ref.



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

def integration_x_ref
  @integration_x_ref
end

#invoice_markup_amount ⇒ Object

Returns the value of attribute invoice_markup_amount.



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

def invoice_markup_amount
  @invoice_markup_amount
end

#invoice_markup_option ⇒ Object

Returns the value of attribute invoice_markup_option.



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

def invoice_markup_option
  @invoice_markup_option
end

#max_amount ⇒ Object

Returns the value of attribute max_amount.



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

def max_amount
  @max_amount
end

#mileage_flag ⇒ Object

Returns the value of attribute mileage_flag.



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

def mileage_flag
  @mileage_flag
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#quantity_flag ⇒ Object

Returns the value of attribute quantity_flag.



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

def quantity_flag
  @quantity_flag
end

#reimbursement_rate ⇒ Object

Returns the value of attribute reimbursement_rate.



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

def reimbursement_rate
  @reimbursement_rate
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'amount_caption' => :'amountCaption',
    :'reimbursement_rate' => :'reimbursementRate',
    :'bill_expenses' => :'billExpenses',
    :'invoice_markup_option' => :'invoiceMarkupOption',
    :'invoice_markup_amount' => :'invoiceMarkupAmount',
    :'advanced_amount_flag' => :'advancedAmountFlag',
    :'mileage_flag' => :'mileageFlag',
    :'quantity_flag' => :'quantityFlag',
    :'inactive_flag' => :'inactiveFlag',
    :'max_amount' => :'maxAmount',
    :'external_integration_x_ref' => :'externalIntegrationXRef',
    :'integration_x_ref' => :'integrationXRef',
    :'_info' => :'_info'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'amount_caption' => :'String',
    :'reimbursement_rate' => :'Float',
    :'bill_expenses' => :'String',
    :'invoice_markup_option' => :'String',
    :'invoice_markup_amount' => :'Float',
    :'advanced_amount_flag' => :'BOOLEAN',
    :'mileage_flag' => :'BOOLEAN',
    :'quantity_flag' => :'BOOLEAN',
    :'inactive_flag' => :'BOOLEAN',
    :'max_amount' => :'Float',
    :'external_integration_x_ref' => :'ExternalExpenseTypeIntegrationReference',
    :'integration_x_ref' => :'String',
    :'_info' => :'Metadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/connectwise-ruby-sdk/models/expense_type.rb', line 266

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      amount_caption == o.amount_caption &&
      reimbursement_rate == o.reimbursement_rate &&
      bill_expenses == o.bill_expenses &&
      invoice_markup_option == o.invoice_markup_option &&
      invoice_markup_amount == o.invoice_markup_amount &&
      advanced_amount_flag == o.advanced_amount_flag &&
      mileage_flag == o.mileage_flag &&
      quantity_flag == o.quantity_flag &&
      inactive_flag == o.inactive_flag &&
      max_amount == o.max_amount &&
      external_integration_x_ref == o.external_integration_x_ref &&
      integration_x_ref == o.integration_x_ref &&
      _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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/connectwise-ruby-sdk/models/expense_type.rb', line 322

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



388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/connectwise-ruby-sdk/models/expense_type.rb', line 388

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



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/connectwise-ruby-sdk/models/expense_type.rb', line 301

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


288
289
290
 
# File 'lib/connectwise-ruby-sdk/models/expense_type.rb', line 288

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



294
295
296
 
# File 'lib/connectwise-ruby-sdk/models/expense_type.rb', line 294

def hash
  [id, name, amount_caption, reimbursement_rate, bill_expenses, invoice_markup_option, invoice_markup_amount, advanced_amount_flag, mileage_flag, quantity_flag, inactive_flag, max_amount, external_integration_x_ref, integration_x_ref, _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



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

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

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

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

  if @invoice_markup_option.nil?
    invalid_properties.push("invalid value for 'invoice_markup_option', invoice_markup_option 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



368
369
370
 
# File 'lib/connectwise-ruby-sdk/models/expense_type.rb', line 368

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



374
375
376
377
378
379
380
381
382
 
# File 'lib/connectwise-ruby-sdk/models/expense_type.rb', line 374

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



362
363
364
 
# File 'lib/connectwise-ruby-sdk/models/expense_type.rb', line 362

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



205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/connectwise-ruby-sdk/models/expense_type.rb', line 205

def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 30
  return false if @amount_caption.nil?
  return false if @bill_expenses.nil?
  bill_expenses_validator = EnumAttributeValidator.new('String', ["Billable", "DoNotBill", "NoCharge"])
  return false unless bill_expenses_validator.valid?(@bill_expenses)
  return false if @invoice_markup_option.nil?
  invoice_markup_option_validator = EnumAttributeValidator.new('String', ["Percent", "Amount", "Mile"])
  return false unless invoice_markup_option_validator.valid?(@invoice_markup_option)
  return false if !@integration_x_ref.nil? && @integration_x_ref.to_s.length > 50
  return true
end