Class: PaypalServerSdk::ConfirmOrderRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/paypal_server_sdk/models/confirm_order_request.rb

Overview

Payer confirms the intent to pay for the Order using the provided payment source.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(payment_source:, application_context: SKIP) ⇒ ConfirmOrderRequest

Returns a new instance of ConfirmOrderRequest.



41
42
43
44
# File 'lib/paypal_server_sdk/models/confirm_order_request.rb', line 41

def initialize(payment_source:, application_context: SKIP)
  @payment_source = payment_source
  @application_context = application_context unless application_context == SKIP
end

Instance Attribute Details

#application_contextOrderConfirmApplicationContext

Customizes the payer confirmation experience.



19
20
21
# File 'lib/paypal_server_sdk/models/confirm_order_request.rb', line 19

def application_context
  @application_context
end

#payment_sourcePaymentSource

The payment source definition.

Returns:



15
16
17
# File 'lib/paypal_server_sdk/models/confirm_order_request.rb', line 15

def payment_source
  @payment_source
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



47
48
49
50
51
52
53
54
55
56
57
58
# File 'lib/paypal_server_sdk/models/confirm_order_request.rb', line 47

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  payment_source = PaymentSource.from_hash(hash['payment_source']) if hash['payment_source']
  application_context = OrderConfirmApplicationContext.from_hash(hash['application_context']) if
    hash['application_context']

  # Create object from extracted values.
  ConfirmOrderRequest.new(payment_source: payment_source,
                          application_context: application_context)
end

.namesObject

A mapping from model property names to API property names.



22
23
24
25
26
27
# File 'lib/paypal_server_sdk/models/confirm_order_request.rb', line 22

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['payment_source'] = 'payment_source'
  @_hash['application_context'] = 'application_context'
  @_hash
end

.nullablesObject

An array for nullable fields



37
38
39
# File 'lib/paypal_server_sdk/models/confirm_order_request.rb', line 37

def self.nullables
  []
end

.optionalsObject

An array for optional fields



30
31
32
33
34
# File 'lib/paypal_server_sdk/models/confirm_order_request.rb', line 30

def self.optionals
  %w[
    application_context
  ]
end

Instance Method Details

#inspectObject

Provides a debugging-friendly string with detailed object information.



68
69
70
71
72
# File 'lib/paypal_server_sdk/models/confirm_order_request.rb', line 68

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} payment_source: #{@payment_source.inspect}, application_context:"\
  " #{@application_context.inspect}>"
end

#to_sObject

Provides a human-readable string representation of the object.



61
62
63
64
65
# File 'lib/paypal_server_sdk/models/confirm_order_request.rb', line 61

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} payment_source: #{@payment_source}, application_context:"\
  " #{@application_context}>"
end