Class: OrbipayPaymentsapiClient::PaymentSetup

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

Returns a new instance of PaymentSetup.

Parameters:

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

    attribute in the form of String.



155
156
157
158
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 155

def initialize(id_payment_setup: nil)
    @id_payment_setup = id_payment_setup
    @id = id_payment_setup
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.



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

def amount
  @amount
end

#audit_info ⇒ AuditInfo (readonly)

Returns The attribute audit_info.

Returns:



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

def audit_info
  @audit_info
end

#card_cvv_number ⇒ String (readonly)

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

Returns:

  • (String) —

    The attribute card_cvv_number.



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

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 (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo.

Returns:

  • (String) —

    The attribute comments.



64
65
66
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 64

def comments
  @comments
end

#confirmation_number ⇒ String (readonly)

The confirmation number or reference provided to the customer for the payment setup.

Returns:

  • (String) —

    The attribute confirmation_number.



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

def confirmation_number
  @confirmation_number
end

#currency_code3d ⇒ String (readonly)

The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by Orbipay. This defaults to USD.

Returns:

  • (String) —

    The attribute currency_code3d.



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

def currency_code3d
  @currency_code3d
end

#custom_fields ⇒ Hash<String, String> (readonly)

The additional information or meta-information that Orbipay can accept, maintain and transmit back to the client. The custom fields need to be configured with Orbipay before they can be accepted. Orbipay 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 Orbipay, would be accepted in the requests.

Returns:

  • (Hash<String, String>) —

    The attribute custom_fields.



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

def custom_fields
  @custom_fields
end

#customer ⇒ Customer (readonly)

Returns The attribute customer.

Returns:

  • (Customer) —

    The attribute customer.



71
72
73
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 71

def customer
  @customer
end

#customer_account ⇒ CustomerAccount (readonly)

Returns The attribute customer_account.

Returns:



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

def 
  @customer_account
end

#deleted ⇒ String (readonly)

The status of payment which says whether the payment is deleted or not

Returns:

  • (String) —

    The attribute deleted.



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

def deleted
  @deleted
end

#fee ⇒ Fee (readonly)

Returns The attribute fee.

Returns:

  • (Fee) —

    The attribute fee.



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

def fee
  @fee
end

#funding_account ⇒ FundingAccount (readonly)

Returns The attribute funding_account.

Returns:



74
75
76
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 74

def 
  @funding_account
end

#id ⇒ String (readonly)

The unique identifier assigned by Orbipay to the payment setup.

Returns:

  • (String) —

    The attribute id.



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

def id
  @id
end

#id_customer ⇒ String (readonly)

The unique identifier assigned by EBPP to the customer.

Returns:

  • (String) —

    The attribute id_customer.



87
88
89
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 87

def id_customer
  @id_customer
end

#id_payment_setup ⇒ String (readonly)

The unique identifier assigned by EBPP to the payment setup.

Returns:

  • (String) —

    The attribute id_payment_setup.



91
92
93
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 91

def id_payment_setup
  @id_payment_setup
end

#next_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 next_payment_date.



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

def next_payment_date
  @next_payment_date
end

#payment_method ⇒ String (readonly)

The fulfillment method for the payment.

Returns:

  • (String) —

    The attribute payment_method.



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

def payment_method
  @payment_method
end

#payment_network_response ⇒ PaymentNetworkResponse (readonly)

Returns The attribute payment_network_response.

Returns:



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

def payment_network_response
  @payment_network_response
end

#payment_schedule ⇒ PaymentSchedule (readonly)

Returns The attribute payment_schedule.

Returns:



56
57
58
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 56

def payment_schedule
  @payment_schedule
end

#payment_setup_entry_date ⇒ String (readonly)

The date on which the payment setup is captured in Orbipay. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

Returns:

  • (String) —

    The attribute payment_setup_entry_date.



60
61
62
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 60

def payment_setup_entry_date
  @payment_setup_entry_date
end

#payment_setup_reference ⇒ String (readonly)

The unique identifier in the client system for the payment setup.

Returns:

  • (String) —

    The attribute payment_setup_reference.



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

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.



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

def payment_setup_schedule_type
  @payment_setup_schedule_type
end

#status ⇒ String (readonly)

The status of the payment.

Returns:

  • (String) —

    The attribute status.



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

def status
  @status
end

#url ⇒ String (readonly)

This URL fetches the details of payment setup.

Returns:

  • (String) —

    The attribute url.



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

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 95

def self.attribute_map
  {
    :'id' => :'id', 
    :'url' => :'url', 
    :'fee' => :'fee', 
    :'status' => :'status', 
    :'payment_method' => :'payment_method', 
    :'payment_setup_schedule_type' => :'payment_setup_schedule_type', 
    :'confirmation_number' => :'confirmation_number', 
    :'custom_fields' => :'custom_fields', 
    :'currency_code3d' => :'currency_code3d', 
    :'amount' => :'amount', 
    :'card_cvv_number' => :'card_cvv_number', 
    :'next_payment_date' => :'next_payment_date', 
    :'payment_setup_reference' => :'payment_setup_reference', 
    :'payment_schedule' => :'payment_schedule', 
    :'payment_setup_entry_date' => :'payment_setup_entry_date', 
    :'comments' => :'comments', 
    :'deleted' => :'deleted', 
    :'customer' => :'customer', 
    :'funding_account' => :'funding_account', 
    :'customer_account' => :'customer_account', 
    :'payment_network_response' => :'payment_network_response', 
    :'audit_info' => :'audit_info', 
    :'id_customer' => :'ID_CUSTOMER', 
    :'id_payment_setup' => :'ID_PAYMENT_SETUP' 
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'String',	
    :'url' => :'String',	
    :'fee' => :'Fee',	
    :'status' => :'String',	
    :'payment_method' => :'String',	
    :'payment_setup_schedule_type' => :'String',	
    :'confirmation_number' => :'String',	
    :'custom_fields' => :'Hash<String, String>',	
    :'currency_code3d' => :'String',	
    :'amount' => :'String',	
    :'card_cvv_number' => :'String',	
    :'next_payment_date' => :'String',	
    :'payment_setup_reference' => :'String',	
    :'payment_schedule' => :'PaymentSchedule',	
    :'payment_setup_entry_date' => :'String',	
    :'comments' => :'String',	
    :'deleted' => :'String',	
    :'customer' => :'Customer',	
    :'funding_account' => :'FundingAccount',	
    :'customer_account' => :'CustomerAccount',	
    :'payment_network_response' => :'PaymentNetworkResponse',	
    :'audit_info' => :'AuditInfo',	
    :'id_customer' => :'String',	
    :'id_payment_setup' => :'String'	
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      url == o.url &&
      fee == o.fee &&
      status == o.status &&
      payment_method == o.payment_method &&
      payment_setup_schedule_type == o.payment_setup_schedule_type &&
      confirmation_number == o.confirmation_number &&
      custom_fields == o.custom_fields &&
      currency_code3d == o.currency_code3d &&
      amount == o.amount &&
      card_cvv_number == o.card_cvv_number &&
      next_payment_date == o.next_payment_date &&
      payment_setup_reference == o.payment_setup_reference &&
      payment_schedule == o.payment_schedule &&
      payment_setup_entry_date == o.payment_setup_entry_date &&
      comments == o.comments &&
      deleted == o.deleted &&
      customer == o.customer &&
       == o. &&
       == o. &&
      payment_network_response == o.payment_network_response &&
      audit_info == o.audit_info &&
      id_customer == o.id_customer &&
      id_payment_setup == o.id_payment_setup
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



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
451
452
453
454
455
456
457
458
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 410

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



489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 489

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



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 389

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) ⇒ PaymentSetup

Returns The Instance of PaymentSetup.

Returns:



284
285
286
287
288
289
290
291
292
293
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 284

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::CreateRecurringPaymentSetupHandler.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) ⇒ PaymentSetup

