method-ruby 0.1.0 → 0.2.0

data/rbi/method_ruby/models/entity_corporation.rbi

@@ -8,49 +8,50 @@ module MethodRuby
           T.any(MethodRuby::EntityCorporation, MethodRuby::Internal::AnyHash)
         end
 
+      # Doing business as name.
       sig { returns(T.nilable(String)) }
       attr_accessor :dba
 
+      # Employer Identification Number.
       sig { returns(T.nilable(String)) }
-      attr_reader :ein
-
-      sig { params(ein: String).void }
-      attr_writer :ein
+      attr_accessor :ein
 
+      # Legal name of the corporation.
       sig { returns(T.nilable(String)) }
-      attr_reader :name
-
-      sig { params(name: String).void }
-      attr_writer :name
+      attr_accessor :name
 
+      # List of beneficial owners.
       sig { returns(T.nilable(T::Array[MethodRuby::EntityCorporationOwner])) }
-      attr_reader :owners
-
-      sig do
-        params(
-          owners: T::Array[MethodRuby::EntityCorporationOwner::OrHash]
-        ).void
-      end
-      attr_writer :owners
+      attr_accessor :owners
 
       sig do
         params(
           dba: T.nilable(String),
-          ein: String,
-          name: String,
-          owners: T::Array[MethodRuby::EntityCorporationOwner::OrHash]
+          ein: T.nilable(String),
+          name: T.nilable(String),
+          owners:
+            T.nilable(T::Array[MethodRuby::EntityCorporationOwner::OrHash])
         ).returns(T.attached_class)
       end
-      def self.new(dba: nil, ein: nil, name: nil, owners: nil)
+      def self.new(
+        # Doing business as name.
+        dba: nil,
+        # Employer Identification Number.
+        ein: nil,
+        # Legal name of the corporation.
+        name: nil,
+        # List of beneficial owners.
+        owners: nil
+      )
       end
 
       sig do
         override.returns(
           {
             dba: T.nilable(String),
-            ein: String,
-            name: String,
-            owners: T::Array[MethodRuby::EntityCorporationOwner]
+            ein: T.nilable(String),
+            name: T.nilable(String),
+            owners: T.nilable(T::Array[MethodRuby::EntityCorporationOwner])
           }
         )
       end

data/rbi/method_ruby/models/entity_corporation_owner.rbi

@@ -11,36 +11,42 @@ module MethodRuby
           )
         end
 
+      # Postal mailing address.
       sig { returns(T.nilable(MethodRuby::Address)) }
       attr_reader :address
 
       sig { params(address: MethodRuby::Address::OrHash).void }
       attr_writer :address
 
+      # Date of birth of the owner (YYYY-MM-DD).
       sig { returns(T.nilable(Date)) }
       attr_reader :dob
 
       sig { params(dob: Date).void }
       attr_writer :dob
 
+      # Email address of the owner.
       sig { returns(T.nilable(String)) }
       attr_reader :email
 
       sig { params(email: String).void }
       attr_writer :email
 
+      # First name of the owner.
       sig { returns(T.nilable(String)) }
       attr_reader :first_name
 
       sig { params(first_name: String).void }
       attr_writer :first_name
 
+      # Last name of the owner.
       sig { returns(T.nilable(String)) }
       attr_reader :last_name
 
       sig { params(last_name: String).void }
       attr_writer :last_name
 
+      # Phone number of the owner.
       sig { returns(T.nilable(String)) }
       attr_reader :phone
 
@@ -58,11 +64,17 @@ module MethodRuby
         ).returns(T.attached_class)
       end
       def self.new(
+        # Postal mailing address.
         address: nil,
+        # Date of birth of the owner (YYYY-MM-DD).
         dob: nil,
+        # Email address of the owner.
         email: nil,
+        # First name of the owner.
         first_name: nil,
+        # Last name of the owner.
         last_name: nil,
+        # Phone number of the owner.
         phone: nil
       )
       end

data/rbi/method_ruby/models/entity_create_params.rbi

@@ -11,6 +11,7 @@ module MethodRuby
           T.any(MethodRuby::EntityCreateParams, MethodRuby::Internal::AnyHash)
         end
 
