method-ruby 0.1.0 → 0.2.0

data/rbi/method_ruby/models/entity_list_params.rbi

@@ -11,68 +11,121 @@ module MethodRuby
           T.any(MethodRuby::EntityListParams, MethodRuby::Internal::AnyHash)
         end
 
+      sig { returns(MethodRuby::EntityListParams::MethodVersion::OrSymbol) }
+      attr_accessor :method_version
+
+      # Expand related entity resources inline. Supports the entity expandable fields
+      # documented by the API validator for entity list and retrieve operations.
+      sig do
+        returns(
+          T.nilable(T::Array[MethodRuby::EntityListParams::Expand::OrSymbol])
+        )
+      end
+      attr_reader :expand
+
+      sig do
+        params(
+          expand: T::Array[MethodRuby::EntityListParams::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 entities by their name.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # 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 entities by status.
+      sig { returns(T.nilable(MethodRuby::EntityListParams::Status::OrSymbol)) }
+      attr_reader :status
+
+      sig do
+        params(status: MethodRuby::EntityListParams::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
 
-      sig do
-        returns(
-          T.nilable(MethodRuby::EntityListParams::MethodVersion::OrSymbol)
-        )
-      end
-      attr_reader :method_version
+      # Filter entities by type.
+      sig { returns(T.nilable(MethodRuby::EntityListParams::Type::OrSymbol)) }
+      attr_reader :type
 
-      sig do
-        params(
-          method_version: MethodRuby::EntityListParams::MethodVersion::OrSymbol
-        ).void
-      end
-      attr_writer :method_version
+      sig { params(type: MethodRuby::EntityListParams::Type::OrSymbol).void }
+      attr_writer :type
 
       sig do
         params(
+          method_version: MethodRuby::EntityListParams::MethodVersion::OrSymbol,
+          expand: T::Array[MethodRuby::EntityListParams::Expand::OrSymbol],
           from_date: Date,
+          name: String,
           page: Integer,
           page_cursor: String,
           page_limit: Integer,
+          status: MethodRuby::EntityListParams::Status::OrSymbol,
           to_date: Date,
-          method_version: MethodRuby::EntityListParams::MethodVersion::OrSymbol,
+          type: MethodRuby::EntityListParams::Type::OrSymbol,
           request_options: MethodRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        method_version:,
+        # Expand related entity resources inline. Supports the entity expandable fields
+        # documented by the API validator for entity list and retrieve operations.
+        expand: nil,
+        # Filter results from this date (inclusive, YYYY-MM-DD format).
         from_date: nil,
+        # Filter entities by their name.
+        name: 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 entities by status.
+        status: nil,
+        # Filter results to this date (inclusive, YYYY-MM-DD format).
         to_date: nil,
-        method_version: nil,
+        # Filter entities by type.
+        type: nil,
         request_options: {}
       )
       end
@@ -80,13 +133,17 @@ module MethodRuby
       sig do
         override.returns(
           {
+            method_version:
+              MethodRuby::EntityListParams::MethodVersion::OrSymbol,
+            expand: T::Array[MethodRuby::EntityListParams::Expand::OrSymbol],
             from_date: Date,
+            name: String,
             page: Integer,
             page_cursor: String,
             page_limit: Integer,
+            status: MethodRuby::EntityListParams::Status::OrSymbol,
             to_date: Date,
-            method_version:
-              MethodRuby::EntityListParams::MethodVersion::OrSymbol,
+            type: MethodRuby::EntityListParams::Type::OrSymbol,
             request_options: MethodRuby::RequestOptions
           }
         )
@@ -103,25 +160,99 @@ module MethodRuby
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        METHOD_VERSION_2024_04_04 =
+        METHOD_VERSION_2025_12_01 =
           T.let(
-            :"2024-04-04",
+            :"2025-12-01",
             MethodRuby::EntityListParams::MethodVersion::TaggedSymbol
           )
-        METHOD_VERSION_2025_07_04 =
+
+        sig do
+          override.returns(
+            T::Array[MethodRuby::EntityListParams::MethodVersion::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module Expand
+        extend MethodRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, MethodRuby::EntityListParams::Expand) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CONNECT =
+          T.let(:connect, MethodRuby::EntityListParams::Expand::TaggedSymbol)
+        CREDIT_SCORE =
+          T.let(
+            :credit_score,
+            MethodRuby::EntityListParams::Expand::TaggedSymbol
+          )
+        ATTRIBUTE =
+          T.let(:attribute, MethodRuby::EntityListParams::Expand::TaggedSymbol)
+        VEHICLE =
+          T.let(:vehicle, MethodRuby::EntityListParams::Expand::TaggedSymbol)
+        PHONE_LATEST_VERIFICATION_SESSION =
           T.let(
-            :"2025-07-04",
-            MethodRuby::EntityListParams::MethodVersion::TaggedSymbol
+            :phone_latest_verification_session,
+            MethodRuby::EntityListParams::Expand::TaggedSymbol
           )
-        METHOD_VERSION_2025_12_01 =
+        IDENTITY_LATEST_VERIFICATION_SESSION =
           T.let(
-            :"2025-12-01",
-            MethodRuby::EntityListParams::MethodVersion::TaggedSymbol
+            :identity_latest_verification_session,
+            MethodRuby::EntityListParams::Expand::TaggedSymbol
           )
 
         sig do
           override.returns(
-            T::Array[MethodRuby::EntityListParams::MethodVersion::TaggedSymbol]
+            T::Array[MethodRuby::EntityListParams::Expand::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Filter entities by status.
+      module Status
+        extend MethodRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, MethodRuby::EntityListParams::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(:active, MethodRuby::EntityListParams::Status::TaggedSymbol)
+        INCOMPLETE =
+          T.let(:incomplete, MethodRuby::EntityListParams::Status::TaggedSymbol)
+        DISABLED =
+          T.let(:disabled, MethodRuby::EntityListParams::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[MethodRuby::EntityListParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Filter entities by type.
+      module Type
+        extend MethodRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, MethodRuby::EntityListParams::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        INDIVIDUAL =
+          T.let(:individual, MethodRuby::EntityListParams::Type::TaggedSymbol)
+        CORPORATION =
+          T.let(:corporation, MethodRuby::EntityListParams::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[MethodRuby::EntityListParams::Type::TaggedSymbol]
           )
         end
         def self.values

data/rbi/method_ruby/models/entity_list_response.rbi

@@ -11,74 +11,38 @@ module MethodRuby
           )
         end
 
-      sig { returns(T.nilable(T::Array[MethodRuby::Entity])) }
-      attr_reader :data
+      sig { returns(T.anything) }
+      attr_accessor :data
 
-      sig { params(data: T::Array[MethodRuby::Entity::OrHash]).void }
-      attr_writer :data
+      sig { returns(T.nilable(String)) }
+      attr_accessor :message
 
-      sig do
-        returns(
-          T.nilable(
-            MethodRuby::Models::EntityListResponse::Success::TaggedBoolean
-          )
-        )
-      end
-      attr_reader :success
+      # Always `true` for successful responses.
+      sig { returns(T::Boolean) }
+      attr_accessor :success
 
       sig do
         params(
-          success: MethodRuby::Models::EntityListResponse::Success::OrBoolean
-        ).void
-      end
-      attr_writer :success
-
-      sig do
-        params(
-          data: T::Array[MethodRuby::Entity::OrHash],
-          success: MethodRuby::Models::EntityListResponse::Success::OrBoolean
+          data: T.anything,
+          message: T.nilable(String),
+          success: T::Boolean
         ).returns(T.attached_class)
       end
-      def self.new(data: nil, success: nil)
+      def self.new(
+        data:,
+        message:,
+        # Always `true` for successful responses.
+        success:
+      )
       end
 
       sig do
         override.returns(
-          {
-            data: T::Array[MethodRuby::Entity],
-            success:
-              MethodRuby::Models::EntityListResponse::Success::TaggedBoolean
-          }
+          { data: T.anything, message: T.nilable(String), success: T::Boolean }
         )
       end
       def to_hash
       end
-
-      module Success
-        extend MethodRuby::Internal::Type::Enum
-
-        TaggedBoolean =
-          T.type_alias do
-            T.all(T::Boolean, MethodRuby::Models::EntityListResponse::Success)
-          end
-        OrBoolean = T.type_alias { T::Boolean }
-
-        TRUE =
-          T.let(
-            true,
-            MethodRuby::Models::EntityListResponse::Success::TaggedBoolean
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              MethodRuby::Models::EntityListResponse::Success::TaggedBoolean
-            ]
-          )
-        end
-        def self.values
-        end
-      end
     end
   end
 end

data/rbi/method_ruby/models/entity_retrieve_params.rbi

@@ -12,40 +12,56 @@ module MethodRuby
         end
 
       sig { returns(String) }
-      attr_accessor :ent_id
+      attr_accessor :entity_id
 
+      sig { returns(MethodRuby::EntityRetrieveParams::MethodVersion::OrSymbol) }
+      attr_accessor :method_version
+
+      # Expand related entity resources inline. Supports the entity expandable fields
+      # documented by the API validator for entity list and retrieve operations.
       sig do
         returns(
-          T.nilable(MethodRuby::EntityRetrieveParams::MethodVersion::OrSymbol)
+          T.nilable(
+            T::Array[MethodRuby::EntityRetrieveParams::Expand::OrSymbol]
+          )
         )
       end
-      attr_reader :method_version
+      attr_reader :expand
 
       sig do
         params(
-          method_version:
-            MethodRuby::EntityRetrieveParams::MethodVersion::OrSymbol
+          expand: T::Array[MethodRuby::EntityRetrieveParams::Expand::OrSymbol]
         ).void
       end
-      attr_writer :method_version
+      attr_writer :expand
 
       sig do
         params(
-          ent_id: String,
+          entity_id: String,
           method_version:
             MethodRuby::EntityRetrieveParams::MethodVersion::OrSymbol,
+          expand: T::Array[MethodRuby::EntityRetrieveParams::Expand::OrSymbol],
           request_options: MethodRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(ent_id:, method_version: nil, request_options: {})
+      def self.new(
+        entity_id:,
+        method_version:,
+        # Expand related entity resources inline. Supports the entity expandable fields
+        # documented by the API validator for entity list and retrieve operations.
+        expand: nil,
+        request_options: {}
+      )
       end
 
       sig do
         override.returns(
           {
-            ent_id: String,
+            entity_id: String,
             method_version:
               MethodRuby::EntityRetrieveParams::MethodVersion::OrSymbol,
+            expand:
+              T::Array[MethodRuby::EntityRetrieveParams::Expand::OrSymbol],
             request_options: MethodRuby::RequestOptions
           }
         )
@@ -62,16 +78,6 @@ module MethodRuby
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        METHOD_VERSION_2024_04_04 =
-          T.let(
-            :"2024-04-04",
-            MethodRuby::EntityRetrieveParams::MethodVersion::TaggedSymbol
-          )
-        METHOD_VERSION_2025_07_04 =
-          T.let(
-            :"2025-07-04",
-            MethodRuby::EntityRetrieveParams::MethodVersion::TaggedSymbol
-          )
         METHOD_VERSION_2025_12_01 =
           T.let(
             :"2025-12-01",
@@ -88,6 +94,55 @@ module MethodRuby
         def self.values
         end
       end
+
+      module Expand
+        extend MethodRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, MethodRuby::EntityRetrieveParams::Expand)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CONNECT =
+          T.let(
+            :connect,
+            MethodRuby::EntityRetrieveParams::Expand::TaggedSymbol
+          )
+        CREDIT_SCORE =
+          T.let(
+            :credit_score,
+            MethodRuby::EntityRetrieveParams::Expand::TaggedSymbol
+          )
+        ATTRIBUTE =
+          T.let(
+            :attribute,
+            MethodRuby::EntityRetrieveParams::Expand::TaggedSymbol
+          )
+        VEHICLE =
+          T.let(
+            :vehicle,
+            MethodRuby::EntityRetrieveParams::Expand::TaggedSymbol
+          )
+        PHONE_LATEST_VERIFICATION_SESSION =
+          T.let(
+            :phone_latest_verification_session,
+            MethodRuby::EntityRetrieveParams::Expand::TaggedSymbol
+          )
+        IDENTITY_LATEST_VERIFICATION_SESSION =
+          T.let(
+            :identity_latest_verification_session,
+            MethodRuby::EntityRetrieveParams::Expand::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[MethodRuby::EntityRetrieveParams::Expand::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/method_ruby/models/entity_retrieve_response.rbi

@@ -11,79 +11,48 @@ module MethodRuby
           )
         end
 
-      sig { returns(T.nilable(MethodRuby::Entity)) }
-      attr_reader :data
+      # An Entity represents an individual or business profile within Method.
+      sig { returns(MethodRuby::Entity::Variants) }
+      attr_accessor :data
 
-      sig { params(data: MethodRuby::Entity::OrHash).void }
-      attr_writer :data
+      sig { returns(T.nilable(String)) }
+      attr_accessor :message
 
-      sig do
-        returns(
-          T.nilable(
-            MethodRuby::Models::EntityRetrieveResponse::Success::TaggedBoolean
-          )
-        )
-      end
-      attr_reader :success
+      # Always `true` for successful responses.
+      sig { returns(T::Boolean) }
+      attr_accessor :success
 
       sig do
         params(
-          success:
-            MethodRuby::Models::EntityRetrieveResponse::Success::OrBoolean
-        ).void
-      end
-      attr_writer :success
-
-      sig do
-        params(
-          data: MethodRuby::Entity::OrHash,
-          success:
-            MethodRuby::Models::EntityRetrieveResponse::Success::OrBoolean
+          data:
+            T.any(
+              MethodRuby::Entity::EntityIndividualResource::OrHash,
+              MethodRuby::Entity::EntityCorporationResource::OrHash
+            ),
+          message: T.nilable(String),
+          success: T::Boolean
         ).returns(T.attached_class)
       end
-      def self.new(data: nil, success: nil)
+      def self.new(
+        # An Entity represents an individual or business profile within Method.
+        data:,
+        message:,
+        # Always `true` for successful responses.
+        success:
+      )
       end
 
       sig do
         override.returns(
           {
-            data: MethodRuby::Entity,
-            success:
-              MethodRuby::Models::EntityRetrieveResponse::Success::TaggedBoolean
+            data: MethodRuby::Entity::Variants,
+            message: T.nilable(String),
+            success: T::Boolean
           }
         )
       end
       def to_hash
       end
-
-      module Success
-        extend MethodRuby::Internal::Type::Enum
-
-        TaggedBoolean =
-          T.type_alias do
-            T.all(
-              T::Boolean,
-              MethodRuby::Models::EntityRetrieveResponse::Success
-            )
-          end
-        OrBoolean = T.type_alias { T::Boolean }
-
-        TRUE =
-          T.let(
-            true,
-            MethodRuby::Models::EntityRetrieveResponse::Success::TaggedBoolean
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              MethodRuby::Models::EntityRetrieveResponse::Success::TaggedBoolean
-            ]
-          )
-        end
-        def self.values
-        end
-      end
     end
   end
 end