method-ruby 0.1.0 → 0.2.0

data/lib/method_ruby/models/entity_retrieve_params.rb

@@ -7,31 +7,58 @@ module MethodRuby
       extend MethodRuby::Internal::Type::RequestParameters::Converter
       include MethodRuby::Internal::Type::RequestParameters
 
-      # @!attribute ent_id
+      # @!attribute entity_id
       #
       #   @return [String]
-      required :ent_id, String
+      required :entity_id, String
 
       # @!attribute method_version
       #
-      #   @return [Symbol, MethodRuby::Models::EntityRetrieveParams::MethodVersion, nil]
-      optional :method_version, enum: -> { MethodRuby::EntityRetrieveParams::MethodVersion }
+      #   @return [Symbol, MethodRuby::Models::EntityRetrieveParams::MethodVersion]
+      required :method_version, enum: -> { MethodRuby::EntityRetrieveParams::MethodVersion }
 
-      # @!method initialize(ent_id:, method_version: nil, request_options: {})
-      #   @param ent_id [String]
+      # @!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::EntityRetrieveParams::Expand>, nil]
+      optional :expand,
+               -> { MethodRuby::Internal::Type::ArrayOf[enum: MethodRuby::EntityRetrieveParams::Expand] }
+
+      # @!method initialize(entity_id:, method_version:, expand: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {MethodRuby::Models::EntityRetrieveParams} for more details.
+      #
+      #   @param entity_id [String]
+      #
       #   @param method_version [Symbol, MethodRuby::Models::EntityRetrieveParams::MethodVersion]
+      #
+      #   @param expand [Array<Symbol, MethodRuby::Models::EntityRetrieveParams::Expand>] Expand related entity resources inline. Supports the entity expandable fields
+      #
       #   @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
     end
   end
 end

data/lib/method_ruby/models/entity_retrieve_response.rb

@@ -5,28 +5,28 @@ module MethodRuby
     # @see MethodRuby::Resources::Entities#retrieve
     class EntityRetrieveResponse < 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::EntityRetrieveResponse::Success, nil]
-      optional :success, enum: -> { MethodRuby::Models::EntityRetrieveResponse::Success }
-
-      # @!method initialize(data: nil, success: nil)
-      #   @param data [MethodRuby::Models::Entity]
-      #   @param success [Boolean, MethodRuby::Models::EntityRetrieveResponse::Success]
+      #   @return [String, nil]
+      required :message, String, nil?: true
 
-      # @see MethodRuby::Models::EntityRetrieveResponse#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_update_params.rb

@@ -7,28 +7,34 @@ module MethodRuby
       extend MethodRuby::Internal::Type::RequestParameters::Converter
       include MethodRuby::Internal::Type::RequestParameters
 
-      # @!attribute ent_id
+      # @!attribute entity_id
       #
       #   @return [String]
-      required :ent_id, String
+      required :entity_id, String
+
+      # @!attribute method_version
+      #
+      #   @return [Symbol, MethodRuby::Models::EntityUpdateParams::MethodVersion]
+      required :method_version, enum: -> { MethodRuby::EntityUpdateParams::MethodVersion }
 
       # @!attribute address
+      #   Postal mailing address.
       #
       #   @return [MethodRuby::Models::Address, nil]
       optional :address, -> { MethodRuby::Address }
 
       # @!attribute corporation
       #
-      #   @return [MethodRuby::Models::EntityCorporation, nil]
-      optional :corporation, -> { MethodRuby::EntityCorporation }
+      #   @return [MethodRuby::Models::EntityUpdateParams::Corporation, nil]
+      optional :corporation, -> { MethodRuby::EntityUpdateParams::Corporation }
 
       # @!attribute individual
       #
-      #   @return [MethodRuby::Models::EntityIndividual, nil]
-      optional :individual, -> { MethodRuby::EntityIndividual }
+      #   @return [MethodRuby::Models::EntityUpdateParams::Individual, nil]
+      optional :individual, -> { MethodRuby::EntityUpdateParams::Individual }
 
       # @!attribute metadata
-      #   Custom metadata associated with the resource
+      #   Arbitrary key-value metadata attached to the resource.
       #
       #   @return [Hash{Symbol=>Object}, nil]
       optional :metadata, MethodRuby::Internal::Type::HashOf[MethodRuby::Internal::Type::Unknown], nil?: true
@@ -38,38 +44,125 @@ module MethodRuby
       #   @return [String, nil]
       optional :idempotency_key, String
 
-      # @!attribute method_version
+      # @!method initialize(entity_id:, method_version:, address: nil, corporation: nil, individual: nil, metadata: nil, idempotency_key: nil, request_options: {})
+      #   @param entity_id [String]
       #
