modern_treasury 0.1.0.pre.alpha.22 → 0.1.0

data/lib/modern_treasury/models/contact_detail.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class ContactDetail < ModernTreasury::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute contact_identifier
+      #
+      #   @return [String]
+      required :contact_identifier, String
+
+      # @!attribute contact_identifier_type
+      #
+      #   @return [Symbol, ModernTreasury::Models::ContactDetail::ContactIdentifierType]
+      required :contact_identifier_type, enum: -> { ModernTreasury::ContactDetail::ContactIdentifierType }
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute discarded_at
+      #
+      #   @return [Time, nil]
+      required :discarded_at, Time, nil?: true
+
+      # @!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]
+      required :live_mode, ModernTreasury::Internal::Type::Boolean
+
+      # @!attribute object
+      #
+      #   @return [String]
+      required :object, String
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!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::Models::ContactDetail} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param contact_identifier [String]
+      #
+      #   @param contact_identifier_type [Symbol, ModernTreasury::Models::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::Models::ContactDetail#contact_identifier_type
+      module ContactIdentifierType
+        extend ModernTreasury::Internal::Type::Enum
+
+        EMAIL = :email
+        PHONE_NUMBER = :phone_number
+        WEBSITE = :website
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/contact_detail_create_request.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class ContactDetailCreateRequest < ModernTreasury::Internal::Type::BaseModel
+      # @!attribute contact_identifier
+      #
+      #   @return [String, nil]
+      optional :contact_identifier, String
+
+      # @!attribute contact_identifier_type
+      #
+      #   @return [Symbol, ModernTreasury::Models::ContactDetailCreateRequest::ContactIdentifierType, nil]
+      optional :contact_identifier_type,
+               enum: -> { ModernTreasury::ContactDetailCreateRequest::ContactIdentifierType }
+
+      # @!method initialize(contact_identifier: nil, contact_identifier_type: nil)
+      #   @param contact_identifier [String]
+      #   @param contact_identifier_type [Symbol, ModernTreasury::Models::ContactDetailCreateRequest::ContactIdentifierType]
+
+      # @see ModernTreasury::Models::ContactDetailCreateRequest#contact_identifier_type
+      module ContactIdentifierType
+        extend ModernTreasury::Internal::Type::Enum
+
+        EMAIL = :email
+        PHONE_NUMBER = :phone_number
+        WEBSITE = :website
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/counterparty.rb

@@ -34,6 +34,12 @@ module ModernTreasury
       #   @return [String, nil]
       required :email, String, nil?: true
 
+      # @!attribute external_id
+      #   An optional user-defined 180 character unique identifier.
+      #
+      #   @return [String, nil]
+      required :external_id, String, nil?: true
+
       # @!attribute legal_entity_id
       #   The id of the legal entity.
       #
@@ -83,7 +89,7 @@ module ModernTreasury
       #   @return [Symbol, ModernTreasury::Models::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:)
+      # @!method initialize(id:, accounts:, created_at:, discarded_at:, email:, external_id:, legal_entity_id:, live_mode:, metadata:, name:, object:, send_remittance_advice:, updated_at:, verification_status:)
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::Counterparty} for more details.
       #
@@ -97,6 +103,8 @@ module ModernTreasury
       #
       #   @param email [String, nil] The counterparty's email.
       #
+      #   @param external_id [String, nil] An optional user-defined 180 character unique identifier.
+      #
       #   @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
@@ -135,10 +143,10 @@ module ModernTreasury
 
         # @!attribute contact_details
         #
-        #   @return [Array<ModernTreasury::Models::Counterparty::Account::ContactDetail>, nil]
+        #   @return [Array<ModernTreasury::Models::ContactDetail>, nil]
         optional :contact_details,
                  -> {
-                   ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Counterparty::Account::ContactDetail]
+                   ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ContactDetail]
                  }
 
         # @!attribute created_at
@@ -151,6 +159,12 @@ module ModernTreasury
         #   @return [Time, nil]
         optional :discarded_at, Time, nil?: true
 
+        # @!attribute external_id
+        #   An optional user-defined 180 character unique identifier.
+        #
+        #   @return [String, nil]
+        optional :external_id, String, nil?: true
+
         # @!attribute ledger_account_id
         #   If the external account links to a ledger account in Modern Treasury, the id of
         #   the ledger account will be populated here.
@@ -187,8 +201,8 @@ module ModernTreasury
         # @!attribute party_address
         #   The address associated with the owner or `null`.
         #
-        #   @return [ModernTreasury::Models::Counterparty::Account::PartyAddress, nil]
-        optional :party_address, -> { ModernTreasury::Counterparty::Account::PartyAddress }, nil?: true
+        #   @return [ModernTreasury::Models::Address, nil]
+        optional :party_address, -> { ModernTreasury::Address }, nil?: true
 
         # @!attribute party_name
         #   The legal name of the entity which owns the account.
