Class: OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels::SimplePaymentCustomerRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.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 = {}) ⇒ SimplePaymentCustomerRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
194
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 127

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ AddressVo (readonly)

Returns The attribute address.

Returns:



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

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

Returns:

  • (Hash<String, String>) —

    The attribute custom_fields.



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

def custom_fields
  @custom_fields
end

#customer_reference ⇒ String (readonly)

The unique identifier in the client system for the customer.

Returns:

  • (String) —

    The attribute customer_reference.



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

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.



46
47
48
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 46

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.



58
59
60
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 58

def email
  @email
end

#first_name ⇒ String (readonly)

The first name of the customer.

Returns:

  • (String) —

    The attribute first_name.



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

def first_name
  @first_name
end

#gender ⇒ String (readonly)

The gender of the customer.

Returns:

  • (String) —

    The attribute gender.



42
43
44
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 42

def gender
  @gender
end

#home_phone ⇒ String (readonly)

The home phone number of the customer.

Returns:

  • (String) —

    The attribute home_phone.



66
67
68
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 66

def home_phone
  @home_phone
end

#last_name ⇒ String (readonly)

The last name of the customer.

Returns:

  • (String) —

    The attribute last_name.



34
35
36
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 34

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.



54
55
56
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 54

def locale
  @locale
end

#middle_name ⇒ String (readonly)

The middle name of the customer.

Returns:

  • (String) —

    The attribute middle_name.



38
39
40
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 38

def middle_name
  @middle_name
end

#mobile_phone ⇒ String (readonly)

The mobile phone number of the customer.

Returns:

  • (String) —

    The attribute mobile_phone.



74
75
76
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 74

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



62
63
64
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 62

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.



50
51
52
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 50

def ssn
  @ssn
end

#work_phone ⇒ String (readonly)

The work phone number of the customer.

Returns:

  • (String) —

    The attribute work_phone.



70
71
72
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 70

def work_phone
  @work_phone
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 84

def self.attribute_map
  {
    :'customer_reference' => :'customer_reference',
    :'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'
  }
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
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 105

def self.swagger_types
  {
    :'customer_reference' => :'String',
    :'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' => :'AddressVo',
    :'custom_fields' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • o (Object) —

    Object to be compared



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 207

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      customer_reference == o.customer_reference &&
      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
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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 263

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



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 342

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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 242

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


229
230
231
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 229

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



235
236
237
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 235

def hash
  [customer_reference, first_name, last_name, middle_name, gender, date_of_birth, ssn, locale, email, registered_email, home_phone, work_phone, mobile_phone, address, custom_fields].hash
end

#set_values(args) ⇒ Object 



197
198
199
200
201
202
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 197

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



321
322
323
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 321

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



327
328
329
330
331
332
333
334
335
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 327

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



315
316
317
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb', line 315

def to_s
  to_hash.to_s
end