modern_treasury 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.19

data/lib/modern_treasury/models/counterparty.rb

@@ -12,9 +12,11 @@ module ModernTreasury
       # @!attribute accounts
       #   The accounts for this counterparty.
       #
-      #   @return [Array<ModernTreasury::Models::Counterparty::Account>]
+      #   @return [Array<ModernTreasury::Counterparty::Account>]
       required :accounts,
-               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::Counterparty::Account] }
+               -> {
+                 ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Counterparty::Account]
+               }
 
       # @!attribute created_at
       #
@@ -78,94 +80,72 @@ module ModernTreasury
       # @!attribute verification_status
       #   The verification status of the counterparty.
       #
-      #   @return [Symbol, ModernTreasury::Models::Counterparty::VerificationStatus]
-      required :verification_status, enum: -> { ModernTreasury::Models::Counterparty::VerificationStatus }
-
-      # @!parse
-      #   # @param id [String]
-      #   # @param accounts [Array<ModernTreasury::Models::Counterparty::Account>]
-      #   # @param created_at [Time]
-      #   # @param discarded_at [Time, nil]
-      #   # @param email [String, nil]
-      #   # @param legal_entity_id [String, nil]
-      #   # @param live_mode [Boolean]
-      #   # @param metadata [Hash{Symbol=>String}]
-      #   # @param name [String, nil]
-      #   # @param object [String]
-      #   # @param send_remittance_advice [Boolean]
-      #   # @param updated_at [Time]
-      #   # @param verification_status [Symbol, ModernTreasury::Models::Counterparty::VerificationStatus]
-      #   #
-      #   def initialize(
-      #     id:,
-      #     accounts:,
-      #     created_at:,
-      #     discarded_at:,
-      #     email:,
-      #     legal_entity_id:,
-      #     live_mode:,
-      #     metadata:,
-      #     name:,
-      #     object:,
-      #     send_remittance_advice:,
-      #     updated_at:,
-      #     verification_status:,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      #   @return [Symbol, ModernTreasury::Counterparty::VerificationStatus]
+      required :verification_status, enum: -> { ModernTreasury::Counterparty::VerificationStatus }
+
+      # @!method initialize(id:, accounts:, created_at:, discarded_at:, email:, legal_entity_id:, live_mode:, metadata:, name:, object:, send_remittance_advice:, updated_at:, verification_status:)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Counterparty} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param accounts [Array<ModernTreasury::Counterparty::Account>] The accounts for this counterparty.
+      #
+      #   @param created_at [Time]
+      #
+      #   @param discarded_at [Time, nil]
+      #
+      #   @param email [String, nil] The counterparty's email.
+      #
+      #   @param legal_entity_id [String, nil] The id of the legal entity.
+      #
+      #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+      #
+      #   @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+      #
+      #   @param name [String, nil] A human friendly name for this counterparty.
+      #
+      #   @param object [String]
+      #
+      #   @param send_remittance_advice [Boolean] Send an email to the counterparty whenever an associated payment order is sent t
+      #
+      #   @param updated_at [Time]
+      #
+      #   @param verification_status [Symbol, ModernTreasury::Counterparty::VerificationStatus] The verification status of the counterparty.
 
       class Account < ModernTreasury::Internal::Type::BaseModel
-        # @!attribute [r] id
+        # @!attribute id
         #
         #   @return [String, nil]
         optional :id, String
 
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :id
-
-        # @!attribute [r] account_details
+        # @!attribute account_details
         #
-        #   @return [Array<ModernTreasury::Models::AccountDetail>, nil]
+        #   @return [Array<ModernTreasury::AccountDetail>, nil]
         optional :account_details,
-                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::AccountDetail] }
-
-        # @!parse
-        #   # @return [Array<ModernTreasury::Models::AccountDetail>]
-        #   attr_writer :account_details
+                 -> {
+                   ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::AccountDetail]
+                 }
 
-        # @!attribute [r] account_type
+        # @!attribute account_type
         #   Can be `checking`, `savings` or `other`.
         #
