Class: OrbipayPaymentsapiClient::Customer

Inherits:
Base
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/wrappers/customer.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: nil) ⇒ Customer

Returns a new instance of Customer.

Parameters:

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

    attribute in the form of String.



162
163
164
165
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 162

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

Instance Attribute Details

#address ⇒ Address (readonly)

Returns The attribute address.

Returns:

  • (Address) —

    The attribute address.



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

def address
  @address
end

#audit_info ⇒ AuditInfo (readonly)

Returns The attribute audit_info.

Returns:



92
93
94
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 92

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.



77
78
79
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 77

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



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

def custom_fields
  @custom_fields
end

#customer_accounts ⇒ CustomerAccounts (readonly)

Returns The attribute customer_accounts.

Returns:



80
81
82
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 80

def customer_accounts
  @customer_accounts
end

#customer_reference ⇒ String (readonly)

The unique identifier in the client system for the customer.

Returns:

  • (String) —

    The attribute customer_reference.



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

def customer_reference
  @customer_reference
end

#date_of_birth ⇒ String (readonly)

The date of birth of the customer. It should be in the full-date format as per ISO8601, namely, YYYY-MM-DD.

Returns:

  • (String) —

    The attribute date_of_birth.



22
23
24
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 22

def date_of_birth
  @date_of_birth
end

#email ⇒ String (readonly)

The email address of the customer to which notifications from EBPP will be sent. This will default to the registered_email while creating a customer.

Returns:

  • (String) —

    The attribute email.



34
35
36
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 34

def email
  @email
end

#first_name ⇒ String (readonly)

The first name of the customer. Either first_name or last_name is required to create a customer.

Returns:

  • (String) —

    The attribute first_name.



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

def first_name
  @first_name
end

#funding_accounts ⇒ FundingAccounts (readonly)

Returns The attribute funding_accounts.

Returns:



83
84
85
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 83

def funding_accounts
  @funding_accounts
end

#gender ⇒ String (readonly)

The gender of the customer.

Returns:

  • (String) —

    The attribute gender.



18
19
20
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 18

def gender
  @gender
end

#home_phone ⇒ String (readonly)

The home phone number of the customer.

Returns:

  • (String) —

    The attribute home_phone.



42
43
44
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 42

def home_phone
  @home_phone
end

#id ⇒ String (readonly)

The unique identifier assigned by EBPP to the customer.

Returns:

  • (String) —

    The attribute id.



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

def id
  @id
end

#id_customer ⇒ String (readonly)

The unique identifier assigned by EBPP to the customer.

Returns:

  • (String) —

    The attribute id_customer.



96
97
98
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 96

def id_customer
  @id_customer
end

#last_name ⇒ String (readonly)

The last name of the customer. Either first_name or last_name is required to create a customer.

Returns:

  • (String) —

    The attribute last_name.



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

def last_name
  @last_name
end

#locale ⇒ String (readonly)

The language in which the customer wants the alerts and notifications from EBPP. This is to be specified in the format,
< ISO-639-1 language code >_< ISO ALPHA-2 Country Code >.
For e.g., en_US indicates the language preference as US English, which is also the default value.

Returns:

  • (String) —

    The attribute locale.



30
31
32
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 30

def locale
  @locale
end

#middle_name ⇒ String (readonly)

The middle name of the customer.

Returns:

  • (String) —

    The attribute middle_name.



14
15
16
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 14

def middle_name
  @middle_name
end

#mobile_phone ⇒ String (readonly)

The mobile phone number of the customer.

Returns:

  • (String) —

    The attribute mobile_phone.



50
51
52
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 50

def mobile_phone
  @mobile_phone
end

#payment_setups ⇒ PaymentSetups (readonly)

Returns The attribute payment_setups.

Returns:



89
90
91
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 89

def payment_setups
  @payment_setups
end

#payments ⇒ Payments (readonly)

Returns The attribute payments.

Returns:

  • (Payments) —

    The attribute payments.



86
87
88
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 86

def payments
  @payments
end

#registered_email ⇒ String (readonly)

The email address of the customer registered with the client. This may be used to uniquely identify the customer if the client is set up accordingly in EBPP.

Returns:

  • (String) —

    The attribute registered_email.



38
39
40
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 38

def registered_email
  @registered_email
end

#ssn ⇒ String (readonly)

The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business.

Returns:

  • (String) —

    The attribute ssn.



26
27
28
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 26

def ssn
  @ssn
end

#status ⇒ String (readonly)

The status of the customer in EBPP.

Returns:

  • (String) —

    The attribute status.



69
70
71
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 69

def status
  @status
end

#url ⇒ String (readonly)

