method-ruby 0.1.0 → 0.2.0

data/lib/method_ruby/models/entity_corporation.rb

@@ -4,30 +4,39 @@ module MethodRuby
   module Models
     class EntityCorporation < MethodRuby::Internal::Type::BaseModel
       # @!attribute dba
+      #   Doing business as name.
       #
       #   @return [String, nil]
       optional :dba, String, nil?: true
 
       # @!attribute ein
+      #   Employer Identification Number.
       #
       #   @return [String, nil]
-      optional :ein, String
+      optional :ein, String, nil?: true
 
       # @!attribute name
+      #   Legal name of the corporation.
       #
       #   @return [String, nil]
-      optional :name, String
+      optional :name, String, nil?: true
 
       # @!attribute owners
+      #   List of beneficial owners.
       #
       #   @return [Array<MethodRuby::Models::EntityCorporationOwner>, nil]
-      optional :owners, -> { MethodRuby::Internal::Type::ArrayOf[MethodRuby::EntityCorporationOwner] }
+      optional :owners,
+               -> { MethodRuby::Internal::Type::ArrayOf[MethodRuby::EntityCorporationOwner] },
+               nil?: true
 
       # @!method initialize(dba: nil, ein: nil, name: nil, owners: nil)
-      #   @param dba [String, nil]
-      #   @param ein [String]
-      #   @param name [String]
-      #   @param owners [Array<MethodRuby::Models::EntityCorporationOwner>]
+      #   @param dba [String, nil] Doing business as name.
+      #
+      #   @param ein [String, nil] Employer Identification Number.
+      #
+      #   @param name [String, nil] Legal name of the corporation.
+      #
+      #   @param owners [Array<MethodRuby::Models::EntityCorporationOwner>, nil] List of beneficial owners.
     end
   end
 end

data/lib/method_ruby/models/entity_corporation_owner.rb

@@ -4,42 +4,53 @@ module MethodRuby
   module Models
     class EntityCorporationOwner < MethodRuby::Internal::Type::BaseModel
       # @!attribute address
+      #   Postal mailing address.
       #
       #   @return [MethodRuby::Models::Address, nil]
       optional :address, -> { MethodRuby::Address }
 
       # @!attribute dob
+      #   Date of birth of the owner (YYYY-MM-DD).
       #
       #   @return [Date, nil]
       optional :dob, Date
 
       # @!attribute email
+      #   Email address of the owner.
       #
       #   @return [String, nil]
       optional :email, String
 
       # @!attribute first_name
+      #   First name of the owner.
       #
       #   @return [String, nil]
       optional :first_name, String
 
       # @!attribute last_name
+      #   Last name of the owner.
       #
       #   @return [String, nil]
       optional :last_name, String
 
       # @!attribute phone
+      #   Phone number of the owner.
       #
       #   @return [String, nil]
       optional :phone, String
 
       # @!method initialize(address: nil, dob: nil, email: nil, first_name: nil, last_name: nil, phone: nil)
-      #   @param address [MethodRuby::Models::Address]
-      #   @param dob [Date]
-      #   @param email [String]
-      #   @param first_name [String]
-      #   @param last_name [String]
-      #   @param phone [String]
+      #   @param address [MethodRuby::Models::Address] Postal mailing address.
+      #
+      #   @param dob [Date] Date of birth of the owner (YYYY-MM-DD).
+      #
+      #   @param email [String] Email address of the owner.
+      #
+      #   @param first_name [String] First name of the owner.
+      #
+      #   @param last_name [String] Last name of the owner.
+      #
+      #   @param phone [String] Phone number of the owner.
     end
   end
 end

data/lib/method_ruby/models/entity_create_params.rb

@@ -8,26 +8,31 @@ module MethodRuby
       include MethodRuby::Internal::Type::RequestParameters
 
       # @!attribute body
+      #   Request body for creating an entity.
       #
       #   @return [MethodRuby::Models::EntityCreateParams::Body::Individual, MethodRuby::Models::EntityCreateParams::Body::Corporation]
       required :body, union: -> { MethodRuby::EntityCreateParams::Body }
 
