Class: Increase::Models::Entity::Validation::Issue

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/entity.rb

Defined Under Namespace

Modules: Category Classes: BeneficialOwnerAddress, BeneficialOwnerIdentity, EntityAddress, EntityTaxIdentifier

Instance Attribute Summary collapse

Class Method 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(beneficial_owner_id:) ⇒ Object

Details when the issue is with a beneficial owner’s identity verification.

Parameters:

  • beneficial_owner_id (String) —

    The ID of the beneficial owner.



1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
 
# File 'lib/increase/models/entity.rb', line 1626

class Issue < Increase::Internal::Type::BaseModel
  # @!attribute beneficial_owner_address
  #   Details when the issue is with a beneficial owner's address.
  #
  #   @return [Increase::Models::Entity::Validation::Issue::BeneficialOwnerAddress, nil]
  required :beneficial_owner_address,
           -> { Increase::Entity::Validation::Issue::BeneficialOwnerAddress },
           nil?: true

  # @!attribute beneficial_owner_identity
  #   Details when the issue is with a beneficial owner's identity verification.
  #
  #   @return [Increase::Models::Entity::Validation::Issue::BeneficialOwnerIdentity, nil]
  required :beneficial_owner_identity,
           -> { Increase::Entity::Validation::Issue::BeneficialOwnerIdentity },
           nil?: true

  # @!attribute category
  #   The type of issue. We may add additional possible values for this enum over
  #   time; your application should be able to handle such additions gracefully.
  #
  #   @return [Symbol, Increase::Models::Entity::Validation::Issue::Category]
  required :category, enum: -> { Increase::Entity::Validation::Issue::Category }

  # @!attribute entity_address
  #   Details when the issue is with the entity's address.
  #
  #   @return [Increase::Models::Entity::Validation::Issue::EntityAddress, nil]
  required :entity_address, -> { Increase::Entity::Validation::Issue::EntityAddress }, nil?: true

  # @!attribute entity_tax_identifier
  #   Details when the issue is with the entity's tax ID.
  #
  #   @return [Increase::Models::Entity::Validation::Issue::EntityTaxIdentifier, nil]
  required :entity_tax_identifier,
           -> { Increase::Entity::Validation::Issue::EntityTaxIdentifier },
           nil?: true

  # @!method initialize(beneficial_owner_address:, beneficial_owner_identity:, category:, entity_address:, entity_tax_identifier:)
  #   Some parameter documentations has been truncated, see
  #   {Increase::Models::Entity::Validation::Issue} for more details.
  #
  #   @param beneficial_owner_address [Increase::Models::Entity::Validation::Issue::BeneficialOwnerAddress, nil] Details when the issue is with a beneficial owner's address.
  #
  #   @param beneficial_owner_identity [Increase::Models::Entity::Validation::Issue::BeneficialOwnerIdentity, nil] Details when the issue is with a beneficial owner's identity verification.
  #
  #   @param category [Symbol, Increase::Models::Entity::Validation::Issue::Category] The type of issue. We may add additional possible values for this enum over time
  #
  #   @param entity_address [Increase::Models::Entity::Validation::Issue::EntityAddress, nil] Details when the issue is with the entity's address.
  #
  #   @param entity_tax_identifier [Increase::Models::Entity::Validation::Issue::EntityTaxIdentifier, nil] Details when the issue is with the entity's tax ID.

  # @see Increase::Models::Entity::Validation::Issue#beneficial_owner_address
  class BeneficialOwnerAddress < Increase::Internal::Type::BaseModel
    # @!attribute beneficial_owner_id
    #   The ID of the beneficial owner.
    #
    #   @return [String]
    required :beneficial_owner_id, String

    # @!attribute reason
    #   The reason the address is invalid.
    #
    #   @return [Symbol, Increase::Models::Entity::Validation::Issue::BeneficialOwnerAddress::Reason]
    required :reason, enum: -> { Increase::Entity::Validation::Issue::BeneficialOwnerAddress::Reason }

    # @!method initialize(beneficial_owner_id:, reason:)
    #   Details when the issue is with a beneficial owner's address.
    #
    #   @param beneficial_owner_id [String] The ID of the beneficial owner.
    #
    #   @param reason [Symbol, Increase::Models::Entity::Validation::Issue::BeneficialOwnerAddress::Reason] The reason the address is invalid.

    # The reason the address is invalid.
    #
    # @see Increase::Models::Entity::Validation::Issue::BeneficialOwnerAddress#reason
    module Reason
      extend Increase::Internal::Type::Enum

      # The address is a mailbox or other non-physical address.
      MAILBOX_ADDRESS = :mailbox_address

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

  # @see Increase::Models::Entity::Validation::Issue#beneficial_owner_identity
  class BeneficialOwnerIdentity < Increase::Internal::Type::BaseModel
    # @!attribute beneficial_owner_id
    #   The ID of the beneficial owner.
    #
    #   @return [String]
    required :beneficial_owner_id, String

    # @!method initialize(beneficial_owner_id:)
    #   Details when the issue is with a beneficial owner's identity verification.
    #
    #   @param beneficial_owner_id [String] The ID of the beneficial owner.
  end

  # The type of issue. We may add additional possible values for this enum over
  # time; your application should be able to handle such additions gracefully.
  #
  # @see Increase::Models::Entity::Validation::Issue#category
  module Category
    extend Increase::Internal::Type::Enum

    # The entity's tax identifier could not be validated. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.tax_identifier).
    ENTITY_TAX_IDENTIFIER = :entity_tax_identifier

    # The entity's address could not be validated. Update the address with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.address).
    ENTITY_ADDRESS = :entity_address

    # A beneficial owner's identity could not be verified. Update the identification with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner).
    BENEFICIAL_OWNER_IDENTITY = :beneficial_owner_identity

    # A beneficial owner's address could not be validated. Update the address with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner).
    BENEFICIAL_OWNER_ADDRESS = :beneficial_owner_address

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

  # @see Increase::Models::Entity::Validation::Issue#entity_address
  class EntityAddress < Increase::Internal::Type::BaseModel
    # @!attribute reason
    #   The reason the address is invalid.
    #
    #   @return [Symbol, Increase::Models::Entity::Validation::Issue::EntityAddress::Reason]
    required :reason, enum: -> { Increase::Entity::Validation::Issue::EntityAddress::Reason }

    # @!method initialize(reason:)
    #   Details when the issue is with the entity's address.
    #
    #   @param reason [Symbol, Increase::Models::Entity::Validation::Issue::EntityAddress::Reason] The reason the address is invalid.

    # The reason the address is invalid.
    #
    # @see Increase::Models::Entity::Validation::Issue::EntityAddress#reason
    module Reason
      extend Increase::Internal::Type::Enum

      # The address is a mailbox or other non-physical address.
      MAILBOX_ADDRESS = :mailbox_address

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

  # @see Increase::Models::Entity::Validation::Issue#entity_tax_identifier
  class EntityTaxIdentifier < Increase::Internal::Type::BaseModel
    # @!method initialize
    #   Details when the issue is with the entity's tax ID.
  end
