modern_treasury 0.1.0.pre.alpha.15 → 0.1.0.pre.alpha.17

data/lib/modern_treasury/models/invoice_create_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class InvoiceCreateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Invoices#create
+    class InvoiceCreateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute counterparty_id
       #   The ID of the counterparty receiving the invoice.
@@ -27,18 +28,18 @@ module ModernTreasury
 
       # @!attribute auto_advance
       #   When true, the invoice will progress to unpaid automatically and cannot be
-      #     edited after entering that state. If the invoice fails to progress to unpaid,
-      #     the errors will be returned and the invoice will not be created.
+      #   edited after entering that state. If the invoice fails to progress to unpaid,
+      #   the errors will be returned and the invoice will not be created.
       #
       #   @return [Boolean, nil]
-      optional :auto_advance, ModernTreasury::BooleanModel, nil?: true
+      optional :auto_advance, ModernTreasury::Internal::Type::Boolean, nil?: true
 
       # @!attribute [r] contact_details
       #   The invoicer's contact details displayed at the top of the invoice.
       #
       #   @return [Array<ModernTreasury::Models::InvoiceCreateParams::ContactDetail>, nil]
       optional :contact_details,
-               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::InvoiceCreateParams::ContactDetail] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::InvoiceCreateParams::ContactDetail] }
 
       # @!parse
       #   # @return [Array<ModernTreasury::Models::InvoiceCreateParams::ContactDetail>]
@@ -82,27 +83,27 @@ module ModernTreasury
 
       # @!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]
       optional :fallback_payment_method, String, nil?: true
 
       # @!attribute ingest_ledger_entries
       #   Whether to ingest the ledger_entries to populate the invoice line items. If this
-      #     is false, then a line item must be provided. If this is true, line_items must be
-      #     empty. Ignored if ledger_account_settlement_id is empty.
+      #   is false, then a line item must be provided. If this is true, line_items must be
+      #   empty. Ignored if ledger_account_settlement_id is empty.
       #
       #   @return [Boolean, nil]
-      optional :ingest_ledger_entries, ModernTreasury::BooleanModel, nil?: true
+      optional :ingest_ledger_entries, ModernTreasury::Internal::Type::Boolean, nil?: true
 
       # @!attribute invoice_line_items
       #   An array of invoice line items. The API supports a maximum of 50 invoice line
-      #     items per invoice. If a greater number of invoice line items is required, please
-      #     contact support.
+      #   items per invoice. If a greater number of invoice line items is required, please
+      #   contact support.
       #
       #   @return [Array<ModernTreasury::Models::InvoiceCreateParams::InvoiceLineItem>, nil]
       optional :invoice_line_items,
-               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::InvoiceCreateParams::InvoiceLineItem] },
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::InvoiceCreateParams::InvoiceLineItem] },
                nil?: true
 
       # @!attribute invoicer_address
@@ -121,25 +122,25 @@ module ModernTreasury
 
       # @!attribute 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], nil?: true
+      optional :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]
-      optional :notification_email_addresses, ModernTreasury::ArrayOf[String], nil?: true
+      optional :notification_email_addresses, ModernTreasury::Internal::Type::ArrayOf[String], nil?: true
 
       # @!attribute [r] notifications_enabled
       #   If true, the invoice will send email notifications to the invoice recipients
-      #     about invoice status changes.
+      #   about invoice status changes.
       #
       #   @return [Boolean, nil]
-      optional :notifications_enabled, ModernTreasury::BooleanModel
+      optional :notifications_enabled, ModernTreasury::Internal::Type::Boolean
 
       # @!parse
       #   # @return [Boolean]
@@ -147,8 +148,8 @@ module ModernTreasury
 
       # @!attribute [r] 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]
       optional :payment_effective_date, Date
@@ -159,11 +160,11 @@ module ModernTreasury
 
       # @!attribute [r] payment_method
       #   The method by which the invoice can be paid. `ui` will show the embedded payment
