Class: PaypalServerSdk::VaultExperienceContext

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

Overview

Customizes the Vault creation flow experience for your customers.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(brand_name: SKIP, locale: SKIP, return_url: SKIP, cancel_url: SKIP, shipping_preference: 'GET_FROM_FILE', vault_instruction: 'ON_CREATE_PAYMENT_TOKENS') ⇒ VaultExperienceContext

Returns a new instance of VaultExperienceContext.



79
80
81
82
83
84
85
86
87
88
 
# File 'lib/paypal_server_sdk/models/vault_experience_context.rb', line 79

def initialize(brand_name: SKIP, locale: SKIP, return_url: SKIP,
               cancel_url: SKIP, shipping_preference: 'GET_FROM_FILE',
               vault_instruction: 'ON_CREATE_PAYMENT_TOKENS')
  @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
  @shipping_preference = shipping_preference unless shipping_preference == SKIP
  @vault_instruction = vault_instruction unless vault_instruction == SKIP
end

Instance Attribute Details

#brand_name ⇒ String

The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.

Returns:

  • (String) 


16
17
18
 
# File 'lib/paypal_server_sdk/models/vault_experience_context.rb', line 16

def brand_name
  @brand_name
end

#cancel_url ⇒ String

The URL where the customer is redirected after customer cancels or leaves the flow. It is a required field for contingency flows like PayPal wallet, 3DS.

Returns:

  • (String) 


39
40
41
 
# File 'lib/paypal_server_sdk/models/vault_experience_context.rb', line 39

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) 


27
28
29
 
# File 'lib/paypal_server_sdk/models/vault_experience_context.rb', line 27

def locale
  @locale
end

#return_url ⇒ String

The URL where the customer is redirected after customer approves leaves the flow. It is a required field for contingency flows like PayPal wallet, 3DS.

Returns:

  • (String) 


33
34
35
 
# File 'lib/paypal_server_sdk/models/vault_experience_context.rb', line 33

def return_url
  @return_url
end

#shipping_preference ⇒ String

The shipping preference. This only applies to PayPal payment source.

Returns:

  • (String) 


43
44
45
 
# File 'lib/paypal_server_sdk/models/vault_experience_context.rb', line 43

def shipping_preference
  @shipping_preference
end

#vault_instruction ⇒ String

Vault Instruction on action to be performed after a successful payer approval.

Returns:

  • (String) 


48
49
50
 
# File 'lib/paypal_server_sdk/models/vault_experience_context.rb', line 48

def vault_instruction
  @vault_instruction
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/paypal_server_sdk/models/vault_experience_context.rb', line 91

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
  shipping_preference = hash['shipping_preference'] ||= 'GET_FROM_FILE'
  vault_instruction =
    hash['vault_instruction'] ||= 'ON_CREATE_PAYMENT_TOKENS'

  # Create object from extracted values.
  VaultExperienceContext.new(brand_name: brand_name,
                             locale: locale,
                             return_url: return_url,
                             cancel_url: cancel_url,
                             shipping_preference: shipping_preference,
                             vault_instruction: vault_instruction)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

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['shipping_preference'] = 'shipping_preference'
  @_hash['vault_instruction'] = 'vault_instruction'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



75
76
77
 
# File 'lib/paypal_server_sdk/models/vault_experience_context.rb', line 75

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

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