Class: OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels::CustomerAccountResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/models/customer_account_response.rb

Overview

.

############################################################################################
## This class subject to change without prior notice, Please dont use this class directly.##
############################################################################################

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomerAccountResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
194
195
196
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
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 150

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'account_holder_name')
    self. = attributes[:'account_holder_name']
  end

  if attributes.has_key?(:'nickname')
    self.nickname = attributes[:'nickname']
  end

  if attributes.has_key?(:'address')
    self.address = attributes[:'address']
  end

  if attributes.has_key?(:'customer_account_reference')
    self. = attributes[:'customer_account_reference']
  end

  if attributes.has_key?(:'account_number')
    self. = attributes[:'account_number']
  end

  if attributes.has_key?(:'current_balance')
    self.current_balance = attributes[:'current_balance']
  end

  if attributes.has_key?(:'current_statement_balance')
    self.current_statement_balance = attributes[:'current_statement_balance']
  end

  if attributes.has_key?(:'minimum_payment_due')
    self.minimum_payment_due = attributes[:'minimum_payment_due']
  end

  if attributes.has_key?(:'past_amount_due')
    self.past_amount_due = attributes[:'past_amount_due']
  end

  if attributes.has_key?(:'payment_due_date')
    self.payment_due_date = attributes[:'payment_due_date']
  end

  if attributes.has_key?(:'statement_date')
    self.statement_date = attributes[:'statement_date']
  end

  if attributes.has_key?(:'payoff_amount')
    self.payoff_amount = attributes[:'payoff_amount']
  end

  if attributes.has_key?(:'payoff_expiry_date')
    self.payoff_expiry_date = attributes[:'payoff_expiry_date']
  end

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'url')
    self.url = attributes[:'url']
  end

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  end

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

  if attributes.has_key?(:'comments')
    self.comments = attributes[:'comments']
  end

  if attributes.has_key?(:'audit_info')
    self.audit_info = attributes[:'audit_info']
  end
end

Instance Attribute Details

#account_holder_name ⇒ String (readonly)

The name as specified on the account.

Returns:

  • (String) —

    The attribute account_holder_name.



26
27
28
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 26

def 
  @account_holder_name
end

#account_number ⇒ String (readonly)

The number or reference that a customer uses to identify the customer's account.

Returns:

  • (String) —

    The attribute account_number.



41
42
43
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 41

def 
  @account_number
end

#address ⇒ AddressVo (readonly)

Returns The attribute address.

Returns:



33
34
35
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 33

def address
  @address
end

#audit_info ⇒ AuditInfoVo (readonly)

Returns The attribute audit_info.

Returns:



96
97
98
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 96

def audit_info
  @audit_info
end

#comments ⇒ String (readonly)

Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.

Returns:

  • (String) —

    The attribute comments.



93
94
95
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 93

def comments
  @comments
end

#current_balance ⇒ String (readonly)

The current balance on the customer's account with the biller.

Returns:

  • (String) —

    The attribute current_balance.



45
46
47
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 45

def current_balance
  @current_balance
end

#current_statement_balance ⇒ String (readonly)

The balance on the customer’s account with the biller as reported on the last statement.

Returns:

  • (String) —

    The attribute current_statement_balance.



49
50
51
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 49

def current_statement_balance
  @current_statement_balance
end

#custom_fields ⇒ Hash<String, String> (readonly)

The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href = "mailto: support@billerpayments.com">support@billerpayments.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in EBPP, would be accepted in the requests.

Returns:

  • (Hash<String, String>) —

    The attribute custom_fields.



89
90
91
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 89

def custom_fields
  @custom_fields
end

#customer_account_reference ⇒ String (readonly)

The unique identifier in the client system for the customer account.

Returns:

  • (String) —

    The attribute customer_account_reference.



37
38
39
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 37

def 
  @customer_account_reference
end

#id ⇒ String (readonly)

Id is a unique identifier assigned to the customer account in EBPP.

Returns:

  • (String) —

    The attribute id.



77
78
79
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 77

def id
  @id
end

#minimum_payment_due ⇒ String (readonly)

The minimum payment amount, as specified by the biller, that needs to be made against the customer’s account.

Returns:

  • (String) —

    The attribute minimum_payment_due.



53
54
55
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 53

def minimum_payment_due
  @minimum_payment_due
end

#nickname ⇒ String (readonly)

The nickname by which a customer might want to identify the account.

Returns:

  • (String) —

    The attribute nickname.



30
31
32
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 30

def nickname
  @nickname
end

#past_amount_due ⇒ String (readonly)

The amount that is due from the past bills/statements on the customer’s account with the biller.

Returns:

  • (String) —

    The attribute past_amount_due.



57
58
59
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 57

def past_amount_due
  @past_amount_due
end

#payment_due_date ⇒ String (readonly)

The date by which the customer needs to clear the dues against the customer's account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