+      # @!attribute method_version
+      #
+      #   @return [Symbol, MethodRuby::Models::EntityCreateParams::MethodVersion]
+      required :method_version, enum: -> { MethodRuby::EntityCreateParams::MethodVersion }
+
       # @!attribute idempotency_key
       #
       #   @return [String, nil]
       optional :idempotency_key, String
 
-      # @!attribute method_version
+      # @!method initialize(body:, method_version:, idempotency_key: nil, request_options: {})
+      #   @param body [MethodRuby::Models::EntityCreateParams::Body::Individual, MethodRuby::Models::EntityCreateParams::Body::Corporation] Request body for creating an entity.
       #
-      #   @return [Symbol, MethodRuby::Models::EntityCreateParams::MethodVersion, nil]
-      optional :method_version, enum: -> { MethodRuby::EntityCreateParams::MethodVersion }
-
-      # @!method initialize(body:, idempotency_key: nil, method_version: nil, request_options: {})
-      #   @param body [MethodRuby::Models::EntityCreateParams::Body::Individual, MethodRuby::Models::EntityCreateParams::Body::Corporation]
-      #   @param idempotency_key [String]
       #   @param method_version [Symbol, MethodRuby::Models::EntityCreateParams::MethodVersion]
+      #
+      #   @param idempotency_key [String]
+      #
       #   @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}]
 
+      # Request body for creating an entity.
       module Body
         extend MethodRuby::Internal::Type::Union
 
@@ -44,17 +49,19 @@ module MethodRuby
           required :individual, -> { MethodRuby::EntityCreateParams::Body::Individual::Individual }
 
           # @!attribute type
+          #   The type of entity to create.
           #
           #   @return [Symbol, :individual]
           required :type, const: :individual
 
           # @!attribute address
+          #   Postal mailing address.
           #
           #   @return [MethodRuby::Models::Address, nil]
           optional :address, -> { MethodRuby::Address }
 
           # @!attribute metadata
-          #   Custom metadata associated with the resource
+          #   Arbitrary key-value metadata attached to the resource.
           #
           #   @return [Hash{Symbol=>Object}, nil]
           optional :metadata,
@@ -64,45 +71,70 @@ module MethodRuby
           # @!method initialize(individual:, address: nil, metadata: nil, type: :individual)
           #   @param individual [MethodRuby::Models::EntityCreateParams::Body::Individual::Individual]
           #
-          #   @param address [MethodRuby::Models::Address]
+          #   @param address [MethodRuby::Models::Address] Postal mailing address.
           #
-          #   @param metadata [Hash{Symbol=>Object}, nil] Custom metadata associated with the resource
+          #   @param metadata [Hash{Symbol=>Object}, nil] Arbitrary key-value metadata attached to the resource.
           #
-          #   @param type [Symbol, :individual]
+          #   @param type [Symbol, :individual] The type of entity to create.
 
           # @see MethodRuby::Models::EntityCreateParams::Body::Individual#individual
           class Individual < MethodRuby::Internal::Type::BaseModel
-            # @!attribute first_name
-            #
-            #   @return [String]
-            required :first_name, String
-
-            # @!attribute last_name
-            #
-            #   @return [String]
-            required :last_name, String
-
             # @!attribute dob
+            #   Date of birth of the individual (YYYY-MM-DD).
             #
             #   @return [Date, nil]
             optional :dob, Date
 
             # @!attribute email
+            #   Email address of the individual.
             #
             #   @return [String, nil]
             optional :email, String
 
+            # @!attribute first_name
+            #   First name of the individual.
+            #
+            #   @return [String, nil]
+            optional :first_name, String
+
+            # @!attribute last_name
+            #   Last name of the individual.
+            #
+            #   @return [String, nil]
+            optional :last_name, String
+
             # @!attribute phone
+            #   Phone number of the individual.
             #
             #   @return [String, nil]
             optional :phone, String
 