end

Instance Attribute Details

#beneficial_owner_address ⇒ Increase::Models::Entity::Validation::Issue::BeneficialOwnerAddress?

Details when the issue is with a beneficial owner’s address.

Returns:



1631
1632
1633
 
# File 'lib/increase/models/entity.rb', line 1631

required :beneficial_owner_address,
-> { Increase::Entity::Validation::Issue::BeneficialOwnerAddress },
nil?: true

#beneficial_owner_identity ⇒ Increase::Models::Entity::Validation::Issue::BeneficialOwnerIdentity?

Details when the issue is with a beneficial owner’s identity verification.

Returns:



1639
1640
1641
 
# File 'lib/increase/models/entity.rb', line 1639

required :beneficial_owner_identity,
-> { Increase::Entity::Validation::Issue::BeneficialOwnerIdentity },
nil?: true

#category ⇒ Symbol, Increase::Models::Entity::Validation::Issue::Category

The type of issue. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.

Returns:



1648
 
# File 'lib/increase/models/entity.rb', line 1648

required :category, enum: -> { Increase::Entity::Validation::Issue::Category }

#entity_address ⇒ Increase::Models::Entity::Validation::Issue::EntityAddress?

Details when the issue is with the entity’s address.

Returns:



1654
 
# File 'lib/increase/models/entity.rb', line 1654

required :entity_address, -> { Increase::Entity::Validation::Issue::EntityAddress }, nil?: true

#entity_tax_identifier ⇒ Increase::Models::Entity::Validation::Issue::EntityTaxIdentifier?

Details when the issue is with the entity’s tax ID.

Returns:



1660
1661
1662
 
# File 'lib/increase/models/entity.rb', line 1660

required :entity_tax_identifier,
-> { Increase::Entity::Validation::Issue::EntityTaxIdentifier },
nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/entity.rb', line 1708