modern_treasury 0.0.0 → 0.1.0.pre.alpha.16

data/rbi/lib/modern_treasury/resources/ledgers.rbi

@@ -0,0 +1,118 @@
+# typed: strong
+
+module ModernTreasury
+  module Resources
+    class Ledgers
+      # Create a ledger.
+      sig do
+        params(
+          name: String,
+          description: T.nilable(String),
+          metadata: T::Hash[Symbol, String],
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Models::Ledger)
+      end
+      def create(
+        # The name of the ledger.
+        name:,
+        # 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.
+      sig do
+        params(
+          id: String,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Models::Ledger)
+      end
+      def retrieve(
+        # id
+        id,
+        request_options: {}
+      )
+      end
+
+      # Update the details of a ledger.
+      sig do
+        params(
+          id: String,
+          description: T.nilable(String),
+          metadata: T::Hash[Symbol, String],
+          name: String,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Models::Ledger)
+      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,
+        # The name of the ledger.
+        name: nil,
+        request_options: {}
+      )
+      end
+
+      # Get a list of ledgers.
+      sig do
+        params(
+          id: T::Array[String],
+          after_cursor: T.nilable(String),
+          metadata: T::Hash[Symbol, String],
+          per_page: Integer,
+          updated_at: T::Hash[Symbol, Time],
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Page[ModernTreasury::Models::Ledger])
+      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,
+        # 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,
+        # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+        #   posted at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
+        #   updated_at%5Bgt%5D=2000-01-01T12:00:00Z.
+        updated_at: nil,
+        request_options: {}
+      )
+      end
+
+      # Delete a ledger.
+      sig do
+        params(
+          id: String,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Models::Ledger)
+      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

data/rbi/lib/modern_treasury/resources/legal_entities.rbi

