Class: PaypalServerSdk::CustomerResponse

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

Overview

Customer in merchant’s or partner’s system of records.

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, merchant_customer_id: SKIP) ⇒ CustomerResponse

Returns a new instance of CustomerResponse.



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

def initialize(id: SKIP, merchant_customer_id: SKIP)
  @id = id unless id == SKIP
  @merchant_customer_id = merchant_customer_id unless merchant_customer_id == SKIP
end

Instance Attribute Details

#id ⇒ String

The unique ID for a customer generated by PayPal.

Returns:

  • (String) 


14
15
16
 
# File 'lib/paypal_server_sdk/models/customer_response.rb', line 14

def id
  @id
end

#merchant_customer_id ⇒ String

Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a customer.

Returns:

  • (String) 


20
21
22
 
# File 'lib/paypal_server_sdk/models/customer_response.rb', line 20

def merchant_customer_id
  @merchant_customer_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  id = hash.key?('id') ? hash['id'] : SKIP
  merchant_customer_id =
    hash.key?('merchant_customer_id') ? hash['merchant_customer_id'] : SKIP

  # Create object from extracted values.
  CustomerResponse.new(id: id,
                       merchant_customer_id: merchant_customer_id)
end

.names ⇒ Object

A mapping from model property names to API property names.



23
24
25
26
27
28
 
# File 'lib/paypal_server_sdk/models/customer_response.rb', line 23

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

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



31
32
33
34
35
36
 
# File 'lib/paypal_server_sdk/models/customer_response.rb', line 31

def self.optionals
  %w[
    id
    merchant_customer_id
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



69
70
71
72
73
 
# File 'lib/paypal_server_sdk/models/customer_response.rb', line 69

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



63
64
65
66
 
# File 'lib/paypal_server_sdk/models/customer_response.rb', line 63

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