Class: FdxV660Api::RegistryReference

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

Overview

Used for registry references. Properties in this structure use 'snake_case' names to match the properties in IETF RFC 7591

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(registered_entity_name: SKIP, registered_entity_id: SKIP, registry: SKIP, additional_properties: nil) ⇒ RegistryReference

Returns a new instance of RegistryReference.



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

def initialize(registered_entity_name: SKIP, registered_entity_id: SKIP,
               registry: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @registered_entity_name = registered_entity_name unless registered_entity_name == SKIP
  @registered_entity_id = registered_entity_id unless registered_entity_id == SKIP
  @registry = registry unless registry == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#registered_entity_id ⇒ String

An ID representing the intermediary that can be looked up from a legal identity registry source

Returns:

  • (String) 


21
22
23
 
# File 'lib/fdx_v660_api/models/registry_reference.rb', line 21

def registered_entity_id
  @registered_entity_id
end

#registered_entity_name ⇒ String

The legal company name for the intermediary

Returns:

  • (String) 


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

def registered_entity_name
  @registered_entity_name
end

#registry ⇒ Registry2

The Registry source

Returns:



25
26
27
 
# File 'lib/fdx_v660_api/models/registry_reference.rb', line 25

def registry
  @registry
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/fdx_v660_api/models/registry_reference.rb', line 62

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  registered_entity_name =
    hash.key?('registered_entity_name') ? hash['registered_entity_name'] : SKIP
  registered_entity_id =
    hash.key?('registered_entity_id') ? hash['registered_entity_id'] : SKIP
  registry = hash.key?('registry') ? hash['registry'] : 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.
  RegistryReference.new(registered_entity_name: registered_entity_name,
                        registered_entity_id: registered_entity_id,
                        registry: registry,
                        additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



28
29
30
31
32
33
34
 
# File 'lib/fdx_v660_api/models/registry_reference.rb', line 28

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['registered_entity_name'] = 'registered_entity_name'
  @_hash['registered_entity_id'] = 'registered_entity_id'
  @_hash['registry'] = 'registry'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



46
47
48
 
# File 'lib/fdx_v660_api/models/registry_reference.rb', line 46

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



37
38
39
40
41
42
43
 
# File 'lib/fdx_v660_api/models/registry_reference.rb', line 37

def self.optionals
  %w[
    registered_entity_name
    registered_entity_id
    registry
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



95
96
97
98
99
100
 
# File 'lib/fdx_v660_api/models/registry_reference.rb', line 95

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



87
88
89
90
91
92
 
# File 'lib/fdx_v660_api/models/registry_reference.rb', line 87

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} registered_entity_name: #{@registered_entity_name}, registered_entity_id:"\
  " #{@registered_entity_id}, registry: #{@registry}, additional_properties:"\
  " #{@additional_properties}>"
end