modern_treasury 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.20

data/lib/modern_treasury/models/invoice.rb

@@ -28,14 +28,14 @@ module ModernTreasury
       #
       #   @return [Array<ModernTreasury::Models::Invoice::ContactDetail>]
       required :contact_details,
-               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::Invoice::ContactDetail] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Invoice::ContactDetail] }
 
       # @!attribute counterparty_billing_address
       #   The counterparty's billing address.
       #
       #   @return [ModernTreasury::Models::Invoice::CounterpartyBillingAddress, nil]
       required :counterparty_billing_address,
-               -> { ModernTreasury::Models::Invoice::CounterpartyBillingAddress },
+               -> { ModernTreasury::Invoice::CounterpartyBillingAddress },
                nil?: true
 
       # @!attribute counterparty_id
@@ -49,7 +49,7 @@ module ModernTreasury
       #
       #   @return [ModernTreasury::Models::Invoice::CounterpartyShippingAddress, nil]
       required :counterparty_shipping_address,
-               -> { ModernTreasury::Models::Invoice::CounterpartyShippingAddress },
+               -> { ModernTreasury::Invoice::CounterpartyShippingAddress },
                nil?: true
 
       # @!attribute created_at
@@ -61,10 +61,10 @@ module ModernTreasury
       #   Currency that the invoice is denominated in. Defaults to `USD` if not provided.
       #
       #   @return [Symbol, ModernTreasury::Models::Currency]
-      required :currency, enum: -> { ModernTreasury::Models::Currency }
+      required :currency, enum: -> { ModernTreasury::Currency }
 
       # @!attribute description
-      #   A free-form description of the invoice.
+      #   An optional free-form description of the invoice.
       #
       #   @return [String]
       required :description, String
@@ -80,7 +80,7 @@ module ModernTreasury
       #
       #   @return [Array<ModernTreasury::Models::ExpectedPayment>]
       required :expected_payments,
-               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::ExpectedPayment] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ExpectedPayment] }
 
       # @!attribute fallback_payment_method
       #   When payment_method is automatic, the fallback payment method to use when an
@@ -99,7 +99,7 @@ module ModernTreasury
       #   The invoice issuer's business address.
       #
       #   @return [ModernTreasury::Models::Invoice::InvoicerAddress, nil]
-      required :invoicer_address, -> { ModernTreasury::Models::Invoice::InvoicerAddress }, nil?: true
+      required :invoicer_address, -> { ModernTreasury::Invoice::InvoicerAddress }, nil?: true
 
       # @!attribute ledger_account_settlement_id
       #   The ledger account settlement object linked to the invoice.
@@ -166,21 +166,20 @@ module ModernTreasury
       #   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
+      required :payment_method, enum: -> { ModernTreasury::Invoice::PaymentMethod }, nil?: true
 
       # @!attribute payment_orders
       #   The payment orders created for paying the invoice through the invoice payment
       #   UI.
       #
       #   @return [Array<ModernTreasury::Models::PaymentOrder>]
-      required :payment_orders,
-               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::PaymentOrder] }
+      required :payment_orders, -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::PaymentOrder] }
 
       # @!attribute payment_type
       #   One of `ach` or `eft`.
       #
       #   @return [Symbol, ModernTreasury::Models::Invoice::PaymentType, nil]
-      required :payment_type, enum: -> { ModernTreasury::Models::Invoice::PaymentType }, nil?: true
+      required :payment_type, enum: -> { ModernTreasury::Invoice::PaymentType }, nil?: true
 
       # @!attribute pdf_url
       #   The URL where the invoice PDF can be downloaded.
@@ -219,7 +218,7 @@ module ModernTreasury
       #   The status of the invoice.
       #
       #   @return [Symbol, ModernTreasury::Models::Invoice::Status]
-      required :status, enum: -> { ModernTreasury::Models::Invoice::Status }
+      required :status, enum: -> { ModernTreasury::Invoice::Status }
 
       # @!attribute total_amount
       #   Total amount due in specified currency's smallest unit, e.g., $10 USD would be
@@ -245,89 +244,83 @@ module ModernTreasury
       #   @return [String, nil]
       required :virtual_account_id, String, nil?: true
 