@@ -0,0 +1,217 @@
+# typed: strong
+
+module ModernTreasury
+  module Resources
+    class LegalEntities
+      # create legal_entity
+      sig do
+        params(
+          legal_entity_type: ModernTreasury::Models::LegalEntityCreateParams::LegalEntityType::OrSymbol,
+          addresses: T::Array[T.any(ModernTreasury::Models::LegalEntityCreateParams::Address, ModernTreasury::Util::AnyHash)],
+          bank_settings: T.nilable(T.any(ModernTreasury::Models::BankSettings, ModernTreasury::Util::AnyHash)),
+          business_name: T.nilable(String),
+          citizenship_country: T.nilable(String),
+          date_formed: T.nilable(Date),
+          date_of_birth: T.nilable(Date),
+          doing_business_as_names: T::Array[String],
+          email: T.nilable(String),
+          first_name: T.nilable(String),
+          identifications: T::Array[T.any(ModernTreasury::Models::LegalEntityCreateParams::Identification, ModernTreasury::Util::AnyHash)],
+          last_name: T.nilable(String),
+          legal_entity_associations: T.nilable(
+            T::Array[
+            T.any(
+              ModernTreasury::Models::LegalEntityCreateParams::LegalEntityAssociation,
+              ModernTreasury::Util::AnyHash
+            )
+            ]
+          ),
+          legal_structure: T.nilable(ModernTreasury::Models::LegalEntityCreateParams::LegalStructure::OrSymbol),
+          metadata: T::Hash[Symbol, String],
+          middle_name: T.nilable(String),
+          phone_numbers: T::Array[T.any(ModernTreasury::Models::LegalEntityCreateParams::PhoneNumber, ModernTreasury::Util::AnyHash)],
+          politically_exposed_person: T.nilable(T::Boolean),
+          preferred_name: T.nilable(String),
+          prefix: T.nilable(String),
+          risk_rating: T.nilable(ModernTreasury::Models::LegalEntityCreateParams::RiskRating::OrSymbol),
+          suffix: T.nilable(String),
+          wealth_and_employment_details: T.nilable(T.any(ModernTreasury::Models::WealthAndEmploymentDetails, ModernTreasury::Util::AnyHash)),
+          website: T.nilable(String),
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Models::LegalEntity)
+      end
+      def create(
+        # The type of legal entity.
+        legal_entity_type:,
+        # A list of addresses for the entity.
+        addresses: nil,
+        bank_settings: nil,
+        # The business's legal business name.
+        business_name: nil,
+        # The country of citizenship for an individual.
+        citizenship_country: nil,
+        # A business's formation date (YYYY-MM-DD).
+        date_formed: nil,
+        # An individual's date of birth (YYYY-MM-DD).
+        date_of_birth: nil,
+        doing_business_as_names: nil,
+        # The entity's primary email.
+        email: nil,
+        # An individual's first name.
+        first_name: nil,
+        # A list of identifications for the legal entity.
+        identifications: nil,
+        # An individual's last name.
+        last_name: nil,
+        # The legal entity associations and its child legal entities.
+        legal_entity_associations: nil,
+        # The business's legal structure.
+        legal_structure: nil,
+        # Additional data represented as key-value pairs. Both the key and value must be
+        #   strings.
+        metadata: nil,
+        # An individual's middle name.
+        middle_name: nil,
+        phone_numbers: nil,
+        # Whether the individual is a politically exposed person.
+        politically_exposed_person: nil,
+        # An individual's preferred name.
+        preferred_name: nil,
+        # An individual's prefix.
+        prefix: nil,
+        # The risk rating of the legal entity. One of low, medium, high.
+        risk_rating: nil,
+        # An individual's suffix.
+        suffix: nil,
+        wealth_and_employment_details: nil,
+        # The entity's primary website URL.
+        website: nil,
+        request_options: {}
+      )
+      end
+
+      # Get details on a single legal entity.
+      sig do
+        params(
+          id: String,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Models::LegalEntity)
+      end
+      def retrieve(
+        # id
+        id,
+        request_options: {}
+      )
+      end
+
+      # Update a legal entity.
+      sig do
+        params(
+          id: String,
+          addresses: T::Array[T.any(ModernTreasury::Models::LegalEntityUpdateParams::Address, ModernTreasury::Util::AnyHash)],
+          bank_settings: T.nilable(T.any(ModernTreasury::Models::BankSettings, ModernTreasury::Util::AnyHash)),
+          business_name: T.nilable(String),
+          citizenship_country: T.nilable(String),
+          date_formed: T.nilable(Date),
+          date_of_birth: T.nilable(Date),
+          doing_business_as_names: T::Array[String],
+          email: T.nilable(String),
+          first_name: T.nilable(String),
+          identifications: T::Array[T.any(ModernTreasury::Models::LegalEntityUpdateParams::Identification, ModernTreasury::Util::AnyHash)],
+          last_name: T.nilable(String),
+          legal_structure: T.nilable(ModernTreasury::Models::LegalEntityUpdateParams::LegalStructure::OrSymbol),
+          metadata: T::Hash[Symbol, String],
+          middle_name: T.nilable(String),
+          phone_numbers: T::Array[T.any(ModernTreasury::Models::LegalEntityUpdateParams::PhoneNumber, ModernTreasury::Util::AnyHash)],
+          politically_exposed_person: T.nilable(T::Boolean),
+          preferred_name: T.nilable(String),
+          prefix: T.nilable(String),
+          risk_rating: T.nilable(ModernTreasury::Models::LegalEntityUpdateParams::RiskRating::OrSymbol),
+          suffix: T.nilable(String),
+          wealth_and_employment_details: T.nilable(T.any(ModernTreasury::Models::WealthAndEmploymentDetails, ModernTreasury::Util::AnyHash)),
+          website: T.nilable(String),
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Models::LegalEntity)
+      end
+      def update(
+        # id
+        id,
+        # A list of addresses for the entity.
+        addresses: nil,
+        bank_settings: nil,
+        # The business's legal business name.
+        business_name: nil,
+        # The country of citizenship for an individual.
+        citizenship_country: nil,
+        # A business's formation date (YYYY-MM-DD).
+        date_formed: nil,
+        # An individual's date of birth (YYYY-MM-DD).
+        date_of_birth: nil,
+        doing_business_as_names: nil,
+        # The entity's primary email.
+        email: nil,
+        # An individual's first name.
+        first_name: nil,
+        # A list of identifications for the legal entity.
+        identifications: nil,
+        # An individual's last name.
+        last_name: nil,
+        # The business's legal structure.
+        legal_structure: nil,
+        # Additional data represented as key-value pairs. Both the key and value must be
+        #   strings.
+        metadata: nil,
+        # An individual's middle name.
+        middle_name: nil,
+        phone_numbers: nil,
+        # Whether the individual is a politically exposed person.
+        politically_exposed_person: nil,
+        # An individual's preferred name.
+        preferred_name: nil,
+        # An individual's prefix.
+        prefix: nil,
+        # The risk rating of the legal entity. One of low, medium, high.
+        risk_rating: nil,
+        # An individual's suffix.
+        suffix: nil,
+        wealth_and_employment_details: nil,
+        # The entity's primary website URL.
+        website: nil,
+        request_options: {}
+      )
+      end
+
+      # Get a list of all legal entities.
+      sig do
+        params(
+          after_cursor: T.nilable(String),
+          legal_entity_type: ModernTreasury::Models::LegalEntityListParams::LegalEntityType::OrSymbol,
+          metadata: T::Hash[Symbol, String],
+          per_page: Integer,
+          show_deleted: String,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Page[ModernTreasury::Models::LegalEntity])
+      end
+      def list(
+        after_cursor: nil,
+        legal_entity_type: 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,
+        show_deleted: nil,
+        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/legal_entity_associations.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module ModernTreasury
+  module Resources
+    class LegalEntityAssociations
+      # create legal_entity_association
+      sig do
+        params(
+          parent_legal_entity_id: String,
+          relationship_types: T::Array[ModernTreasury::Models::LegalEntityAssociationCreateParams::RelationshipType::OrSymbol],
+          child_legal_entity: T.any(
+            ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity,
+            ModernTreasury::Util::AnyHash
+          ),
+          child_legal_entity_id: String,
+          ownership_percentage: T.nilable(Integer),
+          title: T.nilable(String),
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Models::LegalEntityAssociation)
+      end
+      def create(
+        # The ID of the parent legal entity. This must be a business or joint legal
+        #   entity.
+        parent_legal_entity_id:,
+        relationship_types:,
+        # The child legal entity.
+        child_legal_entity: nil,
+        # The ID of the child legal entity.
+        child_legal_entity_id: nil,
+        # The child entity's ownership percentage iff they are a beneficial owner.
+        ownership_percentage: nil,
+        # The job title of the child entity at the parent entity.
+        title: nil,
+        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/line_items.rbi

@@ -0,0 +1,81 @@
+# typed: strong
+
+module ModernTreasury
+  module Resources
+    class LineItems
+      # Get a single line item
+      sig do
+        params(
+          id: String,
+          itemizable_type: ModernTreasury::Models::LineItemRetrieveParams::ItemizableType::OrSymbol,
+          itemizable_id: String,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Models::LineItem)
+      end
+      def retrieve(
+        # The ID of the line item.
+        id,
+        # One of `payment_orders` or `expected_payments`.
+        itemizable_type:,
+        # The ID of the payment order or expected payment.
+        itemizable_id:,
+        request_options: {}
+      )
+      end
+
+      # update line item
+      sig do
+        params(
+          id: String,
+          itemizable_type: ModernTreasury::Models::LineItemUpdateParams::ItemizableType::OrSymbol,
+          itemizable_id: String,
+          metadata: T::Hash[Symbol, String],
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Models::LineItem)
+      end
+      def update(
+        # Path param: The ID of the line item.
+        id,
+        # Path param: One of `payment_orders` or `expected_payments`.
+        itemizable_type:,
+        # Path param: The ID of the payment order or expected payment.
+        itemizable_id:,
+        # Body param: Additional data represented as key-value pairs. Both the key and
+        #   value must be strings.
+        metadata: nil,
+        request_options: {}
+      )
+      end
+
+      # Get a list of line items
+      sig do
+        params(
+          itemizable_id: String,
+          itemizable_type: ModernTreasury::Models::LineItemListParams::ItemizableType::OrSymbol,
+          after_cursor: T.nilable(String),
+          per_page: Integer,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Page[ModernTreasury::Models::LineItem])
+      end
+      def list(
+        # Path param: The ID of the payment order or expected payment.
+        itemizable_id,
+        # Path param: One of `payment_orders` or `expected_payments`.
+        itemizable_type:,
+        # Query param:
+        after_cursor: nil,
+        # Query param:
+        per_page: nil,
+        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/paper_items.rbi

@@ -0,0 +1,52 @@
+# typed: strong
+
+module ModernTreasury
+  module Resources
+    class PaperItems
+      # Get details on a single paper item.
+      sig do
+        params(
+          id: String,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Models::PaperItem)
+      end
+      def retrieve(
+        # id
+        id,
+        request_options: {}
+      )
+      end
+
+      # Get a list of all paper items.
+      sig do
+        params(
+          after_cursor: T.nilable(String),
+          deposit_date_end: Date,
+          deposit_date_start: Date,
+          lockbox_number: String,
+          per_page: Integer,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Page[ModernTreasury::Models::PaperItem])
+      end
+      def list(
+        after_cursor: nil,
+        # Specify an inclusive end date (YYYY-MM-DD) when filtering by deposit_date
+        deposit_date_end: nil,
+        # Specify an inclusive start date (YYYY-MM-DD) when filtering by deposit_date
+        deposit_date_start: nil,
+        # Specify `lockbox_number` if you wish to see paper items that are associated with
+        #   a specific lockbox number.
+        lockbox_number: nil,
+        per_page: nil,
+        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/payment_flows.rbi

@@ -0,0 +1,108 @@
+# typed: strong
+
+module ModernTreasury
+  module Resources
+    class PaymentFlows
+      # create payment_flow
+      sig do
+        params(
+          amount: Integer,
+          counterparty_id: String,
+          currency: String,
+          direction: ModernTreasury::Models::PaymentFlowCreateParams::Direction::OrSymbol,
+          originating_account_id: String,
+          due_date: Date,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Models::PaymentFlow)
+      end
+      def create(
+        # Required. Value in specified currency's smallest unit. e.g. $10 would be
+        #   represented as 1000. Can be any integer up to 36 digits.
+        amount:,
+        # Required. The ID of a counterparty associated with the payment. As part of the
+        #   payment workflow an external account will be associated with this model.
+        counterparty_id:,
+        # Required. The currency of the payment.
+        currency:,
+        # Required. Describes the direction money is flowing in the transaction. Can only
+        #   be `debit`. A `debit` pulls money from someone else's account to your own.
+        direction:,
+        # Required. The ID of one of your organization's internal accounts.
+        originating_account_id:,
+        # Optional. Can only be passed in when `effective_date_selection_enabled` is
+        #   `true`. When set, the due date is shown to your end-user in the pre-built UI as
+        #   they are selecting a payment `effective_date`.
+        due_date: nil,
+        request_options: {}
+      )
+      end
+
+      # get payment_flow
+      sig do
+        params(
+          id: String,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Models::PaymentFlow)
+      end
+      def retrieve(
+        # id
+        id,
+        request_options: {}
+      )
+      end
+
+      # update payment_flow
+      sig do
+        params(
+          id: String,
+          status: ModernTreasury::Models::PaymentFlowUpdateParams::Status::OrSymbol,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Models::PaymentFlow)
+      end
+      def update(
+        # id
+        id,
+        # Required. The updated status of the payment flow. Can only be used to mark a
+        #   flow as `cancelled`.
+        status:,
+        request_options: {}
+      )
+      end
+
+      # list payment_flows
+      sig do
+        params(
+          after_cursor: T.nilable(String),
+          client_token: String,
+          counterparty_id: String,
+          originating_account_id: String,
+          payment_order_id: String,
+          per_page: Integer,
+          receiving_account_id: String,
+          status: String,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+        )
+          .returns(ModernTreasury::Page[ModernTreasury::Models::PaymentFlow])
+      end
+      def list(
+        after_cursor: nil,
+        client_token: nil,
+        counterparty_id: nil,
+        originating_account_id: nil,
+        payment_order_id: nil,
+        per_page: nil,
+        receiving_account_id: nil,
+        status: nil,
+        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/payment_orders/reversals.rbi

@@ -0,0 +1,82 @@
+# typed: strong
+
+module ModernTreasury
+  module Resources
+    class PaymentOrders
+      class Reversals
+        # Create a reversal for a payment order.
+        sig do
+          params(
+            payment_order_id: String,
+            reason: ModernTreasury::Models::PaymentOrders::ReversalCreateParams::Reason::OrSymbol,
+            ledger_transaction: T.any(
+              ModernTreasury::Models::PaymentOrders::ReversalCreateParams::LedgerTransaction,
+              ModernTreasury::Util::AnyHash
+            ),
+            metadata: T::Hash[Symbol, String],
+            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+          )
+            .returns(ModernTreasury::Models::PaymentOrders::Reversal)
+        end
+        def create(
+          # The id of the payment order being reversed.
+          payment_order_id,
+          # The reason for the reversal. Must be one of `duplicate`, `incorrect_amount`,
+          #   `incorrect_receiving_account`, `date_earlier_than_intended`,
+          #   `date_later_than_intended`.
+          reason:,
+          # Specifies a ledger transaction object that will be created with the reversal. If
+          #   the ledger transaction cannot be created, then the reversal creation will fail.
+          #   The resulting ledger transaction will mirror the status of the reversal.
+          ledger_transaction: 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 reversal of a payment order.
+        sig do
+          params(
+            reversal_id: String,
+            payment_order_id: String,
+            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+          )
+            .returns(ModernTreasury::Models::PaymentOrders::Reversal)
+        end
+        def retrieve(
+          # The ID of the reversal.
+          reversal_id,
+          # The id of the payment order being reversed.
+          payment_order_id:,
+          request_options: {}
+        )
+        end
+
+        # Get a list of all reversals of a payment order.
+        sig do
+          params(
+            payment_order_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::PaymentOrders::Reversal])
+        end
+        def list(
+          # The ID of the relevant Payment Order.
+          payment_order_id,
+          after_cursor: nil,
+          per_page: nil,
+          request_options: {}
+        )
+        end
+
+        sig { params(client: ModernTreasury::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end