Class: PaypalServerSdk::VaultInstruction

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

Overview

Base vaulting specification. The object can be extended for specific use cases within each payment_source that supports vaulting.

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(store_in_vault:) ⇒ VaultInstruction

Returns a new instance of VaultInstruction.



34
35
36
 
# File 'lib/paypal_server_sdk/models/vault_instruction.rb', line 34

def initialize(store_in_vault:)
  @store_in_vault = store_in_vault
end

Instance Attribute Details

#store_in_vault ⇒ StoreInVaultInstruction

Defines how and when the payment source gets vaulted.

Returns:



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

def store_in_vault
  @store_in_vault
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



39
40
41
42
43
44
45
46
47
48
 
# File 'lib/paypal_server_sdk/models/vault_instruction.rb', line 39

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  store_in_vault =
    hash.key?('store_in_vault') ? hash['store_in_vault'] : nil

  # Create object from extracted values.
  VaultInstruction.new(store_in_vault: store_in_vault)
end

.names ⇒ Object

A mapping from model property names to API property names.



18
19
20
21
22
 
# File 'lib/paypal_server_sdk/models/vault_instruction.rb', line 18

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

.nullables ⇒ Object

An array for nullable fields



30
31
32
 
# File 'lib/paypal_server_sdk/models/vault_instruction.rb', line 30

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



57
58
59
60
 
# File 'lib/paypal_server_sdk/models/vault_instruction.rb', line 57

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



51
52
53
54
 
# File 'lib/paypal_server_sdk/models/vault_instruction.rb', line 51

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