-            # @!method initialize(first_name:, last_name:, dob: nil, email: nil, phone: nil)
-            #   @param first_name [String]
-            #   @param last_name [String]
-            #   @param dob [Date]
-            #   @param email [String]
-            #   @param phone [String]
+            # @!attribute ssn
+            #   Social security number (9 digits). Mutually exclusive with ssn_4.
+            #
+            #   @return [String, nil]
+            optional :ssn, String
+
+            # @!attribute ssn_4
+            #   Last 4 digits of SSN. Mutually exclusive with ssn.
+            #
+            #   @return [String, nil]
+            optional :ssn_4, String
+
+            # @!method initialize(dob: nil, email: nil, first_name: nil, last_name: nil, phone: nil, ssn: nil, ssn_4: nil)
+            #   @param dob [Date] Date of birth of the individual (YYYY-MM-DD).
+            #
+            #   @param email [String] Email address of the individual.
+            #
+            #   @param first_name [String] First name of the individual.
+            #
+            #   @param last_name [String] Last name of the individual.
+            #
+            #   @param phone [String] Phone number of the individual.
+            #
+            #   @param ssn [String] Social security number (9 digits). Mutually exclusive with ssn_4.
+            #
+            #   @param ssn_4 [String] Last 4 digits of SSN. Mutually exclusive with ssn.
           end
         end
 
@@ -113,17 +145,19 @@ module MethodRuby
           required :corporation, -> { MethodRuby::EntityCreateParams::Body::Corporation::Corporation }
 
           # @!attribute type
+          #   The type of entity to create.
           #
           #   @return [Symbol, :corporation]
           required :type, const: :corporation
 
           # @!attribute address
+          #   Postal mailing address.
           #
           #   @return [MethodRuby::Models::Address, nil]
           optional :address, -> { MethodRuby::Address }
 
           # @!attribute metadata
-          #   Custom metadata associated with the resource
+          #   Arbitrary key-value metadata attached to the resource.
           #
           #   @return [Hash{Symbol=>Object}, nil]
           optional :metadata,
@@ -133,39 +167,46 @@ module MethodRuby
           # @!method initialize(corporation:, address: nil, metadata: nil, type: :corporation)
           #   @param corporation [MethodRuby::Models::EntityCreateParams::Body::Corporation::Corporation]
           #
-          #   @param address [MethodRuby::Models::Address]
+          #   @param address [MethodRuby::Models::Address] Postal mailing address.
           #
-          #   @param metadata [Hash{Symbol=>Object}, nil] Custom metadata associated with the resource
+          #   @param metadata [Hash{Symbol=>Object}, nil] Arbitrary key-value metadata attached to the resource.
           #
-          #   @param type [Symbol, :corporation]
+          #   @param type [Symbol, :corporation] The type of entity to create.
 
           # @see MethodRuby::Models::EntityCreateParams::Body::Corporation#corporation
           class Corporation < MethodRuby::Internal::Type::BaseModel
-            # @!attribute name
-            #
-            #   @return [String]
-            required :name, String
-
             # @!attribute dba
+            #   Doing business as name.
             #
             #   @return [String, nil]
             optional :dba, String
 
             # @!attribute ein
+            #   Employer Identification Number.
             #
             #   @return [String, nil]
             optional :ein, String
 
+            # @!attribute name
+            #   Legal name of the corporation.
+            #
+            #   @return [String, nil]
+            optional :name, String
+
             # @!attribute owners
+            #   List of beneficial owners.
             #
             #   @return [Array<MethodRuby::Models::EntityCorporationOwner>, nil]
             optional :owners, -> { MethodRuby::Internal::Type::ArrayOf[MethodRuby::EntityCorporationOwner] }
 
-            # @!method initialize(name:, dba: nil, ein: nil, owners: nil)
-            #   @param name [String]
-            #   @param dba [String]
-            #   @param ein [String]
-            #   @param owners [Array<MethodRuby::Models::EntityCorporationOwner>]
+            # @!method initialize(dba: nil, ein: nil, name: nil, owners: nil)
+            #   @param dba [String] Doing business as name.
+            #
+            #   @param ein [String] Employer Identification Number.
+            #
+            #   @param name [String] Legal name of the corporation.
+            #
+            #   @param owners [Array<MethodRuby::Models::EntityCorporationOwner>] List of beneficial owners.
           end
         end
 
