Class: CityPayApiClient::RemittanceData

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RemittanceData

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



78
79
80
81
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
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 78

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `CityPayApiClient::RemittanceData` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `CityPayApiClient::RemittanceData`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

Instance Attribute Details

#date_created ⇒ Object

Represents the date and time when the remittance was processed. This timestamp follows the ISO 8601 format for datetime representation.



19
20
21
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 19

def date_created
  @date_created
end

#net_amount ⇒ Object

Represents the net amount after accounting for refunds. This is calculated as SalesAmount - RefundAmount and expressed in the smallest currency unit.



22
23
24
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 22

def net_amount
  @net_amount
end

#refund_amount ⇒ Object

The total amount refunded to customers.



25
26
27
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 25

def refund_amount
  @refund_amount
end

#refund_count ⇒ Object

The total number of refund transactions processed. This figure helps in understanding the frequency of refunds relative to sales.



28
29
30
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 28

def refund_count
  @refund_count
end

#sales_amount ⇒ Object

The total monetary amount of sales transactions.



31
32
33
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 31

def sales_amount
  @sales_amount
end

#sales_count ⇒ Object

Indicates the total number of sales transactions that occurred. This count provides insight into the volume of sales.



34
35
36
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 34

def sales_count
  @sales_count
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 304

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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



49
50
51
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 49

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



54
55
56
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 54

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 37

def self.attribute_map
  {
    :'date_created' => :'date_created',
    :'net_amount' => :'net_amount',
    :'refund_amount' => :'refund_amount',
    :'refund_count' => :'refund_count',
    :'sales_amount' => :'sales_amount',
    :'sales_count' => :'sales_count'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 280

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



71
72
73
74
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 71

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'date_created' => :'Time',
    :'net_amount' => :'Integer',
    :'refund_amount' => :'Integer',
    :'refund_count' => :'Integer',
    :'sales_amount' => :'Integer',
    :'sales_count' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



254
255
256
257
258
259
260
261
262
263
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 254

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date_created == o.date_created &&
      net_amount == o.net_amount &&
      refund_amount == o.refund_amount &&
      refund_count == o.refund_count &&
      sales_amount == o.sales_amount &&
      sales_count == o.sales_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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 375

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:

  • to be compared

Returns:

See Also:

  • `==` method


267
268
269
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 267

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



273
274
275
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 273

def hash
  [date_created, net_amount, refund_amount, refund_count, sales_amount, sales_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



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
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 119

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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 !@refund_amount.nil? && @refund_amount > 999999999
    invalid_properties.push('invalid value for "refund_amount", must be smaller than or equal to 999999999.')
  end

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

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

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

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

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

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

  if !@sales_count.nil? && @sales_count < 0
    invalid_properties.push('invalid value for "sales_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:

  • Returns the object in the form of hash



351
352
353
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 351

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 357

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 presentation of the object



345
346
347
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 345

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • true if the model is valid



167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/citypay_api_client/models/remittance_data.rb', line 167

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@net_amount.nil? && @net_amount > 999999999
  return false if !@net_amount.nil? && @net_amount < 0
  return false if !@refund_amount.nil? && @refund_amount > 999999999
  return false if !@refund_amount.nil? && @refund_amount < 0
  return false if !@refund_count.nil? && @refund_count > 999999999
  return false if !@refund_count.nil? && @refund_count < 0
  return false if !@sales_amount.nil? && @sales_amount > 999999999
  return false if !@sales_amount.nil? && @sales_amount < 0
  return false if !@sales_count.nil? && @sales_count > 999999999
  return false if !@sales_count.nil? && @sales_count < 0
  true
end