modern_treasury 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.18

data/lib/modern_treasury/models/counterparty.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class Counterparty < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Counterparties#create
+    class Counterparty < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -12,7 +13,8 @@ module ModernTreasury
       #   The accounts for this counterparty.
       #
       #   @return [Array<ModernTreasury::Models::Counterparty::Account>]
-      required :accounts, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::Counterparty::Account] }
+      required :accounts,
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::Counterparty::Account] }
 
       # @!attribute created_at
       #
@@ -38,17 +40,17 @@ module ModernTreasury
 
       # @!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.
+      #   if it exists in the test environment.
       #
       #   @return [Boolean]
-      required :live_mode, ModernTreasury::BooleanModel
+      required :live_mode, ModernTreasury::Internal::Type::Boolean
 
       # @!attribute metadata
       #   Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
+      #   strings.
       #
       #   @return [Hash{Symbol=>String}]
-      required :metadata, ModernTreasury::HashOf[String]
+      required :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!attribute name
       #   A human friendly name for this counterparty.
@@ -63,10 +65,10 @@ module ModernTreasury
 
       # @!attribute send_remittance_advice
       #   Send an email to the counterparty whenever an associated payment order is sent
-      #     to the bank.
+      #   to the bank.
       #
       #   @return [Boolean]
-      required :send_remittance_advice, ModernTreasury::BooleanModel
+      required :send_remittance_advice, ModernTreasury::Internal::Type::Boolean
 
       # @!attribute updated_at
       #
@@ -113,9 +115,9 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      class Account < ModernTreasury::BaseModel
+      class Account < ModernTreasury::Internal::Type::BaseModel
         # @!attribute [r] id
         #
         #   @return [String, nil]
@@ -128,7 +130,8 @@ module ModernTreasury
         # @!attribute [r] account_details
         #
         #   @return [Array<ModernTreasury::Models::AccountDetail>, nil]
-        optional :account_details, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::AccountDetail] }
+        optional :account_details,
+                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::AccountDetail] }
 
         # @!parse
         #   # @return [Array<ModernTreasury::Models::AccountDetail>]
@@ -148,7 +151,7 @@ module ModernTreasury
         #
         #   @return [Array<ModernTreasury::Models::Counterparty::Account::ContactDetail>, nil]
         optional :contact_details,
-                 -> { ModernTreasury::ArrayOf[ModernTreasury::Models::Counterparty::Account::ContactDetail] }
+                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::Counterparty::Account::ContactDetail] }
 
         # @!parse
         #   # @return [Array<ModernTreasury::Models::Counterparty::Account::ContactDetail>]
@@ -170,17 +173,17 @@ module ModernTreasury
 
         # @!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.
+        #   the ledger account will be populated here.
         #
         #   @return [String, nil]
         optional :ledger_account_id, String, nil?: true
 
         # @!attribute [r] live_mode
         #   This field will be true if this object exists in the live environment or false
-        #     if it exists in the test environment.
+        #   if it exists in the test environment.
         #
         #   @return [Boolean, nil]
-        optional :live_mode, ModernTreasury::BooleanModel
+        optional :live_mode, ModernTreasury::Internal::Type::Boolean
 
         # @!parse
         #   # @return [Boolean]
@@ -188,10 +191,10 @@ module ModernTreasury
 
         # @!attribute [r] metadata
         #   Additional data represented as key-value pairs. Both the key and value must be
-        #     strings.
+        #   strings.
         #
         #   @return [Hash{Symbol=>String}, nil]
-        optional :metadata, ModernTreasury::HashOf[String]
+        optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
         # @!parse
         #   # @return [Hash{Symbol=>String}]
@@ -199,7 +202,7 @@ module ModernTreasury
 
         # @!attribute name
         #   A nickname for the external account. This is only for internal usage and won't
-        #     affect any payments
+        #   affect any payments
         #
         #   @return [String, nil]
         optional :name, String, nil?: true
@@ -238,7 +241,8 @@ module ModernTreasury
         # @!attribute [r] routing_details
         #
         #   @return [Array<ModernTreasury::Models::RoutingDetail>, nil]
-        optional :routing_details, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::RoutingDetail] }
+        optional :routing_details,
+                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::RoutingDetail] }
 
         # @!parse
         #   # @return [Array<ModernTreasury::Models::RoutingDetail>]
