modern_treasury 0.0.0 → 0.1.0.pre.alpha.16

data/rbi/lib/modern_treasury/resources/invoices/line_items.rbi

@@ -0,0 +1,157 @@
+# typed: strong
+
+module ModernTreasury
+  module Resources
+    class Invoices
+      class LineItems
+        # create invoice_line_item
+        sig do
+          params(
+            invoice_id: String,
+            name: String,
+            unit_amount: Integer,
+            description: String,
+            direction: String,
+            metadata: T::Hash[Symbol, String],
+            quantity: Integer,
+            unit_amount_decimal: String,
+            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+          )
+            .returns(ModernTreasury::Models::Invoices::InvoiceLineItem)
+        end
+        def create(
+          # invoice_id
+          invoice_id,
+          # The name of the line item, typically a product or SKU name.
+          name:,
+          # The cost per unit of the product or service that this line item is for,
+          #   specified in the invoice currency's smallest unit.
+          unit_amount:,
+          # An optional free-form description of the line item.
+          description: nil,
+          # 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.
+          direction: nil,
+          # Additional data represented as key-value pairs. Both the key and value must be
+          #   strings.
+          metadata: nil,
+          # 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.
+          quantity: nil,
+          # 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
+          unit_amount_decimal: nil,
+          request_options: {}
+        )
+        end
+
+        # get invoice_line_item
+        sig do
+          params(
+            id: String,
+            invoice_id: String,
+            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+          )
+            .returns(ModernTreasury::Models::Invoices::InvoiceLineItem)
+        end
+        def retrieve(
+          # id
+          id,
+          # invoice_id
+          invoice_id:,
+          request_options: {}
+        )
+        end
+
+        # update invoice_line_item
+        sig do
+          params(
+            id: String,
+            invoice_id: String,
+            description: String,
+            direction: String,
+            metadata: T::Hash[Symbol, String],
+            name: String,
+            quantity: Integer,
+            unit_amount: Integer,
+            unit_amount_decimal: String,
+            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+          )
+            .returns(ModernTreasury::Models::Invoices::InvoiceLineItem)
+        end
+        def update(
+          # Path param: id
+          id,
+          # Path param: invoice_id
+          invoice_id:,
+          # Body param: An optional free-form description of the line item.
+          description: nil,
+          # Body param: 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.
+          direction: nil,
+          # Body param: Additional data represented as key-value pairs. Both the key and
+          #   value must be strings.
+          metadata: nil,
+          # Body param: The name of the line item, typically a product or SKU name.
+          name: nil,
+          # Body param: 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.
+          quantity: nil,
+          # Body param: The cost per unit of the product or service that this line item is
+          #   for, specified in the invoice currency's smallest unit.
+          unit_amount: nil,
+          # Body param: 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
+          unit_amount_decimal: nil,
+          request_options: {}
+        )
+        end
+
+        # list invoice_line_items
+        sig do
+          params(
+            invoice_id: String,
+            after_cursor: T.nilable(String),
+            per_page: Integer,
+            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+          )
+            .returns(ModernTreasury::Page[ModernTreasury::Models::Invoices::InvoiceLineItem])
+        end
+        def list(
+          # invoice_id
+          invoice_id,
+          after_cursor: nil,
+          per_page: nil,
+          request_options: {}
+        )
+        end
+
+        # delete invoice_line_item
+        sig do
+          params(
+            id: String,
+            invoice_id: String,
+            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+          )
+            .returns(ModernTreasury::Models::Invoices::InvoiceLineItem)
+        end
+        def delete(
+          # id
+          id,
+          # invoice_id
+          invoice_id:,
+          request_options: {}
+        )
+        end
+
+        sig { params(client: ModernTreasury::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/lib/modern_treasury/resources/invoices.rbi

@@ -0,0 +1,338 @@
+# typed: strong
+
+module ModernTreasury
+  module Resources
+    class Invoices
+      sig { returns(ModernTreasury::Resources::Invoices::LineItems) }
+      attr_reader :line_items
+
+      # create invoice
+      sig do
+        params(
+          counterparty_id: String,
+          due_date: Time,
+          originating_account_id: String,
+          auto_advance: T.nilable(T::Boolean),
+          contact_details: T::Array[T.any(ModernTreasury::Models::InvoiceCreateParams::ContactDetail, ModernTreasury::Util::AnyHash)],
+          counterparty_billing_address: T.nilable(
+            T.any(
+              ModernTreasury::Models::InvoiceCreateParams::CounterpartyBillingAddress,
+              ModernTreasury::Util::AnyHash
+            )
+          ),
+          counterparty_shipping_address: T.nilable(
+            T.any(
+              ModernTreasury::Models::InvoiceCreateParams::CounterpartyShippingAddress,
+              ModernTreasury::Util::AnyHash
+            )
+          ),
+          currency: ModernTreasury::Models::Currency::OrSymbol,
+          description: String,
+          fallback_payment_method: T.nilable(String),
+          ingest_ledger_entries: T.nilable(T::Boolean),
+          invoice_line_items: T.nilable(
+            T::Array[T.any(ModernTreasury::Models::InvoiceCreateParams::InvoiceLineItem, ModernTreasury::Util::AnyHash)]
+          ),
+          invoicer_address: T.nilable(
+            T.any(ModernTreasury::Models::InvoiceCreateParams::InvoicerAddress, ModernTreasury::Util::AnyHash)
+          ),
+          ledger_account_settlement_id: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          notification_email_addresses: T.nilable(T::Array[String]),
+          notifications_enabled: T::Boolean,
+          payment_effective_date: Date,
+          payment_method: ModernTreasury::Models::InvoiceCreateParams::PaymentMethod::OrSymbol,
+          payment_type: ModernTreasury::Models::PaymentOrderType::OrSymbol,
+          receiving_account_id: String,
+          recipient_email: T.nilable(String),
+          recipient_name: T.nilable(String),
+          remind_after_overdue_days: T.nilable(T::Array[Integer]),
+          virtual_account_id: T.nilable(String),
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Models::Invoice)
+      end
+      def create(
+        # The ID of the counterparty receiving the invoice.
+        counterparty_id:,
+        # A future date by when the invoice needs to be paid.
+        due_date:,
+        # The ID of the internal account the invoice should be paid to.
+        originating_account_id:,
+        # 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.
+        auto_advance: nil,
+        # The invoicer's contact details displayed at the top of the invoice.
+        contact_details: nil,
+        # The counterparty's billing address.
+        counterparty_billing_address: nil,
+        # The counterparty's shipping address where physical goods should be delivered.
+        counterparty_shipping_address: nil,
+        # Currency that the invoice is denominated in. Defaults to `USD` if not provided.
+        currency: nil,
+        # A free-form description of the invoice.
+        description: nil,
+        # When payment_method is automatic, the fallback payment method to use when an
+        #   automatic payment fails. One of `manual` or `ui`.
+        fallback_payment_method: nil,
+        # 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.
+        ingest_ledger_entries: nil,
+        # 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.
+        invoice_line_items: nil,
+        # The invoice issuer's business address.
+        invoicer_address: nil,
+        # The ID of the virtual account the invoice should be paid to.
+        ledger_account_settlement_id: nil,
+        # Additional data represented as key-value pairs. Both the key and value must be
+        #   strings.
+        metadata: nil,
+        # 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.
+        notification_email_addresses: nil,
+        # If true, the invoice will send email notifications to the invoice recipients
+        #   about invoice status changes.
+        notifications_enabled: nil,
+        # 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.
+        payment_effective_date: nil,
+        # 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`.
+        payment_method: nil,
+        # 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`.
+        payment_type: nil,
+        # The receiving account ID. Can be an `external_account`.
+        receiving_account_id: nil,
+        # The email of the recipient of the invoice. Leaving this value as null will
+        #   fallback to using the counterparty's name.
+        recipient_email: nil,
+        # The name of the recipient of the invoice. Leaving this value as null will
+        #   fallback to using the counterparty's name.
+        recipient_name: nil,
+        # Number of days after due date when overdue reminder emails will be sent out to
+        #   invoice recipients.
+        remind_after_overdue_days: nil,
+        # The ID of the virtual account the invoice should be paid to.
+        virtual_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      # get invoice
+      sig do
+        params(
+          id: String,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Models::Invoice)
+      end
+      def retrieve(
+        # id
+        id,
+        request_options: {}
+      )
+      end
+
+      # update invoice
+      sig do
+        params(
+          id: String,
+          contact_details: T::Array[T.any(ModernTreasury::Models::InvoiceUpdateParams::ContactDetail, ModernTreasury::Util::AnyHash)],
+          counterparty_billing_address: T.nilable(
+            T.any(
+              ModernTreasury::Models::InvoiceUpdateParams::CounterpartyBillingAddress,
+              ModernTreasury::Util::AnyHash
+            )
+          ),
+          counterparty_id: String,
+          counterparty_shipping_address: T.nilable(
+            T.any(
+              ModernTreasury::Models::InvoiceUpdateParams::CounterpartyShippingAddress,
+              ModernTreasury::Util::AnyHash
+            )
+          ),
+          currency: ModernTreasury::Models::Currency::OrSymbol,
+          description: String,
+          due_date: Time,
+          fallback_payment_method: T.nilable(String),
+          ingest_ledger_entries: T.nilable(T::Boolean),
+          invoice_line_items: T.nilable(
+            T::Array[T.any(ModernTreasury::Models::InvoiceUpdateParams::InvoiceLineItem, ModernTreasury::Util::AnyHash)]
+          ),
+          invoicer_address: T.nilable(
+            T.any(ModernTreasury::Models::InvoiceUpdateParams::InvoicerAddress, ModernTreasury::Util::AnyHash)
+          ),
+          ledger_account_settlement_id: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          notification_email_addresses: T.nilable(T::Array[String]),
+          notifications_enabled: T::Boolean,
+          originating_account_id: String,
+          payment_effective_date: Date,
+          payment_method: ModernTreasury::Models::InvoiceUpdateParams::PaymentMethod::OrSymbol,
+          payment_type: ModernTreasury::Models::PaymentOrderType::OrSymbol,
+          receiving_account_id: String,
+          recipient_email: T.nilable(String),
+          recipient_name: T.nilable(String),
+          remind_after_overdue_days: T.nilable(T::Array[Integer]),
+          status: String,
+          virtual_account_id: T.nilable(String),
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Models::Invoice)
+      end
+      def update(
+        # id
+        id,
+        # The invoicer's contact details displayed at the top of the invoice.
+        contact_details: nil,
+        # The counterparty's billing address.
+        counterparty_billing_address: nil,
+        # The ID of the counterparty receiving the invoice.
+        counterparty_id: nil,
+        # The counterparty's shipping address where physical goods should be delivered.
+        counterparty_shipping_address: nil,
+        # Currency that the invoice is denominated in. Defaults to `USD` if not provided.
+        currency: nil,
+        # A free-form description of the invoice.
+        description: nil,
+        # A future date by when the invoice needs to be paid.
+        due_date: nil,
+        # When payment_method is automatic, the fallback payment method to use when an
+        #   automatic payment fails. One of `manual` or `ui`.
+        fallback_payment_method: nil,
+        # 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.
+        ingest_ledger_entries: nil,
+        # 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.
+        invoice_line_items: nil,
+        # The invoice issuer's business address.
+        invoicer_address: nil,
+        # The ID of the virtual account the invoice should be paid to.
+        ledger_account_settlement_id: nil,
+        # Additional data represented as key-value pairs. Both the key and value must be
+        #   strings.
+        metadata: nil,
+        # 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.
+        notification_email_addresses: nil,
+        # If true, the invoice will send email notifications to the invoice recipients
+        #   about invoice status changes.
+        notifications_enabled: nil,
+        # The ID of the internal account the invoice should be paid to.
+        originating_account_id: nil,
+        # 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.
+        payment_effective_date: nil,
+        # 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`.
+        payment_method: nil,
+        # 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`.
+        payment_type: nil,
+        # The receiving account ID. Can be an `external_account`.
+        receiving_account_id: nil,
+        # The email of the recipient of the invoice. Leaving this value as null will
+        #   fallback to using the counterparty's name.
+        recipient_email: nil,
+        # The name of the recipient of the invoice. Leaving this value as null will
+        #   fallback to using the counterparty's name.
+        recipient_name: nil,
+        # Number of days after due date when overdue reminder emails will be sent out to
+        #   invoice recipients.
+        remind_after_overdue_days: nil,
+        # Invoice status must be updated in a `PATCH` request that does not modify any
+        #   other invoice attributes. Valid state transitions are `draft` to `unpaid`,
+        #   `draft` or `unpaid` to `voided`, and `draft` or `unpaid` to `paid`.
+        status: nil,
+        # The ID of the virtual account the invoice should be paid to.
+        virtual_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      # list invoices
+      sig do
+        params(
+          after_cursor: T.nilable(String),
+          counterparty_id: String,
+          due_date_end: Date,
+          due_date_start: Date,
+          expected_payment_id: String,
+          metadata: T::Hash[Symbol, String],
+          number: String,
+          originating_account_id: String,
+          payment_order_id: String,
+          per_page: Integer,
+          status: ModernTreasury::Models::InvoiceListParams::Status::OrSymbol,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Page[ModernTreasury::Models::Invoice])
+      end
+      def list(
+        after_cursor: nil,
+        counterparty_id: nil,
+        # An inclusive upper bound for searching due_date
+        due_date_end: nil,
+        # An inclusive lower bound for searching due_date
+        due_date_start: nil,
+        expected_payment_id: nil,
+        # 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.
+        metadata: nil,
+        # A unique record number assigned to each invoice that is issued.
+        number: nil,
+        originating_account_id: nil,
+        payment_order_id: nil,
+        per_page: nil,
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Add a payment order to an invoice.
+      sig do
+        params(
+          payment_order_id: String,
+          id: String,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .void
+      end
+      def add_payment_order(
+        # payment_order_id
+        payment_order_id,
+        # id
+        id:,
+        request_options: {}
+      )
+      end
+
+      sig { params(client: ModernTreasury::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/lib/modern_treasury/resources/ledger_account_balance_monitors.rbi

@@ -0,0 +1,119 @@
+# typed: strong
+
+module ModernTreasury
+  module Resources
+    class LedgerAccountBalanceMonitors
+      # Create a ledger account balance monitor.
+      sig do
+        params(
+          alert_condition: T.any(
+            ModernTreasury::Models::LedgerAccountBalanceMonitorCreateParams::AlertCondition,
+            ModernTreasury::Util::AnyHash
+          ),
+          ledger_account_id: String,
+          description: String,
+          metadata: T::Hash[Symbol, String],
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Models::LedgerAccountBalanceMonitor)
+      end
+      def create(
+        # Describes the condition that must be satisfied for the monitor to be triggered.
+        alert_condition:,
+        # The ledger account associated with this balance monitor.
+        ledger_account_id:,
+        # An optional, free-form description for internal use.
+        description: nil,
+        # Additional data represented as key-value pairs. Both the key and value must be
+        #   strings.
+        metadata: nil,
+        request_options: {}
+      )
+      end
+
+      # Get details on a single ledger account balance monitor.
+      sig do
+        params(
+          id: String,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Models::LedgerAccountBalanceMonitor)
+      end
+      def retrieve(
+        # id
+        id,
+        request_options: {}
+      )
+      end
+
+      # Update a ledger account balance monitor.
+      sig do
+        params(
+          id: String,
+          description: String,
+          metadata: T::Hash[Symbol, String],
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Models::LedgerAccountBalanceMonitor)
+      end
+      def update(
+        # id
+        id,
+        # An optional, free-form description for internal use.
+        description: nil,
+        # Additional data represented as key-value pairs. Both the key and value must be
+        #   strings.
+        metadata: nil,
+        request_options: {}
+      )
+      end
+
+      # Get a list of ledger account balance monitors.
+      sig do
+        params(
+          id: T::Array[String],
+          after_cursor: T.nilable(String),
+          ledger_account_id: String,
+          metadata: T::Hash[Symbol, String],
+          per_page: Integer,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Page[ModernTreasury::Models::LedgerAccountBalanceMonitor])
+      end
+      def list(
+        # If you have specific IDs to retrieve in bulk, you can pass them as query
+        #   parameters delimited with `id[]=`, for example `?id[]=123&id[]=abc`.
+        id: nil,
+        after_cursor: nil,
+        # Query the balance monitors for a single ledger account.
+        ledger_account_id: nil,
+        # 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.
+        metadata: nil,
+        per_page: nil,
+        request_options: {}
+      )
+      end
+
+      # Delete a ledger account balance monitor.
+      sig do
+        params(
+          id: String,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Models::LedgerAccountBalanceMonitor)
+      end
+      def delete(
+        # id
+        id,
+        request_options: {}
+      )
+      end
+
+      sig { params(client: ModernTreasury::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end