-      #     collection flow. `automatic` will automatically initiate payment based upon the
-      #     account details of the receiving_account id.\nIf the invoice amount is positive,
-      #     the automatically initiated payment order's direction will be debit. If the
-      #     invoice amount is negative, the automatically initiated payment order's
-      #     direction will be credit. One of `manual`, `ui`, or `automatic`.
+      #   collection flow. `automatic` will automatically initiate payment based upon the
+      #   account details of the receiving_account id.\nIf the invoice amount is positive,
+      #   the automatically initiated payment order's direction will be debit. If the
+      #   invoice amount is negative, the automatically initiated payment order's
+      #   direction will be credit. One of `manual`, `ui`, or `automatic`.
       #
       #   @return [Symbol, ModernTreasury::Models::InvoiceCreateParams::PaymentMethod, nil]
       optional :payment_method, enum: -> { ModernTreasury::Models::InvoiceCreateParams::PaymentMethod }
@@ -174,8 +175,8 @@ module ModernTreasury
 
       # @!attribute [r] payment_type
       #   One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`,
-      #     `sepa`, `bacs`, `au_becs`, `interac`, `neft`, `nics`,
-      #     `nz_national_clearing_code`, `sic`, `signet`, `provexchange`, `zengin`.
+      #   `sepa`, `bacs`, `au_becs`, `interac`, `neft`, `nics`,
+      #   `nz_national_clearing_code`, `sic`, `signet`, `provexchange`, `zengin`.
       #
       #   @return [Symbol, ModernTreasury::Models::PaymentOrderType, nil]
       optional :payment_type, enum: -> { ModernTreasury::Models::PaymentOrderType }
@@ -196,24 +197,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]
       optional :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]
       optional :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]
-      optional :remind_after_overdue_days, ModernTreasury::ArrayOf[Integer], nil?: true
+      optional :remind_after_overdue_days, ModernTreasury::Internal::Type::ArrayOf[Integer], nil?: true
 
       # @!attribute virtual_account_id
       #   The ID of the virtual account the invoice should be paid to.
@@ -281,9 +282,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]
@@ -312,10 +313,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
         #
@@ -351,22 +352,12 @@ module ModernTreasury
         #     super
         #   end
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
-
-        # @abstract
-        #
-        # @example
-        # ```ruby
-        # case contact_identifier_type
-        # in :email
-        #   # ...
-        # in :phone_number
-        #   # ...
-        # in :website
-        #   # ...
-        # end
-        # ```
-        class ContactIdentifierType < ModernTreasury::Enum
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+
+        # @see ModernTreasury::Models::InvoiceCreateParams::ContactDetail#contact_identifier_type
+        module ContactIdentifierType
+          extend ModernTreasury::Internal::Type::Enum
+
           EMAIL = :email
           PHONE_NUMBER = :phone_number
           WEBSITE = :website
@@ -375,12 +366,11 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end
 
-      class CounterpartyBillingAddress < ModernTreasury::BaseModel
+      class CounterpartyBillingAddress < ModernTreasury::Internal::Type::BaseModel
         # @!attribute country
         #   Country code conforms to [ISO 3166-1 alpha-2]
         #
@@ -431,10 +421,10 @@ 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
+      class CounterpartyShippingAddress < ModernTreasury::Internal::Type::BaseModel
         # @!attribute country
         #   Country code conforms to [ISO 3166-1 alpha-2]
         #
@@ -485,10 +475,10 @@ 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 InvoiceLineItem < ModernTreasury::BaseModel
+      class InvoiceLineItem < ModernTreasury::Internal::Type::BaseModel
         # @!attribute name
         #   The name of the line item, typically a product or SKU name.
         #
@@ -497,7 +487,7 @@ module ModernTreasury
 
         # @!attribute unit_amount
         #   The cost per unit of the product or service that this line item is for,
-        #     specified in the invoice currency's smallest unit.
+        #   specified in the invoice currency's smallest unit.
         #
         #   @return [Integer]
         required :unit_amount, Integer