This URL fetches the Customer details.

Returns:

  • (String) —

    The attribute url.



73
74
75
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 73

def url
  @url
end

#work_phone ⇒ String (readonly)

The work phone number of the customer.

Returns:

  • (String) —

    The attribute work_phone.



46
47
48
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 46

def work_phone
  @work_phone
end

Class Method Details

.attribute_map ⇒ Object

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



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
127
128
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 100

def self.attribute_map
  {
    :'first_name' => :'first_name', 
    :'last_name' => :'last_name', 
    :'middle_name' => :'middle_name', 
    :'gender' => :'gender', 
    :'date_of_birth' => :'date_of_birth', 
    :'ssn' => :'ssn', 
    :'locale' => :'locale', 
    :'email' => :'email', 
    :'registered_email' => :'registered_email', 
    :'home_phone' => :'home_phone', 
    :'work_phone' => :'work_phone', 
    :'mobile_phone' => :'mobile_phone', 
    :'address' => :'address', 
    :'custom_fields' => :'custom_fields', 
    :'customer_reference' => :'customer_reference', 
    :'id' => :'id', 
    :'status' => :'status', 
    :'url' => :'url', 
    :'comments' => :'comments', 
    :'customer_accounts' => :'customer_accounts', 
    :'funding_accounts' => :'funding_accounts', 
    :'payments' => :'payments', 
    :'payment_setups' => :'payment_setups', 
    :'audit_info' => :'audit_info', 
    :'id_customer' => :'ID_CUSTOMER' 
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 131

def self.swagger_types
  {
    :'first_name' => :'String',	
    :'last_name' => :'String',	
    :'middle_name' => :'String',	
    :'gender' => :'String',	
    :'date_of_birth' => :'String',	
    :'ssn' => :'String',	
    :'locale' => :'String',	
    :'email' => :'String',	
    :'registered_email' => :'String',	
    :'home_phone' => :'String',	
    :'work_phone' => :'String',	
    :'mobile_phone' => :'String',	
    :'address' => :'Address',	
    :'custom_fields' => :'Hash<String, String>',	
    :'customer_reference' => :'String',	
    :'id' => :'String',	
    :'status' => :'String',	
    :'url' => :'String',	
    :'comments' => :'String',	
    :'customer_accounts' => :'CustomerAccounts',	
    :'funding_accounts' => :'FundingAccounts',	
    :'payments' => :'Payments',	
    :'payment_setups' => :'PaymentSetups',	
    :'audit_info' => :'AuditInfo',	
    :'id_customer' => :'String'	
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



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
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 337

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      middle_name == o.middle_name &&
      gender == o.gender &&
      date_of_birth == o.date_of_birth &&
      ssn == o.ssn &&
      locale == o.locale &&
      email == o.email &&
      registered_email == o.registered_email &&
      home_phone == o.home_phone &&
      work_phone == o.work_phone &&
      mobile_phone == o.mobile_phone &&
      address == o.address &&
      custom_fields == o.custom_fields &&
      customer_reference == o.customer_reference &&
      id == o.id &&
      status == o.status &&
      url == o.url &&
      comments == o.comments &&
      customer_accounts == o.customer_accounts &&
      funding_accounts == o.funding_accounts &&
      payments == o.payments &&
      payment_setups == o.payment_setups &&
      audit_info == o.audit_info &&
      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



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 402

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



481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 481

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



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 381

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

#create(invocation_context: nil, live_mode: nil, api_end_point: nil) ⇒ Customer

Returns The Instance of Customer.

Returns:

  • (Customer) —

    The Instance of Customer.



288
289
290
291
292
293
294
295
296
297
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 288

def create(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::CreateCustomerHandler.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

#created_by(requestor: nil, requestor_type: nil) ⇒ Customer

Returns The Instance of Customer.

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:

  • (Customer) —

    The Instance of Customer.



266
267
268
269
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 266

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

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


368
369
370
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 368

def eql?(o)
  self == o
end

#for_client(client_key: nil) ⇒ Customer

Returns The Instance of Customer.

Parameters:

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

    attribute in the form of String.

Returns:

  • (Customer) —

    The Instance of Customer.



170
171
172
173
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 170

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

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

Returns The Instance of Customer.

Returns:

  • (Customer) —

    The Instance of Customer.



301
302
303
304
305
306
307
308
309
310
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 301

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::GetCustomerHandler.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



374
375
376
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 374

def hash
  [first_name, last_name, middle_name, gender, date_of_birth, ssn, locale, email, registered_email, home_phone, work_phone, mobile_phone, address, custom_fields, customer_reference, id, status, url, comments, customer_accounts, funding_accounts, payments, payment_setups, audit_info, id_customer].hash
end

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

Returns The Instance of Customer.

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:

  • (Customer) —

    The Instance of Customer.



274
275
276
277
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 274

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 



328
329
330
331
332
333
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 328

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



460
461
462
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 460

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



466
467
468
469
470
471
472
473
474
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 466

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



454
455
456
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 454

def to_s
  to_hash.to_s
end

#update(invocation_context: nil, live_mode: nil, api_end_point: nil) ⇒ Customer

Returns The Instance of Customer.

Returns:

  • (Customer) —

    The Instance of Customer.



314
315
316
317
318
319
320
321
322
323
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 314

def update(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::UpdateCustomerHandler.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

#updated_by(requestor: nil, requestor_type: nil) ⇒ Customer

Returns The Instance of Customer.

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:

  • (Customer) —

    The Instance of Customer.



282
283
284
285
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 282

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

#vide_channel(channel: nil) ⇒ Customer

Returns The Instance of Customer.

Parameters:

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

    attribute in the form of String.

Returns:

  • (Customer) —

    The Instance of Customer.



177
178
179
180
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 177

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

#with_accounts(customer_accounts: nil) ⇒ Customer

Returns The Instance of Customer.

Parameters:

  • customer_accounts (CustomerAccounts) (defaults to: nil) —

    attribute in the form of CustomerAccounts.

Returns:

  • (Customer) —

    The Instance of Customer.



237
238
239
240
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 237

def with_accounts(customer_accounts: nil)
    @customer_accounts = customer_accounts
    self 
end

#with_address(address: nil) ⇒ Customer

Returns The Instance of Customer.

Parameters:

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

    attribute in the form of Address.

Returns:

  • (Customer) —

    The Instance of Customer.



244
245
246
247
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 244

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

#with_contact_info(email: nil, home_phone: nil, work_phone: nil, mobile_phone: nil) ⇒ Customer

Returns The Instance of Customer.

Parameters:

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

    attribute in the form of String.

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

    attribute in the form of String.

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

    attribute in the form of String.

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

    attribute in the form of String.

Returns:

  • (Customer) —

    The Instance of Customer.



220
221
222
223
224
225
226
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 220

def with_contact_info(email: nil, home_phone: nil, work_phone: nil, mobile_phone: nil)
    @email = email
    @home_phone = home_phone
    @work_phone = work_phone
    @mobile_phone = mobile_phone
    self 
end

#with_custom_fields(custom_fields: nil) ⇒ Customer

Returns The Instance of Customer.

Parameters:

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

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

Returns:

  • (Customer) —

    The Instance of Customer.



251
252
253
254
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 251

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

#with_details(first_name: nil, last_name: nil, middle_name: nil, date_of_birth: nil, ssn: nil, gender: nil, registered_email: nil) ⇒ Customer

Returns The Instance of Customer.

Parameters:

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

    attribute in the form of String.

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

    attribute in the form of String.

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

    attribute in the form of String.

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

    attribute in the form of String.

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

    attribute in the form of String.

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

    attribute in the form of String.

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

    attribute in the form of String.

Returns:

  • (Customer) —

    The Instance of Customer.



190
191
192
193
194
195
196
197
198
199
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 190

def with_details(first_name: nil, last_name: nil, middle_name: nil, date_of_birth: nil, ssn: nil, gender: nil, registered_email: nil)
    @first_name = first_name
    @last_name = last_name
    @middle_name = middle_name
    @date_of_birth = date_of_birth
    @ssn = ssn
    @gender = gender
    @registered_email = registered_email
    self 
end

#with_locale(locale: nil) ⇒ Customer

Returns The Instance of Customer.

Parameters:

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

    attribute in the form of String.

Returns:

  • (Customer) —

    The Instance of Customer.



230
231
232
233
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 230

def with_locale(locale: nil)
    @locale = locale
    self 
end

#with_memo(comments: nil) ⇒ Customer

Returns The Instance of Customer.

Parameters:

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

    attribute in the form of String.

Returns:

  • (Customer) —

    The Instance of Customer.



258
259
260
261
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 258

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

#with_reference(customer_reference: nil) ⇒ Customer

Returns The Instance of Customer.

Parameters:

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

    attribute in the form of String.

Returns:

  • (Customer) —

    The Instance of Customer.



203
204
205
206
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 203

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

#with_status(status: nil) ⇒ Customer

Returns The Instance of Customer.

Parameters:

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

    attribute in the form of String.

Returns:

  • (Customer) —

    The Instance of Customer.



210
211
212
213
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customer.rb', line 210

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