Class: OrbipayPaymentsapiClient::CustomerAccount

Inherits:
Base
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/wrappers/customer_account.rb

Instance Attribute Summary collapse

Attributes inherited from Base

#api_end_point, #http_status_code, #invocation_context, #live_mode

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#requested_by, #set_api_end_point, #with_context

Constructor Details

#initialize(id_customer_account: nil) ⇒ CustomerAccount

Returns a new instance of CustomerAccount.

Parameters:

  • id_customer_account (String) (defaults to: nil) —

    attribute in the form of String.



130
131
132
133
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 130

def initialize(id_customer_account: nil)
    @id_customer_account = 
    @id = 
end

Instance Attribute Details

#account_holder_name ⇒ String (readonly)

The name as specified on the account.

Returns:

  • (String) —

    The attribute account_holder_name.



6
7
8
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 6

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.



21
22
23
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 21

def 
  @account_number
end

#address ⇒ Address (readonly)

Returns The attribute address.

Returns:

  • (Address) —

    The attribute address.



13
14
15
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 13

def address
  @address
end

#audit_info ⇒ AuditInfo (readonly)

Returns The attribute audit_info.

Returns:



68
69
70
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 68

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.



65
66
67
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 65

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.



25
26
27
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 25

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.



29
30
31
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 29

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.



61
62
63
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 61

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.



17
18
19
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 17

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.



49
50
51
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 49

def id
  @id
end

#id_customer ⇒ String (readonly)

The unique identifier assigned by EBPP to the customer.

Returns:

  • (String) —

    The attribute id_customer.



76
77
78
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 76

def id_customer
  @id_customer
end

#id_customer_account ⇒ String (readonly)

The unique identifier assigned by EBPP to the Customer Account.

Returns:

  • (String) —

    The attribute id_customer_account.



72
73
74
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 72

def 
  @id_customer_account
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.



33
34
35
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 33

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.



10
11
12
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 10

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.



37
38
39
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 37

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.



41
42
43
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 41

def payment_due_date
  @payment_due_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.



45
46
47
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 45

def statement_date
  @statement_date
end

#status ⇒ String (readonly)

The status of the customer's account in EBPP.

Returns:

  • (String) —

    The attribute status.



57
58
59
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 57

def status
  @status
end

#url ⇒ String (readonly)

This URL fetches the Account details.

Returns:

  • (String) —

    The attribute url.



53
54
55
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 53

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 80

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', 
    :'id' => :'id', 
    :'url' => :'url', 
    :'status' => :'status', 
    :'custom_fields' => :'custom_fields', 
    :'comments' => :'comments', 
    :'audit_info' => :'audit_info', 
    :'id_customer_account' => :'ID_CUSTOMER_ACCOUNT', 
    :'id_customer' => :'ID_CUSTOMER' 
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 105