-        #   @return [Symbol, ModernTreasury::Models::ExternalAccountType, nil]
-        optional :account_type, enum: -> { ModernTreasury::Models::ExternalAccountType }
+        #   @return [Symbol, ModernTreasury::ExternalAccountType, nil]
+        optional :account_type, enum: -> { ModernTreasury::ExternalAccountType }
 
-        # @!parse
-        #   # @return [Symbol, ModernTreasury::Models::ExternalAccountType]
-        #   attr_writer :account_type
-
-        # @!attribute [r] contact_details
+        # @!attribute contact_details
         #
-        #   @return [Array<ModernTreasury::Models::Counterparty::Account::ContactDetail>, nil]
+        #   @return [Array<ModernTreasury::Counterparty::Account::ContactDetail>, nil]
         optional :contact_details,
-                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::Counterparty::Account::ContactDetail] }
-
-        # @!parse
-        #   # @return [Array<ModernTreasury::Models::Counterparty::Account::ContactDetail>]
-        #   attr_writer :contact_details
+                 -> {
+                   ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Counterparty::Account::ContactDetail]
+                 }
 
-        # @!attribute [r] created_at
+        # @!attribute created_at
         #
         #   @return [Time, nil]
         optional :created_at, Time
 
-        # @!parse
-        #   # @return [Time]
-        #   attr_writer :created_at
-
         # @!attribute discarded_at
         #
         #   @return [Time, nil]
@@ -178,28 +158,20 @@ module ModernTreasury
         #   @return [String, nil]
         optional :ledger_account_id, String, nil?: true
 
-        # @!attribute [r] live_mode
+        # @!attribute live_mode
         #   This field will be true if this object exists in the live environment or false
         #   if it exists in the test environment.
         #
         #   @return [Boolean, nil]
         optional :live_mode, ModernTreasury::Internal::Type::Boolean
 
-        # @!parse
-        #   # @return [Boolean]
-        #   attr_writer :live_mode
-
-        # @!attribute [r] metadata
+        # @!attribute metadata
         #   Additional data represented as key-value pairs. Both the key and value must be
         #   strings.
         #
         #   @return [Hash{Symbol=>String}, nil]
         optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
-        # @!parse
-        #   # @return [Hash{Symbol=>String}]
-        #   attr_writer :metadata
-
         # @!attribute name
         #   A nickname for the external account. This is only for internal usage and won't
         #   affect any payments
@@ -207,118 +179,93 @@ module ModernTreasury
         #   @return [String, nil]
         optional :name, String, nil?: true
 
-        # @!attribute [r] object
+        # @!attribute object
         #
         #   @return [String, nil]
         optional :object, String
 
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :object
-
         # @!attribute party_address
         #   The address associated with the owner or `null`.
         #
-        #   @return [ModernTreasury::Models::Counterparty::Account::PartyAddress, nil]
-        optional :party_address, -> { ModernTreasury::Models::Counterparty::Account::PartyAddress }, nil?: true
+        #   @return [ModernTreasury::Counterparty::Account::PartyAddress, nil]
+        optional :party_address, -> { ModernTreasury::Counterparty::Account::PartyAddress }, nil?: true
 
-        # @!attribute [r] party_name
+        # @!attribute party_name
         #   The legal name of the entity which owns the account.
         #
         #   @return [String, nil]
         optional :party_name, String
 
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :party_name
-
         # @!attribute party_type
         #   Either `individual` or `business`.
         #
-        #   @return [Symbol, ModernTreasury::Models::Counterparty::Account::PartyType, nil]
-        optional :party_type, enum: -> { ModernTreasury::Models::Counterparty::Account::PartyType }, nil?: true
+        #   @return [Symbol, ModernTreasury::Counterparty::Account::PartyType, nil]
+        optional :party_type, enum: -> { ModernTreasury::Counterparty::Account::PartyType }, nil?: true
 
-        # @!attribute [r] routing_details
+        # @!attribute routing_details
         #