-      # @!parse
-      #   # @param id [String]
-      #   # @param amount_paid [Integer]
-      #   # @param amount_remaining [Integer]
-      #   # @param contact_details [Array<ModernTreasury::Models::Invoice::ContactDetail>]
-      #   # @param counterparty_billing_address [ModernTreasury::Models::Invoice::CounterpartyBillingAddress, nil]
-      #   # @param counterparty_id [String]
-      #   # @param counterparty_shipping_address [ModernTreasury::Models::Invoice::CounterpartyShippingAddress, nil]
-      #   # @param created_at [Time]
-      #   # @param currency [Symbol, ModernTreasury::Models::Currency]
-      #   # @param description [String]
-      #   # @param due_date [Time]
-      #   # @param expected_payments [Array<ModernTreasury::Models::ExpectedPayment>]
-      #   # @param fallback_payment_method [String, nil]
-      #   # @param hosted_url [String]
-      #   # @param invoicer_address [ModernTreasury::Models::Invoice::InvoicerAddress, nil]
-      #   # @param ledger_account_settlement_id [String, nil]
-      #   # @param live_mode [Boolean]
-      #   # @param metadata [Hash{Symbol=>String}, nil]
-      #   # @param notification_email_addresses [Array<String>, nil]
-      #   # @param notifications_enabled [Boolean]
-      #   # @param number [String]
-      #   # @param object [String]
-      #   # @param originating_account_id [String]
-      #   # @param payment_effective_date [Date, nil]
-      #   # @param payment_method [Symbol, ModernTreasury::Models::Invoice::PaymentMethod, nil]
-      #   # @param payment_orders [Array<ModernTreasury::Models::PaymentOrder>]
-      #   # @param payment_type [Symbol, ModernTreasury::Models::Invoice::PaymentType, nil]
-      #   # @param pdf_url [String, nil]
-      #   # @param receiving_account_id [String, nil]
-      #   # @param recipient_email [String, nil]
-      #   # @param recipient_name [String, nil]
-      #   # @param remind_after_overdue_days [Array<Integer>, nil]
-      #   # @param status [Symbol, ModernTreasury::Models::Invoice::Status]
-      #   # @param total_amount [Integer]
-      #   # @param transaction_line_item_ids [Array<String>]
-      #   # @param updated_at [Time]
-      #   # @param virtual_account_id [String, nil]
-      #   #
-      #   def initialize(
-      #     id:,
-      #     amount_paid:,
-      #     amount_remaining:,
-      #     contact_details:,
-      #     counterparty_billing_address:,
-      #     counterparty_id:,
-      #     counterparty_shipping_address:,
-      #     created_at:,
-      #     currency:,
-      #     description:,
-      #     due_date:,
-      #     expected_payments:,
-      #     fallback_payment_method:,
-      #     hosted_url:,
-      #     invoicer_address:,
-      #     ledger_account_settlement_id:,
-      #     live_mode:,
-      #     metadata:,
-      #     notification_email_addresses:,
-      #     notifications_enabled:,
-      #     number:,
-      #     object:,
-      #     originating_account_id:,
-      #     payment_effective_date:,
-      #     payment_method:,
-      #     payment_orders:,
-      #     payment_type:,
-      #     pdf_url:,
-      #     receiving_account_id:,
-      #     recipient_email:,
-      #     recipient_name:,
-      #     remind_after_overdue_days:,
-      #     status:,
-      #     total_amount:,
-      #     transaction_line_item_ids:,
-      #     updated_at:,
-      #     virtual_account_id:,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(id:, amount_paid:, amount_remaining:, contact_details:, counterparty_billing_address:, counterparty_id:, counterparty_shipping_address:, created_at:, currency:, description:, due_date:, expected_payments:, fallback_payment_method:, hosted_url:, invoicer_address:, ledger_account_settlement_id:, live_mode:, metadata:, notification_email_addresses:, notifications_enabled:, number:, object:, originating_account_id:, payment_effective_date:, payment_method:, payment_orders:, payment_type:, pdf_url:, receiving_account_id:, recipient_email:, recipient_name:, remind_after_overdue_days:, status:, total_amount:, transaction_line_item_ids:, updated_at:, virtual_account_id:)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::Invoice} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param amount_paid [Integer] Amount paid on the invoice in specified currency's smallest unit, e.g., $10 USD
+      #
+      #   @param amount_remaining [Integer] Amount remaining due on the invoice in specified currency's smallest unit, e.g.,
+      #
+      #   @param contact_details [Array<ModernTreasury::Models::Invoice::ContactDetail>] The invoicer's contact details displayed at the top of the invoice.
+      #
+      #   @param counterparty_billing_address [ModernTreasury::Models::Invoice::CounterpartyBillingAddress, nil] The counterparty's billing address.
+      #
+      #   @param counterparty_id [String] The ID of the counterparty receiving the invoice.
+      #
+      #   @param counterparty_shipping_address [ModernTreasury::Models::Invoice::CounterpartyShippingAddress, nil] The counterparty's shipping address where physical goods should be delivered.
+      #
+      #   @param created_at [Time]
+      #
+      #   @param currency [Symbol, ModernTreasury::Models::Currency] Currency that the invoice is denominated in. Defaults to `USD` if not provided.
+      #
+      #   @param description [String] An optional free-form description of the invoice.
+      #
+      #   @param due_date [Time] A future date by when the invoice needs to be paid.
+      #
+      #   @param expected_payments [Array<ModernTreasury::Models::ExpectedPayment>] The expected payments created for an unpaid invoice.
+      #
+      #   @param fallback_payment_method [String, nil] When payment_method is automatic, the fallback payment method to use when an aut
+      #
+      #   @param hosted_url [String] The URL of the hosted web UI where the invoice can be viewed.
+      #
+      #   @param invoicer_address [ModernTreasury::Models::Invoice::InvoicerAddress, nil] The invoice issuer's business address.
+      #
+      #   @param ledger_account_settlement_id [String, nil] The ledger account settlement object linked to the invoice.
+      #
+      #   @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}, nil] Additional data represented as key-value pairs. Both the key and value must be s
+      #
+      #   @param notification_email_addresses [Array<String>, nil] Emails in addition to the counterparty email to send invoice status notification
+      #
+      #   @param notifications_enabled [Boolean] If true, the invoice will send email notifications to the invoice recipients abo
+      #
+      #   @param number [String] A unique record number assigned to each invoice that is issued.
+      #
+      #   @param object [String]
+      #
+      #   @param originating_account_id [String] The ID of the internal account the invoice should be paid to.
+      #
+      #   @param payment_effective_date [Date, nil] Date transactions are to be posted to the participants' account. Defaults to the
+      #
+      #   @param payment_method [Symbol, ModernTreasury::Models::Invoice::PaymentMethod, nil] When opening an invoice, whether to show the embedded payment UI , automatically
+      #
+      #   @param payment_orders [Array<ModernTreasury::Models::PaymentOrder>] The payment orders created for paying the invoice through the invoice payment UI
+      #
+      #   @param payment_type [Symbol, ModernTreasury::Models::Invoice::PaymentType, nil] One of `ach` or `eft`.
+      #
+      #   @param pdf_url [String, nil] The URL where the invoice PDF can be downloaded.
+      #
+      #   @param receiving_account_id [String, nil] The receiving account ID. Can be an `internal_account`.
+      #
+      #   @param recipient_email [String, nil] The email of the recipient of the invoice. Leaving this value as null will fallb
+      #
+      #   @param recipient_name [String, nil] The name of the recipient of the invoice. Leaving this value as null will fallba
+      #
+      #   @param remind_after_overdue_days [Array<Integer>, nil] Number of days after due date when overdue reminder emails will be sent out to i
+      #
+      #   @param status [Symbol, ModernTreasury::Models::Invoice::Status] The status of the invoice.
+      #
+      #   @param total_amount [Integer] Total amount due in specified currency's smallest unit, e.g., $10 USD would be r
+      #
+      #   @param transaction_line_item_ids [Array<String>] IDs of transaction line items associated with an invoice.
+      #
+      #   @param updated_at [Time]
+      #
+      #   @param virtual_account_id [String, nil] The ID of the virtual account the invoice should be paid to.
 
       class ContactDetail < ModernTreasury::Internal::Type::BaseModel
         # @!attribute id