@@ -176,8 +217,6 @@ module MethodRuby
       module MethodVersion
         extend MethodRuby::Internal::Type::Enum
 
-        METHOD_VERSION_2024_04_04 = :"2024-04-04"
-        METHOD_VERSION_2025_07_04 = :"2025-07-04"
         METHOD_VERSION_2025_12_01 = :"2025-12-01"
 
         # @!method self.values

data/lib/method_ruby/models/entity_create_response.rb

@@ -5,28 +5,28 @@ module MethodRuby
     # @see MethodRuby::Resources::Entities#create
     class EntityCreateResponse < MethodRuby::Internal::Type::BaseModel
       # @!attribute data
+      #   An Entity represents an individual or business profile within Method.
       #
-      #   @return [MethodRuby::Models::Entity, nil]
-      optional :data, -> { MethodRuby::Entity }
+      #   @return [MethodRuby::Models::Entity::EntityIndividualResource, MethodRuby::Models::Entity::EntityCorporationResource]
+      required :data, union: -> { MethodRuby::Entity }
 
-      # @!attribute success
+      # @!attribute message
       #
-      #   @return [Boolean, MethodRuby::Models::EntityCreateResponse::Success, nil]
-      optional :success, enum: -> { MethodRuby::Models::EntityCreateResponse::Success }
-
-      # @!method initialize(data: nil, success: nil)
-      #   @param data [MethodRuby::Models::Entity]
-      #   @param success [Boolean, MethodRuby::Models::EntityCreateResponse::Success]
+      #   @return [String, nil]
+      required :message, String, nil?: true
 
-      # @see MethodRuby::Models::EntityCreateResponse#success
-      module Success
-        extend MethodRuby::Internal::Type::Enum
-
-        TRUE = true
+      # @!attribute success
+      #   Always `true` for successful responses.
+      #
+      #   @return [Boolean]
+      required :success, MethodRuby::Internal::Type::Boolean
 
-        # @!method self.values
-        #   @return [Array<Boolean>]
-      end
+      # @!method initialize(data:, message:, success:)
+      #   @param data [MethodRuby::Models::Entity::EntityIndividualResource, MethodRuby::Models::Entity::EntityCorporationResource] An Entity represents an individual or business profile within Method.
+      #
+      #   @param message [String, nil]
+      #
+      #   @param success [Boolean] Always `true` for successful responses.
     end
   end
 end

data/lib/method_ruby/models/entity_individual.rb

@@ -4,36 +4,61 @@ module MethodRuby
   module Models
     class EntityIndividual < MethodRuby::Internal::Type::BaseModel
       # @!attribute dob
+      #   Date of birth of the individual (YYYY-MM-DD).
       #
       #   @return [Date, nil]
       optional :dob, Date, nil?: true
 
       # @!attribute email
+      #   Email address of the individual.
       #
       #   @return [String, nil]
       optional :email, String, nil?: true
 
       # @!attribute first_name
+      #   First name of the individual.
       #
       #   @return [String, nil]
-      optional :first_name, String
+      optional :first_name, String, nil?: true
 
       # @!attribute last_name
+      #   Last name of the individual.
       #
       #   @return [String, nil]
-      optional :last_name, String
+      optional :last_name, String, nil?: true
 
       # @!attribute phone
+      #   Phone number of the individual.
       #
       #   @return [String, nil]
       optional :phone, String, nil?: true
 