@@ -314,9 +318,9 @@ module ModernTreasury
         #     super
         #   end
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-        class ContactDetail < ModernTreasury::BaseModel
+        class ContactDetail < ModernTreasury::Internal::Type::BaseModel
           # @!attribute id
           #
           #   @return [String]
@@ -345,10 +349,10 @@ module ModernTreasury
 
           # @!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.
+          #   if it exists in the test environment.
           #
           #   @return [Boolean]
-          required :live_mode, ModernTreasury::BooleanModel
+          required :live_mode, ModernTreasury::Internal::Type::Boolean
 
           # @!attribute object
           #
@@ -384,10 +388,11 @@ module ModernTreasury
           #     super
           #   end
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
+          # @see ModernTreasury::Models::Counterparty::Account::ContactDetail#contact_identifier_type
           module ContactIdentifierType
-            extend ModernTreasury::Enum
+            extend ModernTreasury::Internal::Type::Enum
 
             EMAIL = :email
             PHONE_NUMBER = :phone_number
@@ -401,7 +406,8 @@ module ModernTreasury
           end
         end
 
-        class PartyAddress < ModernTreasury::BaseModel
+        # @see ModernTreasury::Models::Counterparty::Account#party_address
+        class PartyAddress < ModernTreasury::Internal::Type::BaseModel
           # @!attribute id
           #
           #   @return [String]
@@ -430,10 +436,10 @@ module ModernTreasury
 
           # @!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.
+          #   if it exists in the test environment.
           #
           #   @return [Boolean]
-          required :live_mode, ModernTreasury::BooleanModel
+          required :live_mode, ModernTreasury::Internal::Type::Boolean
 
           # @!attribute locality
           #   Locality or City.
@@ -495,12 +501,14 @@ module ModernTreasury
           #     super
           #   end
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
         end
 
         # Either `individual` or `business`.
+        #
+        # @see ModernTreasury::Models::Counterparty::Account#party_type
         module PartyType
-          extend ModernTreasury::Enum
+          extend ModernTreasury::Internal::Type::Enum
 
           BUSINESS = :business
           INDIVIDUAL = :individual
@@ -512,8 +520,9 @@ module ModernTreasury
           #   def self.values; end
         end
 
+        # @see ModernTreasury::Models::Counterparty::Account#verification_source
         module VerificationSource
-          extend ModernTreasury::Enum
+          extend ModernTreasury::Internal::Type::Enum
 
           ACH_PRENOTE = :ach_prenote
           MICRODEPOSITS = :microdeposits
@@ -526,8 +535,9 @@ module ModernTreasury
           #   def self.values; end
         end
 
+        # @see ModernTreasury::Models::Counterparty::Account#verification_status
         module VerificationStatus
-          extend ModernTreasury::Enum
+          extend ModernTreasury::Internal::Type::Enum
 
           PENDING_VERIFICATION = :pending_verification
           UNVERIFIED = :unverified
@@ -542,8 +552,10 @@ module ModernTreasury
       end
 
       # The verification status of the counterparty.
+      #
+      # @see ModernTreasury::Models::Counterparty#verification_status
       module VerificationStatus
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         DENIED = :denied
         NEEDS_APPROVAL = :needs_approval

data/lib/modern_treasury/models/counterparty_collect_account_params.rb

@@ -2,23 +2,24 @@
 
 module ModernTreasury
   module Models
-    class CounterpartyCollectAccountParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Counterparties#collect_account
+    class CounterpartyCollectAccountParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute direction
       #   One of `credit` or `debit`. Use `credit` when you want to pay a counterparty.
-      #     Use `debit` when you need to charge a counterparty. This field helps us send a
-      #     more tailored email to your counterparties."
+      #   Use `debit` when you need to charge a counterparty. This field helps us send a
+      #   more tailored email to your counterparties."
       #
       #   @return [Symbol, ModernTreasury::Models::TransactionDirection]
       required :direction, enum: -> { ModernTreasury::Models::TransactionDirection }
 
       # @!attribute [r] custom_redirect
       #   The URL you want your customer to visit upon filling out the form. By default,
-      #     they will be sent to a Modern Treasury landing page. This must be a valid HTTPS
-      #     URL if set.
+      #   they will be sent to a Modern Treasury landing page. This must be a valid HTTPS
+      #   URL if set.
       #
       #   @return [String, nil]
       optional :custom_redirect, String