@@ -344,7 +337,7 @@ module ModernTreasury
         #
         #   @return [Symbol, ModernTreasury::Models::Invoice::ContactDetail::ContactIdentifierType]
         required :contact_identifier_type,
-                 enum: -> { ModernTreasury::Models::Invoice::ContactDetail::ContactIdentifierType }
+                 enum: -> { ModernTreasury::Invoice::ContactDetail::ContactIdentifierType }
 
         # @!attribute created_at
         #
@@ -373,31 +366,25 @@ module ModernTreasury
         #   @return [Time]
         required :updated_at, Time
 
-        # @!parse
-        #   # @param id [String]
-        #   # @param contact_identifier [String]
-        #   # @param contact_identifier_type [Symbol, ModernTreasury::Models::Invoice::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
+        # @!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::Invoice::ContactDetail} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param contact_identifier [String]
+        #
+        #   @param contact_identifier_type [Symbol, ModernTreasury::Models::Invoice::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::Invoice::ContactDetail#contact_identifier_type
         module ContactIdentifierType
@@ -407,11 +394,8 @@ 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
 
@@ -446,28 +430,25 @@ module ModernTreasury
         #   @return [String]
         required :region, String
 
-        # @!attribute [r] line2
+        # @!attribute line2
         #
         #   @return [String, nil]
         optional :line2, String
 
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :line2
-
-        # @!parse
-        #   # The counterparty's billing address.
-        #   #
-        #   # @param country [String]
-        #   # @param line1 [String]
-        #   # @param locality [String]
-        #   # @param postal_code [String]
-        #   # @param region [String]
-        #   # @param line2 [String]
-        #   #
-        #   def initialize(country:, line1:, locality:, postal_code:, region:, line2: nil, **) = super
-
-        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+        # @!method initialize(country:, line1:, locality:, postal_code:, region:, line2: nil)
+        #   The counterparty's billing address.
+        #
+        #   @param country [String] Country code conforms to [ISO 3166-1 alpha-2]
+        #
+        #   @param line1 [String]
+        #
+        #   @param locality [String] Locality or City.
+        #
+        #   @param postal_code [String] The postal code of the address.
+        #
+        #   @param region [String] Region or State.
+        #
+        #   @param line2 [String]
       end
 
       # @see ModernTreasury::Models::Invoice#counterparty_shipping_address