Returns:

  • (String) —

    The attribute payment_due_date.



61
62
63
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 61

def payment_due_date
  @payment_due_date
end

#payoff_amount ⇒ String (readonly)

This field contains the computed current loan payoff amount at the time of inquiry for the customer’s account with the biller.

Returns:

  • (String) —

    The attribute payoff_amount.



69
70
71
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 69

def payoff_amount
  @payoff_amount
end

#payoff_expiry_date ⇒ String (readonly)

The date till the payoff_amount is valid for the customer’s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

Returns:

  • (String) —

    The attribute payoff_expiry_date.



73
74
75
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 73

def payoff_expiry_date
  @payoff_expiry_date
end

#statement_date ⇒ String (readonly)

The date on which the biller generates the statement for the customer's account. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

Returns:

  • (String) —

    The attribute statement_date.



65
66
67
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 65

def statement_date
  @statement_date
end

#status ⇒ String (readonly)

The status of the customer's account in EBPP.

Returns:

  • (String) —

    The attribute status.



85
86
87
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 85

def status
  @status
end

#url ⇒ String (readonly)

This URL fetches the Account details.

Returns:

  • (String) —

    The attribute url.



81
82
83
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 81

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 99

def self.attribute_map
  {
    :'account_holder_name' => :'account_holder_name',
    :'nickname' => :'nickname',
    :'address' => :'address',
    :'customer_account_reference' => :'customer_account_reference',
    :'account_number' => :'account_number',
    :'current_balance' => :'current_balance',
    :'current_statement_balance' => :'current_statement_balance',
    :'minimum_payment_due' => :'minimum_payment_due',
    :'past_amount_due' => :'past_amount_due',
    :'payment_due_date' => :'payment_due_date',
    :'statement_date' => :'statement_date',
    :'payoff_amount' => :'payoff_amount',
    :'payoff_expiry_date' => :'payoff_expiry_date',
    :'id' => :'id',
    :'url' => :'url',
    :'status' => :'status',
    :'custom_fields' => :'custom_fields',
    :'comments' => :'comments',
    :'audit_info' => :'audit_info'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 124

def self.swagger_types
  {
    :'account_holder_name' => :'String',
    :'nickname' => :'String',
    :'address' => :'AddressVo',
    :'customer_account_reference' => :'String',
    :'account_number' => :'String',
    :'current_balance' => :'String',
    :'current_statement_balance' => :'String',
    :'minimum_payment_due' => :'String',
    :'past_amount_due' => :'String',
    :'payment_due_date' => :'String',
    :'statement_date' => :'String',
    :'payoff_amount' => :'String',
    :'payoff_expiry_date' => :'String',
    :'id' => :'String',
    :'url' => :'String',
    :'status' => :'String',
    :'custom_fields' => :'Hash<String, String>',
    :'comments' => :'String',
    :'audit_info' => :'AuditInfoVo'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • o (Object) —

    Object to be compared



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 246

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      nickname == o.nickname &&
      address == o.address &&
       == o. &&
       == o. &&
      current_balance == o.current_balance &&
      current_statement_balance == o.current_statement_balance &&
      minimum_payment_due == o.minimum_payment_due &&
      past_amount_due == o.past_amount_due &&
      payment_due_date == o.payment_due_date &&
      statement_date == o.statement_date &&
      payoff_amount == o.payoff_amount &&
      payoff_expiry_date == o.payoff_expiry_date &&
      id == o.id &&
      url == o.url &&
      status == o.status &&
      custom_fields == o.custom_fields &&
      comments == o.comments &&
      audit_info == o.audit_info
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type (string) —

    Data type

  • value (string) —

    Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 306

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    if value.nil?
      value
    else
      value.to_s
    end
  when :Integer
    if value.nil?
      value
    else
      value.to_i
    end
  when :Float
    if value.nil?
      value
    else
      value.to_f
    end
  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
    temp_model = OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash, Object

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

  • (Object) —

    Returns the object if it cannot be converted to hash



385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 385

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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 285

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        set_values(key => attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      set_values(key => _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • o (Object) —

    Object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


272
273
274
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



278
279
280
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 278

def hash
  [, nickname, address, , , current_balance, current_statement_balance, minimum_payment_due, past_amount_due, payment_due_date, statement_date, payoff_amount, payoff_expiry_date, id, url, status, custom_fields, comments, audit_info].hash
end

#set_values(args) ⇒ Object 



236
237
238
239
240
241
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 236

def set_values(args)
  args.each do |attr, arg|
    (class << self; self; end).send(:attr_reader, attr.to_sym)
    instance_variable_set("@#{attr}", arg)
  end
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



364
365
366
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 364

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



370
371
372
373
374
375
376
377
378
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 370

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



358
359
360
 
# File 'lib/orbipay_paymentsapi_client/models/customer_account_response.rb', line 358

def to_s
  to_hash.to_s
end