@@ -514,8 +504,8 @@ module ModernTreasury
 
         # @!attribute [r] direction
         #   Either `debit` or `credit`. `debit` indicates that a client owes the business
-        #     money and increases the invoice's `total_amount` due. `credit` has the opposite
-        #     intention and effect.
+        #   money and increases the invoice's `total_amount` due. `credit` has the opposite
+        #   intention and effect.
         #
         #   @return [String, nil]
         optional :direction, String
@@ -526,10 +516,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}]
@@ -537,7 +527,7 @@ module ModernTreasury
 
         # @!attribute [r] quantity
         #   The number of units of a product or service that this line item is for. Must be
-        #     a whole number. Defaults to 1 if not provided.
+        #   a whole number. Defaults to 1 if not provided.
         #
         #   @return [Integer, nil]
         optional :quantity, Integer
@@ -548,8 +538,8 @@ module ModernTreasury
 
         # @!attribute [r] unit_amount_decimal
         #   The cost per unit of the product or service that this line item is for,
-        #     specified in the invoice currency's smallest unit. Accepts decimal strings with
-        #     up to 12 decimals
+        #   specified in the invoice currency's smallest unit. Accepts decimal strings with
+        #   up to 12 decimals
         #
         #   @return [String, nil]
         optional :unit_amount_decimal, String
@@ -580,10 +570,10 @@ module ModernTreasury
         #     super
         #   end
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
 
-      class InvoicerAddress < ModernTreasury::BaseModel
+      class InvoicerAddress < ModernTreasury::Internal::Type::BaseModel
         # @!attribute country
         #   Country code conforms to [ISO 3166-1 alpha-2]
         #
@@ -634,30 +624,18 @@ 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
 
-      # @abstract
-      #
       # The method by which the invoice can be paid. `ui` will show the embedded payment
-      #   collection flow. `automatic` will automatically initiate payment based upon the
-      #   account details of the receiving_account id.\nIf the invoice amount is positive,
-      #   the automatically initiated payment order's direction will be debit. If the
-      #   invoice amount is negative, the automatically initiated payment order's
-      #   direction will be credit. One of `manual`, `ui`, or `automatic`.
-      #
-      # @example
-      # ```ruby
-      # case payment_method
-      # in :ui
-      #   # ...
-      # in :manual
-      #   # ...
-      # in :automatic
-      #   # ...
-      # end
-      # ```
-      class PaymentMethod < ModernTreasury::Enum
+      # collection flow. `automatic` will automatically initiate payment based upon the
+      # account details of the receiving_account id.\nIf the invoice amount is positive,
+      # the automatically initiated payment order's direction will be debit. If the
+      # invoice amount is negative, the automatically initiated payment order's
+      # direction will be credit. One of `manual`, `ui`, or `automatic`.
+      module PaymentMethod
+        extend ModernTreasury::Internal::Type::Enum
+
         UI = :ui
         MANUAL = :manual
         AUTOMATIC = :automatic
@@ -666,7 +644,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/invoice_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class InvoiceListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Invoices#list
+    class InvoiceListParams < 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
       #
@@ -52,11 +53,11 @@ module ModernTreasury
 
       # @!attribute [r] metadata
       #   For example, if you want to query for records with metadata key `Type` and value
-      #     `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
-      #     parameters.
+      #   `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
+      #   parameters.
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :metadata, ModernTreasury::HashOf[String]
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!parse
       #   # @return [Hash{Symbol=>String}]
@@ -140,28 +141,11 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case status
-      # in :draft
-      #   # ...
-      # in :paid
-      #   # ...
-      # in :partially_paid
-      #   # ...
-      # in :payment_pending
-      #   # ...
-      # in :unpaid
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class Status < ModernTreasury::Enum
         DRAFT = :draft
         PAID = :paid
         PARTIALLY_PAID = :partially_paid
@@ -173,7 +157,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/invoice_retrieve_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class InvoiceRetrieveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Invoices#retrieve
+    class InvoiceRetrieveParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!parse
       #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
       #   #
       #   def initialize(request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end