modern_treasury 0.0.0 → 0.1.0.pre.alpha.16

data/rbi/lib/modern_treasury/models/expected_payment_list_params.rbi

@@ -0,0 +1,197 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class ExpectedPaymentListParams < ModernTreasury::BaseModel
+      extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :after_cursor
+
+      # Specify counterparty_id to see expected_payments for a specific account.
+      sig { returns(T.nilable(String)) }
+      attr_reader :counterparty_id
+
+      sig { params(counterparty_id: String).void }
+      attr_writer :counterparty_id
+
+      # Used to return expected payments created after some datetime
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at_lower_bound
+
+      sig { params(created_at_lower_bound: Time).void }
+      attr_writer :created_at_lower_bound
+
+      # Used to return expected payments created before some datetime
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at_upper_bound
+
+      sig { params(created_at_upper_bound: Time).void }
+      attr_writer :created_at_upper_bound
+
+      # One of credit, debit
+      sig { returns(T.nilable(ModernTreasury::Models::TransactionDirection::OrSymbol)) }
+      attr_reader :direction
+
+      sig { params(direction: ModernTreasury::Models::TransactionDirection::OrSymbol).void }
+      attr_writer :direction
+
+      # Specify internal_account_id to see expected_payments for a specific account.
+      sig { returns(T.nilable(String)) }
+      attr_reader :internal_account_id
+
+      sig { params(internal_account_id: String).void }
+      attr_writer :internal_account_id
+
+      # 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.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :per_page
+
+      sig { params(per_page: Integer).void }
+      attr_writer :per_page
+
+      # One of unreconciled, reconciled, or archived.
+      sig { returns(T.nilable(ModernTreasury::Models::ExpectedPaymentListParams::Status::OrSymbol)) }
+      attr_reader :status
+
+      sig { params(status: ModernTreasury::Models::ExpectedPaymentListParams::Status::OrSymbol).void }
+      attr_writer :status
+
+      # One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp,sen,
+      #   sepa, signet, wire
+      sig { returns(T.nilable(ModernTreasury::Models::ExpectedPaymentListParams::Type::OrSymbol)) }
+      attr_reader :type
+
+      sig { params(type: ModernTreasury::Models::ExpectedPaymentListParams::Type::OrSymbol).void }
+      attr_writer :type
+
+      sig do
+        params(
+          after_cursor: T.nilable(String),
+          counterparty_id: String,
+          created_at_lower_bound: Time,
+          created_at_upper_bound: Time,
+          direction: ModernTreasury::Models::TransactionDirection::OrSymbol,
+          internal_account_id: String,
+          metadata: T::Hash[Symbol, String],
+          per_page: Integer,
+          status: ModernTreasury::Models::ExpectedPaymentListParams::Status::OrSymbol,
+          type: ModernTreasury::Models::ExpectedPaymentListParams::Type::OrSymbol,
+          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        after_cursor: nil,
+        counterparty_id: nil,
+        created_at_lower_bound: nil,
+        created_at_upper_bound: nil,
+        direction: nil,
+        internal_account_id: nil,
+        metadata: nil,
+        per_page: nil,
+        status: nil,
+        type: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              after_cursor: T.nilable(String),
+              counterparty_id: String,
+              created_at_lower_bound: Time,
+              created_at_upper_bound: Time,
+              direction: ModernTreasury::Models::TransactionDirection::OrSymbol,
+              internal_account_id: String,
+              metadata: T::Hash[Symbol, String],
+              per_page: Integer,
+              status: ModernTreasury::Models::ExpectedPaymentListParams::Status::OrSymbol,
+              type: ModernTreasury::Models::ExpectedPaymentListParams::Type::OrSymbol,
+              request_options: ModernTreasury::RequestOptions
+            }
+          )
+      end
+      def to_hash
+      end
+
+      # One of unreconciled, reconciled, or archived.
+      module Status
+        extend ModernTreasury::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, ModernTreasury::Models::ExpectedPaymentListParams::Status) }
+        OrSymbol =
+          T.type_alias { T.any(Symbol, ModernTreasury::Models::ExpectedPaymentListParams::Status::TaggedSymbol) }
+
+        ARCHIVED = T.let(:archived, ModernTreasury::Models::ExpectedPaymentListParams::Status::TaggedSymbol)
+        PARTIALLY_RECONCILED =
+          T.let(:partially_reconciled, ModernTreasury::Models::ExpectedPaymentListParams::Status::TaggedSymbol)
+        RECONCILED = T.let(:reconciled, ModernTreasury::Models::ExpectedPaymentListParams::Status::TaggedSymbol)
+        UNRECONCILED =
+          T.let(:unreconciled, ModernTreasury::Models::ExpectedPaymentListParams::Status::TaggedSymbol)
+
+        sig { override.returns(T::Array[ModernTreasury::Models::ExpectedPaymentListParams::Status::TaggedSymbol]) }
+        def self.values
+        end
+      end
+
+      # One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp,sen,
+      #   sepa, signet, wire
+      module Type
+        extend ModernTreasury::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, ModernTreasury::Models::ExpectedPaymentListParams::Type) }
+        OrSymbol =
+          T.type_alias { T.any(Symbol, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol) }
+
+        ACH = T.let(:ach, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        AU_BECS = T.let(:au_becs, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        BACS = T.let(:bacs, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        BOOK = T.let(:book, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        CARD = T.let(:card, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        CHATS = T.let(:chats, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        CHECK = T.let(:check, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        CROSS_BORDER =
+          T.let(:cross_border, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        DK_NETS = T.let(:dk_nets, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        EFT = T.let(:eft, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        HU_ICS = T.let(:hu_ics, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        INTERAC = T.let(:interac, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        MASAV = T.let(:masav, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        MX_CCEN = T.let(:mx_ccen, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        NEFT = T.let(:neft, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        NICS = T.let(:nics, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        NZ_BECS = T.let(:nz_becs, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        PL_ELIXIR = T.let(:pl_elixir, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        PROVXCHANGE = T.let(:provxchange, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        RO_SENT = T.let(:ro_sent, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        RTP = T.let(:rtp, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        SE_BANKGIROT =
+          T.let(:se_bankgirot, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        SEN = T.let(:sen, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        SEPA = T.let(:sepa, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        SG_GIRO = T.let(:sg_giro, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        SIC = T.let(:sic, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        SIGNET = T.let(:signet, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        SKNBI = T.let(:sknbi, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        WIRE = T.let(:wire, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+        ZENGIN = T.let(:zengin, ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol)
+
+        sig { override.returns(T::Array[ModernTreasury::Models::ExpectedPaymentListParams::Type::TaggedSymbol]) }
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/lib/modern_treasury/models/expected_payment_retrieve_params.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class ExpectedPaymentRetrieveParams < ModernTreasury::BaseModel
+      extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      sig do
+        params(request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+          .returns(T.attached_class)
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({request_options: ModernTreasury::RequestOptions}) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lib/modern_treasury/models/expected_payment_type.rbi

@@ -0,0 +1,49 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    # One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
+    #   sepa, signet, wire.
+    module ExpectedPaymentType
+      extend ModernTreasury::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, ModernTreasury::Models::ExpectedPaymentType) }
+      OrSymbol = T.type_alias { T.any(Symbol, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol) }
+
+      ACH = T.let(:ach, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      AU_BECS = T.let(:au_becs, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      BACS = T.let(:bacs, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      BOOK = T.let(:book, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      CARD = T.let(:card, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      CHATS = T.let(:chats, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      CHECK = T.let(:check, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      CROSS_BORDER = T.let(:cross_border, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      DK_NETS = T.let(:dk_nets, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      EFT = T.let(:eft, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      HU_ICS = T.let(:hu_ics, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      INTERAC = T.let(:interac, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      MASAV = T.let(:masav, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      MX_CCEN = T.let(:mx_ccen, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      NEFT = T.let(:neft, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      NICS = T.let(:nics, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      NZ_BECS = T.let(:nz_becs, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      PL_ELIXIR = T.let(:pl_elixir, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      PROVXCHANGE = T.let(:provxchange, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      RO_SENT = T.let(:ro_sent, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      RTP = T.let(:rtp, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      SE_BANKGIROT = T.let(:se_bankgirot, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      SEN = T.let(:sen, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      SEPA = T.let(:sepa, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      SG_GIRO = T.let(:sg_giro, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      SIC = T.let(:sic, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      SIGNET = T.let(:signet, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      SKNBI = T.let(:sknbi, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      WIRE = T.let(:wire, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+      ZENGIN = T.let(:zengin, ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol)
+
+      sig { override.returns(T::Array[ModernTreasury::Models::ExpectedPaymentType::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/lib/modern_treasury/models/expected_payment_update_params.rbi

@@ -0,0 +1,201 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class ExpectedPaymentUpdateParams < ModernTreasury::BaseModel
+      extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # The lowest amount this expected payment may be equal to. Value in specified
+      #   currency's smallest unit. e.g. $10 would be represented as 1000.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :amount_lower_bound
+
+      # The highest amount this expected payment may be equal to. Value in specified
+      #   currency's smallest unit. e.g. $10 would be represented as 1000.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :amount_upper_bound
+
+      # The ID of the counterparty you expect for this payment.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :counterparty_id
+
+      # Must conform to ISO 4217. Defaults to the currency of the internal account.
+      sig { returns(T.nilable(ModernTreasury::Models::Currency::OrSymbol)) }
+      attr_accessor :currency
+
+      # The earliest date the payment may come in. Format: yyyy-mm-dd
+      sig { returns(T.nilable(Date)) }
+      attr_accessor :date_lower_bound
+
+      # The latest date the payment may come in. Format: yyyy-mm-dd
+      sig { returns(T.nilable(Date)) }
+      attr_accessor :date_upper_bound
+
+      # An optional description for internal use.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # One of credit or debit. When you are receiving money, use credit. When you are
+      #   being charged, use debit.
+      sig { returns(T.nilable(ModernTreasury::Models::ExpectedPaymentUpdateParams::Direction::OrSymbol)) }
+      attr_accessor :direction
+
+      # The ID of the Internal Account for the expected payment.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :internal_account_id
+
+      # Additional data represented as key-value pairs. Both the key and value must be
+      #   strings.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
+      # The reconciliation filters you have for this payment.
+      sig { returns(T.nilable(T.anything)) }
+      attr_accessor :reconciliation_filters
+
+      # The reconciliation groups you have for this payment.
+      sig { returns(T.nilable(T.anything)) }
+      attr_accessor :reconciliation_groups
+
+      # An array of reconciliation rule variables for this payment.
+      sig { returns(T.nilable(T::Array[ModernTreasury::Models::ReconciliationRule])) }
+      attr_accessor :reconciliation_rule_variables
+
+      # For `ach`, this field will be passed through on an addenda record. For `wire`
+      #   payments the field will be passed through as the "Originator to Beneficiary
+      #   Information", also known as OBI or Fedwire tag 6000.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :remittance_information
+
+      # The statement description you expect to see on the transaction. For ACH
+      #   payments, this will be the full line item passed from the bank. For wire
+      #   payments, this will be the OBI field on the wire. For check payments, this will
+      #   be the memo field.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :statement_descriptor
+
+      # The Expected Payment's status can be updated from partially_reconciled to
+      #   reconciled.
+      sig { returns(T.nilable(ModernTreasury::Models::ExpectedPaymentUpdateParams::Status::OrSymbol)) }
+      attr_accessor :status
+
+      # One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
+      #   sepa, signet, wire.
+      sig { returns(T.nilable(ModernTreasury::Models::ExpectedPaymentType::OrSymbol)) }
+      attr_accessor :type
+
+      sig do
+        params(
+          amount_lower_bound: T.nilable(Integer),
+          amount_upper_bound: T.nilable(Integer),
+          counterparty_id: T.nilable(String),
+          currency: T.nilable(ModernTreasury::Models::Currency::OrSymbol),
+          date_lower_bound: T.nilable(Date),
+          date_upper_bound: T.nilable(Date),
+          description: T.nilable(String),
+          direction: T.nilable(ModernTreasury::Models::ExpectedPaymentUpdateParams::Direction::OrSymbol),
+          internal_account_id: T.nilable(String),
+          metadata: T::Hash[Symbol, String],
+          reconciliation_filters: T.nilable(T.anything),
+          reconciliation_groups: T.nilable(T.anything),
+          reconciliation_rule_variables: T.nilable(T::Array[T.any(ModernTreasury::Models::ReconciliationRule, ModernTreasury::Util::AnyHash)]),
+          remittance_information: T.nilable(String),
+          statement_descriptor: T.nilable(String),
+          status: T.nilable(ModernTreasury::Models::ExpectedPaymentUpdateParams::Status::OrSymbol),
+          type: T.nilable(ModernTreasury::Models::ExpectedPaymentType::OrSymbol),
+          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        amount_lower_bound: nil,
+        amount_upper_bound: nil,
+        counterparty_id: nil,
+        currency: nil,
+        date_lower_bound: nil,
+        date_upper_bound: nil,
+        description: nil,
+        direction: nil,
+        internal_account_id: nil,
+        metadata: nil,
+        reconciliation_filters: nil,
+        reconciliation_groups: nil,
+        reconciliation_rule_variables: nil,
+        remittance_information: nil,
+        statement_descriptor: nil,
+        status: nil,
+        type: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              amount_lower_bound: T.nilable(Integer),
+              amount_upper_bound: T.nilable(Integer),
+              counterparty_id: T.nilable(String),
+              currency: T.nilable(ModernTreasury::Models::Currency::OrSymbol),
+              date_lower_bound: T.nilable(Date),
+              date_upper_bound: T.nilable(Date),
+              description: T.nilable(String),
+              direction: T.nilable(ModernTreasury::Models::ExpectedPaymentUpdateParams::Direction::OrSymbol),
+              internal_account_id: T.nilable(String),
+              metadata: T::Hash[Symbol, String],
+              reconciliation_filters: T.nilable(T.anything),
+              reconciliation_groups: T.nilable(T.anything),
+              reconciliation_rule_variables: T.nilable(T::Array[ModernTreasury::Models::ReconciliationRule]),
+              remittance_information: T.nilable(String),
+              statement_descriptor: T.nilable(String),
+              status: T.nilable(ModernTreasury::Models::ExpectedPaymentUpdateParams::Status::OrSymbol),
+              type: T.nilable(ModernTreasury::Models::ExpectedPaymentType::OrSymbol),
+              request_options: ModernTreasury::RequestOptions
+            }
+          )
+      end
+      def to_hash
+      end
+
+      # One of credit or debit. When you are receiving money, use credit. When you are
+      #   being charged, use debit.
+      module Direction
+        extend ModernTreasury::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, ModernTreasury::Models::ExpectedPaymentUpdateParams::Direction) }
+        OrSymbol =
+          T.type_alias { T.any(Symbol, ModernTreasury::Models::ExpectedPaymentUpdateParams::Direction::TaggedSymbol) }
+
+        CREDIT = T.let(:credit, ModernTreasury::Models::ExpectedPaymentUpdateParams::Direction::TaggedSymbol)
+        DEBIT = T.let(:debit, ModernTreasury::Models::ExpectedPaymentUpdateParams::Direction::TaggedSymbol)
+
+        sig { override.returns(T::Array[ModernTreasury::Models::ExpectedPaymentUpdateParams::Direction::TaggedSymbol]) }
+        def self.values
+        end
+      end
+
+      # The Expected Payment's status can be updated from partially_reconciled to
+      #   reconciled.
+      module Status
+        extend ModernTreasury::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, ModernTreasury::Models::ExpectedPaymentUpdateParams::Status) }
+        OrSymbol =
+          T.type_alias { T.any(Symbol, ModernTreasury::Models::ExpectedPaymentUpdateParams::Status::TaggedSymbol) }
+
+        RECONCILED =
+          T.let(:reconciled, ModernTreasury::Models::ExpectedPaymentUpdateParams::Status::TaggedSymbol)
+
+        sig { override.returns(T::Array[ModernTreasury::Models::ExpectedPaymentUpdateParams::Status::TaggedSymbol]) }
+        def self.values
+        end
+      end
+    end
+  end
+end