Class: FdxV660Api::PartyEntity

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

Overview

FDX Participant - an entity or person that is a part of a FDX API transaction

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(name:, type:, home_uri: SKIP, logo_uri: SKIP, registry: SKIP, registered_entity_name: SKIP, registered_entity_id: SKIP, additional_properties: nil) ⇒ PartyEntity

Returns a new instance of PartyEntity.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/fdx_v660_api/models/party_entity.rb', line 72

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

  @name = name
  @type = type
  @home_uri = home_uri unless home_uri == SKIP
  @logo_uri = logo_uri unless logo_uri == SKIP
  @registry = registry unless registry == SKIP
  @registered_entity_name = registered_entity_name unless registered_entity_name == SKIP
  @registered_entity_id = registered_entity_id unless registered_entity_id == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#home_uri ⇒ String

URI for party, where an end user could learn more about the company or application involved in the data sharing chain

Returns:

  • (String) 


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

def home_uri
  @home_uri
end

#logo_uri ⇒ String

URI for a logo asset to be displayed to the end user

Returns:

  • (String) 


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

def logo_uri
  @logo_uri
end

#name ⇒ String

Human recognizable common name

Returns:

  • (String) 


15
16
17
 
# File 'lib/fdx_v660_api/models/party_entity.rb', line 15

def name
  @name
end

#registered_entity_id ⇒ String

Registered id of party

Returns:

  • (String) 


41
42
43
 
# File 'lib/fdx_v660_api/models/party_entity.rb', line 41

def registered_entity_id
  @registered_entity_id
end

#registered_entity_name ⇒ String

Registered name of party

Returns:

  • (String) 


37
38
39
 
# File 'lib/fdx_v660_api/models/party_entity.rb', line 37

def registered_entity_name
  @registered_entity_name
end

#registry ⇒ Registry3

The registry containing the party's registration with name and id: FDX, GLEIF, ICANN, PRIVATE

Returns:



33
34
35
 
# File 'lib/fdx_v660_api/models/party_entity.rb', line 33

def registry
  @registry
end

#type ⇒ PartyType3

Extensible string enum identifying the type of the party

Returns:



19
20
21
 
# File 'lib/fdx_v660_api/models/party_entity.rb', line 19

def type
  @type
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
111
112
113
114
115
116
117
118
119
 
# File 'lib/fdx_v660_api/models/party_entity.rb', line 89

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  name = hash.key?('name') ? hash['name'] : nil
  type = hash.key?('type') ? hash['type'] : nil
  home_uri = hash.key?('homeUri') ? hash['homeUri'] : SKIP
  logo_uri = hash.key?('logoUri') ? hash['logoUri'] : SKIP
  registry = hash.key?('registry') ? hash['registry'] : SKIP
  registered_entity_name =
    hash.key?('registeredEntityName') ? hash['registeredEntityName'] : SKIP
  registered_entity_id =
    hash.key?('registeredEntityId') ? hash['registeredEntityId'] : 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.
  PartyEntity.new(name: name,
                  type: type,
                  home_uri: home_uri,
                  logo_uri: logo_uri,
                  registry: registry,
                  registered_entity_name: registered_entity_name,
                  registered_entity_id: registered_entity_id,
                  additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/fdx_v660_api/models/party_entity.rb', line 44

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['name'] = 'name'
  @_hash['type'] = 'type'
  @_hash['home_uri'] = 'homeUri'
  @_hash['logo_uri'] = 'logoUri'
  @_hash['registry'] = 'registry'
  @_hash['registered_entity_name'] = 'registeredEntityName'
  @_hash['registered_entity_id'] = 'registeredEntityId'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



68
69
70
 
# File 'lib/fdx_v660_api/models/party_entity.rb', line 68

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



57
58
59
60
61
62
63
64
65
 
# File 'lib/fdx_v660_api/models/party_entity.rb', line 57

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

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



131
132
133
134
135
136
137
 
# File 'lib/fdx_v660_api/models/party_entity.rb', line 131

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



122
123
124
125
126
127
128
 
# File 'lib/fdx_v660_api/models/party_entity.rb', line 122

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