Class: PaypalServerSdk::VaultedDigitalWallet

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

Overview

Resource consolidating common request and response attributes for vaulting a Digital Wallet.

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(description: SKIP, usage_pattern: SKIP, shipping: SKIP, permit_multiple_payment_tokens: false, usage_type: SKIP, customer_type: SKIP) ⇒ VaultedDigitalWallet

Returns a new instance of VaultedDigitalWallet.



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

def initialize(description: SKIP, usage_pattern: SKIP, shipping: SKIP,
               permit_multiple_payment_tokens: false, usage_type: SKIP,
               customer_type: SKIP)
  @description = description unless description == SKIP
  @usage_pattern = usage_pattern unless usage_pattern == SKIP
  @shipping = shipping unless shipping == SKIP
  unless permit_multiple_payment_tokens == SKIP
    @permit_multiple_payment_tokens =
      permit_multiple_payment_tokens
  end
  @usage_type = usage_type unless usage_type == SKIP
  @customer_type = customer_type unless customer_type == SKIP
end

Instance Attribute Details

#customer_type ⇒ PaypalPaymentTokenCustomerType

The customer type associated with a digital wallet payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.

Returns:



46
47
48
 
# File 'lib/paypal_server_sdk/models/vaulted_digital_wallet.rb', line 46

def customer_type
  @customer_type
end

#description ⇒ String

The description displayed to the consumer on the approval flow for a digital wallet, as well as on the merchant view of the payment token management experience. exp: PayPal.com.

Returns:

  • (String) 


17
18
19
 
# File 'lib/paypal_server_sdk/models/vaulted_digital_wallet.rb', line 17

def description
  @description
end

#permit_multiple_payment_tokens ⇒ TrueClass | FalseClass

Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source.

Returns:

  • (TrueClass | FalseClass) 


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

def permit_multiple_payment_tokens
  @permit_multiple_payment_tokens
end

#shipping ⇒ VaultedDigitalWalletShippingDetails

The shipping details.

Returns:



25
26
27
 
# File 'lib/paypal_server_sdk/models/vaulted_digital_wallet.rb', line 25

def shipping
  @shipping
end

#usage_pattern ⇒ UsagePattern

Expected business/charge model for the billing agreement.

Returns:



21
22
23
 
# File 'lib/paypal_server_sdk/models/vaulted_digital_wallet.rb', line 21

def usage_pattern
  @usage_pattern
end

#usage_type ⇒ PaypalPaymentTokenUsageType

The usage type associated with a digital wallet payment token.

Returns:



40
41
42
 
# File 'lib/paypal_server_sdk/models/vaulted_digital_wallet.rb', line 40

def usage_type
  @usage_type
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  description = hash.key?('description') ? hash['description'] : SKIP
  usage_pattern = hash.key?('usage_pattern') ? hash['usage_pattern'] : SKIP
  shipping = VaultedDigitalWalletShippingDetails.from_hash(hash['shipping']) if
    hash['shipping']
  permit_multiple_payment_tokens =
    hash['permit_multiple_payment_tokens'] ||= false
  usage_type = hash.key?('usage_type') ? hash['usage_type'] : SKIP
  customer_type = hash.key?('customer_type') ? hash['customer_type'] : SKIP

  # Create object from extracted values.

  VaultedDigitalWallet.new(description: description,
                           usage_pattern: usage_pattern,
                           shipping: shipping,
                           permit_multiple_payment_tokens: permit_multiple_payment_tokens,
                           usage_type: usage_type,
                           customer_type: customer_type)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['description'] = 'description'
  @_hash['usage_pattern'] = 'usage_pattern'
  @_hash['shipping'] = 'shipping'
  @_hash['permit_multiple_payment_tokens'] =
    'permit_multiple_payment_tokens'
  @_hash['usage_type'] = 'usage_type'
  @_hash['customer_type'] = 'customer_type'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    description
    usage_pattern
    shipping
    permit_multiple_payment_tokens
    usage_type
    customer_type
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



124
125
126
127
128
129
130
 
# File 'lib/paypal_server_sdk/models/vaulted_digital_wallet.rb', line 124

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} description: #{@description.inspect}, usage_pattern:"\
  " #{@usage_pattern.inspect}, shipping: #{@shipping.inspect}, permit_multiple_payment_tokens:"\
  " #{@permit_multiple_payment_tokens.inspect}, usage_type: #{@usage_type.inspect},"\
  " customer_type: #{@customer_type.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



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

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} description: #{@description}, usage_pattern: #{@usage_pattern}, shipping:"\
  " #{@shipping}, permit_multiple_payment_tokens: #{@permit_multiple_payment_tokens},"\
  " usage_type: #{@usage_type}, customer_type: #{@customer_type}>"
end