def self.swagger_types
  {
    :'account_holder_name' => :'String',	
    :'nickname' => :'String',	
    :'address' => :'Address',	
    :'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',	
    :'id' => :'String',	
    :'url' => :'String',	
    :'status' => :'String',	
    :'custom_fields' => :'Hash<String, String>',	
    :'comments' => :'String',	
    :'audit_info' => :'AuditInfo',	
    :'id_customer_account' => :'String',	
    :'id_customer' => :'String'	
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 273

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 &&
      id == o.id &&
      url == o.url &&
      status == o.status &&
      custom_fields == o.custom_fields &&
      comments == o.comments &&
      audit_info == o.audit_info &&
       == o. &&
      id_customer == o.id_customer
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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 332

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



411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 411

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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 311

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

Returns:

  • (Boolean)

See Also:

  • `==` method


298
299
300
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 298

def eql?(o)
  self == o
end

#for_client(client_key: nil) ⇒ CustomerAccount

Returns The Instance of CustomerAccount.

Parameters:

  • client_key (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



138
139
140
141
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 138

def for_client(client_key: nil)
    super(client_key: client_key)
    self 
end

#for_customer(id_customer: nil) ⇒ CustomerAccount

Returns The Instance of CustomerAccount.

Parameters:

  • id_customer (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



215
216
217
218
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 215

def for_customer(id_customer: nil)
    @id_customer = id_customer
    self 
end

#get(invocation_context: nil, live_mode: nil, api_end_point: nil) ⇒ CustomerAccount

Returns The Instance of CustomerAccount.

Returns:



237
238
239
240
241
242
243
244
245
246
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 237

def get(invocation_context: nil, live_mode: nil, api_end_point: nil)
	begin
		Base.instance_method(:with_context).bind(self).call(invocation_context, live_mode: live_mode, api_end_point: api_end_point)
    	OrbipayPaymentsapiClientHandlers::GetCustomerAccountHandler.new.process(self)
		rescue ApiError => e
			raise OrbipayApiError.new(http_status_code: e.code, response_headers: e.response_headers, timed_out:e.timed_out, response_body: e.response_body, message: e.message,  masked_authorization_string: e.masked_authorization_string, http_request_body: e.request_body, http_request_headers: e.request_headers),nil, e.backtrace
		rescue StandardError => e
			raise OrbipayApiError.new(message: e.message),nil, e.backtrace
		end
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



304
305
306
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 304

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

#renew(invocation_context: nil, live_mode: nil, api_end_point: nil) ⇒ CustomerAccount

Returns The Instance of CustomerAccount.

Returns:



250
251
252
253
254
255
256
257
258
259
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 250

def renew(invocation_context: nil, live_mode: nil, api_end_point: nil)
	begin
		Base.instance_method(:with_context).bind(self).call(invocation_context, live_mode: live_mode, api_end_point: api_end_point)
    	OrbipayPaymentsapiClientHandlers::RenewCustomerAccountHandler.new.process(self)
		rescue ApiError => e
			raise OrbipayApiError.new(http_status_code: e.code, response_headers: e.response_headers, timed_out:e.timed_out, response_body: e.response_body, message: e.message,  masked_authorization_string: e.masked_authorization_string, http_request_body: e.request_body, http_request_headers: e.request_headers),nil, e.backtrace
		rescue StandardError => e
			raise OrbipayApiError.new(message: e.message),nil, e.backtrace
		end
end

#renewed_by(requestor: nil, requestor_type: nil) ⇒ CustomerAccount

Returns The Instance of CustomerAccount.

Parameters:

  • requestor (String) (defaults to: nil) —

    attribute in the form of String.

  • requestor_type (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



231
232
233
234
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 231

def renewed_by(requestor: nil, requestor_type: nil)
    Base.instance_method(:requested_by).bind(self).call(requestor: requestor, requestor_type: requestor_type)
    self
end

#retrieved_by(requestor: nil, requestor_type: nil) ⇒ CustomerAccount

Returns The Instance of CustomerAccount.

Parameters:

  • requestor (String) (defaults to: nil) —

    attribute in the form of String.

  • requestor_type (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



223
224
225
226
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 223

def retrieved_by(requestor: nil, requestor_type: nil)
    Base.instance_method(:requested_by).bind(self).call(requestor: requestor, requestor_type: requestor_type)
    self
end

#set_values(args) ⇒ Object 



264
265
266
267
268
269
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 264

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



390
391
392
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 390

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



396
397
398
399
400
401
402
403
404
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 396

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



384
385
386
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 384

def to_s
  to_hash.to_s
end

#vide_channel(channel: nil) ⇒ CustomerAccount

Returns The Instance of CustomerAccount.

Parameters:

  • channel (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



145
146
147
148
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 145

def vide_channel(channel: nil)
    super(channel: channel)
    self 
end

#with_address(address: nil) ⇒ CustomerAccount

Returns The Instance of CustomerAccount.

Parameters:

  • address (Address) (defaults to: nil) —

    attribute in the form of Address.

Returns:



194
195
196
197
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 194

def with_address(address: nil)
    @address = address
    self 
end

#with_balances(current_balance: nil, current_statement_balance: nil) ⇒ CustomerAccount

Returns The Instance of CustomerAccount.

Parameters:

  • current_balance (String) (defaults to: nil) —

    attribute in the form of String.

  • current_statement_balance (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



172
173
174
175
176
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 172

def with_balances(current_balance: nil, current_statement_balance: nil)
    @current_balance = current_balance
    @current_statement_balance = current_statement_balance
    self 
end

#with_custom_fields(custom_fields: nil) ⇒ CustomerAccount

Returns The Instance of CustomerAccount.

Parameters:

  • custom_fields (Hash<String, String>) (defaults to: nil) —

    attribute in the form of Hash&lt;String, String&gt;.

Returns:



201
202
203
204
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 201

def with_custom_fields(custom_fields: nil)
    @custom_fields = custom_fields
    self 
end

#with_details(account_holder_name: nil, nickname: nil, account_number: nil, minimum_payment_due: nil, past_amount_due: nil, payment_due_date: nil, statement_date: nil) ⇒ CustomerAccount

Returns The Instance of CustomerAccount.

Parameters:

  • account_holder_name (String) (defaults to: nil) —

    attribute in the form of String.

  • nickname (String) (defaults to: nil) —

    attribute in the form of String.

  • account_number (String) (defaults to: nil) —

    attribute in the form of String.

  • minimum_payment_due (String) (defaults to: nil) —

    attribute in the form of String.

  • past_amount_due (String) (defaults to: nil) —

    attribute in the form of String.

  • payment_due_date (String) (defaults to: nil) —

    attribute in the form of String.

  • statement_date (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



158
159
160
161
162
163
164
165
166
167
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 158

def with_details(account_holder_name: nil, nickname: nil, account_number: nil, minimum_payment_due: nil, past_amount_due: nil, payment_due_date: nil, statement_date: nil)
    @account_holder_name = 
    @nickname = nickname
    @account_number = 
    @minimum_payment_due = minimum_payment_due
    @past_amount_due = past_amount_due
    @payment_due_date = payment_due_date
    @statement_date = statement_date
    self 
end

#with_memo(comments: nil) ⇒ CustomerAccount

Returns The Instance of CustomerAccount.

Parameters:

  • comments (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



208
209
210
211
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 208

def with_memo(comments: nil)
    @comments = comments
    self 
end

#with_reference(customer_account_reference: nil) ⇒ CustomerAccount

Returns The Instance of CustomerAccount.

Parameters:

  • customer_account_reference (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



180
181
182
183
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 180

def with_reference(customer_account_reference: nil)
    @customer_account_reference = 
    self 
end

#with_status(status: nil) ⇒ CustomerAccount

Returns The Instance of CustomerAccount.

Parameters:

  • status (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



187
188
189
190
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer_account.rb', line 187

def with_status(status: nil)
    @status = status
    self 
end