Class: CityPayApiClient::NetSummaryResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/citypay_api_client/models/net_summary_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NetSummaryResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



82
83
84
85
86
87
88
89
90
91
92
93
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
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 82

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

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

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

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

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

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

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

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

Instance Attribute Details

#credit_items_amount ⇒ Object

The total value of refund (credit) transaction items. Represents the sum of funds returned to customers.



18
19
20
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 18

def credit_items_amount
  @credit_items_amount
end

#credit_items_count ⇒ Object

The count of refund (credit) transaction items. Reflects the number of refund transactions processed.



21
22
23
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 21

def credit_items_count
  @credit_items_count
end

#credit_items_value ⇒ Object

The total value of refund (credit) transaction items. Represents the sum of funds returned to customers.



24
25
26
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 24

def credit_items_value
  @credit_items_value
end

#debit_items_amount ⇒ Object

The total value of charge (debit) transaction items. Represents the sum of funds received from charges.



27
28
29
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 27

def debit_items_amount
  @debit_items_amount
end

#debit_items_count ⇒ Object

The count of charge (debit) transaction items. Indicates the number of charge transactions processed.



30
31
32
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 30

def debit_items_count
  @debit_items_count
end

#debit_items_value ⇒ Object

The total value of charge (debit) transaction items. Represents the sum of funds received from charges.



33
34
35
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 33

def debit_items_value
  @debit_items_value
end

#net_amount ⇒ Object

The absolute net value, reflecting the net gain or loss from transactions.



36
37
38
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 36

def net_amount
  @net_amount
end

#total_count ⇒ Object

The total count of all transaction items.



39
40
41
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 39

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



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 385

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



56
57
58
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 56

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 42

def self.attribute_map
  {
    :'credit_items_amount' => :'credit_items_amount',
    :'credit_items_count' => :'credit_items_count',
    :'credit_items_value' => :'credit_items_value',
    :'debit_items_amount' => :'debit_items_amount',
    :'debit_items_count' => :'debit_items_count',
    :'debit_items_value' => :'debit_items_value',
    :'net_amount' => :'net_amount',
    :'total_count' => :'total_count'
  }
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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 361

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



75
76
77
78
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 75

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

.openapi_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 61

def self.openapi_types
  {
    :'credit_items_amount' => :'String',
    :'credit_items_count' => :'Integer',
    :'credit_items_value' => :'Integer',
    :'debit_items_amount' => :'String',
    :'debit_items_count' => :'Integer',
    :'debit_items_value' => :'Integer',
    :'net_amount' => :'Integer',
    :'total_count' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 333

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      credit_items_amount == o.credit_items_amount &&
      credit_items_count == o.credit_items_count &&
      credit_items_value == o.credit_items_value &&
      debit_items_amount == o.debit_items_amount &&
      debit_items_count == o.debit_items_count &&
      debit_items_value == o.debit_items_value &&
      net_amount == o.net_amount &&
      total_count == o.total_count
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



456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 456

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


348
349
350
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 348

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



354
355
356
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 354

def hash
  [credit_items_amount, credit_items_count, credit_items_value, debit_items_amount, debit_items_count, debit_items_value, net_amount, total_count].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



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
182
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 130

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@credit_items_count.nil? && @credit_items_count > 999999
    invalid_properties.push('invalid value for "credit_items_count", must be smaller than or equal to 999999.')
  end

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

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

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

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

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

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

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

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

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

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

  if !@total_count.nil? && @total_count < 0
    invalid_properties.push('invalid value for "total_count", must be greater than or equal to 0.')
  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



432
433
434
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 432

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



438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 438

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



426
427
428
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 426

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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/citypay_api_client/models/net_summary_response.rb', line 186

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@credit_items_count.nil? && @credit_items_count > 999999
  return false if !@credit_items_count.nil? && @credit_items_count < 0
  return false if !@credit_items_value.nil? && @credit_items_value > 999999999
  return false if !@credit_items_value.nil? && @credit_items_value < 0
  return false if !@debit_items_count.nil? && @debit_items_count > 999999
  return false if !@debit_items_count.nil? && @debit_items_count < 0
  return false if !@debit_items_value.nil? && @debit_items_value > 999999999
  return false if !@debit_items_value.nil? && @debit_items_value < 0
  return false if !@net_amount.nil? && @net_amount > 999999999
  return false if !@net_amount.nil? && @net_amount < 0
  return false if !@total_count.nil? && @total_count > 999999
  return false if !@total_count.nil? && @total_count < 0
  true
end