Class: FdxV660Api::CustomerNameEntity

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/fdx_v660_api/models/customer_name_entity.rb

Overview

The name of an individual in their role as a customer. Japanese participants should send 'Kana' values in name fields using the character set defined by Zengin (Japanese Banks' Payment Clearing Network)

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(first: SKIP, middle: SKIP, last: SKIP, suffix: SKIP, prefix: SKIP, company: SKIP, additional_properties: nil) ⇒ CustomerNameEntity

Returns a new instance of CustomerNameEntity.



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/fdx_v660_api/models/customer_name_entity.rb', line 67

def initialize(first: SKIP, middle: SKIP, last: SKIP, suffix: SKIP,
               prefix: SKIP, company: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @first = first unless first == SKIP
  @middle = middle unless middle == SKIP
  @last = last unless last == SKIP
  @suffix = suffix unless suffix == SKIP
  @prefix = prefix unless prefix == SKIP
  @company = company unless company == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#company ⇒ String

Company name

Returns:

  • (String) 


36
37
38
 
# File 'lib/fdx_v660_api/models/customer_name_entity.rb', line 36

def company
  @company
end

#first ⇒ String

First name

Returns:

  • (String) 


16
17
18
 
# File 'lib/fdx_v660_api/models/customer_name_entity.rb', line 16

def first
  @first
end

#last ⇒ String

Last name

Returns:

  • (String) 


24
25
26
 
# File 'lib/fdx_v660_api/models/customer_name_entity.rb', line 24

def last
  @last
end

#middle ⇒ String

Middle initial

Returns:

  • (String) 


20
21
22
 
# File 'lib/fdx_v660_api/models/customer_name_entity.rb', line 20

def middle
  @middle
end

#prefix ⇒ String

Name prefix, e.g. Mr.

Returns:

  • (String) 


32
33
34
 
# File 'lib/fdx_v660_api/models/customer_name_entity.rb', line 32

def prefix
  @prefix
end

#suffix ⇒ String

Generational or academic suffix

Returns:

  • (String) 


28
29
30
 
# File 'lib/fdx_v660_api/models/customer_name_entity.rb', line 28

def suffix
  @suffix
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/fdx_v660_api/models/customer_name_entity.rb', line 82

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  first = hash.key?('first') ? hash['first'] : SKIP
  middle = hash.key?('middle') ? hash['middle'] : SKIP
  last = hash.key?('last') ? hash['last'] : SKIP
  suffix = hash.key?('suffix') ? hash['suffix'] : SKIP
  prefix = hash.key?('prefix') ? hash['prefix'] : SKIP
  company = hash.key?('company') ? hash['company'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  CustomerNameEntity.new(first: first,
                         middle: middle,
                         last: last,
                         suffix: suffix,
                         prefix: prefix,
                         company: company,
                         additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['first'] = 'first'
  @_hash['middle'] = 'middle'
  @_hash['last'] = 'last'
  @_hash['suffix'] = 'suffix'
  @_hash['prefix'] = 'prefix'
  @_hash['company'] = 'company'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



63
64
65
 
# File 'lib/fdx_v660_api/models/customer_name_entity.rb', line 63

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



51
52
53
54
55
56
57
58
59
60
 
# File 'lib/fdx_v660_api/models/customer_name_entity.rb', line 51

def self.optionals
  %w[
    first
    middle
    last
    suffix
    prefix
    company
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



112
113
114
115
116
117
118
 
# File 'lib/fdx_v660_api/models/customer_name_entity.rb', line 112

def self.validate(value)
  return true if value.instance_of? self

  return false unless value.instance_of? Hash

  true
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



129
130
131
132
133
134
 
# File 'lib/fdx_v660_api/models/customer_name_entity.rb', line 129

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} first: #{@first.inspect}, middle: #{@middle.inspect}, last:"\
  " #{@last.inspect}, suffix: #{@suffix.inspect}, prefix: #{@prefix.inspect}, company:"\
  " #{@company.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



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

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} first: #{@first}, middle: #{@middle}, last: #{@last}, suffix: #{@suffix},"\
  " prefix: #{@prefix}, company: #{@company}, additional_properties:"\
  " #{@additional_properties}>"
end