@@ -227,7 +241,7 @@ module ModernTreasury
         #   @return [Symbol, ModernTreasury::Models::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)
+        # @!method initialize(id: nil, account_details: nil, account_type: nil, contact_details: nil, created_at: nil, discarded_at: nil, external_id: 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::Models::Counterparty::Account} for more details.
         #
@@ -237,12 +251,14 @@ module ModernTreasury
         #
         #   @param account_type [Symbol, ModernTreasury::Models::ExternalAccountType] Can be `checking`, `savings` or `other`.
         #
-        #   @param contact_details [Array<ModernTreasury::Models::Counterparty::Account::ContactDetail>]
+        #   @param contact_details [Array<ModernTreasury::Models::ContactDetail>]
         #
         #   @param created_at [Time]
         #
         #   @param discarded_at [Time, nil]
         #
+        #   @param external_id [String, nil] An optional user-defined 180 character unique identifier.
+        #
         #   @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
@@ -253,7 +269,7 @@ module ModernTreasury
         #
         #   @param object [String]
         #
-        #   @param party_address [ModernTreasury::Models::Counterparty::Account::PartyAddress, nil] The address associated with the owner or `null`.
+        #   @param party_address [ModernTreasury::Models::Address, nil] The address associated with the owner or `null`.
         #
         #   @param party_name [String] The legal name of the entity which owns the account.
         #
@@ -267,175 +283,6 @@ module ModernTreasury
         #
         #   @param verification_status [Symbol, ModernTreasury::Models::Counterparty::Account::VerificationStatus]
 
-        class ContactDetail < ModernTreasury::Internal::Type::BaseModel
-          # @!attribute id
-          #
-          #   @return [String]
-          required :id, String
-
-          # @!attribute contact_identifier
-          #
-          #   @return [String]
-          required :contact_identifier, String
-
-          # @!attribute contact_identifier_type
-          #
-          #   @return [Symbol, ModernTreasury::Models::Counterparty::Account::ContactDetail::ContactIdentifierType]
-          required :contact_identifier_type,
-                   enum: -> { ModernTreasury::Counterparty::Account::ContactDetail::ContactIdentifierType }
-
-          # @!attribute created_at
-          #
-          #   @return [Time]
-          required :created_at, Time
-
-          # @!attribute discarded_at
-          #
-          #   @return [Time, nil]
-          required :discarded_at, Time, nil?: true
-
-          # @!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]
-          required :live_mode, ModernTreasury::Internal::Type::Boolean
-
-          # @!attribute object
-          #
-          #   @return [String]
-          required :object, String
-
-          # @!attribute updated_at
-          #
-          #   @return [Time]
-          required :updated_at, Time
-
-          # @!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::Models::Counterparty::Account::ContactDetail} for more details.
-          #
-          #   @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] 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::Models::Counterparty::Account::ContactDetail#contact_identifier_type
-          module ContactIdentifierType
-            extend ModernTreasury::Internal::Type::Enum
-
-            EMAIL = :email
-            PHONE_NUMBER = :phone_number
-            WEBSITE = :website
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-        end
-
-        # @see ModernTreasury::Models::Counterparty::Account#party_address
-        class PartyAddress < ModernTreasury::Internal::Type::BaseModel
-          # @!attribute id
-          #
-          #   @return [String]
-          required :id, String
-
-          # @!attribute country
-          #   Country code conforms to [ISO 3166-1 alpha-2]
-          #
-          #   @return [String, nil]
-          required :country, String, nil?: true
-
-          # @!attribute created_at
-          #
-          #   @return [Time]
-          required :created_at, Time
-
-          # @!attribute line1
-          #
-          #   @return [String, nil]
-          required :line1, String, nil?: true
-
-          # @!attribute line2
-          #
-          #   @return [String, nil]
-          required :line2, String, nil?: true
-
-          # @!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]
-          required :live_mode, ModernTreasury::Internal::Type::Boolean
-
-          # @!attribute locality
-          #   Locality or City.
-          #
-          #   @return [String, nil]
-          required :locality, String, nil?: true
-
-          # @!attribute object
-          #
-          #   @return [String]
-          required :object, String
-
-          # @!attribute postal_code
-          #   The postal code of the address.
-          #
-          #   @return [String, nil]
-          required :postal_code, String, nil?: true
-
-          # @!attribute region
-          #   Region or State.
-          #
-          #   @return [String, nil]
-          required :region, String, nil?: true
-
-          # @!attribute updated_at
-          #
-          #   @return [Time]
-          required :updated_at, Time
-
-          # @!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::Models::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