-        #   @return [Array<ModernTreasury::Models::RoutingDetail>, nil]
+        #   @return [Array<ModernTreasury::RoutingDetail>, nil]
         optional :routing_details,
-                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::RoutingDetail] }
+                 -> {
+                   ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::RoutingDetail]
+                 }
 
-        # @!parse
-        #   # @return [Array<ModernTreasury::Models::RoutingDetail>]
-        #   attr_writer :routing_details
-
-        # @!attribute [r] updated_at
+        # @!attribute updated_at
         #
         #   @return [Time, nil]
         optional :updated_at, Time
 
-        # @!parse
-        #   # @return [Time]
-        #   attr_writer :updated_at
-
         # @!attribute verification_source
         #
-        #   @return [Symbol, ModernTreasury::Models::Counterparty::Account::VerificationSource, nil]
+        #   @return [Symbol, ModernTreasury::Counterparty::Account::VerificationSource, nil]
         optional :verification_source,
-                 enum: -> { ModernTreasury::Models::Counterparty::Account::VerificationSource },
+                 enum: -> { ModernTreasury::Counterparty::Account::VerificationSource },
                  nil?: true
 
-        # @!attribute [r] verification_status
-        #
-        #   @return [Symbol, ModernTreasury::Models::Counterparty::Account::VerificationStatus, nil]
-        optional :verification_status,
-                 enum: -> { ModernTreasury::Models::Counterparty::Account::VerificationStatus }
-
-        # @!parse
-        #   # @return [Symbol, ModernTreasury::Models::Counterparty::Account::VerificationStatus]
-        #   attr_writer :verification_status
-
-        # @!parse
-        #   # @param id [String]
-        #   # @param account_details [Array<ModernTreasury::Models::AccountDetail>]
-        #   # @param account_type [Symbol, ModernTreasury::Models::ExternalAccountType]
-        #   # @param contact_details [Array<ModernTreasury::Models::Counterparty::Account::ContactDetail>]
-        #   # @param created_at [Time]
-        #   # @param discarded_at [Time, nil]
-        #   # @param ledger_account_id [String, nil]
-        #   # @param live_mode [Boolean]
-        #   # @param metadata [Hash{Symbol=>String}]
-        #   # @param name [String, nil]
-        #   # @param object [String]
-        #   # @param party_address [ModernTreasury::Models::Counterparty::Account::PartyAddress, nil]
-        #   # @param party_name [String]
-        #   # @param party_type [Symbol, ModernTreasury::Models::Counterparty::Account::PartyType, nil]
-        #   # @param routing_details [Array<ModernTreasury::Models::RoutingDetail>]
-        #   # @param updated_at [Time]
-        #   # @param verification_source [Symbol, ModernTreasury::Models::Counterparty::Account::VerificationSource, nil]
-        #   # @param verification_status [Symbol, ModernTreasury::Models::Counterparty::Account::VerificationStatus]
-        #   #
-        #   def initialize(
-        #     id: nil,
-        #     account_details: nil,
-        #     account_type: nil,
-        #     contact_details: nil,
-        #     created_at: nil,
-        #     discarded_at: nil,
-        #     ledger_account_id: nil,
-        #     live_mode: nil,
-        #     metadata: nil,
-        #     name: nil,
-        #     object: nil,
-        #     party_address: nil,
-        #     party_name: nil,
-        #     party_type: nil,
-        #     routing_details: nil,
-        #     updated_at: nil,
-        #     verification_source: nil,
-        #     verification_status: nil,
-        #     **
-        #   )
-        #     super
-        #   end
-
-        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+        # @!attribute verification_status
+        #
+        #   @return [Symbol, ModernTreasury::Counterparty::Account::VerificationStatus, nil]
+        optional :verification_status, enum: -> { ModernTreasury::Counterparty::Account::VerificationStatus }
+
+        # @!method initialize(id: nil, account_details: nil, account_type: nil, contact_details: nil, created_at: nil, discarded_at: nil, ledger_account_id: nil, live_mode: nil, metadata: nil, name: nil, object: nil, party_address: nil, party_name: nil, party_type: nil, routing_details: nil, updated_at: nil, verification_source: nil, verification_status: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Counterparty::Account} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param account_details [Array<ModernTreasury::AccountDetail>]
+        #
+        #   @param account_type [Symbol, ModernTreasury::ExternalAccountType] Can be `checking`, `savings` or `other`.
+        #
+        #   @param contact_details [Array<ModernTreasury::Counterparty::Account::ContactDetail>]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param discarded_at [Time, nil]
+        #
+        #   @param ledger_account_id [String, nil] If the external account links to a ledger account in Modern Treasury, the id of
+        #
+        #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+        #
+        #   @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+        #
+        #   @param name [String, nil] A nickname for the external account. This is only for internal usage and won't a
+        #
+        #   @param object [String]
+        #
+        #   @param party_address [ModernTreasury::Counterparty::Account::PartyAddress, nil] The address associated with the owner or `null`.
+        #
+        #   @param party_name [String] The legal name of the entity which owns the account.
+        #
+        #   @param party_type [Symbol, ModernTreasury::Counterparty::Account::PartyType, nil] Either `individual` or `business`.
+        #
+        #   @param routing_details [Array<ModernTreasury::RoutingDetail>]
+        #
+        #   @param updated_at [Time]
+        #
+        #   @param verification_source [Symbol, ModernTreasury::Counterparty::Account::VerificationSource, nil]
+        #
+        #   @param verification_status [Symbol, ModernTreasury::Counterparty::Account::VerificationStatus]
 
         class ContactDetail < ModernTreasury::Internal::Type::BaseModel
           # @!attribute id