+      # Request body for creating an entity.
       sig do
         returns(
           T.any(
@@ -21,27 +22,15 @@ module MethodRuby
       end
       attr_accessor :body
 
+      sig { returns(MethodRuby::EntityCreateParams::MethodVersion::OrSymbol) }
+      attr_accessor :method_version
+
       sig { returns(T.nilable(String)) }
       attr_reader :idempotency_key
 
       sig { params(idempotency_key: String).void }
       attr_writer :idempotency_key
 
-      sig do
-        returns(
-          T.nilable(MethodRuby::EntityCreateParams::MethodVersion::OrSymbol)
-        )
-      end
-      attr_reader :method_version
-
-      sig do
-        params(
-          method_version:
-            MethodRuby::EntityCreateParams::MethodVersion::OrSymbol
-        ).void
-      end
-      attr_writer :method_version
-
       sig do
         params(
           body:
@@ -49,16 +38,17 @@ module MethodRuby
               MethodRuby::EntityCreateParams::Body::Individual::OrHash,
               MethodRuby::EntityCreateParams::Body::Corporation::OrHash
             ),
-          idempotency_key: String,
           method_version:
             MethodRuby::EntityCreateParams::MethodVersion::OrSymbol,
+          idempotency_key: String,
           request_options: MethodRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        # Request body for creating an entity.
         body:,
+        method_version:,
         idempotency_key: nil,
-        method_version: nil,
         request_options: {}
       )
       end
@@ -71,9 +61,9 @@ module MethodRuby
                 MethodRuby::EntityCreateParams::Body::Individual,
                 MethodRuby::EntityCreateParams::Body::Corporation
               ),
-            idempotency_key: String,
             method_version:
               MethodRuby::EntityCreateParams::MethodVersion::OrSymbol,
+            idempotency_key: String,
             request_options: MethodRuby::RequestOptions
           }
         )
@@ -81,6 +71,7 @@ module MethodRuby
       def to_hash
       end
 
+      # Request body for creating an entity.
       module Body
         extend MethodRuby::Internal::Type::Union
 
@@ -116,16 +107,18 @@ module MethodRuby
           end
           attr_writer :individual
 
+          # The type of entity to create.
           sig { returns(Symbol) }
           attr_accessor :type
 
+          # Postal mailing address.
           sig { returns(T.nilable(MethodRuby::Address)) }
           attr_reader :address
 
           sig { params(address: MethodRuby::Address::OrHash).void }
           attr_writer :address
 
-          # Custom metadata associated with the resource
+          # Arbitrary key-value metadata attached to the resource.
           sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
           attr_accessor :metadata
 
@@ -140,9 +133,11 @@ module MethodRuby
           end
           def self.new(
             individual:,
+            # Postal mailing address.
             address: nil,
-            # Custom metadata associated with the resource
+            # Arbitrary key-value metadata attached to the resource.
             metadata: nil,
+            # The type of entity to create.
             type: :individual
           )
           end
@@ -170,56 +165,94 @@ module MethodRuby
                 )
               end
 
-            sig { returns(String) }
-            attr_accessor :first_name
-
-            sig { returns(String) }
-            attr_accessor :last_name
-
+            # Date of birth of the individual (YYYY-MM-DD).
             sig { returns(T.nilable(Date)) }
             attr_reader :dob
 
             sig { params(dob: Date).void }
             attr_writer :dob
 
+            # Email address of the individual.
             sig { returns(T.nilable(String)) }
             attr_reader :email
 
             sig { params(email: String).void }
             attr_writer :email
 
+            # First name of the individual.
+            sig { returns(T.nilable(String)) }
+            attr_reader :first_name
+
+            sig { params(first_name: String).void }
+            attr_writer :first_name
+
+            # Last name of the individual.
+            sig { returns(T.nilable(String)) }
+            attr_reader :last_name
+
+            sig { params(last_name: String).void }
+            attr_writer :last_name
+
+            # Phone number of the individual.
             sig { returns(T.nilable(String)) }
             attr_reader :phone
 
             sig { params(phone: String).void }
             attr_writer :phone
 
