Class: PaypalServerSdk::Name

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/paypal_server_sdk/models/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(given_name: SKIP, surname: SKIP) ⇒ Name

Returns a new instance of Name.



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

def initialize(given_name: SKIP, surname: SKIP)
  @given_name = given_name unless given_name == SKIP
  @surname = surname unless surname == SKIP
end

Instance Attribute Details

#given_name ⇒ String

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

Returns:

  • (String) 


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

def given_name
  @given_name
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) 


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

def surname
  @surname
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
 
# File 'lib/paypal_server_sdk/models/name.rb', line 49

def self.from_hash(hash)
  return nil unless hash

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

  # Create object from extracted values.
  Name.new(given_name: given_name,
           surname: surname)
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/name.rb', line 23

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

.nullables ⇒ Object

An array for nullable fields



39
40
41
 
# File 'lib/paypal_server_sdk/models/name.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/name.rb', line 31

def self.optionals
  %w[
    given_name
    surname
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



68
69
70
71
 
# File 'lib/paypal_server_sdk/models/name.rb', line 68

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



62
63
64
65
 
# File 'lib/paypal_server_sdk/models/name.rb', line 62

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