-      #   @return [Symbol, MethodRuby::Models::EntityUpdateParams::MethodVersion, nil]
-      optional :method_version, enum: -> { MethodRuby::EntityUpdateParams::MethodVersion }
-
-      # @!method initialize(ent_id:, address: nil, corporation: nil, individual: nil, metadata: nil, idempotency_key: nil, method_version: nil, request_options: {})
-      #   @param ent_id [String]
+      #   @param method_version [Symbol, MethodRuby::Models::EntityUpdateParams::MethodVersion]
       #
-      #   @param address [MethodRuby::Models::Address]
+      #   @param address [MethodRuby::Models::Address] Postal mailing address.
       #
-      #   @param corporation [MethodRuby::Models::EntityCorporation]
+      #   @param corporation [MethodRuby::Models::EntityUpdateParams::Corporation]
       #
-      #   @param individual [MethodRuby::Models::EntityIndividual]
+      #   @param individual [MethodRuby::Models::EntityUpdateParams::Individual]
       #
-      #   @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 idempotency_key [String]
       #
-      #   @param method_version [Symbol, MethodRuby::Models::EntityUpdateParams::MethodVersion]
-      #
       #   @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
+
+      class Corporation < MethodRuby::Internal::Type::BaseModel
+        # @!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(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
+
+      class Individual < MethodRuby::Internal::Type::BaseModel
+        # @!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
+
+        # @!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
   end
 end

data/lib/method_ruby/models/entity_update_response.rb

@@ -5,28 +5,28 @@ module MethodRuby
     # @see MethodRuby::Resources::Entities#update
     class EntityUpdateResponse < 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::EntityUpdateResponse::Success, nil]
-      optional :success, enum: -> { MethodRuby::Models::EntityUpdateResponse::Success }
-
-      # @!method initialize(data: nil, success: nil)
-      #   @param data [MethodRuby::Models::Entity]
-      #   @param success [Boolean, MethodRuby::Models::EntityUpdateResponse::Success]
+      #   @return [String, nil]
+      required :message, String, nil?: true
 
-      # @see MethodRuby::Models::EntityUpdateResponse#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/event_list_params.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    # @see MethodRuby::Resources::Events#list
+    class EventListParams < MethodRuby::Internal::Type::BaseModel
+      extend MethodRuby::Internal::Type::RequestParameters::Converter
+      include MethodRuby::Internal::Type::RequestParameters
+
+      # @!attribute method_version
+      #
+      #   @return [Symbol, MethodRuby::Models::EventListParams::MethodVersion]
+      required :method_version, enum: -> { MethodRuby::EventListParams::MethodVersion }
+
+      # @!attribute from_date
+      #   Filter results from this date (inclusive, YYYY-MM-DD format).
+      #
+      #   @return [Date, nil]
+      optional :from_date, Date
+
+      # @!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 to_date
+      #   Filter results to this date (inclusive, YYYY-MM-DD format).
+      #
+      #   @return [Date, nil]
+      optional :to_date, Date
+
+      # @!attribute type
+      #   Filter events by event type.
+      #
+      #   @return [String, nil]
+      optional :type, String
+
+      # @!method initialize(method_version:, from_date: nil, page: nil, page_cursor: nil, page_limit: nil, to_date: nil, type: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {MethodRuby::Models::EventListParams} for more details.
+      #
+      #   @param method_version [Symbol, MethodRuby::Models::EventListParams::MethodVersion]
+      #
+      #   @param from_date [Date] Filter results from this date (inclusive, YYYY-MM-DD format).
+      #
+      #   @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 to_date [Date] Filter results to this date (inclusive, YYYY-MM-DD format).
+      #
+      #   @param type [String] Filter events by event type.
+      #
+      #   @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}]
+
+      module MethodVersion
+        extend MethodRuby::Internal::Type::Enum
+
+        METHOD_VERSION_2025_12_01 = :"2025-12-01"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/method_ruby/models/event_list_response.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    # @see MethodRuby::Resources::Events#list
+    class EventListResponse < MethodRuby::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Object]
+      required :data, MethodRuby::Internal::Type::Unknown
+
+      # @!attribute message
+      #
+      #   @return [String, nil]
+      required :message, String, nil?: true
+
+      # @!attribute success
+      #   Always `true` for successful responses.
+      #
+      #   @return [Boolean]
+      required :success, MethodRuby::Internal::Type::Boolean
+
+      # @!method initialize(data:, message:, success:)
+      #   @param data [Object]
+      #
+      #   @param message [String, nil]
+      #
+      #   @param success [Boolean] Always `true` for successful responses.
+    end
+  end
+end

