Class: FattureInCloud_Ruby_Sdk::CashbookEntry

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CashbookEntry

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 125

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount_in ⇒ Object

Only for cashbook entry in

Cashbook total amount in



37
38
39
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 37

def amount_in
  @amount_in
end

#amount_out ⇒ Object

Only for cashbook entry out

Cashbook total amount out



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

def amount_out
  @amount_out
end

#date ⇒ Object

Cashbook date



22
23
24
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 22

def date
  @date
end

#description ⇒ Object

Cashbook description



25
26
27
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 25

def description
  @description
end

#document ⇒ Object

Returns the value of attribute document.



34
35
36
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 34

def document
  @document
end

#entity_name ⇒ Object

Cashbook entity name



32
33
34
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 32

def entity_name
  @entity_name
end

#id ⇒ Object

Cashbook id



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

def id
  @id
end

#kind ⇒ Object

Returns the value of attribute kind.



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

def kind
  @kind
end

#payment_account_in ⇒ Object

Returns the value of attribute payment_account_in.



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

def 
  @payment_account_in
end

#payment_account_out ⇒ Object

Returns the value of attribute payment_account_out.



44
45
46
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 44

def 
  @payment_account_out
end

#type ⇒ Object

Returns the value of attribute type.



29
30
31
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 29

def type
  @type
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



255
256
257
258
259
260
261
262
263
264
265
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
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 255

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



86
87
88
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 86

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 69

def self.attribute_map
  {
    :'id' => :'id',
    :'date' => :'date',
    :'description' => :'description',
    :'kind' => :'kind',
    :'type' => :'type',
    :'entity_name' => :'entity_name',
    :'document' => :'document',
    :'amount_in' => :'amount_in',
    :'payment_account_in' => :'payment_account_in',
    :'amount_out' => :'amount_out',
    :'payment_account_out' => :'payment_account_out'
  }
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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 231

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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 108

def self.openapi_nullable
  Set.new([
    :'id',
    :'date',
    :'description',
    :'type',
    :'entity_name',
    :'document',
    :'amount_in',
    :'payment_account_in',
    :'amount_out',
    :'payment_account_out'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 91

def self.openapi_types
  {
    :'id' => :'String',
    :'date' => :'Date',
    :'description' => :'String',
    :'kind' => :'CashbookEntryKind',
    :'type' => :'CashbookEntryType',
    :'entity_name' => :'String',
    :'document' => :'CashbookEntryDocument',
    :'amount_in' => :'Float',
    :'payment_account_in' => :'PaymentAccount',
    :'amount_out' => :'Float',
    :'payment_account_out' => :'PaymentAccount'
  }
end

Instance Method Details

#==(o) ⇒ 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
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 200

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      date == o.date &&
      description == o.description &&
      kind == o.kind &&
      type == o.type &&
      entity_name == o.entity_name &&
      document == o.document &&
      amount_in == o.amount_in &&
       == o. &&
      amount_out == o.amount_out &&
       == o.
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



328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 328

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


218
219
220
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 218

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



224
225
226
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 224

def hash
  [id, date, description, kind, type, entity_name, document, amount_in, , amount_out, ].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



185
186
187
188
189
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 185

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



304
305
306
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 304

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



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 310

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



298
299
300
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 298

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



193
194
195
196
 
# File 'lib/fattureincloud_ruby_sdk/models/cashbook_entry.rb', line 193

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