Returns The Instance of PaymentSetup.

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:



254
255
256
257
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 254

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

#delete(invocation_context: nil, live_mode: nil, api_end_point: nil) ⇒ PaymentSetup

Returns The Instance of PaymentSetup.

Returns:



297
298
299
300
301
302
303
304
305
306
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 297

def delete(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::DeletePaymentSetupHandler.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

#deleted_by(requestor: nil, requestor_type: nil) ⇒ PaymentSetup

Returns The Instance of PaymentSetup.

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:



262
263
264
265
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 262

def deleted_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


376
377
378
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 376

def eql?(o)
  self == o
end

#for_client(client_key: nil) ⇒ PaymentSetup

Returns The Instance of PaymentSetup.

Parameters:

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

    attribute in the form of String.

Returns:



163
164
165
166
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 163

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

#for_customer(id_customer: nil) ⇒ PaymentSetup

Returns The Instance of PaymentSetup.

Parameters:

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

    attribute in the form of String.

Returns:



244
245
246
247
248
249
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 244

def for_customer(id_customer: nil)
    @id_customer = id_customer
    @customer = Customer.new
    @customer.set_values(id: id_customer)
    self 
end

#from_account(funding_account: nil) ⇒ PaymentSetup

Returns The Instance of PaymentSetup.

Parameters:

  • funding_account (FundingAccount) (defaults to: nil) —

    attribute in the form of FundingAccount.

Returns:



188
189
190
191
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 188

def (funding_account: nil)
    @funding_account = 
    self 
end

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

Returns The Instance of PaymentSetup.

Returns:



310
311
312
313
314
315
316
317
318
319
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 310

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



382
383
384
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 382

def hash
  [id, url, fee, status, payment_method, payment_setup_schedule_type, confirmation_number, custom_fields, currency_code3d, amount, card_cvv_number, next_payment_date, payment_setup_reference, payment_schedule, payment_setup_entry_date, comments, deleted, customer, , , payment_network_response, audit_info, id_customer, id_payment_setup].hash
end

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

Returns The Instance of PaymentSetup.

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:



270
271
272
273
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 270

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 



337
338
339
340
341
342
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 337

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_account(customer_account: nil) ⇒ PaymentSetup

Returns The Instance of PaymentSetup.

Parameters:

  • customer_account (CustomerAccount) (defaults to: nil) —

    attribute in the form of CustomerAccount.

Returns:



195
196
197
198
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 195

def (customer_account: nil)
    @customer_account = 
    self 
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



468
469
470
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 468

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



474
475
476
477
478
479
480
481
482
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 474

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



462
463
464
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 462

def to_s
  to_hash.to_s
end

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

Returns The Instance of PaymentSetup.

Returns:



323
324
325
326
327
328
329
330
331
332
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 323

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::UpdatePaymentSetupHandler.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) ⇒ PaymentSetup