-      # @!method initialize(dob: nil, email: nil, first_name: nil, last_name: nil, phone: nil)
-      #   @param dob [Date, nil]
-      #   @param email [String, nil]
-      #   @param first_name [String]
-      #   @param last_name [String]
-      #   @param phone [String, nil]
+      # @!attribute ssn
+      #   Social security number (masked).
+      #
+      #   @return [String, nil]
+      optional :ssn, String, nil?: true
+
+      # @!attribute ssn_4
+      #   Last 4 digits of SSN (masked).
+      #
+      #   @return [String, nil]
+      optional :ssn_4, String, nil?: true
+
+      # @!method initialize(dob: nil, email: nil, first_name: nil, last_name: nil, phone: nil, ssn: nil, ssn_4: nil)
+      #   @param dob [Date, nil] Date of birth of the individual (YYYY-MM-DD).
+      #
+      #   @param email [String, nil] Email address of the individual.
+      #
+      #   @param first_name [String, nil] First name of the individual.
+      #
+      #   @param last_name [String, nil] Last name of the individual.
+      #
+      #   @param phone [String, nil] Phone number of the individual.
+      #
+      #   @param ssn [String, nil] Social security number (masked).
+      #
+      #   @param ssn_4 [String, nil] Last 4 digits of SSN (masked).
     end
   end
 end

data/lib/method_ruby/models/entity_list_params.rb

@@ -7,55 +7,138 @@ module MethodRuby
       extend MethodRuby::Internal::Type::RequestParameters::Converter
       include MethodRuby::Internal::Type::RequestParameters
 
+      # @!attribute method_version
+      #
+      #   @return [Symbol, MethodRuby::Models::EntityListParams::MethodVersion]
+      required :method_version, enum: -> { MethodRuby::EntityListParams::MethodVersion }
+
+      # @!attribute expand
+      #   Expand related entity resources inline. Supports the entity expandable fields
+      #   documented by the API validator for entity list and retrieve operations.
+      #
+      #   @return [Array<Symbol, MethodRuby::Models::EntityListParams::Expand>, nil]
+      optional :expand, -> { MethodRuby::Internal::Type::ArrayOf[enum: MethodRuby::EntityListParams::Expand] }
+
       # @!attribute from_date
+      #   Filter results from this date (inclusive, YYYY-MM-DD format).
       #
       #   @return [Date, nil]
       optional :from_date, Date
 
+      # @!attribute name
+      #   Filter entities by their name.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
       # @!attribute page
+      #   Page number for pagination (1-indexed).
       #
       #   @return [Integer, nil]
       optional :page, Integer
 
       # @!attribute page_cursor
+      #   Cursor for cursor-based pagination. Use the value from
+      #   `Pagination-Page-Cursor-Next` or `Pagination-Page-Cursor-Prev` response headers.
       #
       #   @return [String, nil]
       optional :page_cursor, String
 
       # @!attribute page_limit
+      #   Number of items per page.
       #
       #   @return [Integer, nil]
       optional :page_limit, Integer
 
+      # @!attribute status
+      #   Filter entities by status.
+      #
+      #   @return [Symbol, MethodRuby::Models::EntityListParams::Status, nil]
+      optional :status, enum: -> { MethodRuby::EntityListParams::Status }
+
       # @!attribute to_date
+      #   Filter results to this date (inclusive, YYYY-MM-DD format).
       #
       #   @return [Date, nil]
       optional :to_date, Date
 
-      # @!attribute method_version
+      # @!attribute type
+      #   Filter entities by type.
       #
-      #   @return [Symbol, MethodRuby::Models::EntityListParams::MethodVersion, nil]
-      optional :method_version, enum: -> { MethodRuby::EntityListParams::MethodVersion }
+      #   @return [Symbol, MethodRuby::Models::EntityListParams::Type, nil]
+      optional :type, enum: -> { MethodRuby::EntityListParams::Type }
 
-      # @!method initialize(from_date: nil, page: nil, page_cursor: nil, page_limit: nil, to_date: nil, method_version: nil, request_options: {})
-      #   @param from_date [Date]
-      #   @param page [Integer]
-      #   @param page_cursor [String]
-      #   @param page_limit [Integer]
-      #   @param to_date [Date]
+      # @!method initialize(method_version:, expand: nil, from_date: nil, name: nil, page: nil, page_cursor: nil, page_limit: nil, status: nil, to_date: nil, type: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {MethodRuby::Models::EntityListParams} for more details.
+      #
       #   @param method_version [Symbol, MethodRuby::Models::EntityListParams::MethodVersion]
