modern_treasury 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.17

data/lib/modern_treasury/models/internal_accounts/balance_report_create_params.rb

@@ -3,10 +3,11 @@
 module ModernTreasury
   module Models
     module InternalAccounts
-      class BalanceReportCreateParams < ModernTreasury::BaseModel
+      # @see ModernTreasury::Resources::InternalAccounts::BalanceReports#create
+      class BalanceReportCreateParams < ModernTreasury::Internal::Type::BaseModel
         # @!parse
-        #   extend ModernTreasury::RequestParameters::Converter
-        include ModernTreasury::RequestParameters
+        #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+        include ModernTreasury::Internal::Type::RequestParameters
 
         # @!attribute as_of_date
         #   The date of the balance report in local time.
@@ -22,7 +23,7 @@ module ModernTreasury
 
         # @!attribute balance_report_type
         #   The specific type of balance report. One of `intraday`, `previous_day`,
-        #     `real_time`, or `other`.
+        #   `real_time`, or `other`.
         #
         #   @return [Symbol, ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::BalanceReportType]
         required :balance_report_type,
@@ -33,7 +34,7 @@ module ModernTreasury
         #
         #   @return [Array<ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance>]
         required :balances,
-                 -> { ModernTreasury::ArrayOf[ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance] }
+                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance] }
 
         # @!parse
         #   # @param as_of_date [Date]
@@ -44,12 +45,12 @@ module ModernTreasury
         #   #
         #   def initialize(as_of_date:, as_of_time:, balance_report_type:, balances:, request_options: {}, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
         # The specific type of balance report. One of `intraday`, `previous_day`,
-        #   `real_time`, or `other`.
+        # `real_time`, or `other`.
         module BalanceReportType
-          extend ModernTreasury::Enum
+          extend ModernTreasury::Internal::Type::Enum
 
           INTRADAY = :intraday
           OTHER = :other
@@ -63,7 +64,7 @@ module ModernTreasury
           #   def self.values; end
         end
 
-        class Balance < ModernTreasury::BaseModel
+        class Balance < ModernTreasury::Internal::Type::BaseModel
           # @!attribute amount
           #   The balance amount.
           #
@@ -72,9 +73,9 @@ module ModernTreasury
 
           # @!attribute balance_type
           #   The specific type of balance reported. One of `opening_ledger`,
-          #     `closing_ledger`, `current_ledger`, `opening_available`,
-          #     `opening_available_next_business_day`, `closing_available`, `current_available`,
-          #     'previously_closed_book', or `other`.
+          #   `closing_ledger`, `current_ledger`, `opening_available`,
+          #   `opening_available_next_business_day`, `closing_available`, `current_available`,
+          #   'previously_closed_book', or `other`.
           #
           #   @return [Symbol, ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance::BalanceType]
           required :balance_type,
@@ -88,9 +89,9 @@ module ModernTreasury
 
           # @!attribute vendor_code_type
           #   The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`,
-          #     `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
-          #     `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
-          #     `swift`, or `us_bank`.
+          #   `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
+          #   `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
+          #   `swift`, or `us_bank`.
           #
           #   @return [String, nil]
           required :vendor_code_type, String, nil?: true
@@ -103,14 +104,16 @@ module ModernTreasury
           #   #
           #   def initialize(amount:, balance_type:, vendor_code:, vendor_code_type:, **) = super
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
           # The specific type of balance reported. One of `opening_ledger`,
-          #   `closing_ledger`, `current_ledger`, `opening_available`,
-          #   `opening_available_next_business_day`, `closing_available`, `current_available`,
-          #   'previously_closed_book', or `other`.
+          # `closing_ledger`, `current_ledger`, `opening_available`,
+          # `opening_available_next_business_day`, `closing_available`, `current_available`,
+          # 'previously_closed_book', or `other`.
+          #
+          # @see ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance#balance_type
           module BalanceType
-            extend ModernTreasury::Enum
+            extend ModernTreasury::Internal::Type::Enum
 
             CLOSING_AVAILABLE = :closing_available
             CLOSING_LEDGER = :closing_ledger

data/lib/modern_treasury/models/internal_accounts/balance_report_delete_params.rb

