Class: ConnectWise::ExpenseType

Inherits:
Object
  • Object
show all
Defined in:
lib/connect_wise/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

Raises:

  • (ArgumentError) 


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
 
# File 'lib/connect_wise/models/expense_type.rb', line 110

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `ConnectWise::ExpenseType` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `ConnectWise::ExpenseType`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.name = attributes[:name] if attributes.key?(:name)

  self.amount_caption = attributes[:amount_caption] if attributes.key?(:amount_caption)

  self.bill_expenses = attributes[:bill_expenses] if attributes.key?(:bill_expenses)

  self.invoice_markup_option = attributes[:invoice_markup_option] if attributes.key?(:invoice_markup_option)

  self.id = attributes[:id] if attributes.key?(:id)

  self.reimbursement_rate = attributes[:reimbursement_rate] if attributes.key?(:reimbursement_rate)

  self.invoice_markup_amount = attributes[:invoice_markup_amount] if attributes.key?(:invoice_markup_amount)

  self.advanced_amount_flag = attributes[:advanced_amount_flag] if attributes.key?(:advanced_amount_flag)

  self.mileage_flag = attributes[:mileage_flag] if attributes.key?(:mileage_flag)

  self.quantity_flag = attributes[:quantity_flag] if attributes.key?(:quantity_flag)

  self.inactive_flag = attributes[:inactive_flag] if attributes.key?(:inactive_flag)

  self.max_amount = attributes[:max_amount] if attributes.key?(:max_amount)

  self.integration_x_ref = attributes[:integration_x_ref] if attributes.key?(:integration_x_ref)

  self.default_flag = attributes[:default_flag] if attributes.key?(:default_flag)

  return unless attributes.key?(:_info)
  return unless (value = attributes[:_info]).is_a?(Hash)

  self._info = value
end

Instance Attribute Details

#_info ⇒ Object

Returns the value of attribute _info.



19
20
21
 
# File 'lib/connect_wise/models/expense_type.rb', line 19

def _info
  @_info
end

#advanced_amount_flag ⇒ Object

Returns the value of attribute advanced_amount_flag.



19
20
21
 
# File 'lib/connect_wise/models/expense_type.rb', line 19

def advanced_amount_flag
  @advanced_amount_flag
end

#amount_caption ⇒ Object

Returns the value of attribute amount_caption.



19
20
21
 
# File 'lib/connect_wise/models/expense_type.rb', line 19

def amount_caption
  @amount_caption
end

#bill_expenses ⇒ Object

Returns the value of attribute bill_expenses.



19
20
21
 
# File 'lib/connect_wise/models/expense_type.rb', line 19

def bill_expenses
  @bill_expenses
end

#default_flag ⇒ Object

Returns the value of attribute default_flag.



19
20
21
 
# File 'lib/connect_wise/models/expense_type.rb', line 19

def default_flag
  @default_flag
end

#id ⇒ Object

Returns the value of attribute id.



19
20
21
 
# File 'lib/connect_wise/models/expense_type.rb', line 19

def id
  @id
end

#inactive_flag ⇒ Object

Returns the value of attribute inactive_flag.



19
20
21
 
# File 'lib/connect_wise/models/expense_type.rb', line 19

def inactive_flag
  @inactive_flag
end

#integration_x_ref ⇒ Object

Max length: 50;



22
23
24
 
# File 'lib/connect_wise/models/expense_type.rb', line 22

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/connect_wise/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.



19
20
21
 
# File 'lib/connect_wise/models/expense_type.rb', line 19

def invoice_markup_option
  @invoice_markup_option
end

#max_amount ⇒ Object

Returns the value of attribute max_amount.



19
20
21
 
# File 'lib/connect_wise/models/expense_type.rb', line 19

def max_amount
  @max_amount
end

#mileage_flag ⇒ Object

Returns the value of attribute mileage_flag.



19
20
21
 
# File 'lib/connect_wise/models/expense_type.rb', line 19

def mileage_flag
  @mileage_flag
end

#name ⇒ Object

Max length: 30;



17
18
19
 
# File 'lib/connect_wise/models/expense_type.rb', line 17

def name
  @name
end

#quantity_flag ⇒ Object

Returns the value of attribute quantity_flag.



