Class: PaypalServerSdk::OrderConfirmApplicationContext

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

Overview

Customizes the payer confirmation experience.

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(brand_name: SKIP, locale: SKIP, return_url: SKIP, cancel_url: SKIP, stored_payment_source: SKIP) ⇒ OrderConfirmApplicationContext

Returns a new instance of OrderConfirmApplicationContext.



78
79
80
81
82
83
84
85
 
# File 'lib/paypal_server_sdk/models/order_confirm_application_context.rb', line 78

def initialize(brand_name: SKIP, locale: SKIP, return_url: SKIP,
               cancel_url: SKIP, stored_payment_source: SKIP)
  @brand_name = brand_name unless brand_name == SKIP
  @locale = locale unless locale == SKIP
  @return_url = return_url unless return_url == SKIP
  @cancel_url = cancel_url unless cancel_url == SKIP
  @stored_payment_source = stored_payment_source unless stored_payment_source == SKIP
end

Instance Attribute Details

#brand_name ⇒ String

Label to present to your payer as part of the PayPal hosted web experience.

Returns:

  • (String) 


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

def brand_name
  @brand_name
end

#cancel_url ⇒ String

The URL where the customer is redirected after the customer cancels the payment.

Returns:

  • (String) 


36
37
38
 
# File 'lib/paypal_server_sdk/models/order_confirm_application_context.rb', line 36

def cancel_url
  @cancel_url
end

#locale ⇒ String

The [language tag](tools.ietf.org/html/bcp47#section-2) for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the [ISO 639-2 language code](www.loc.gov/standards/iso639-2/php/code_list.php), the optional [ISO-15924 script tag](www.unicode.org/iso15924/codelists.html), and the [ISO-3166 alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region code](unstats.un.org/unsd/methodology/m49/).

Returns:

  • (String) 


26
27
28
 
# File 'lib/paypal_server_sdk/models/order_confirm_application_context.rb', line 26

def locale
  @locale
end

#return_url ⇒ String

The URL where the customer is redirected after the customer approves the payment.

Returns:

  • (String) 


31
32
33
 
# File 'lib/paypal_server_sdk/models/order_confirm_application_context.rb', line 31

def return_url
  @return_url
end

#stored_payment_source ⇒ StoredPaymentSource

Provides additional details to process a payment using a ‘payment_source` that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file). Parameter compatibility: `payment_type=ONE_TIME` is compatible only with `payment_initiator=CUSTOMER`. `usage=FIRST` is compatible only with `payment_initiator=CUSTOMER`. `previous_transaction_reference` or `previous_network_transaction_reference` is compatible only with `payment_initiator=MERCHANT`. Only one of the parameters - `previous_transaction_reference` and `previous_network_transaction_reference` - can be present in the request.

Returns:



49
50
51
 
# File 'lib/paypal_server_sdk/models/order_confirm_application_context.rb', line 49

def stored_payment_source
  @stored_payment_source
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/paypal_server_sdk/models/order_confirm_application_context.rb', line 88

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  brand_name = hash.key?('brand_name') ? hash['brand_name'] : SKIP
  locale = hash.key?('locale') ? hash['locale'] : SKIP
  return_url = hash.key?('return_url') ? hash['return_url'] : SKIP
  cancel_url = hash.key?('cancel_url') ? hash['cancel_url'] : SKIP
  stored_payment_source = StoredPaymentSource.from_hash(hash['stored_payment_source']) if
    hash['stored_payment_source']

  # Create object from extracted values.
  OrderConfirmApplicationContext.new(brand_name: brand_name,
                                     locale: locale,
                                     return_url: return_url,
                                     cancel_url: cancel_url,
                                     stored_payment_source: stored_payment_source)
end

.names ⇒ Object

A mapping from model property names to API property names.



52
53
54
55
56
57
58
59
60
 
# File 'lib/paypal_server_sdk/models/order_confirm_application_context.rb', line 52

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['brand_name'] = 'brand_name'
  @_hash['locale'] = 'locale'
  @_hash['return_url'] = 'return_url'
  @_hash['cancel_url'] = 'cancel_url'
  @_hash['stored_payment_source'] = 'stored_payment_source'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



74
75
76
 
# File 'lib/paypal_server_sdk/models/order_confirm_application_context.rb', line 74

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



63
64
65
66
67
68
69
70
71
 
# File 'lib/paypal_server_sdk/models/order_confirm_application_context.rb', line 63

def self.optionals
  %w[
    brand_name
    locale
    return_url
    cancel_url
    stored_payment_source
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



115
116
117
118
119
120
 
# File 'lib/paypal_server_sdk/models/order_confirm_application_context.rb', line 115

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} brand_name: #{@brand_name.inspect}, locale: #{@locale.inspect}, return_url:"\
  " #{@return_url.inspect}, cancel_url: #{@cancel_url.inspect}, stored_payment_source:"\
  " #{@stored_payment_source.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



108
109
110
111
112
 
# File 'lib/paypal_server_sdk/models/order_confirm_application_context.rb', line 108

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} brand_name: #{@brand_name}, locale: #{@locale}, return_url: #{@return_url},"\
  " cancel_url: #{@cancel_url}, stored_payment_source: #{@stored_payment_source}>"
end