+            # Social security number (9 digits). Mutually exclusive with ssn_4.
+            sig { returns(T.nilable(String)) }
+            attr_reader :ssn
+
+            sig { params(ssn: String).void }
+            attr_writer :ssn
+
+            # Last 4 digits of SSN. Mutually exclusive with ssn.
+            sig { returns(T.nilable(String)) }
+            attr_reader :ssn_4
+
+            sig { params(ssn_4: String).void }
+            attr_writer :ssn_4
+
             sig do
               params(
-                first_name: String,
-                last_name: String,
                 dob: Date,
                 email: String,
-                phone: String
+                first_name: String,
+                last_name: String,
+                phone: String,
+                ssn: String,
+                ssn_4: String
               ).returns(T.attached_class)
             end
             def self.new(
-              first_name:,
-              last_name:,
+              # Date of birth of the individual (YYYY-MM-DD).
               dob: nil,
+              # Email address of the individual.
               email: nil,
-              phone: nil
+              # First name of the individual.
+              first_name: nil,
+              # Last name of the individual.
+              last_name: nil,
+              # Phone number of the individual.
+              phone: nil,
+              # Social security number (9 digits). Mutually exclusive with ssn_4.
+              ssn: nil,
+              # Last 4 digits of SSN. Mutually exclusive with ssn.
+              ssn_4: nil
             )
             end
 
             sig do
               override.returns(
                 {
-                  first_name: String,
-                  last_name: String,
                   dob: Date,
                   email: String,
-                  phone: String
+                  first_name: String,
+                  last_name: String,
+                  phone: String,
+                  ssn: String,
+                  ssn_4: String
                 }
               )
             end
@@ -252,16 +285,18 @@ module MethodRuby
           end
           attr_writer :corporation
 
+          # The type of entity to create.
           sig { returns(Symbol) }
           attr_accessor :type
 
+          # Postal mailing address.
           sig { returns(T.nilable(MethodRuby::Address)) }
           attr_reader :address
 
           sig { params(address: MethodRuby::Address::OrHash).void }
           attr_writer :address
 
-          # Custom metadata associated with the resource
+          # Arbitrary key-value metadata attached to the resource.
           sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
           attr_accessor :metadata
 
@@ -276,9 +311,11 @@ module MethodRuby
           end
           def self.new(
             corporation:,
+            # Postal mailing address.
             address: nil,
-            # Custom metadata associated with the resource
+            # Arbitrary key-value metadata attached to the resource.
             metadata: nil,
+            # The type of entity to create.
             type: :corporation
           )
           end
@@ -306,21 +343,28 @@ module MethodRuby
                 )
               end
 
-            sig { returns(String) }
-            attr_accessor :name
-
+            # Doing business as name.
             sig { returns(T.nilable(String)) }
             attr_reader :dba
 
             sig { params(dba: String).void }
             attr_writer :dba
 
+            # Employer Identification Number.
             sig { returns(T.nilable(String)) }
             attr_reader :ein
 
             sig { params(ein: String).void }
             attr_writer :ein
 
+            # Legal name of the corporation.
+            sig { returns(T.nilable(String)) }
+            attr_reader :name
+
+            sig { params(name: String).void }
+            attr_writer :name
+
+            # List of beneficial owners.
             sig do
               returns(T.nilable(T::Array[MethodRuby::EntityCorporationOwner]))
             end
@@ -335,21 +379,30 @@ module MethodRuby
 
             sig do
               params(
-                name: String,
                 dba: String,
                 ein: String,
+                name: String,
                 owners: T::Array[MethodRuby::EntityCorporationOwner::OrHash]
               ).returns(T.attached_class)
             end
-            def self.new(name:, dba: nil, ein: nil, owners: nil)
+            def self.new(
+              # Doing business as name.
+              dba: nil,
+              # Employer Identification Number.
+              ein: nil,
+              # Legal name of the corporation.
+              name: nil,
+              # List of beneficial owners.
+              owners: nil
+            )
             end
 
             sig do
               override.returns(
                 {
-                  name: String,
                   dba: String,
                   ein: String,
+                  name: String,
                   owners: T::Array[MethodRuby::EntityCorporationOwner]
                 }
               )
