Class: OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels::RecordPaymentRequest

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



105
106
107
108
109
110
111
112
113
114
115
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
 
# File 'lib/orbipay_paymentsapi_client/models/record_payment_request.rb', line 105

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'comments')
    self.comments = attributes[:'comments']
  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

#amount ⇒ String (readonly)

The amount being paid. In case the payment_amount_type is 'other', the amount needs to be specified. In other cases, this is derived from the payment_amount_type.

Returns:

  • (String) —

    The attribute amount.



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

def amount
  @amount
end

#comments ⇒ String (readonly)

Returns The attribute comments.

Returns:

  • (String) —

    The attribute comments.



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

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.

Returns:

  • (Hash<String, String>) —

    The attribute custom_fields.



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

def custom_fields
  @custom_fields
end

#customer ⇒ SimplePaymentCustomerRequest (readonly)

Returns The attribute customer.

Returns:



48
49
50
 
# File 'lib/orbipay_paymentsapi_client/models/record_payment_request.rb', line 48

def customer
  @customer
end

#customer_account ⇒ CreateCustomerAccountRequest (readonly)

Returns The attribute customer_account.

Returns:



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

def 
  @customer_account
end

#fee ⇒ FeeRequest (readonly)

Returns The attribute fee.

Returns:



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

def fee
  @fee
end

#funding_account ⇒ RecordedPaymentFundingAccount (readonly)

Returns The attribute funding_account.

Returns:



51
52
53
 
# File 'lib/orbipay_paymentsapi_client/models/record_payment_request.rb', line 51

def 
  @funding_account
end

#payment_amount_type ⇒ String (readonly)

The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.

Returns:

  • (String) —

    The attribute payment_amount_type.



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

def payment_amount_type
  @payment_amount_type
end

#payment_date ⇒ String (readonly)

The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

Returns:

  • (String) —

    The attribute payment_date.



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

def payment_date
  @payment_date
end

#payment_method ⇒ String (readonly)

The non fulfillment method for the payment.

Returns:

  • (String) —

    The attribute payment_method.



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

def payment_method
  @payment_method
end

#payment_reference ⇒ String (readonly)

The unique identifier in the client system for the payment.

Returns:

  • (String) —

    The attribute payment_reference.



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

def payment_reference
  @payment_reference
end

#token ⇒ String (readonly)

The token is used to uniquely identify the payment, such as the POS token.

Returns:

  • (String) —

    The attribute token.



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

def token
  @token
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/orbipay_paymentsapi_client/models/record_payment_request.rb', line 68

def self.attribute_map
  {
    :'amount' => :'amount',
    :'payment_date' => :'payment_date',
    :'payment_amount_type' => :'payment_amount_type',
    :'payment_method' => :'payment_method',
    :'token' => :'token',
    :'fee' => :'fee',
    :'customer' => :'customer',
    :'funding_account' => :'funding_account',
    :'customer_account' => :'customer_account',
    :'payment_reference' => :'payment_reference',
    :'comments' => :'comments',
    :'custom_fields' => :'custom_fields'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'amount' => :'String',
    :'payment_date' => :'String',
    :'payment_amount_type' => :'String',
    :'payment_method' => :'String',
    :'token' => :'String',
    :'fee' => :'FeeRequest',
    :'customer' => :'SimplePaymentCustomerRequest',
    :'funding_account' => :'RecordedPaymentFundingAccount',
    :'customer_account' => :'CreateCustomerAccountRequest',
    :'payment_reference' => :'String',
    :'comments' => :'String',
    :'custom_fields' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • o (Object) —

    Object to be compared



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/orbipay_paymentsapi_client/models/record_payment_request.rb', line 173

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      payment_date == o.payment_date &&
      payment_amount_type == o.payment_amount_type &&
      payment_method == o.payment_method &&
      token == o.token &&
      fee == o.fee &&
      customer == o.customer &&
       == o. &&
       == o. &&
      payment_reference == o.payment_reference &&
      comments == o.comments &&
      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



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
 
# File 'lib/orbipay_paymentsapi_client/models/record_payment_request.rb', line 226

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



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/orbipay_paymentsapi_client/models/record_payment_request.rb', line 305

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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/orbipay_paymentsapi_client/models/record_payment_request.rb', line 205

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


192
193
194
 
# File 'lib/orbipay_paymentsapi_client/models/record_payment_request.rb', line 192

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



198
199
200
 
# File 'lib/orbipay_paymentsapi_client/models/record_payment_request.rb', line 198

def hash
  [amount, payment_date, payment_amount_type, payment_method, token, fee, customer, , , payment_reference, comments, custom_fields].hash
end

#set_values(args) ⇒ Object 



163
164
165
166
167
168
 
# File 'lib/orbipay_paymentsapi_client/models/record_payment_request.rb', line 163

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



284
285
286
 
# File 'lib/orbipay_paymentsapi_client/models/record_payment_request.rb', line 284

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



290
291
292
293
294
295
296
297
298
 
# File 'lib/orbipay_paymentsapi_client/models/record_payment_request.rb', line 290

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



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

def to_s
  to_hash.to_s
end