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

data/rbi/modern_treasury/models/return_create_params.rbi

@@ -0,0 +1,345 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class ReturnCreateParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::ReturnCreateParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
+      # The ID of the object being returned or `null`.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :returnable_id
+
+      # The type of object being returned. Currently, this may only be
+      # incoming_payment_detail.
+      sig do
+        returns(ModernTreasury::ReturnCreateParams::ReturnableType::OrSymbol)
+      end
+      attr_accessor :returnable_type
+
+      # Some returns may include additional information from the bank. In these cases,
+      # this string will be present.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :additional_information
+
+      # The return code. For ACH returns, this is the required ACH return code.
+      sig do
+        returns(T.nilable(ModernTreasury::ReturnCreateParams::Code::OrSymbol))
+      end
+      attr_accessor :code
+
+      # The raw data from the return file that we get from the bank.
+      sig { returns(T.nilable(T.anything)) }
+      attr_accessor :data
+
+      # If the return code is `R14` or `R15` this is the date the deceased counterparty
+      # passed away.
+      sig { returns(T.nilable(Date)) }
+      attr_accessor :date_of_death
+
+      # An optional description of the reason for the return. This is for internal usage
+      # and will not be transmitted to the bank.”
+      sig { returns(T.nilable(String)) }
+      attr_accessor :reason
+
+      sig do
+        params(
+          returnable_id: T.nilable(String),
+          returnable_type:
+            ModernTreasury::ReturnCreateParams::ReturnableType::OrSymbol,
+          additional_information: T.nilable(String),
+          code: T.nilable(ModernTreasury::ReturnCreateParams::Code::OrSymbol),
+          data: T.nilable(T.anything),
+          date_of_death: T.nilable(Date),
+          reason: T.nilable(String),
+          request_options: ModernTreasury::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the object being returned or `null`.
+        returnable_id:,
+        # The type of object being returned. Currently, this may only be
+        # incoming_payment_detail.
+        returnable_type:,
+        # Some returns may include additional information from the bank. In these cases,
+        # this string will be present.
+        additional_information: nil,
+        # The return code. For ACH returns, this is the required ACH return code.
+        code: nil,
+        # The raw data from the return file that we get from the bank.
+        data: nil,
+        # If the return code is `R14` or `R15` this is the date the deceased counterparty
+        # passed away.
+        date_of_death: nil,
+        # An optional description of the reason for the return. This is for internal usage
+        # and will not be transmitted to the bank.”
+        reason: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            returnable_id: T.nilable(String),
+            returnable_type:
+              ModernTreasury::ReturnCreateParams::ReturnableType::OrSymbol,
+            additional_information: T.nilable(String),
+            code: T.nilable(ModernTreasury::ReturnCreateParams::Code::OrSymbol),
+            data: T.nilable(T.anything),
+            date_of_death: T.nilable(Date),
+            reason: T.nilable(String),
+            request_options: ModernTreasury::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The type of object being returned. Currently, this may only be
+      # incoming_payment_detail.
+      module ReturnableType
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ModernTreasury::ReturnCreateParams::ReturnableType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        INCOMING_PAYMENT_DETAIL =
+          T.let(
+            :incoming_payment_detail,
+            ModernTreasury::ReturnCreateParams::ReturnableType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::ReturnCreateParams::ReturnableType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The return code. For ACH returns, this is the required ACH return code.
+      module Code
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ModernTreasury::ReturnCreateParams::Code)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CODE_901 =
+          T.let(:"901", ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        CODE_902 =
+          T.let(:"902", ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        CODE_903 =
+          T.let(:"903", ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        CODE_904 =
+          T.let(:"904", ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        CODE_905 =
+          T.let(:"905", ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        CODE_907 =
+          T.let(:"907", ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        CODE_908 =
+          T.let(:"908", ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        CODE_909 =
+          T.let(:"909", ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        CODE_910 =
+          T.let(:"910", ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        CODE_911 =
+          T.let(:"911", ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        CODE_912 =
+          T.let(:"912", ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        CODE_914 =
+          T.let(:"914", ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        C01 =
+          T.let(:C01, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        C02 =
+          T.let(:C02, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        C03 =
+          T.let(:C03, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        C05 =
+          T.let(:C05, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        C06 =
+          T.let(:C06, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        C07 =
+          T.let(:C07, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        C08 =
+          T.let(:C08, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        C09 =
+          T.let(:C09, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        C13 =
+          T.let(:C13, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        C14 =
+          T.let(:C14, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R01 =
+          T.let(:R01, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R02 =
+          T.let(:R02, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R03 =
+          T.let(:R03, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R04 =
+          T.let(:R04, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R05 =
+          T.let(:R05, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R06 =
+          T.let(:R06, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R07 =
+          T.let(:R07, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R08 =
+          T.let(:R08, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R09 =
+          T.let(:R09, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R10 =
+          T.let(:R10, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R11 =
+          T.let(:R11, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R12 =
+          T.let(:R12, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R13 =
+          T.let(:R13, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R14 =
+          T.let(:R14, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R15 =
+          T.let(:R15, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R16 =
+          T.let(:R16, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R17 =
+          T.let(:R17, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R18 =
+          T.let(:R18, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R19 =
+          T.let(:R19, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R20 =
+          T.let(:R20, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R21 =
+          T.let(:R21, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R22 =
+          T.let(:R22, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R23 =
+          T.let(:R23, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R24 =
+          T.let(:R24, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R25 =
+          T.let(:R25, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R26 =
+          T.let(:R26, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R27 =
+          T.let(:R27, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R28 =
+          T.let(:R28, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R29 =
+          T.let(:R29, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R30 =
+          T.let(:R30, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R31 =
+          T.let(:R31, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R32 =
+          T.let(:R32, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R33 =
+          T.let(:R33, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R34 =
+          T.let(:R34, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R35 =
+          T.let(:R35, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R36 =
+          T.let(:R36, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R37 =
+          T.let(:R37, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R38 =
+          T.let(:R38, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R39 =
+          T.let(:R39, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R40 =
+          T.let(:R40, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R41 =
+          T.let(:R41, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R42 =
+          T.let(:R42, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R43 =
+          T.let(:R43, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R44 =
+          T.let(:R44, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R45 =
+          T.let(:R45, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R46 =
+          T.let(:R46, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R47 =
+          T.let(:R47, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R50 =
+          T.let(:R50, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R51 =
+          T.let(:R51, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R52 =
+          T.let(:R52, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R53 =
+          T.let(:R53, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R61 =
+          T.let(:R61, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R62 =
+          T.let(:R62, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R67 =
+          T.let(:R67, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R68 =
+          T.let(:R68, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R69 =
+          T.let(:R69, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R70 =
+          T.let(:R70, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R71 =
+          T.let(:R71, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R72 =
+          T.let(:R72, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R73 =
+          T.let(:R73, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R74 =
+          T.let(:R74, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R75 =
+          T.let(:R75, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R76 =
+          T.let(:R76, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R77 =
+          T.let(:R77, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R80 =
+          T.let(:R80, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R81 =
+          T.let(:R81, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R82 =
+          T.let(:R82, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R83 =
+          T.let(:R83, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R84 =
+          T.let(:R84, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        R85 =
+          T.let(:R85, ModernTreasury::ReturnCreateParams::Code::TaggedSymbol)
+        CURRENCYCLOUD =
+          T.let(
+            :currencycloud,
+            ModernTreasury::ReturnCreateParams::Code::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[ModernTreasury::ReturnCreateParams::Code::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/modern_treasury/models/return_list_params.rbi

@@ -0,0 +1,162 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class ReturnListParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::ReturnListParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :after_cursor
+
+      # Specify `counterparty_id` if you wish to see returns that occurred with a
+      # specific counterparty.
+      sig { returns(T.nilable(String)) }
+      attr_reader :counterparty_id
+
+      sig { params(counterparty_id: String).void }
+      attr_writer :counterparty_id
+
+      # Specify `internal_account_id` if you wish to see returns to/from 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
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :per_page
+
+      sig { params(per_page: Integer).void }
+      attr_writer :per_page
+
+      # The ID of a valid returnable. Must be accompanied by `returnable_type`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :returnable_id
+
+      sig { params(returnable_id: String).void }
+      attr_writer :returnable_id
+
+      # One of `payment_order`, `paper_item`, `reversal`, or `incoming_payment_detail`.
+      # Must be accompanied by `returnable_id`.
+      sig do
+        returns(
+          T.nilable(ModernTreasury::ReturnListParams::ReturnableType::OrSymbol)
+        )
+      end
+      attr_reader :returnable_type
+
+      sig do
+        params(
+          returnable_type:
+            ModernTreasury::ReturnListParams::ReturnableType::OrSymbol
+        ).void
+      end
+      attr_writer :returnable_type
+
+      sig do
+        params(
+          after_cursor: T.nilable(String),
+          counterparty_id: String,
+          internal_account_id: String,
+          per_page: Integer,
+          returnable_id: String,
+          returnable_type:
+            ModernTreasury::ReturnListParams::ReturnableType::OrSymbol,
+          request_options: ModernTreasury::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        after_cursor: nil,
+        # Specify `counterparty_id` if you wish to see returns that occurred with a
+        # specific counterparty.
+        counterparty_id: nil,
+        # Specify `internal_account_id` if you wish to see returns to/from a specific
+        # account.
+        internal_account_id: nil,
+        per_page: nil,
+        # The ID of a valid returnable. Must be accompanied by `returnable_type`.
+        returnable_id: nil,
+        # One of `payment_order`, `paper_item`, `reversal`, or `incoming_payment_detail`.
+        # Must be accompanied by `returnable_id`.
+        returnable_type: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            after_cursor: T.nilable(String),
+            counterparty_id: String,
+            internal_account_id: String,
+            per_page: Integer,
+            returnable_id: String,
+            returnable_type:
+              ModernTreasury::ReturnListParams::ReturnableType::OrSymbol,
+            request_options: ModernTreasury::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # One of `payment_order`, `paper_item`, `reversal`, or `incoming_payment_detail`.
+      # Must be accompanied by `returnable_id`.
+      module ReturnableType
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ModernTreasury::ReturnListParams::ReturnableType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        INCOMING_PAYMENT_DETAIL =
+          T.let(
+            :incoming_payment_detail,
+            ModernTreasury::ReturnListParams::ReturnableType::TaggedSymbol
+          )
+        PAPER_ITEM =
+          T.let(
+            :paper_item,
+            ModernTreasury::ReturnListParams::ReturnableType::TaggedSymbol
+          )
+        PAYMENT_ORDER =
+          T.let(
+            :payment_order,
+            ModernTreasury::ReturnListParams::ReturnableType::TaggedSymbol
+          )
+        RETURN =
+          T.let(
+            :return,
+            ModernTreasury::ReturnListParams::ReturnableType::TaggedSymbol
+          )
+        REVERSAL =
+          T.let(
+            :reversal,
+            ModernTreasury::ReturnListParams::ReturnableType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::ReturnListParams::ReturnableType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end