Class: PaypalServerSdk::PayerName

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

Overview

The name of the party.

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(prefix: SKIP, given_name: SKIP, surname: SKIP, middle_name: SKIP, suffix: SKIP, alternate_full_name: SKIP, full_name: SKIP) ⇒ PayerName

Returns a new instance of PayerName.



76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/paypal_server_sdk/models/payer_name.rb', line 76

def initialize(prefix: SKIP, given_name: SKIP, surname: SKIP,
               middle_name: SKIP, suffix: SKIP, alternate_full_name: SKIP,
               full_name: SKIP)
  @prefix = prefix unless prefix == SKIP
  @given_name = given_name unless given_name == SKIP
  @surname = surname unless surname == SKIP
  @middle_name = middle_name unless middle_name == SKIP
  @suffix = suffix unless suffix == SKIP
  @alternate_full_name = alternate_full_name unless alternate_full_name == SKIP
  @full_name = full_name unless full_name == SKIP
end

Instance Attribute Details

#alternate_full_name ⇒ String

DEPRECATED. The party’s alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.

Returns:

  • (String) 


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

def alternate_full_name
  @alternate_full_name
end

#full_name ⇒ String

When the party is a person, the party’s full name.

Returns:

  • (String) 


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

def full_name
  @full_name
end

#given_name ⇒ String

When the party is a person, the party’s given, or first, name.

Returns:

  • (String) 


18
19
20
 
# File 'lib/paypal_server_sdk/models/payer_name.rb', line 18

def given_name
  @given_name
end

#middle_name ⇒ String

When the party is a person, the party’s middle name. Use also to store multiple middle names including the patronymic, or father’s, middle name.

Returns:

  • (String) 


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

def middle_name
  @middle_name
end

#prefix ⇒ String

The prefix, or title, to the party’s name.

Returns:

  • (String) 


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

def prefix
  @prefix
end

#suffix ⇒ String

The suffix for the party’s name.

Returns:

  • (String) 


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

def suffix
  @suffix
end

#surname ⇒ String

When the party is a person, the party’s surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother’s, surname.

Returns:

  • (String) 


24
25
26
 
# File 'lib/paypal_server_sdk/models/payer_name.rb', line 24

def surname
  @surname
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



89
90
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/payer_name.rb', line 89

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  prefix = hash.key?('prefix') ? hash['prefix'] : SKIP
  given_name = hash.key?('given_name') ? hash['given_name'] : SKIP
  surname = hash.key?('surname') ? hash['surname'] : SKIP
  middle_name = hash.key?('middle_name') ? hash['middle_name'] : SKIP
  suffix = hash.key?('suffix') ? hash['suffix'] : SKIP
  alternate_full_name =
    hash.key?('alternate_full_name') ? hash['alternate_full_name'] : SKIP
  full_name = hash.key?('full_name') ? hash['full_name'] : SKIP

  # Create object from extracted values.
  PayerName.new(prefix: prefix,
                given_name: given_name,
                surname: surname,
                middle_name: middle_name,
                suffix: suffix,
                alternate_full_name: alternate_full_name,
                full_name: full_name)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['prefix'] = 'prefix'
  @_hash['given_name'] = 'given_name'
  @_hash['surname'] = 'surname'
  @_hash['middle_name'] = 'middle_name'
  @_hash['suffix'] = 'suffix'
  @_hash['alternate_full_name'] = 'alternate_full_name'
  @_hash['full_name'] = 'full_name'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



72
73
74
 
# File 'lib/paypal_server_sdk/models/payer_name.rb', line 72

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/paypal_server_sdk/models/payer_name.rb', line 59

def self.optionals
  %w[
    prefix
    given_name
    surname
    middle_name
    suffix
    alternate_full_name
    full_name
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



121
122
123
124
125
126
 
# File 'lib/paypal_server_sdk/models/payer_name.rb', line 121

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} prefix: #{@prefix.inspect}, given_name: #{@given_name.inspect}, surname:"\
  " #{@surname.inspect}, middle_name: #{@middle_name.inspect}, suffix: #{@suffix.inspect},"\
  " alternate_full_name: #{@alternate_full_name.inspect}, full_name: #{@full_name.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



113
114
115
116
117
118
 
# File 'lib/paypal_server_sdk/models/payer_name.rb', line 113

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} prefix: #{@prefix}, given_name: #{@given_name}, surname: #{@surname},"\
  " middle_name: #{@middle_name}, suffix: #{@suffix}, alternate_full_name:"\
  " #{@alternate_full_name}, full_name: #{@full_name}>"
end