Class: OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels::CreatePaymentSetupRequest

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



99
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_setup_request.rb', line 99

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

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

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

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

Instance Attribute Details

#amount ⇒ String (readonly)

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

Returns:

  • (String) —

    The attribute amount.



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

def amount
  @amount
end

#card_cvv_number ⇒ String (readonly)

This is never returned by EBPP. This needs to be passed to EBPP when making or editing a payment with a card funding account.

Returns:

  • (String) —

    The attribute card_cvv_number.



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

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



61
62
63
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_setup_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. 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/models/create_payment_setup_request.rb', line 57

def custom_fields
  @custom_fields
end

#customer ⇒ CustomerMinimalRequest (readonly)

Returns The attribute customer.

Returns:



44
45
46
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_setup_request.rb', line 44

def customer
  @customer
end

#customer_account ⇒ CustomerAccountMinimalRequest (readonly)

Returns The attribute customer_account.

Returns:



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

def 
  @customer_account
end

#fee ⇒ FeeRequest (readonly)

Returns The attribute fee.

Returns:



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

def fee
  @fee
end

#funding_account ⇒ FundingAccountMinimalRequest (readonly)

Returns The attribute funding_account.

Returns:



47
48
49
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_setup_request.rb', line 47

def 
  @funding_account
end

#payment_schedule ⇒ PaymentScheduleVo (readonly)

Returns The attribute payment_schedule.

Returns:



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

def payment_schedule
  @payment_schedule
end

#payment_setup_reference ⇒ String (readonly)

The unique identifier in the client system for the paymentSetup.

Returns:

  • (String) —

    The attribute payment_setup_reference.



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

def payment_setup_reference
  @payment_setup_reference
end

#payment_setup_schedule_type ⇒ String (readonly)

The schedule type for the payment setup.

Returns:

  • (String) —

    The attribute payment_setup_schedule_type.



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

def payment_setup_schedule_type
  @payment_setup_schedule_type
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_setup_request.rb', line 64

def self.attribute_map
  {
    :'payment_setup_reference' => :'payment_setup_reference',
    :'payment_setup_schedule_type' => :'payment_setup_schedule_type',
    :'amount' => :'amount',
    :'card_cvv_number' => :'card_cvv_number',
    :'fee' => :'fee',
    :'customer' => :'customer',
    :'funding_account' => :'funding_account',
    :'customer_account' => :'customer_account',
    :'payment_schedule' => :'payment_schedule',
    :'custom_fields' => :'custom_fields',
    :'comments' => :'comments'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_setup_request.rb', line 81

def self.swagger_types
  {
    :'payment_setup_reference' => :'String',
    :'payment_setup_schedule_type' => :'String',
    :'amount' => :'String',
    :'card_cvv_number' => :'String',
    :'fee' => :'FeeRequest',
    :'customer' => :'CustomerMinimalRequest',
    :'funding_account' => :'FundingAccountMinimalRequest',
    :'customer_account' => :'CustomerAccountMinimalRequest',
    :'payment_schedule' => :'PaymentScheduleVo',
    :'custom_fields' => :'Hash<String, String>',
    :'comments' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • o (Object) —

    Object to be compared



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_setup_request.rb', line 163

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      payment_setup_reference == o.payment_setup_reference &&
      payment_setup_schedule_type == o.payment_setup_schedule_type &&
      amount == o.amount &&
      card_cvv_number == o.card_cvv_number &&
      fee == o.fee &&
      customer == o.customer &&
       == o. &&
       == o. &&
      payment_schedule == o.payment_schedule &&
      custom_fields == o.custom_fields &&
      comments == o.comments
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



215
216
217
218
219
220
221
222
223
224
225
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
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_setup_request.rb', line 215

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



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_setup_request.rb', line 294

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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_setup_request.rb', line 194

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


181
182
183
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_setup_request.rb', line 181

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



187
188
189
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_setup_request.rb', line 187

def hash
  [payment_setup_reference, payment_setup_schedule_type, amount, card_cvv_number, fee, customer, , , payment_schedule, custom_fields, comments].hash
end

#set_values(args) ⇒ Object 



153
154
155
156
157
158
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_setup_request.rb', line 153

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



273
274
275
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_setup_request.rb', line 273

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



279
280
281
282
283
284
285
286
287
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_setup_request.rb', line 279

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



267
268
269
 
# File 'lib/orbipay_paymentsapi_client/models/create_payment_setup_request.rb', line 267

def to_s
  to_hash.to_s
end