Class: FactPulse::SimplifiedInvoiceData

Inherits:
ApiModelBase show all
Defined in:
lib/factpulse/models/simplified_invoice_data.rb

Overview

Simplified invoice data (minimal format for auto-enrichment).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ SimplifiedInvoiceData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



94
95
96
97
98
99
100
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
 
# File 'lib/factpulse/models/simplified_invoice_data.rb', line 94

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

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

  if attributes.key?(:'number')
    self.number = attributes[:'number']
  else
    self.number = nil
  end

  if attributes.key?(:'supplier')
    if (value = attributes[:'supplier']).is_a?(Hash)
      self.supplier = value
    end
  else
    self.supplier = nil
  end

  if attributes.key?(:'recipient')
    if (value = attributes[:'recipient']).is_a?(Hash)
      self.recipient = value
    end
  else
    self.recipient = nil
  end

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

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

  if attributes.key?(:'due_days')
    self.due_days = attributes[:'due_days']
  else
    self.due_days = 30
  end

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

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

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

Instance Attribute Details

#comment ⇒ Object

Returns the value of attribute comment.



36
37
38
 
# File 'lib/factpulse/models/simplified_invoice_data.rb', line 36

def comment
  @comment
end

#contract_reference ⇒ Object

Returns the value of attribute contract_reference.



40
41
42
 
# File 'lib/factpulse/models/simplified_invoice_data.rb', line 40

def contract_reference
  @contract_reference
end

#date ⇒ Object

Returns the value of attribute date.



31
32
33
 
# File 'lib/factpulse/models/simplified_invoice_data.rb', line 31

def date
  @date
end

#due_days ⇒ Object

Due date in days (default: 30)



34
35
36
 
# File 'lib/factpulse/models/simplified_invoice_data.rb', line 34

def due_days
  @due_days
end

#lines ⇒ Object

Invoice lines



29
30
31
 
# File 'lib/factpulse/models/simplified_invoice_data.rb', line 29

def lines
  @lines
end

#number ⇒ Object

Unique invoice number



20
21
22
 
# File 'lib/factpulse/models/simplified_invoice_data.rb', line 20

def number
  @number
end

#purchase_order_reference ⇒ Object

Returns the value of attribute purchase_order_reference.



38
39
40
 
# File 'lib/factpulse/models/simplified_invoice_data.rb', line 38

def purchase_order_reference
  @purchase_order_reference
end

#recipient ⇒ Object

Recipient information (siret, …)



26
27
28
 
# File 'lib/factpulse/models/simplified_invoice_data.rb', line 26

def recipient
  @recipient
end

#supplier ⇒ Object

Supplier information (siret, iban, …)



23
24
25
 
# File 'lib/factpulse/models/simplified_invoice_data.rb', line 23

def supplier
  @supplier
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



58
59
60
 
# File 'lib/factpulse/models/simplified_invoice_data.rb', line 58

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



63
64
65
 
# File 'lib/factpulse/models/simplified_invoice_data.rb', line 63

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/factpulse/models/simplified_invoice_data.rb', line 43

def self.attribute_map
  {
    :'number' => :'number',
    :'supplier' => :'supplier',
    :'recipient' => :'recipient',
    :'lines' => :'lines',
    :'date' => :'date',
    :'due_days' => :'dueDays',
    :'comment' => :'comment',
    :'purchase_order_reference' => :'purchaseOrderReference',
    :'contract_reference' => :'contractReference'
  }
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



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/factpulse/models/simplified_invoice_data.rb', line 304

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



83
84
85
86
87
88
89
90
 
# File 'lib/factpulse/models/simplified_invoice_data.rb', line 83

def self.openapi_nullable
  Set.new([
    :'date',
    :'comment',
    :'purchase_order_reference',
    :'contract_reference'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/factpulse/models/simplified_invoice_data.rb', line 68

def self.openapi_types
  {
    :'number' => :'String',
    :'supplier' => :'Hash<String, Object>',
    :'recipient' => :'Hash<String, Object>',
    :'lines' => :'Array<Hash<String, Object>>',
    :'date' => :'String',
    :'due_days' => :'Integer',
    :'comment' => :'String',
    :'purchase_order_reference' => :'String',
    :'contract_reference' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/factpulse/models/simplified_invoice_data.rb', line 275

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      number == o.number &&
      supplier == o.supplier &&
      recipient == o.recipient &&
      lines == o.lines &&
      date == o.date &&
      due_days == o.due_days &&
      comment == o.comment &&
      purchase_order_reference == o.purchase_order_reference &&
      contract_reference == o.contract_reference
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


291
292
293
 
# File 'lib/factpulse/models/simplified_invoice_data.rb', line 291

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



297
298
299
 
# File 'lib/factpulse/models/simplified_invoice_data.rb', line 297

def hash
  [number, supplier, recipient, lines, date, due_days, comment, purchase_order_reference, contract_reference].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



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/factpulse/models/simplified_invoice_data.rb', line 163

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @number.nil?
    invalid_properties.push('invalid value for "number", number cannot be nil.')
  end

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

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

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

  if @lines.length < 1
    invalid_properties.push('invalid value for "lines", number of items must be greater than or equal to 1.')
  end

  if !@due_days.nil? && @due_days > 365
    invalid_properties.push('invalid value for "due_days", must be smaller than or equal to 365.')
  end

  if !@due_days.nil? && @due_days < 0
    invalid_properties.push('invalid value for "due_days", must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/factpulse/models/simplified_invoice_data.rb', line 326

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/factpulse/models/simplified_invoice_data.rb', line 199

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @number.nil?
  return false if @supplier.nil?
  return false if @recipient.nil?
  return false if @lines.nil?
  return false if @lines.length < 1
  return false if !@due_days.nil? && @due_days > 365
  return false if !@due_days.nil? && @due_days < 0
  true
end