Class: CityPayApiClient::RemittedClientData

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RemittedClientData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 116

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

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

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

  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?(:'processed_amount')
    self.processed_amount = attributes[:'processed_amount']
  end

  if attributes.key?(:'processed_count')
    self.processed_count = attributes[:'processed_count']
  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?(:'remittances')
    if (value = attributes[:'remittances']).is_a?(Array)
      self.remittances = value
    end
  else
    self.remittances = nil
  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

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

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

Instance Attribute Details

#batches ⇒ Object

Returns the value of attribute batches.



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

def batches
  @batches
end

#clientid ⇒ Object

The client id that the remittance data is for.



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

def clientid
  @clientid
end

#date ⇒ Object

The date of the remittance.



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

def date
  @date
end

#date_created ⇒ Object

The date time that the remittance was created.



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

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.



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

def net_amount
  @net_amount
end

#processed_amount ⇒ Object

The total monetary amount processed consisting of sale and refund transactions.



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

def processed_amount
  @processed_amount
end

#processed_count ⇒ Object

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



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

def processed_count
  @processed_count
end

#refund_amount ⇒ Object

The total amount refunded to customers.



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

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.



42
43
44
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 42

def refund_count
  @refund_count
end

#remittances ⇒ Object

Returns the value of attribute remittances.



44
45
46
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 44

def remittances
  @remittances
end

#sales_amount ⇒ Object

The total monetary amount of sales transactions.



47
48
49
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 47

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.



50
51
52
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 50

def sales_count
  @sales_count
end

#settlement_implementation ⇒ Object

The name of the implementation.



53
54
55
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 53

def settlement_implementation
  @settlement_implementation
end

#uuid ⇒ Object

The uuid of the settlement file processed on.



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

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



496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 496

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



79
80
81
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 79

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 84

def self.acceptable_attributes
  acceptable_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
69
70
71
72
73
74
75
76
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 59

def self.attribute_map
  {
    :'batches' => :'batches',
    :'clientid' => :'clientid',
    :'date' => :'date',
    :'date_created' => :'date_created',
    :'net_amount' => :'net_amount',
    :'processed_amount' => :'processed_amount',
    :'processed_count' => :'processed_count',
    :'refund_amount' => :'refund_amount',
    :'refund_count' => :'refund_count',
    :'remittances' => :'remittances',
    :'sales_amount' => :'sales_amount',
    :'sales_count' => :'sales_count',
    :'settlement_implementation' => :'settlement_implementation',
    :'uuid' => :'uuid'
  }
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



472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 472

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



109
110
111
112
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 109

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

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 89

def self.openapi_types
  {
    :'batches' => :'Array<MerchantBatchResponse>',
    :'clientid' => :'String',
    :'date' => :'Date',
    :'date_created' => :'Time',
    :'net_amount' => :'Integer',
    :'processed_amount' => :'Integer',
    :'processed_count' => :'Integer',
    :'refund_amount' => :'Integer',
    :'refund_count' => :'Integer',
    :'remittances' => :'Array<RemittanceData>',
    :'sales_amount' => :'Integer',
    :'sales_count' => :'Integer',
    :'settlement_implementation' => :'String',
    :'uuid' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 438

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      batches == o.batches &&
      clientid == o.clientid &&
      date == o.date &&
      date_created == o.date_created &&
      net_amount == o.net_amount &&
      processed_amount == o.processed_amount &&
      processed_count == o.processed_count &&
      refund_amount == o.refund_amount &&
      refund_count == o.refund_count &&
      remittances == o.remittances &&
      sales_amount == o.sales_amount &&
      sales_count == o.sales_count &&
      settlement_implementation == o.settlement_implementation &&
      uuid == o.uuid
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



567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 567

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


459
460
461
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 459

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



465
466
467
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 465

def hash
  [batches, clientid, date, date_created, net_amount, processed_amount, processed_count, refund_amount, refund_count, remittances, sales_amount, sales_count, settlement_implementation, uuid].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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
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
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
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 197

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @batches.nil?
    invalid_properties.push('invalid value for "batches", batches cannot be nil.')
  end

  if !@clientid.nil? && @clientid.to_s.length > 10
    invalid_properties.push('invalid value for "clientid", the character length must be smaller than or equal to 10.')
  end

  if !@clientid.nil? && @clientid.to_s.length < 3
    invalid_properties.push('invalid value for "clientid", the character length must be greater than or equal to 3.')
  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 !@processed_amount.nil? && @processed_amount > 999999999
    invalid_properties.push('invalid value for "processed_amount", must be smaller than or equal to 999999999.')
  end

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

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

  if !@processed_count.nil? && @processed_count < 0
    invalid_properties.push('invalid value for "processed_count", 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 @remittances.nil?
    invalid_properties.push('invalid value for "remittances", remittances cannot be nil.')
  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

  if !@uuid.nil? && @uuid.to_s.length > 36
    invalid_properties.push('invalid value for "uuid", the character length must be smaller than or equal to 36.')
  end

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



543
544
545
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 543

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



549
550
551
552
553
554
555
556
557
558
559
560
561
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 549

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



537
538
539
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 537

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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/citypay_api_client/models/remitted_client_data.rb', line 285

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @batches.nil?
  return false if !@clientid.nil? && @clientid.to_s.length > 10
  return false if !@clientid.nil? && @clientid.to_s.length < 3
  return false if !@net_amount.nil? && @net_amount > 999999999
  return false if !@net_amount.nil? && @net_amount < 0
  return false if !@processed_amount.nil? && @processed_amount > 999999999
  return false if !@processed_amount.nil? && @processed_amount < 0
  return false if !@processed_count.nil? && @processed_count > 999999999
  return false if !@processed_count.nil? && @processed_count < 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 @remittances.nil?
  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
  return false if !@uuid.nil? && @uuid.to_s.length > 36
  return false if !@uuid.nil? && @uuid.to_s.length < 36
  true
end