@@ -377,16 +430,6 @@ module MethodRuby
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        METHOD_VERSION_2024_04_04 =
-          T.let(
-            :"2024-04-04",
-            MethodRuby::EntityCreateParams::MethodVersion::TaggedSymbol
-          )
-        METHOD_VERSION_2025_07_04 =
-          T.let(
-            :"2025-07-04",
-            MethodRuby::EntityCreateParams::MethodVersion::TaggedSymbol
-          )
         METHOD_VERSION_2025_12_01 =
           T.let(
             :"2025-12-01",

data/rbi/method_ruby/models/entity_create_response.rbi

@@ -11,74 +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::EntityCreateResponse::Success::TaggedBoolean
-          )
-        )
-      end
-      attr_reader :success
+      # Always `true` for successful responses.
+      sig { returns(T::Boolean) }
+      attr_accessor :success
 
       sig do
         params(
-          success: MethodRuby::Models::EntityCreateResponse::Success::OrBoolean
-        ).void
-      end
-      attr_writer :success
-
-      sig do
-        params(
-          data: MethodRuby::Entity::OrHash,
-          success: MethodRuby::Models::EntityCreateResponse::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::EntityCreateResponse::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::EntityCreateResponse::Success)
-          end
-        OrBoolean = T.type_alias { T::Boolean }
-
-        TRUE =
-          T.let(
-            true,
-            MethodRuby::Models::EntityCreateResponse::Success::TaggedBoolean
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              MethodRuby::Models::EntityCreateResponse::Success::TaggedBoolean
-            ]
-          )
-        end
-        def self.values
-        end
-      end
     end
   end
 end

data/rbi/method_ruby/models/entity_individual.rbi

@@ -8,42 +8,60 @@ module MethodRuby
           T.any(MethodRuby::EntityIndividual, MethodRuby::Internal::AnyHash)
         end
 
+      # Date of birth of the individual (YYYY-MM-DD).
       sig { returns(T.nilable(Date)) }
       attr_accessor :dob
 
+      # Email address of the individual.
       sig { returns(T.nilable(String)) }
       attr_accessor :email
 
+      # First name of the individual.
       sig { returns(T.nilable(String)) }
-      attr_reader :first_name
+      attr_accessor :first_name
 
-      sig { params(first_name: String).void }
-      attr_writer :first_name
+      # Last name of the individual.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :last_name
 
+      # Phone number of the individual.
       sig { returns(T.nilable(String)) }
-      attr_reader :last_name
+      attr_accessor :phone
 
-      sig { params(last_name: String).void }
-      attr_writer :last_name
+      # Social security number (masked).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :ssn
 
+      # Last 4 digits of SSN (masked).
       sig { returns(T.nilable(String)) }
-      attr_accessor :phone
+      attr_accessor :ssn_4
 
       sig do
         params(
           dob: T.nilable(Date),
           email: T.nilable(String),
-          first_name: String,
-          last_name: String,
-          phone: T.nilable(String)
+          first_name: T.nilable(String),
+          last_name: T.nilable(String),
+          phone: T.nilable(String),
+          ssn: T.nilable(String),
+          ssn_4: T.nilable(String)
         ).returns(T.attached_class)
       end
       def self.new(
+        # Date of birth of the individual (YYYY-MM-DD).
         dob: nil,
+        # Email address of the individual.
         email: nil,
+        # First name of the individual.
         first_name: nil,
+        # Last name of the individual.
         last_name: nil,
-        phone: nil
+        # Phone number of the individual.
+        phone: nil,
+        # Social security number (masked).
+        ssn: nil,
+        # Last 4 digits of SSN (masked).
+        ssn_4: nil
       )
       end
 
@@ -52,9 +70,11 @@ module MethodRuby
           {
             dob: T.nilable(Date),
             email: T.nilable(String),
-            first_name: String,
-            last_name: String,
-            phone: T.nilable(String)
+            first_name: T.nilable(String),
+            last_name: T.nilable(String),
+            phone: T.nilable(String),
+            ssn: T.nilable(String),
+            ssn_4: T.nilable(String)
           }
         )
       end