@@ -3,10 +3,11 @@
 module ModernTreasury
   module Models
     module InternalAccounts
-      class BalanceReportDeleteParams < ModernTreasury::BaseModel
+      # @see ModernTreasury::Resources::InternalAccounts::BalanceReports#delete
+      class BalanceReportDeleteParams < ModernTreasury::Internal::Type::BaseModel
         # @!parse
-        #   extend ModernTreasury::RequestParameters::Converter
-        include ModernTreasury::RequestParameters
+        #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+        include ModernTreasury::Internal::Type::RequestParameters
 
         # @!attribute internal_account_id
         #
@@ -19,7 +20,7 @@ module ModernTreasury
         #   #
         #   def initialize(internal_account_id:, request_options: {}, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
     end
   end

data/lib/modern_treasury/models/internal_accounts/balance_report_list_params.rb

@@ -3,10 +3,11 @@
 module ModernTreasury
   module Models
     module InternalAccounts
-      class BalanceReportListParams < ModernTreasury::BaseModel
+      # @see ModernTreasury::Resources::InternalAccounts::BalanceReports#list
+      class BalanceReportListParams < ModernTreasury::Internal::Type::BaseModel
         # @!parse
-        #   extend ModernTreasury::RequestParameters::Converter
-        include ModernTreasury::RequestParameters
+        #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+        include ModernTreasury::Internal::Type::RequestParameters
 
         # @!attribute after_cursor
         #
@@ -25,7 +26,7 @@ module ModernTreasury
 
         # @!attribute [r] balance_report_type
         #   The specific type of balance report. One of `intraday`, `previous_day`,
-        #     `real_time`, or `other`.
+        #   `real_time`, or `other`.
         #
         #   @return [Symbol, ModernTreasury::Models::InternalAccounts::BalanceReportListParams::BalanceReportType, nil]
         optional :balance_report_type,
@@ -53,12 +54,12 @@ module ModernTreasury
         #   #
         #   def initialize(after_cursor: nil, as_of_date: nil, balance_report_type: nil, per_page: nil, request_options: {}, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
         # The specific type of balance report. One of `intraday`, `previous_day`,
-        #   `real_time`, or `other`.
+        # `real_time`, or `other`.
         module BalanceReportType
-          extend ModernTreasury::Enum
+          extend ModernTreasury::Internal::Type::Enum
 
           INTRADAY = :intraday
           OTHER = :other

data/lib/modern_treasury/models/internal_accounts/balance_report_retrieve_params.rb

@@ -3,10 +3,11 @@
 module ModernTreasury
   module Models
     module InternalAccounts
-      class BalanceReportRetrieveParams < ModernTreasury::BaseModel
+      # @see ModernTreasury::Resources::InternalAccounts::BalanceReports#retrieve
+      class BalanceReportRetrieveParams < ModernTreasury::Internal::Type::BaseModel
         # @!parse
-        #   extend ModernTreasury::RequestParameters::Converter
-        include ModernTreasury::RequestParameters
+        #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+        include ModernTreasury::Internal::Type::RequestParameters
 
         # @!attribute internal_account_id
         #
@@ -19,7 +20,7 @@ module ModernTreasury
         #   #
         #   def initialize(internal_account_id:, request_options: {}, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
     end
   end

data/lib/modern_treasury/models/invoice.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class Invoice < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Invoices#create
+    class Invoice < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -10,14 +11,14 @@ module ModernTreasury
 
       # @!attribute amount_paid
       #   Amount paid on the invoice in specified currency's smallest unit, e.g., $10 USD
-      #     would be represented as 1000.
+      #   would be represented as 1000.
       #
       #   @return [Integer]
       required :amount_paid, Integer
 
       # @!attribute amount_remaining
       #   Amount remaining due on the invoice in specified currency's smallest unit, e.g.,
-      #     $10 USD would be represented as 1000.
+      #   $10 USD would be represented as 1000.
       #
       #   @return [Integer]
       required :amount_remaining, Integer
@@ -26,7 +27,8 @@ module ModernTreasury
       #   The invoicer's contact details displayed at the top of the invoice.
       #
       #   @return [Array<ModernTreasury::Models::Invoice::ContactDetail>]