@@ -501,28 +482,25 @@ module ModernTreasury
         #   @return [String]
         required :region, String
 
-        # @!attribute [r] line2
+        # @!attribute line2
         #
         #   @return [String, nil]
         optional :line2, String
 
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :line2
-
-        # @!parse
-        #   # The counterparty's shipping address where physical goods should be delivered.
-        #   #
-        #   # @param country [String]
-        #   # @param line1 [String]
-        #   # @param locality [String]
-        #   # @param postal_code [String]
-        #   # @param region [String]
-        #   # @param line2 [String]
-        #   #
-        #   def initialize(country:, line1:, locality:, postal_code:, region:, line2: nil, **) = super
-
-        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+        # @!method initialize(country:, line1:, locality:, postal_code:, region:, line2: nil)
+        #   The counterparty's shipping address where physical goods should be delivered.
+        #
+        #   @param country [String] Country code conforms to [ISO 3166-1 alpha-2]
+        #
+        #   @param line1 [String]
+        #
+        #   @param locality [String] Locality or City.
+        #
+        #   @param postal_code [String] The postal code of the address.
+        #
+        #   @param region [String] Region or State.
+        #
+        #   @param line2 [String]
       end
 
       # @see ModernTreasury::Models::Invoice#invoicer_address
@@ -556,28 +534,25 @@ module ModernTreasury
         #   @return [String]
         required :region, String
 
-        # @!attribute [r] line2
+        # @!attribute line2
         #
         #   @return [String, nil]
         optional :line2, String
 
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :line2
-
-        # @!parse
-        #   # The invoice issuer's business address.
-        #   #
-        #   # @param country [String]
-        #   # @param line1 [String]
-        #   # @param locality [String]
-        #   # @param postal_code [String]
-        #   # @param region [String]
-        #   # @param line2 [String]
-        #   #
-        #   def initialize(country:, line1:, locality:, postal_code:, region:, line2: nil, **) = super
-
-        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+        # @!method initialize(country:, line1:, locality:, postal_code:, region:, line2: nil)
+        #   The invoice issuer's business address.
+        #
+        #   @param country [String] Country code conforms to [ISO 3166-1 alpha-2]
+        #
+        #   @param line1 [String]
+        #
+        #   @param locality [String] Locality or City.
+        #
+        #   @param postal_code [String] The postal code of the address.
+        #
+        #   @param region [String] Region or State.
+        #
+        #   @param line2 [String]
       end
 
       # When opening an invoice, whether to show the embedded payment UI , automatically
@@ -591,11 +566,8 @@ module ModernTreasury
         MANUAL = :manual
         AUTOMATIC = :automatic
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       # One of `ach` or `eft`.
@@ -607,11 +579,8 @@ module ModernTreasury
         EFT = :eft
         ACH = :ach
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       # The status of the invoice.
@@ -627,11 +596,8 @@ module ModernTreasury
         UNPAID = :unpaid
         VOIDED = :voided
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/modern_treasury/models/invoice_add_payment_order_params.rb

@@ -4,8 +4,7 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::Invoices#add_payment_order
     class InvoiceAddPaymentOrderParams < ModernTreasury::Internal::Type::BaseModel
-      # @!parse
-      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute id
@@ -13,13 +12,9 @@ module ModernTreasury
       #   @return [String]
       required :id, String
 
-      # @!parse
-      #   # @param id [String]
-      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(id:, request_options: {}, **) = super
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end