data/lib/method_ruby/models/event_retrieve_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    # @see MethodRuby::Resources::Events#retrieve
+    class EventRetrieveParams < MethodRuby::Internal::Type::BaseModel
+      extend MethodRuby::Internal::Type::RequestParameters::Converter
+      include MethodRuby::Internal::Type::RequestParameters
+
+      # @!attribute evt_id
+      #
+      #   @return [String]
+      required :evt_id, String
+
+      # @!attribute method_version
+      #
+      #   @return [Symbol, MethodRuby::Models::EventRetrieveParams::MethodVersion]
+      required :method_version, enum: -> { MethodRuby::EventRetrieveParams::MethodVersion }
+
+      # @!method initialize(evt_id:, method_version:, request_options: {})
+      #   @param evt_id [String]
+      #   @param method_version [Symbol, MethodRuby::Models::EventRetrieveParams::MethodVersion]
+      #   @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}]
+
+      module MethodVersion
+        extend MethodRuby::Internal::Type::Enum
+
+        METHOD_VERSION_2025_12_01 = :"2025-12-01"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/method_ruby/models/event_retrieve_response.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    # @see MethodRuby::Resources::Events#retrieve
+    class EventRetrieveResponse < MethodRuby::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Object]
+      required :data, MethodRuby::Internal::Type::Unknown
+
+      # @!attribute message
+      #
+      #   @return [String, nil]
+      required :message, String, nil?: true
+
+      # @!attribute success
+      #   Always `true` for successful responses.
+      #
+      #   @return [Boolean]
+      required :success, MethodRuby::Internal::Type::Boolean
+
+      # @!method initialize(data:, message:, success:)
+      #   @param data [Object]
+      #
+      #   @param message [String, nil]
+      #
+      #   @param success [Boolean] Always `true` for successful responses.
+    end
+  end
+end

data/lib/method_ruby/models/forwarding_request_create_params.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    # @see MethodRuby::Resources::ForwardingRequests#create
+    class ForwardingRequestCreateParams < MethodRuby::Internal::Type::BaseModel
+      extend MethodRuby::Internal::Type::RequestParameters::Converter
+      include MethodRuby::Internal::Type::RequestParameters
+
+      # @!attribute bindings
+      #   Key-value map of secret bindings to inject into the request.
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :bindings, MethodRuby::Internal::Type::HashOf[String]
+
+      # @!attribute body
+      #   Body to send with the forwarded request.
+      #
+      #   @return [String]
+      required :body, String
+
+      # @!attribute headers
+      #   HTTP headers to include in the forwarded request.
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :headers, MethodRuby::Internal::Type::HashOf[String]
+
+      # @!attribute method_
+      #   HTTP method to use.
+      #
+      #   @return [Symbol, MethodRuby::Models::ForwardingRequestCreateParams::Method]
+      required :method_, enum: -> { MethodRuby::ForwardingRequestCreateParams::Method }, api_name: :method
+
+      # @!attribute url
+      #   The destination URL for the forwarded request.
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute method_version
+      #
+      #   @return [Symbol, MethodRuby::Models::ForwardingRequestCreateParams::MethodVersion]
+      required :method_version, enum: -> { MethodRuby::ForwardingRequestCreateParams::MethodVersion }
+
+      # @!attribute metadata
+      #   Optional metadata to attach to the forwarding request.
+      #
+      #   @return [Object, nil]
+      optional :metadata, MethodRuby::Internal::Type::Unknown, nil?: true
+
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!method initialize(bindings:, body:, headers:, method_:, url:, method_version:, metadata: nil, idempotency_key: nil, request_options: {})
+      #   @param bindings [Hash{Symbol=>String}] Key-value map of secret bindings to inject into the request.
+      #
+      #   @param body [String] Body to send with the forwarded request.
+      #
+      #   @param headers [Hash{Symbol=>String}] HTTP headers to include in the forwarded request.
+      #
+      #   @param method_ [Symbol, MethodRuby::Models::ForwardingRequestCreateParams::Method] HTTP method to use.
+      #
+      #   @param url [String] The destination URL for the forwarded request.
+      #
+      #   @param method_version [Symbol, MethodRuby::Models::ForwardingRequestCreateParams::MethodVersion]
+      #
+      #   @param metadata [Object, nil] Optional metadata to attach to the forwarding request.
+      #
+      #   @param idempotency_key [String]
+      #
+      #   @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}]
+
+      # HTTP method to use.
+      module Method
+        extend MethodRuby::Internal::Type::Enum
+
+        GET = :GET
+        POST = :POST
+        PUT = :PUT
+        PATCH = :PATCH
+        DELETE = :DELETE
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module MethodVersion
+        extend MethodRuby::Internal::Type::Enum
+
+        METHOD_VERSION_2025_12_01 = :"2025-12-01"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/method_ruby/models/forwarding_request_create_response.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    # @see MethodRuby::Resources::ForwardingRequests#create
+    class ForwardingRequestCreateResponse < MethodRuby::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Object]
+      required :data, MethodRuby::Internal::Type::Unknown
+
+      # @!attribute message
+      #
+      #   @return [String, nil]
+      required :message, String, nil?: true
+
+      # @!attribute success
+      #   Always `true` for successful responses.
+      #
+      #   @return [Boolean]
+      required :success, MethodRuby::Internal::Type::Boolean
+
+      # @!method initialize(data:, message:, success:)
+      #   @param data [Object]
+      #
+      #   @param message [String, nil]
+      #
+      #   @param success [Boolean] Always `true` for successful responses.
+    end
+  end
+end