Class: MergeAccountingClient::CreditNoteLineItem

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_accounting_client/models/credit_note_line_item.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreditNoteLineItem

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
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 119

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MergeAccountingClient::CreditNoteLineItem` initialize method"
  end

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

  if attributes.key?(:'item')
    self.item = attributes[:'item']
  end

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

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'quantity')
    self.quantity = attributes[:'quantity']
  end

  if attributes.key?(:'memo')
    self.memo = attributes[:'memo']
  end

  if attributes.key?(:'unit_price')
    self.unit_price = attributes[:'unit_price']
  end

  if attributes.key?(:'tax_rate')
    self.tax_rate = attributes[:'tax_rate']
  end

  if attributes.key?(:'total_line_amount')
    self.total_line_amount = attributes[:'total_line_amount']
  end

  if attributes.key?(:'tracking_category')
    self.tracking_category = attributes[:'tracking_category']
  end

  if attributes.key?(:'tracking_categories')
    if (value = attributes[:'tracking_categories']).is_a?(Array)
      self.tracking_categories = value
    end
  end

  if attributes.key?(:'account')
    self. = attributes[:'account']
  end

  if attributes.key?(:'company')
    self.company = attributes[:'company']
  end

  if attributes.key?(:'remote_id')
    self.remote_id = attributes[:'remote_id']
  end
end

Instance Attribute Details

#account ⇒ Object

The credit note line item’s account.



48
49
50
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 48

def 
  @account
end

#company ⇒ Object

The company the credit note belongs to.



51
52
53
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 51

def company
  @company
end

#description ⇒ Object

The description of the item that is owed.



24
25
26
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 24

def description
  @description
end

#item ⇒ Object

Returns the value of attribute item.



18
19
20
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 18

def item
  @item
end

#memo ⇒ Object

The credit note line item’s memo.



30
31
32
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 30

def memo
  @memo
end

#name ⇒ Object

The credit note line item’s name.



21
22
23
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 21

def name
  @name
end

#quantity ⇒ Object

The credit note line item’s quantity.



27
28
29
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 27

def quantity
  @quantity
end

#remote_id ⇒ Object

The third-party API ID of the matching object.



54
55
56
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 54

def remote_id
  @remote_id
end

#tax_rate ⇒ Object

The credit note line item’s tax rate.



36
37
38
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 36

def tax_rate
  @tax_rate
end

#total_line_amount ⇒ Object

The credit note line item’s total.



39
40
41
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 39

def total_line_amount
  @total_line_amount
end

#tracking_categories ⇒ Object

The credit note line item’s associated tracking categories.



45
46
47
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 45

def tracking_categories
  @tracking_categories
end

#tracking_category ⇒ Object

The credit note line item’s associated tracking category.



42
43
44
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 42

def tracking_category
  @tracking_category
end

#unit_price ⇒ Object

The credit note line item’s unit price.



33
34
35
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 33

def unit_price
  @unit_price
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 57

def self.attribute_map
  {
    :'item' => :'item',
    :'name' => :'name',
    :'description' => :'description',
    :'quantity' => :'quantity',
    :'memo' => :'memo',
    :'unit_price' => :'unit_price',
    :'tax_rate' => :'tax_rate',
    :'total_line_amount' => :'total_line_amount',
    :'tracking_category' => :'tracking_category',
    :'tracking_categories' => :'tracking_categories',
    :'account' => :'account',
    :'company' => :'company',
    :'remote_id' => :'remote_id'
  }
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



291
292
293
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 291

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 100

def self.openapi_nullable
  Set.new([
    :'item',
    :'name',
    :'description',
    :'quantity',
    :'memo',
    :'unit_price',
    :'tax_rate',
    :'total_line_amount',
    :'tracking_category',
    :'account',
    :'company',
    :'remote_id'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 81

def self.openapi_types
  {
    :'item' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'quantity' => :'String',
    :'memo' => :'String',
    :'unit_price' => :'String',
    :'tax_rate' => :'String',
    :'total_line_amount' => :'String',
    :'tracking_category' => :'String',
    :'tracking_categories' => :'Array<String>',
    :'account' => :'String',
    :'company' => :'String',
    :'remote_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 258

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      item == o.item &&
      name == o.name &&
      description == o.description &&
      quantity == o.quantity &&
      memo == o.memo &&
      unit_price == o.unit_price &&
      tax_rate == o.tax_rate &&
      total_line_amount == o.total_line_amount &&
      tracking_category == o.tracking_category &&
      tracking_categories == o.tracking_categories &&
       == o. &&
      company == o.company &&
      remote_id == o.remote_id
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



321
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/merge_accounting_client/models/credit_note_line_item.rb', line 321

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value
  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 = MergeAccountingClient.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



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 392

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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 298

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.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
      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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


278
279
280
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 278

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



284
285
286
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 284

def hash
  [item, name, description, quantity, memo, unit_price, tax_rate, total_line_amount, tracking_category, tracking_categories, , company, remote_id].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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 189

def list_invalid_properties
  invalid_properties = Array.new
  pattern = Regexp.new(/^-?\d{0,24}(?:\.\d{0,8})?$/)
  if !@quantity.nil? && @quantity.to_s !~ pattern
    invalid_properties.push("invalid value for \"quantity\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^-?\d{0,32}(?:\.\d{0,16})?$/)
  if !@unit_price.nil? && @unit_price.to_s !~ pattern
    invalid_properties.push("invalid value for \"unit_price\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^-?\d{0,32}(?:\.\d{0,16})?$/)
  if !@total_line_amount.nil? && @total_line_amount.to_s !~ pattern
    invalid_properties.push("invalid value for \"total_line_amount\", must conform to the pattern #{pattern}.")
  end

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

  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/merge_accounting_client/models/credit_note_line_item.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
383
384
385
386
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 374

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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



362
363
364
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.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



215
216
217
218
219
220
221
 
# File 'lib/merge_accounting_client/models/credit_note_line_item.rb', line 215

def valid?
  return false if !@quantity.nil? && @quantity.to_s !~ Regexp.new(/^-?\d{0,24}(?:\.\d{0,8})?$/)
  return false if !@unit_price.nil? && @unit_price.to_s !~ Regexp.new(/^-?\d{0,32}(?:\.\d{0,16})?$/)
  return false if !@total_line_amount.nil? && @total_line_amount.to_s !~ Regexp.new(/^-?\d{0,32}(?:\.\d{0,16})?$/)
  return false if @tracking_categories.nil?
  true
end