19
20
21
 
# File 'lib/connect_wise/models/expense_type.rb', line 19

def quantity_flag
  @quantity_flag
end

#reimbursement_rate ⇒ Object

Returns the value of attribute reimbursement_rate.



19
20
21
 
# File 'lib/connect_wise/models/expense_type.rb', line 19

def reimbursement_rate
  @reimbursement_rate
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/connect_wise/models/expense_type.rb', line 67

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/connect_wise/models/expense_type.rb', line 46

def self.attribute_map
  {
    name: :name,
    amount_caption: :amountCaption,
    bill_expenses: :billExpenses,
    invoice_markup_option: :invoiceMarkupOption,
    id: :id,
    reimbursement_rate: :reimbursementRate,
    invoice_markup_amount: :invoiceMarkupAmount,
    advanced_amount_flag: :advancedAmountFlag,
    mileage_flag: :mileageFlag,
    quantity_flag: :quantityFlag,
    inactive_flag: :inactiveFlag,
    max_amount: :maxAmount,
    integration_x_ref: :integrationXRef,
    default_flag: :defaultFlag,
    _info: :_info
  }
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



236
237
238
 
# File 'lib/connect_wise/models/expense_type.rb', line 236

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/connect_wise/models/expense_type.rb', line 93

def self.openapi_nullable
  Set.new(i[
            bill_expenses
            invoice_markup_option
            reimbursement_rate
            invoice_markup_amount
            advanced_amount_flag
            mileage_flag
            quantity_flag
            inactive_flag
            max_amount
            default_flag
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/connect_wise/models/expense_type.rb', line 72

def self.openapi_types
  {
    name: :String,
    amount_caption: :String,
    bill_expenses: :String,
    invoice_markup_option: :String,
    id: :Integer,
    reimbursement_rate: :Float,
    invoice_markup_amount: :Float,
    advanced_amount_flag: :Boolean,
    mileage_flag: :Boolean,
    quantity_flag: :Boolean,
    inactive_flag: :Boolean,
    max_amount: :Float,
    integration_x_ref: :String,
    default_flag: :Boolean,
    _info: :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/connect_wise/models/expense_type.rb', line 200

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    name == other.name &&
    amount_caption == other.amount_caption &&
    bill_expenses == other.bill_expenses &&
    invoice_markup_option == other.invoice_markup_option &&
    id == other.id &&
    reimbursement_rate == other.reimbursement_rate &&
    invoice_markup_amount == other.invoice_markup_amount &&
    advanced_amount_flag == other.advanced_amount_flag &&
    mileage_flag == other.mileage_flag &&
    quantity_flag == other.quantity_flag &&
    inactive_flag == other.inactive_flag &&
    max_amount == other.max_amount &&
    integration_x_ref == other.integration_x_ref &&
    default_flag == other.default_flag &&
    _info == other._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



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
 
# File 'lib/connect_wise/models/expense_type.rb', line 266

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = ConnectWise.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/connect_wise/models/expense_type.rb', line 337

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/connect_wise/models/expense_type.rb', line 243

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    elsif 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
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


223
224
225
 
# File 'lib/connect_wise/models/expense_type.rb', line 223

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



229
230
231
 
# File 'lib/connect_wise/models/expense_type.rb', line 229

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



156
157
158
159
160
161
162
163
 
# File 'lib/connect_wise/models/expense_type.rb', line 156

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "name", name cannot be nil.') if @name.nil?

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

  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



313
314
315
 
# File 'lib/connect_wise/models/expense_type.rb', line 313

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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/connect_wise/models/expense_type.rb', line 319

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



307
308
309
 
# File 'lib/connect_wise/models/expense_type.rb', line 307

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



167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/connect_wise/models/expense_type.rb', line 167

def valid?
  return false if @name.nil?
  return false if @amount_caption.nil?

  bill_expenses_validator = EnumAttributeValidator.new('String', %w[Billable DoNotBill NoCharge NoDefault])
  return false unless bill_expenses_validator.valid?(@bill_expenses)

  invoice_markup_option_validator = EnumAttributeValidator.new('String', %w[Amount Mile Percent])
  return false unless invoice_markup_option_validator.valid?(@invoice_markup_option)

  true
end