@@ -333,9 +280,9 @@ module ModernTreasury
 
           # @!attribute contact_identifier_type
           #
-          #   @return [Symbol, ModernTreasury::Models::Counterparty::Account::ContactDetail::ContactIdentifierType]
+          #   @return [Symbol, ModernTreasury::Counterparty::Account::ContactDetail::ContactIdentifierType]
           required :contact_identifier_type,
-                   enum: -> { ModernTreasury::Models::Counterparty::Account::ContactDetail::ContactIdentifierType }
+                   enum: -> { ModernTreasury::Counterparty::Account::ContactDetail::ContactIdentifierType }
 
           # @!attribute created_at
           #
@@ -364,33 +311,27 @@ module ModernTreasury
           #   @return [Time]
           required :updated_at, Time
 
-          # @!parse
-          #   # @param id [String]
-          #   # @param contact_identifier [String]
-          #   # @param contact_identifier_type [Symbol, ModernTreasury::Models::Counterparty::Account::ContactDetail::ContactIdentifierType]
-          #   # @param created_at [Time]
-          #   # @param discarded_at [Time, nil]
-          #   # @param live_mode [Boolean]
-          #   # @param object [String]
-          #   # @param updated_at [Time]
-          #   #
-          #   def initialize(
-          #     id:,
-          #     contact_identifier:,
-          #     contact_identifier_type:,
-          #     created_at:,
-          #     discarded_at:,
-          #     live_mode:,
-          #     object:,
-          #     updated_at:,
-          #     **
-          #   )
-          #     super
-          #   end
-
-          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
-
-          # @see ModernTreasury::Models::Counterparty::Account::ContactDetail#contact_identifier_type
+          # @!method initialize(id:, contact_identifier:, contact_identifier_type:, created_at:, discarded_at:, live_mode:, object:, updated_at:)
+          #   Some parameter documentations has been truncated, see
+          #   {ModernTreasury::Counterparty::Account::ContactDetail} for more details.
+          #
+          #   @param id [String]
+          #
+          #   @param contact_identifier [String]
+          #
+          #   @param contact_identifier_type [Symbol, ModernTreasury::Counterparty::Account::ContactDetail::ContactIdentifierType]
+          #
+          #   @param created_at [Time]
+          #
+          #   @param discarded_at [Time, nil]
+          #
+          #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+          #
+          #   @param object [String]
+          #
+          #   @param updated_at [Time]
+
+          # @see ModernTreasury::Counterparty::Account::ContactDetail#contact_identifier_type
           module ContactIdentifierType
             extend ModernTreasury::Internal::Type::Enum
 