@@ -29,14 +30,14 @@ module ModernTreasury
 
       # @!attribute [r] fields
       #   The list of fields you want on the form. This field is optional and if it is not
-      #     set, will default to [\"nameOnAccount\", \"accountType\", \"accountNumber\",
-      #     \"routingNumber\", \"address\"]. The full list of options is [\"name\",
-      #     \"nameOnAccount\", \"taxpayerIdentifier\", \"accountType\", \"accountNumber\",
-      #     \"routingNumber\", \"address\", \"ibanNumber\", \"swiftCode\"].
+      #   set, will default to [\"nameOnAccount\", \"accountType\", \"accountNumber\",
+      #   \"routingNumber\", \"address\"]. The full list of options is [\"name\",
+      #   \"nameOnAccount\", \"taxpayerIdentifier\", \"accountType\", \"accountNumber\",
+      #   \"routingNumber\", \"address\", \"ibanNumber\", \"swiftCode\"].
       #
       #   @return [Array<Symbol, ModernTreasury::Models::CounterpartyCollectAccountParams::Field>, nil]
       optional :fields,
-               -> { ModernTreasury::ArrayOf[enum: ModernTreasury::Models::CounterpartyCollectAccountParams::Field] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::Models::CounterpartyCollectAccountParams::Field] }
 
       # @!parse
       #   # @return [Array<Symbol, ModernTreasury::Models::CounterpartyCollectAccountParams::Field>]
@@ -44,12 +45,12 @@ module ModernTreasury
 
       # @!attribute [r] send_email
       #   By default, Modern Treasury will send an email to your counterparty that
-      #     includes a link to the form they must fill out. However, if you would like to
-      #     send the counterparty the link, you can set this parameter to `false`. The JSON
-      #     body will include the link to the secure Modern Treasury form.
+      #   includes a link to the form they must fill out. However, if you would like to
+      #   send the counterparty the link, you can set this parameter to `false`. The JSON
+      #   body will include the link to the secure Modern Treasury form.
       #
       #   @return [Boolean, nil]
-      optional :send_email, ModernTreasury::BooleanModel
+      optional :send_email, ModernTreasury::Internal::Type::Boolean
 
       # @!parse
       #   # @return [Boolean]
@@ -64,10 +65,10 @@ module ModernTreasury
       #   #
       #   def initialize(direction:, custom_redirect: nil, fields: nil, send_email: nil, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
       module Field
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         NAME = :name
         NAME_ON_ACCOUNT = :nameOnAccount
@@ -97,7 +98,7 @@ module ModernTreasury
         HU_INTERBANK_CLEARING_CODE = :huInterbankClearingCode
         DK_INTERBANK_CLEARING_CODE = :dkInterbankClearingCode
         ID_SKNBI_CODE = :idSknbiCode
-        ZA_NATIONAL_CLEARING_CODE = :za_national_clearing_code
+        ZA_NATIONAL_CLEARING_CODE = :zaNationalClearingCode
 
         finalize!
 

data/lib/modern_treasury/models/counterparty_collect_account_response.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class CounterpartyCollectAccountResponse < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Counterparties#collect_account
+    class CounterpartyCollectAccountResponse < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #   The id of the existing counterparty.
       #
@@ -11,19 +12,19 @@ module ModernTreasury
 
       # @!attribute form_link
       #   This is the link to the secure Modern Treasury form. By default, Modern Treasury
-      #     will send an email to your counterparty that includes a link to this form.
-      #     However, if `send_email` is passed as `false` in the body then Modern Treasury
-      #     will not send the email and you can send it to the counterparty directly.
+      #   will send an email to your counterparty that includes a link to this form.
+      #   However, if `send_email` is passed as `false` in the body then Modern Treasury
+      #   will not send the email and you can send it to the counterparty directly.
       #
       #   @return [String]
       required :form_link, String
 
       # @!attribute is_resend
       #   This field will be `true` if an email requesting account details has already
-      #     been sent to this counterparty.
+      #   been sent to this counterparty.
       #
       #   @return [Boolean]
-      required :is_resend, ModernTreasury::BooleanModel
+      required :is_resend, ModernTreasury::Internal::Type::Boolean
 
       # @!parse
       #   # @param id [String]
@@ -32,7 +33,7 @@ module ModernTreasury
       #   #
       #   def initialize(id:, form_link:, is_resend:, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end