Class: VoucherifySdk::VoucherTransactionDetailsBalance

Inherits:
Object
  • Object
show all
Defined in:
lib/VoucherifySdk/models/voucher_transaction_details_balance.rb

Overview

Contains information on how the balance was affected by the transaction.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VoucherTransactionDetailsBalance

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 101

def initialize(attributes = {})
  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    h[k.to_sym] = v
  }

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

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

  if attributes.key?(:'object')
    self.object = attributes[:'object']
  else
    self.object = 'balance'
  end

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

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

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

Instance Attribute Details

#balance ⇒ Object

The available points on the card after the transaction as affected by redemption or rollback.



32
33
34
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 32

def balance
  @balance
end

#object ⇒ Object

The type of the object represented by the JSON.



26
27
28
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 26

def object
  @object
end

#points ⇒ Object

Points added or subtracted in the transaction.



29
30
31
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 29

def points
  @points
end

#related_object ⇒ Object

Returns the value of attribute related_object.



34
35
36
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 34

def related_object
  @related_object
end

#total ⇒ Object

The number of all points accumulated on the card as affected by add or subtract operations.



23
24
25
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 23

def total
  @total
end

#type ⇒ Object

The type of voucher whose balance is being adjusted due to the transaction.



20
21
22
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 20

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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 219

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
  else # model
    # models (e.g. Pet) or oneOf
    klass = VoucherifySdk.const_get(type)
    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



71
72
73
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 71

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 59

def self.attribute_map
  {
    :'type' => :'type',
    :'total' => :'total',
    :'object' => :'object',
    :'points' => :'points',
    :'balance' => :'balance',
    :'related_object' => :'related_object'
  }
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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 195

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



88
89
90
91
92
93
94
95
96
97
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 88

def self.openapi_nullable
  Set.new([
    :'type',
    :'total',
    :'object',
    :'points',
    :'balance',
    :'related_object'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 76

def self.openapi_types
  {
    :'type' => :'String',
    :'total' => :'Integer',
    :'object' => :'String',
    :'points' => :'Integer',
    :'balance' => :'Integer',
    :'related_object' => :'VoucherTransactionDetailsBalanceRelatedObject'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



169
170
171
172
173
174
175
176
177
178
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 169

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      total == o.total &&
      object == o.object &&
      points == o.points &&
      balance == o.balance &&
      related_object == o.related_object
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



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 290

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


182
183
184
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 182

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



188
189
190
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 188

def hash
  [type, total, object, points, balance, related_object].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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 138

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  pattern = Regexp.new(/loyalty_card/)
  if !@type.nil? && @type !~ pattern
    invalid_properties.push("invalid value for \"type\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/balance/)
  if !@object.nil? && @object !~ pattern
    invalid_properties.push("invalid value for \"object\", must conform to the pattern #{pattern}.")
  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



266
267
268
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 266

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



272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 272

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



260
261
262
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 260

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



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/VoucherifySdk/models/voucher_transaction_details_balance.rb', line 156

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('String', ["loyalty_card"])
  return false unless type_validator.valid?(@type)
  return false if !@type.nil? && @type !~ Regexp.new(/loyalty_card/)
  object_validator = EnumAttributeValidator.new('String', ["balance"])
  return false unless object_validator.valid?(@object)
  return false if !@object.nil? && @object !~ Regexp.new(/balance/)
  true
end