+      #
+      #   @param expand [Array<Symbol, MethodRuby::Models::EntityListParams::Expand>] Expand related entity resources inline. Supports the entity expandable fields
+      #
+      #   @param from_date [Date] Filter results from this date (inclusive, YYYY-MM-DD format).
+      #
+      #   @param name [String] Filter entities by their name.
+      #
+      #   @param page [Integer] Page number for pagination (1-indexed).
+      #
+      #   @param page_cursor [String] Cursor for cursor-based pagination. Use the value from `Pagination-Page-Cursor-N
+      #
+      #   @param page_limit [Integer] Number of items per page.
+      #
+      #   @param status [Symbol, MethodRuby::Models::EntityListParams::Status] Filter entities by status.
+      #
+      #   @param to_date [Date] Filter results to this date (inclusive, YYYY-MM-DD format).
+      #
+      #   @param type [Symbol, MethodRuby::Models::EntityListParams::Type] Filter entities by type.
+      #
       #   @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}]
 
       module MethodVersion
         extend MethodRuby::Internal::Type::Enum
 
-        METHOD_VERSION_2024_04_04 = :"2024-04-04"
-        METHOD_VERSION_2025_07_04 = :"2025-07-04"
         METHOD_VERSION_2025_12_01 = :"2025-12-01"
 
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      module Expand
+        extend MethodRuby::Internal::Type::Enum
+
+        CONNECT = :connect
+        CREDIT_SCORE = :credit_score
+        ATTRIBUTE = :attribute
+        VEHICLE = :vehicle
+        PHONE_LATEST_VERIFICATION_SESSION = :phone_latest_verification_session
+        IDENTITY_LATEST_VERIFICATION_SESSION = :identity_latest_verification_session
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Filter entities by status.
+      module Status
+        extend MethodRuby::Internal::Type::Enum
+
+        ACTIVE = :active
+        INCOMPLETE = :incomplete
+        DISABLED = :disabled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Filter entities by type.
+      module Type
+        extend MethodRuby::Internal::Type::Enum
+
+        INDIVIDUAL = :individual
+        CORPORATION = :corporation
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/method_ruby/models/entity_list_response.rb

@@ -6,27 +6,26 @@ module MethodRuby
     class EntityListResponse < MethodRuby::Internal::Type::BaseModel
       # @!attribute data
       #
-      #   @return [Array<MethodRuby::Models::Entity>, nil]
-      optional :data, -> { MethodRuby::Internal::Type::ArrayOf[MethodRuby::Entity] }
+      #   @return [Object]
+      required :data, MethodRuby::Internal::Type::Unknown
 
-      # @!attribute success
+      # @!attribute message
       #
-      #   @return [Boolean, MethodRuby::Models::EntityListResponse::Success, nil]
-      optional :success, enum: -> { MethodRuby::Models::EntityListResponse::Success }
-
-      # @!method initialize(data: nil, success: nil)
-      #   @param data [Array<MethodRuby::Models::Entity>]
-      #   @param success [Boolean, MethodRuby::Models::EntityListResponse::Success]
+      #   @return [String, nil]
+      required :message, String, nil?: true
 
-      # @see MethodRuby::Models::EntityListResponse#success
-      module Success
-        extend MethodRuby::Internal::Type::Enum
-
-        TRUE = true
+      # @!attribute success
+      #   Always `true` for successful responses.
+      #
+      #   @return [Boolean]
+      required :success, MethodRuby::Internal::Type::Boolean
 
-        # @!method self.values
-        #   @return [Array<Boolean>]
-      end
+      # @!method initialize(data:, message:, success:)
+      #   @param data [Object]
+      #
+      #   @param message [String, nil]
+      #
+      #   @param success [Boolean] Always `true` for successful responses.
     end
   end
 end