-      required :contact_details, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::Invoice::ContactDetail] }
+      required :contact_details,
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::Invoice::ContactDetail] }
 
       # @!attribute counterparty_billing_address
       #   The counterparty's billing address.
@@ -77,11 +79,12 @@ module ModernTreasury
       #   The expected payments created for an unpaid invoice.
       #
       #   @return [Array<ModernTreasury::Models::ExpectedPayment>]
-      required :expected_payments, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::ExpectedPayment] }
+      required :expected_payments,
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::ExpectedPayment] }
 
       # @!attribute fallback_payment_method
       #   When payment_method is automatic, the fallback payment method to use when an
-      #     automatic payment fails. One of `manual` or `ui`.
+      #   automatic payment fails. One of `manual` or `ui`.
       #
       #   @return [String, nil]
       required :fallback_payment_method, String, nil?: true
@@ -106,32 +109,32 @@ 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}, nil]
-      required :metadata, ModernTreasury::HashOf[String], nil?: true
+      required :metadata, ModernTreasury::Internal::Type::HashOf[String], nil?: true
 
       # @!attribute notification_email_addresses
       #   Emails in addition to the counterparty email to send invoice status
-      #     notifications to. At least one email is required if notifications are enabled
-      #     and the counterparty doesn't have an email.
+      #   notifications to. At least one email is required if notifications are enabled
+      #   and the counterparty doesn't have an email.
       #
       #   @return [Array<String>, nil]
-      required :notification_email_addresses, ModernTreasury::ArrayOf[String], nil?: true
+      required :notification_email_addresses, ModernTreasury::Internal::Type::ArrayOf[String], nil?: true
 
       # @!attribute notifications_enabled
       #   If true, the invoice will send email notifications to the invoice recipients
-      #     about invoice status changes.
+      #   about invoice status changes.
       #
       #   @return [Boolean]
-      required :notifications_enabled, ModernTreasury::BooleanModel
+      required :notifications_enabled, ModernTreasury::Internal::Type::Boolean
 
       # @!attribute number
       #   A unique record number assigned to each invoice that is issued.
@@ -152,25 +155,26 @@ module ModernTreasury
 
       # @!attribute payment_effective_date
       #   Date transactions are to be posted to the participants' account. Defaults to the
-      #     current business day or the next business day if the current day is a bank
-      #     holiday or weekend. Format: yyyy-mm-dd.
+      #   current business day or the next business day if the current day is a bank
+      #   holiday or weekend. Format: yyyy-mm-dd.
       #
       #   @return [Date, nil]
       required :payment_effective_date, Date, nil?: true
 
       # @!attribute payment_method
       #   When opening an invoice, whether to show the embedded payment UI , automatically
-      #     debit the recipient, or rely on manual payment from the recipient.
+      #   debit the recipient, or rely on manual payment from the recipient.
       #
       #   @return [Symbol, ModernTreasury::Models::Invoice::PaymentMethod, nil]
       required :payment_method, enum: -> { ModernTreasury::Models::Invoice::PaymentMethod }, nil?: true
 
       # @!attribute payment_orders
       #   The payment orders created for paying the invoice through the invoice payment
-      #     UI.
+      #   UI.
       #
       #   @return [Array<ModernTreasury::Models::PaymentOrder>]
-      required :payment_orders, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::PaymentOrder] }
+      required :payment_orders,
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::PaymentOrder] }
 
       # @!attribute payment_type
       #   One of `ach` or `eft`.
@@ -192,24 +196,24 @@ module ModernTreasury
 
       # @!attribute recipient_email
       #   The email of the recipient of the invoice. Leaving this value as null will
-      #     fallback to using the counterparty's name.
+      #   fallback to using the counterparty's name.
       #
       #   @return [String, nil]
       required :recipient_email, String, nil?: true
 
       # @!attribute recipient_name
       #   The name of the recipient of the invoice. Leaving this value as null will
-      #     fallback to using the counterparty's name.
+      #   fallback to using the counterparty's name.
       #
       #   @return [String, nil]
       required :recipient_name, String, nil?: true
 
       # @!attribute remind_after_overdue_days
       #   Number of days after due date when overdue reminder emails will be sent out to
-      #     invoice recipients.
+      #   invoice recipients.
       #
       #   @return [Array<Integer>, nil]
