Class: KoronaCloudClient::VoucherTransaction

Inherits:
Object
  • Object
show all
Defined in:
lib/korona-cloud-client/models/voucher_transaction.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VoucherTransaction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
160
161
162
163
164
165
166
167
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 109

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amountObject

Returns the value of attribute amount.



18
19
20
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 18

def amount
  @amount
end

#booking_timeObject

Returns the value of attribute booking_time.



20
21
22
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 20

def booking_time
  @booking_time
end

#cashierObject

Returns the value of attribute cashier.



22
23
24
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 22

def cashier
  @cashier
end

#commentObject

Returns the value of attribute comment.



24
25
26
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 24

def comment
  @comment
end

#external_referencesObject

Returns the value of attribute external_references.



34
35
36
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 34

def external_references
  @external_references
end

#priceObject

Returns the value of attribute price.



26
27
28
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 26

def price
  @price
end

#transaction_typeObject

Returns the value of attribute transaction_type.



28
29
30
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 28

def transaction_type
  @transaction_type
end

#userObject

Returns the value of attribute user.



30
31
32
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 30

def user
  @user
end

#voidedObject

Returns the value of attribute voided.



36
37
38
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 36

def voided
  @voided
end

#voucherObject

Returns the value of attribute voucher.



32
33
34
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 32

def voucher
  @voucher
end

#voucher_configurationObject

Returns the value of attribute voucher_configuration.



38
39
40
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 38

def voucher_configuration
  @voucher_configuration
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



80
81
82
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 80

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 63

def self.attribute_map
  {
    :'amount' => :'amount',
    :'booking_time' => :'bookingTime',
    :'cashier' => :'cashier',
    :'comment' => :'comment',
    :'price' => :'price',
    :'transaction_type' => :'transactionType',
    :'user' => :'user',
    :'voucher' => :'voucher',
    :'external_references' => :'externalReferences',
    :'voided' => :'voided',
    :'voucher_configuration' => :'voucherConfiguration'
  }
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



227
228
229
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 227

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

.openapi_nullableObject

List of attributes with nullable: true



102
103
104
105
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 102

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 85

def self.openapi_types
  {
    :'amount' => :'Float',
    :'booking_time' => :'Time',
    :'cashier' => :'ModelReference',
    :'comment' => :'String',
    :'price' => :'Float',
    :'transaction_type' => :'String',
    :'user' => :'ModelReference',
    :'voucher' => :'ModelReference',
    :'external_references' => :'Hash<String, String>',
    :'voided' => :'Boolean',
    :'voucher_configuration' => :'ModelReference'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 196

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      booking_time == o.booking_time &&
      cashier == o.cashier &&
      comment == o.comment &&
      price == o.price &&
      transaction_type == o.transaction_type &&
      user == o.user &&
      voucher == o.voucher &&
      external_references == o.external_references &&
      voided == o.voided &&
      voucher_configuration == o.voucher_configuration
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



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
295
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 258

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 = KoronaCloudClient.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



329
330
331
332
333
334
335
336
337
338
339
340
341
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 329

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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 234

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)
      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


214
215
216
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 214

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



220
221
222
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 220

def hash
  [amount, booking_time, cashier, comment, price, transaction_type, user, voucher, external_references, voided, voucher_configuration].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



171
172
173
174
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 171

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



305
306
307
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 305

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



311
312
313
314
315
316
317
318
319
320
321
322
323
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 311

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



299
300
301
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 299

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



178
179
180
181
182
# File 'lib/korona-cloud-client/models/voucher_transaction.rb', line 178

def valid?
  transaction_type_validator = EnumAttributeValidator.new('String', ["CREDIT", "DEBIT"])
  return false unless transaction_type_validator.valid?(@transaction_type)
  true
end