Class: FattureInCloud_Ruby_Sdk::IssuedDocumentEiData

Inherits:
Object
  • Object
show all
Defined in:
lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb

Overview

Issued document e-invoice data [Only if e_invoice=true]

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IssuedDocumentEiData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 136

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FattureInCloud_Ruby_Sdk::IssuedDocumentEiData` 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 `FattureInCloud_Ruby_Sdk::IssuedDocumentEiData`. 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?(:'vat_kind')
    self.vat_kind = attributes[:'vat_kind']
  end

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#bank_beneficiary ⇒ Object

E-invoice bank beneficiary



45
46
47
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 45

def bank_beneficiary
  @bank_beneficiary
end

#bank_iban ⇒ Object

E-invoice bank IBAN



42
43
44
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 42

def bank_iban
  @bank_iban
end

#bank_name ⇒ Object

E-invoice bank name



39
40
41
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 39

def bank_name
  @bank_name
end

#cig ⇒ Object

E-invoice CIG



30
31
32
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 30

def cig
  @cig
end

#cup ⇒ Object

E-invoice CUP



33
34
35
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 33

def cup
  @cup
end

#invoice_date ⇒ Object

E-invoice invoice date



51
52
53
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 51

def invoice_date
  @invoice_date
end

#invoice_number ⇒ Object

E-invoice invoice number



48
49
50
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 48

def invoice_number
  @invoice_number
end

#od_date ⇒ Object

E-invoice original document date



27
28
29
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 27

def od_date
  @od_date
end

#od_number ⇒ Object

E-invoice original document number



24
25
26
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 24

def od_number
  @od_number
end

#original_document_type ⇒ Object

Returns the value of attribute original_document_type.



21
22
23
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 21

def original_document_type
  @original_document_type
end

#payment_method ⇒ Object

E-invoice payment method [required for e-invoices] (see [here](www.fatturapa.gov.it/export/documenti/fatturapa/v1.2.2/Rappresentazione_Tabellare_FattOrdinaria_V1.2.2.pdf) for the accepted values of ModalitaPagamento)



36
37
38
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 36

def payment_method
  @payment_method
end

#vat_kind ⇒ Object

Returns the value of attribute vat_kind.



19
20
21
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 19

def vat_kind
  @vat_kind
end

Class Method Details

._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



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
304
305
306
307
308
309
310
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 271

def self._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
  when :Hash
    value
  else # model
    # models (e.g. Pet) or oneOf
    klass = FattureInCloud_Ruby_Sdk.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



94
95
96
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 94

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 76

def self.attribute_map
  {
    :'vat_kind' => :'vat_kind',
    :'original_document_type' => :'original_document_type',
    :'od_number' => :'od_number',
    :'od_date' => :'od_date',
    :'cig' => :'cig',
    :'cup' => :'cup',
    :'payment_method' => :'payment_method',
    :'bank_name' => :'bank_name',
    :'bank_iban' => :'bank_iban',
    :'bank_beneficiary' => :'bank_beneficiary',
    :'invoice_number' => :'invoice_number',
    :'invoice_date' => :'invoice_date'
  }
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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 247

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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 117

def self.openapi_nullable
  Set.new([
    :'vat_kind',
    :'original_document_type',
    :'od_number',
    :'od_date',
    :'cig',
    :'cup',
    :'payment_method',
    :'bank_name',
    :'bank_iban',
    :'bank_beneficiary',
    :'invoice_number',
    :'invoice_date'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'vat_kind' => :'VatKind',
    :'original_document_type' => :'OriginalDocumentType',
    :'od_number' => :'String',
    :'od_date' => :'Date',
    :'cig' => :'String',
    :'cup' => :'String',
    :'payment_method' => :'String',
    :'bank_name' => :'String',
    :'bank_iban' => :'String',
    :'bank_beneficiary' => :'String',
    :'invoice_number' => :'String',
    :'invoice_date' => :'Date'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 215

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      vat_kind == o.vat_kind &&
      original_document_type == o.original_document_type &&
      od_number == o.od_number &&
      od_date == o.od_date &&
      cig == o.cig &&
      cup == o.cup &&
      payment_method == o.payment_method &&
      bank_name == o.bank_name &&
      bank_iban == o.bank_iban &&
      bank_beneficiary == o.bank_beneficiary &&
      invoice_number == o.invoice_number &&
      invoice_date == o.invoice_date
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



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 344

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


234
235
236
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 234

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



240
241
242
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 240

def hash
  [vat_kind, original_document_type, od_number, od_date, cig, cup, payment_method, bank_name, bank_iban, bank_beneficiary, invoice_number, invoice_date].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



200
201
202
203
204
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 200

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



320
321
322
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 320

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



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



314
315
316
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 314

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



208
209
210
211
 
# File 'lib/fattureincloud_ruby_sdk/models/issued_document_ei_data.rb', line 208

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end