method-ruby 0.1.0 → 0.2.1

data/rbi/method_ruby/models/account_list_params.rbi

@@ -0,0 +1,585 @@
+# typed: strong
+
+module MethodRuby
+  module Models
+    class AccountListParams < MethodRuby::Internal::Type::BaseModel
+      extend MethodRuby::Internal::Type::RequestParameters::Converter
+      include MethodRuby::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(MethodRuby::AccountListParams, MethodRuby::Internal::AnyHash)
+        end
+
+      sig { returns(MethodRuby::AccountListParams::MethodVersion::OrSymbol) }
+      attr_accessor :method_version
+
+      # Filter accounts by consent status.
+      sig do
+        returns(
+          T.nilable(MethodRuby::AccountListParams::ConsentStatus::OrSymbol)
+        )
+      end
+      attr_reader :consent_status
+
+      sig do
+        params(
+          consent_status: MethodRuby::AccountListParams::ConsentStatus::OrSymbol
+        ).void
+      end
+      attr_writer :consent_status
+
+      # Expand related account resources inline. Supports the account expandable fields
+      # documented by the API validator for account list and retrieve operations.
+      sig do
+        returns(
+          T.nilable(T::Array[MethodRuby::AccountListParams::Expand::OrSymbol])
+        )
+      end
+      attr_reader :expand
+
+      sig do
+        params(
+          expand: T::Array[MethodRuby::AccountListParams::Expand::OrSymbol]
+        ).void
+      end
+      attr_writer :expand
+
+      # Filter results from this date (inclusive, YYYY-MM-DD format).
+      sig { returns(T.nilable(Date)) }
+      attr_reader :from_date
+
+      sig { params(from_date: Date).void }
+      attr_writer :from_date
+
+      # Filter accounts by the entity ID that owns them.
+      sig { returns(T.nilable(String)) }
+      attr_reader :holder_id
+
+      sig { params(holder_id: String).void }
+      attr_writer :holder_id
+
+      # Filter accounts by one or more entity IDs.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :holder_ids
+
+      sig { params(holder_ids: T::Array[String]).void }
+      attr_writer :holder_ids
+
+      # Include accounts that are still pending consent.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :include_pending_consent
+
+      sig { params(include_pending_consent: T::Boolean).void }
+      attr_writer :include_pending_consent
+
+      sig { returns(T.nilable(MethodRuby::AccountListParams::Liability)) }
+      attr_reader :liability
+
+      sig do
+        params(liability: MethodRuby::AccountListParams::Liability::OrHash).void
+      end
+      attr_writer :liability
+
+      # Page number for pagination (1-indexed).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page
+
+      sig { params(page: Integer).void }
+      attr_writer :page
+
+      # Cursor for cursor-based pagination. Use the value from
+      # `Pagination-Page-Cursor-Next` or `Pagination-Page-Cursor-Prev` response headers.
+      sig { returns(T.nilable(String)) }
+      attr_reader :page_cursor
+
+      sig { params(page_cursor: String).void }
+      attr_writer :page_cursor
+
+      # Number of items per page.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_limit
+
+      sig { params(page_limit: Integer).void }
+      attr_writer :page_limit
+
+      # Filter accounts by status.
+      sig do
+        returns(T.nilable(MethodRuby::AccountListParams::Status::OrSymbol))
+      end
+      attr_reader :status
+
+      sig do
+        params(status: MethodRuby::AccountListParams::Status::OrSymbol).void
+      end
+      attr_writer :status
+
+      # Filter results to this date (inclusive, YYYY-MM-DD format).
+      sig { returns(T.nilable(Date)) }
+      attr_reader :to_date
+
+      sig { params(to_date: Date).void }
+      attr_writer :to_date
+
+      # Filter accounts by type.
+      sig { returns(T.nilable(MethodRuby::AccountListParams::Type::OrSymbol)) }
+      attr_reader :type
+
+      sig { params(type: MethodRuby::AccountListParams::Type::OrSymbol).void }
+      attr_writer :type
+
+      sig do
+        params(
+          method_version:
+            MethodRuby::AccountListParams::MethodVersion::OrSymbol,
+          consent_status:
+            MethodRuby::AccountListParams::ConsentStatus::OrSymbol,
+          expand: T::Array[MethodRuby::AccountListParams::Expand::OrSymbol],
+          from_date: Date,
+          holder_id: String,
+          holder_ids: T::Array[String],
+          include_pending_consent: T::Boolean,
+          liability: MethodRuby::AccountListParams::Liability::OrHash,
+          page: Integer,
+          page_cursor: String,
+          page_limit: Integer,
+          status: MethodRuby::AccountListParams::Status::OrSymbol,
+          to_date: Date,
+          type: MethodRuby::AccountListParams::Type::OrSymbol,
+          request_options: MethodRuby::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        method_version:,
+        # Filter accounts by consent status.
+        consent_status: nil,
+        # Expand related account resources inline. Supports the account expandable fields
+        # documented by the API validator for account list and retrieve operations.
+        expand: nil,
+        # Filter results from this date (inclusive, YYYY-MM-DD format).
+        from_date: nil,
+        # Filter accounts by the entity ID that owns them.
+        holder_id: nil,
+        # Filter accounts by one or more entity IDs.
+        holder_ids: nil,
+        # Include accounts that are still pending consent.
+        include_pending_consent: nil,
+        liability: nil,
+        # Page number for pagination (1-indexed).
+        page: nil,
+        # Cursor for cursor-based pagination. Use the value from
+        # `Pagination-Page-Cursor-Next` or `Pagination-Page-Cursor-Prev` response headers.
+        page_cursor: nil,
+        # Number of items per page.
+        page_limit: nil,
+        # Filter accounts by status.
+        status: nil,
+        # Filter results to this date (inclusive, YYYY-MM-DD format).
+        to_date: nil,
+        # Filter accounts by type.
+        type: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            method_version:
+              MethodRuby::AccountListParams::MethodVersion::OrSymbol,
+            consent_status:
+              MethodRuby::AccountListParams::ConsentStatus::OrSymbol,
+            expand: T::Array[MethodRuby::AccountListParams::Expand::OrSymbol],
+            from_date: Date,
+            holder_id: String,
+            holder_ids: T::Array[String],
+            include_pending_consent: T::Boolean,
+            liability: MethodRuby::AccountListParams::Liability,
+            page: Integer,
+            page_cursor: String,
+            page_limit: Integer,
+            status: MethodRuby::AccountListParams::Status::OrSymbol,
+            to_date: Date,
+            type: MethodRuby::AccountListParams::Type::OrSymbol,
+            request_options: MethodRuby::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module MethodVersion
+        extend MethodRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, MethodRuby::AccountListParams::MethodVersion)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        METHOD_VERSION_2025_12_01 =
+          T.let(
+            :"2025-12-01",
+            MethodRuby::AccountListParams::MethodVersion::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[MethodRuby::AccountListParams::MethodVersion::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Filter accounts by consent status.
+      module ConsentStatus
+        extend MethodRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, MethodRuby::AccountListParams::ConsentStatus)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING =
+          T.let(
+            :pending,
+            MethodRuby::AccountListParams::ConsentStatus::TaggedSymbol
+          )
+        WITHDRAWN =
+          T.let(
+            :withdrawn,
+            MethodRuby::AccountListParams::ConsentStatus::TaggedSymbol
+          )
+        APPROVED =
+          T.let(
+            :approved,
+            MethodRuby::AccountListParams::ConsentStatus::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[MethodRuby::AccountListParams::ConsentStatus::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module Expand
+        extend MethodRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, MethodRuby::AccountListParams::Expand) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SENSITIVE =
+          T.let(:sensitive, MethodRuby::AccountListParams::Expand::TaggedSymbol)
+        BALANCE =
+          T.let(:balance, MethodRuby::AccountListParams::Expand::TaggedSymbol)
+        CARD_BRAND =
+          T.let(
+            :card_brand,
+            MethodRuby::AccountListParams::Expand::TaggedSymbol
+          )
+        ATTRIBUTE =
+          T.let(:attribute, MethodRuby::AccountListParams::Expand::TaggedSymbol)
+        PAYOFF =
+          T.let(:payoff, MethodRuby::AccountListParams::Expand::TaggedSymbol)
+        TRANSACTION =
+          T.let(
+            :transaction,
+            MethodRuby::AccountListParams::Expand::TaggedSymbol
+          )
+        UPDATE =
+          T.let(:update, MethodRuby::AccountListParams::Expand::TaggedSymbol)
+        PAYMENT_INSTRUMENT =
+          T.let(
+            :payment_instrument,
+            MethodRuby::AccountListParams::Expand::TaggedSymbol
+          )
+        LATEST_VERIFICATION_SESSION =
+          T.let(
+            :latest_verification_session,
+            MethodRuby::AccountListParams::Expand::TaggedSymbol
+          )
+        LIABILITY_MCH_ID =
+          T.let(
+            :"liability.mch_id",
+            MethodRuby::AccountListParams::Expand::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[MethodRuby::AccountListParams::Expand::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class Liability < MethodRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MethodRuby::AccountListParams::Liability,
+              MethodRuby::Internal::AnyHash
+            )
+          end
+
+        # Filter liability accounts by merchant ID.
+        sig { returns(T.nilable(String)) }
+        attr_reader :mch_id
+
+        sig { params(mch_id: String).void }
+        attr_writer :mch_id
+
+        # Filter liability accounts by ownership type.
+        sig do
+          returns(
+            T.nilable(
+              MethodRuby::AccountListParams::Liability::Ownership::OrSymbol
+            )
+          )
+        end
+        attr_reader :ownership
+
+        sig do
+          params(
+            ownership:
+              MethodRuby::AccountListParams::Liability::Ownership::OrSymbol
+          ).void
+        end
+        attr_writer :ownership
+
+        # Filter liability accounts by liability type.
+        sig do
+          returns(
+            T.nilable(MethodRuby::AccountListParams::Liability::Type::OrSymbol)
+          )
+        end
+        attr_reader :type
+
+        sig do
+          params(
+            type: MethodRuby::AccountListParams::Liability::Type::OrSymbol
+          ).void
+        end
+        attr_writer :type
+
+        sig do
+          params(
+            mch_id: String,
+            ownership:
+              MethodRuby::AccountListParams::Liability::Ownership::OrSymbol,
+            type: MethodRuby::AccountListParams::Liability::Type::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Filter liability accounts by merchant ID.
+          mch_id: nil,
+          # Filter liability accounts by ownership type.
+          ownership: nil,
+          # Filter liability accounts by liability type.
+          type: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              mch_id: String,
+              ownership:
+                MethodRuby::AccountListParams::Liability::Ownership::OrSymbol,
+              type: MethodRuby::AccountListParams::Liability::Type::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Filter liability accounts by ownership type.
+        module Ownership
+          extend MethodRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, MethodRuby::AccountListParams::Liability::Ownership)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PRIMARY =
+            T.let(
+              :primary,
+              MethodRuby::AccountListParams::Liability::Ownership::TaggedSymbol
+            )
+          AUTHORIZED =
+            T.let(
+              :authorized,
+              MethodRuby::AccountListParams::Liability::Ownership::TaggedSymbol
+            )
+          JOINT =
+            T.let(
+              :joint,
+              MethodRuby::AccountListParams::Liability::Ownership::TaggedSymbol
+            )
+          UNKNOWN =
+            T.let(
+              :unknown,
+              MethodRuby::AccountListParams::Liability::Ownership::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                MethodRuby::AccountListParams::Liability::Ownership::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Filter liability accounts by liability type.
+        module Type
+          extend MethodRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, MethodRuby::AccountListParams::Liability::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CREDIT_CARD =
+            T.let(
+              :credit_card,
+              MethodRuby::AccountListParams::Liability::Type::TaggedSymbol
+            )
+          AUTO_LOAN =
+            T.let(
+              :auto_loan,
+              MethodRuby::AccountListParams::Liability::Type::TaggedSymbol
+            )
+          MORTGAGE =
+            T.let(
+              :mortgage,
+              MethodRuby::AccountListParams::Liability::Type::TaggedSymbol
+            )
+          PERSONAL_LOAN =
+            T.let(
+              :personal_loan,
+              MethodRuby::AccountListParams::Liability::Type::TaggedSymbol
+            )
+          STUDENT_LOAN =
+            T.let(
+              :student_loan,
+              MethodRuby::AccountListParams::Liability::Type::TaggedSymbol
+            )
+          STUDENT_LOANS =
+            T.let(
+              :student_loans,
+              MethodRuby::AccountListParams::Liability::Type::TaggedSymbol
+            )
+          COLLECTION =
+            T.let(
+              :collection,
+              MethodRuby::AccountListParams::Liability::Type::TaggedSymbol
+            )
+          CREDIT_BUILDER =
+            T.let(
+              :credit_builder,
+              MethodRuby::AccountListParams::Liability::Type::TaggedSymbol
+            )
+          INSURANCE =
+            T.let(
+              :insurance,
+              MethodRuby::AccountListParams::Liability::Type::TaggedSymbol
+            )
+          LOAN =
+            T.let(
+              :loan,
+              MethodRuby::AccountListParams::Liability::Type::TaggedSymbol
+            )
+          MEDICAL =
+            T.let(
+              :medical,
+              MethodRuby::AccountListParams::Liability::Type::TaggedSymbol
+            )
+          UTILITY =
+            T.let(
+              :utility,
+              MethodRuby::AccountListParams::Liability::Type::TaggedSymbol
+            )
+          BNPL =
+            T.let(
+              :bnpl,
+              MethodRuby::AccountListParams::Liability::Type::TaggedSymbol
+            )
+          FINTECH =
+            T.let(
+              :fintech,
+              MethodRuby::AccountListParams::Liability::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                MethodRuby::AccountListParams::Liability::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      # Filter accounts by status.
+      module Status
+        extend MethodRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, MethodRuby::AccountListParams::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(:active, MethodRuby::AccountListParams::Status::TaggedSymbol)
+        DISABLED =
+          T.let(:disabled, MethodRuby::AccountListParams::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[MethodRuby::AccountListParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Filter accounts by type.
+      module Type
+        extend MethodRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, MethodRuby::AccountListParams::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACH = T.let(:ach, MethodRuby::AccountListParams::Type::TaggedSymbol)
+        LIABILITY =
+          T.let(:liability, MethodRuby::AccountListParams::Type::TaggedSymbol)
+        CLEARING =
+          T.let(:clearing, MethodRuby::AccountListParams::Type::TaggedSymbol)
+        DEBIT_CARD =
+          T.let(:debit_card, MethodRuby::AccountListParams::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[MethodRuby::AccountListParams::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/method_ruby/models/account_list_response.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module MethodRuby
+  module Models
+    class AccountListResponse < MethodRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            MethodRuby::Models::AccountListResponse,
+            MethodRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.anything) }
+      attr_accessor :data
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :message
+
+      # Always `true` for successful responses.
+      sig { returns(T::Boolean) }
+      attr_accessor :success
+
+      sig do
+        params(
+          data: T.anything,
+          message: T.nilable(String),
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        data:,
+        message:,
+        # Always `true` for successful responses.
+        success:
+      )
+      end
+
+      sig do
+        override.returns(
+          { data: T.anything, message: T.nilable(String), success: T::Boolean }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end