-      required :remind_after_overdue_days, ModernTreasury::ArrayOf[Integer], nil?: true
+      required :remind_after_overdue_days, ModernTreasury::Internal::Type::ArrayOf[Integer], nil?: true
 
       # @!attribute status
       #   The status of the invoice.
@@ -219,7 +223,7 @@ module ModernTreasury
 
       # @!attribute total_amount
       #   Total amount due in specified currency's smallest unit, e.g., $10 USD would be
-      #     represented as 1000.
+      #   represented as 1000.
       #
       #   @return [Integer]
       required :total_amount, Integer
@@ -228,7 +232,7 @@ module ModernTreasury
       #   IDs of transaction line items associated with an invoice.
       #
       #   @return [Array<String>]
-      required :transaction_line_item_ids, ModernTreasury::ArrayOf[String]
+      required :transaction_line_item_ids, ModernTreasury::Internal::Type::ArrayOf[String]
 
       # @!attribute updated_at
       #
@@ -323,9 +327,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]
@@ -354,10 +358,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
         #
@@ -393,10 +397,11 @@ module ModernTreasury
         #     super
         #   end
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
+        # @see ModernTreasury::Models::Invoice::ContactDetail#contact_identifier_type
         module ContactIdentifierType
-          extend ModernTreasury::Enum
+          extend ModernTreasury::Internal::Type::Enum
 
           EMAIL = :email
           PHONE_NUMBER = :phone_number
@@ -410,7 +415,8 @@ module ModernTreasury
         end
       end
 
-      class CounterpartyBillingAddress < ModernTreasury::BaseModel
+      # @see ModernTreasury::Models::Invoice#counterparty_billing_address
+      class CounterpartyBillingAddress < ModernTreasury::Internal::Type::BaseModel
         # @!attribute country
         #   Country code conforms to [ISO 3166-1 alpha-2]
         #
@@ -461,10 +467,11 @@ module ModernTreasury
         #   #
         #   def initialize(country:, line1:, locality:, postal_code:, region:, line2: nil, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
 
-      class CounterpartyShippingAddress < ModernTreasury::BaseModel
+      # @see ModernTreasury::Models::Invoice#counterparty_shipping_address
+      class CounterpartyShippingAddress < ModernTreasury::Internal::Type::BaseModel
         # @!attribute country
         #   Country code conforms to [ISO 3166-1 alpha-2]
         #
@@ -515,10 +522,11 @@ module ModernTreasury
         #   #
         #   def initialize(country:, line1:, locality:, postal_code:, region:, line2: nil, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
 
-      class InvoicerAddress < ModernTreasury::BaseModel
+      # @see ModernTreasury::Models::Invoice#invoicer_address
+      class InvoicerAddress < ModernTreasury::Internal::Type::BaseModel
         # @!attribute country
         #   Country code conforms to [ISO 3166-1 alpha-2]
         #
@@ -569,13 +577,15 @@ module ModernTreasury
         #   #
         #   def initialize(country:, line1:, locality:, postal_code:, region:, line2: nil, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
 
       # When opening an invoice, whether to show the embedded payment UI , automatically
-      #   debit the recipient, or rely on manual payment from the recipient.
+      # debit the recipient, or rely on manual payment from the recipient.
+      #
+      # @see ModernTreasury::Models::Invoice#payment_method
       module PaymentMethod
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         UI = :ui
         MANUAL = :manual
@@ -589,8 +599,10 @@ module ModernTreasury
       end
 
       # One of `ach` or `eft`.
+      #
+      # @see ModernTreasury::Models::Invoice#payment_type
       module PaymentType
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         EFT = :eft
         ACH = :ach
@@ -603,8 +615,10 @@ module ModernTreasury
       end
 
       # The status of the invoice.
+      #
+      # @see ModernTreasury::Models::Invoice#status
       module Status
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         DRAFT = :draft
         PAID = :paid

data/lib/modern_treasury/models/invoice_add_payment_order_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class InvoiceAddPaymentOrderParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Invoices#add_payment_order
+    class InvoiceAddPaymentOrderParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute id
       #
@@ -18,7 +19,7 @@ module ModernTreasury
       #   #
       #   def initialize(id:, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end