@@ -398,15 +339,12 @@ module ModernTreasury
             PHONE_NUMBER = :phone_number
             WEBSITE = :website
 
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
+            # @!method self.values
+            #   @return [Array<Symbol>]
           end
         end
 
-        # @see ModernTreasury::Models::Counterparty::Account#party_address
+        # @see ModernTreasury::Counterparty::Account#party_address
         class PartyAddress < ModernTreasury::Internal::Type::BaseModel
           # @!attribute id
           #
@@ -469,58 +407,49 @@ module ModernTreasury
           #   @return [Time]
           required :updated_at, Time
 
-          # @!parse
-          #   # The address associated with the owner or `null`.
-          #   #
-          #   # @param id [String]
-          #   # @param country [String, nil]
-          #   # @param created_at [Time]
-          #   # @param line1 [String, nil]
-          #   # @param line2 [String, nil]
-          #   # @param live_mode [Boolean]
-          #   # @param locality [String, nil]
-          #   # @param object [String]
-          #   # @param postal_code [String, nil]
-          #   # @param region [String, nil]
-          #   # @param updated_at [Time]
-          #   #
-          #   def initialize(
-          #     id:,
-          #     country:,
-          #     created_at:,
-          #     line1:,
-          #     line2:,
-          #     live_mode:,
-          #     locality:,
-          #     object:,
-          #     postal_code:,
-          #     region:,
-          #     updated_at:,
-          #     **
-          #   )
-          #     super
-          #   end
-
-          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+          # @!method initialize(id:, country:, created_at:, line1:, line2:, live_mode:, locality:, object:, postal_code:, region:, updated_at:)
+          #   Some parameter documentations has been truncated, see
+          #   {ModernTreasury::Counterparty::Account::PartyAddress} for more details.
+          #
+          #   The address associated with the owner or `null`.
+          #
+          #   @param id [String]
+          #
+          #   @param country [String, nil] Country code conforms to [ISO 3166-1 alpha-2]
+          #
+          #   @param created_at [Time]
+          #
+          #   @param line1 [String, nil]
+          #
+          #   @param line2 [String, nil]
+          #
+          #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+          #
+          #   @param locality [String, nil] Locality or City.
+          #
+          #   @param object [String]
+          #
+          #   @param postal_code [String, nil] The postal code of the address.
+          #
+          #   @param region [String, nil] Region or State.
+          #
+          #   @param updated_at [Time]
         end
 
         # Either `individual` or `business`.
         #
-        # @see ModernTreasury::Models::Counterparty::Account#party_type
+        # @see ModernTreasury::Counterparty::Account#party_type
         module PartyType
           extend ModernTreasury::Internal::Type::Enum
 
           BUSINESS = :business
           INDIVIDUAL = :individual
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
 
-        # @see ModernTreasury::Models::Counterparty::Account#verification_source
+        # @see ModernTreasury::Counterparty::Account#verification_source
         module VerificationSource
           extend ModernTreasury::Internal::Type::Enum
 
@@ -528,14 +457,11 @@ module ModernTreasury
           MICRODEPOSITS = :microdeposits
           PLAID = :plaid
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
 
-        # @see ModernTreasury::Models::Counterparty::Account#verification_status
+        # @see ModernTreasury::Counterparty::Account#verification_status
         module VerificationStatus
           extend ModernTreasury::Internal::Type::Enum
 
@@ -543,17 +469,14 @@ module ModernTreasury
           UNVERIFIED = :unverified
           VERIFIED = :verified
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
       end
 
       # The verification status of the counterparty.
       #
-      # @see ModernTreasury::Models::Counterparty#verification_status
+      # @see ModernTreasury::Counterparty#verification_status
       module VerificationStatus
         extend ModernTreasury::Internal::Type::Enum
 
@@ -562,11 +485,8 @@ module ModernTreasury
         UNVERIFIED = :unverified
         VERIFIED = :verified
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end