Returns The Instance of PaymentSetup.

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:



278
279
280
281
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 278

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) ⇒ PaymentSetup

Returns The Instance of PaymentSetup.

Parameters:

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

    attribute in the form of String.

Returns:



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

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

#with_custom_fields(custom_fields: nil) ⇒ PaymentSetup

Returns The Instance of PaymentSetup.

Parameters:

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

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

Returns:



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

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

#with_details(amount: nil, card_cvv_number: nil, payment_setup_schedule_type: nil) ⇒ PaymentSetup

Returns The Instance of PaymentSetup.

Parameters:

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

    attribute in the form of String.

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

    attribute in the form of String.

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

    attribute in the form of String.

Returns:



179
180
181
182
183
184
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 179

def with_details(amount: nil, card_cvv_number: nil, payment_setup_schedule_type: nil)
    @amount = amount
    @card_cvv_number = card_cvv_number
    @payment_setup_schedule_type = payment_setup_schedule_type
    self 
end

#with_fee(fee: nil) ⇒ PaymentSetup

Returns The Instance of PaymentSetup.

Parameters:

  • fee (Fee) (defaults to: nil) —

    attribute in the form of Fee.

Returns:



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

def with_fee(fee: nil)
    @fee = fee
    self 
end

#with_memo(comments: nil) ⇒ PaymentSetup

Returns The Instance of PaymentSetup.

Parameters:

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

    attribute in the form of String.

Returns:



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

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

#with_payment_schedule(payment_schedule: nil) ⇒ PaymentSetup

Returns The Instance of PaymentSetup.

Parameters:

  • payment_schedule (PaymentSchedule) (defaults to: nil) —

    attribute in the form of PaymentSchedule.

Returns:



209
210
211
212
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 209

def with_payment_schedule(payment_schedule: nil)
    @payment_schedule = payment_schedule
    self 
end

#with_reference(payment_setup_reference: nil) ⇒ PaymentSetup

Returns The Instance of PaymentSetup.

Parameters:

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

    attribute in the form of String.

Returns:



202
203
204
205
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 202

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

#with_status(status: nil) ⇒ PaymentSetup

Returns The Instance of PaymentSetup.

Parameters:

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

    attribute in the form of String.

Returns:



216
217
218
219
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb', line 216

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