Class: PaypalServerSdk::SetupTokenResponse

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

Overview

Minimal representation of a cached setup token.

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(id: SKIP, customer: SKIP, status: PaymentTokenStatus::CREATED, payment_source: SKIP, links: SKIP) ⇒ SetupTokenResponse

Returns a new instance of SetupTokenResponse.



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

def initialize(id: SKIP, customer: SKIP,
               status: PaymentTokenStatus::CREATED, payment_source: SKIP,
               links: SKIP)
  @id = id unless id == SKIP
  @customer = customer unless customer == SKIP
  @status = status unless status == SKIP
  @payment_source = payment_source unless payment_source == SKIP
  @links = links unless links == SKIP
end

Instance Attribute Details

#customer ⇒ Customer

This object defines a customer in your system. Use it to manage customer profiles, save payment methods and contact details.

Returns:



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

def customer
  @customer
end

#id ⇒ String

The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant’s server so the saved payment source can be used for future transactions.

Returns:

  • (String) 


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

def id
  @id
end

#links ⇒ Array[LinkDescription]

An array of related [HATEOAS links](/api/rest/responses/#hateoas).

Returns:



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

def links
  @links
end

#payment_source ⇒ SetupTokenResponsePaymentSource

The setup payment method details.

Returns:



29
30
31
 
# File 'lib/paypal_server_sdk/models/setup_token_response.rb', line 29

def payment_source
  @payment_source
end

#status ⇒ PaymentTokenStatus

The status of the payment token.

Returns:



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

def status
  @status
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/paypal_server_sdk/models/setup_token_response.rb', line 73

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  id = hash.key?('id') ? hash['id'] : SKIP
  customer = Customer.from_hash(hash['customer']) if hash['customer']
  status = hash['status'] ||= PaymentTokenStatus::CREATED
  payment_source = SetupTokenResponsePaymentSource.from_hash(hash['payment_source']) if
    hash['payment_source']
  # Parameter is an array, so we need to iterate through it
  links = nil
  unless hash['links'].nil?
    links = []
    hash['links'].each do |structure|
      links << (LinkDescription.from_hash(structure) if structure)
    end
  end

  links = SKIP unless hash.key?('links')

  # Create object from extracted values.
  SetupTokenResponse.new(id: id,
                         customer: customer,
                         status: status,
                         payment_source: payment_source,
                         links: links)
end

.names ⇒ Object

A mapping from model property names to API property names.



36
37
38
39
40
41
42
43
44
 
# File 'lib/paypal_server_sdk/models/setup_token_response.rb', line 36

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['id'] = 'id'
  @_hash['customer'] = 'customer'
  @_hash['status'] = 'status'
  @_hash['payment_source'] = 'payment_source'
  @_hash['links'] = 'links'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    id
    customer
    status
    payment_source
    links
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



109
110
111
112
113
 
# File 'lib/paypal_server_sdk/models/setup_token_response.rb', line 109

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



102
103
104
105
106
 
# File 'lib/paypal_server_sdk/models/setup_token_response.rb', line 102

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