Class: ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity::LegalEntityAssociation

Inherits:
Internal::Type::BaseModel
  • Object
show all
Defined in:
lib/modern_treasury/models/connection_legal_entity_create_params.rb

Defined Under Namespace

Modules: RelationshipType

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(relationship_types: , child_legal_entity: nil, child_legal_entity_id: nil, ownership_percentage: nil, title: nil) ⇒ Object

Parameters:



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/modern_treasury/models/connection_legal_entity_create_params.rb', line 264

class LegalEntityAssociation < ModernTreasury::Internal::Type::BaseModel
  # @!attribute relationship_types
  #
  #   @return [Array<Symbol, ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity::LegalEntityAssociation::RelationshipType>]
  required :relationship_types,
           -> do
             ModernTreasury::Internal::Type::ArrayOf[
               enum: ModernTreasury::ConnectionLegalEntityCreateParams::LegalEntity::LegalEntityAssociation::RelationshipType
             ]
           end

  # @!attribute child_legal_entity
  #   The child legal entity.
  #
  #   @return [ModernTreasury::Models::ChildLegalEntityCreate, nil]
  optional :child_legal_entity, -> { ModernTreasury::ChildLegalEntityCreate }

  # @!attribute child_legal_entity_id
  #   The ID of the child legal entity.
  #
  #   @return [String, nil]
  optional :child_legal_entity_id, String

  # @!attribute ownership_percentage
  #   The child entity's ownership percentage iff they are a beneficial owner.
  #
  #   @return [Integer, nil]
  optional :ownership_percentage, Integer, nil?: true

  # @!attribute title
  #   The job title of the child entity at the parent entity.
  #
  #   @return [String, nil]
  optional :title, String, nil?: true

  # @!method initialize(relationship_types:, child_legal_entity: nil, child_legal_entity_id: nil, ownership_percentage: nil, title: nil)
  #   @param relationship_types [Array<Symbol, ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity::LegalEntityAssociation::RelationshipType>]
  #
  #   @param child_legal_entity [ModernTreasury::Models::ChildLegalEntityCreate] The child legal entity.
  #
  #   @param child_legal_entity_id [String] The ID of the child legal entity.
  #
  #   @param ownership_percentage [Integer, nil] The child entity's ownership percentage iff they are a beneficial owner.
  #
  #   @param title [String, nil] The job title of the child entity at the parent entity.

  # A list of relationship types for how the child entity relates to parent entity.
  module RelationshipType
    extend ModernTreasury::Internal::Type::Enum

    AUTHORIZED_SIGNER = :authorized_signer
    BENEFICIAL_OWNER = :beneficial_owner
    CONTROL_PERSON = :control_person

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

The child legal entity.

Returns:



279
 
# File 'lib/modern_treasury/models/connection_legal_entity_create_params.rb', line 279

optional :child_legal_entity, -> { ModernTreasury::ChildLegalEntityCreate }

#child_legal_entity_id ⇒ String?

The ID of the child legal entity.

Returns:

  • (String, nil) 


285
 
# File 'lib/modern_treasury/models/connection_legal_entity_create_params.rb', line 285

optional :child_legal_entity_id, String

#ownership_percentage ⇒ Integer?

The child entity’s ownership percentage iff they are a beneficial owner.

Returns:

  • (Integer, nil) 


291
 
# File 'lib/modern_treasury/models/connection_legal_entity_create_params.rb', line 291

optional :ownership_percentage, Integer, nil?: true

#relationship_types ⇒ Array<Symbol, ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity::LegalEntityAssociation::RelationshipType>

Returns:



268
269
270
271
272
273
 
# File 'lib/modern_treasury/models/connection_legal_entity_create_params.rb', line 268

required :relationship_types,
-> do
  ModernTreasury::Internal::Type::ArrayOf[
    enum: ModernTreasury::ConnectionLegalEntityCreateParams::LegalEntity::LegalEntityAssociation::RelationshipType
  ]
end

#title ⇒ String?

The job title of the child entity at the parent entity.

Returns:

  • (String, nil) 


297
 
# File 'lib/modern_treasury/models/connection_legal_entity_create_params.rb', line 297

optional :title, String, nil?: true