method-ruby 0.1.0 → 0.2.1

data/rbi/method_ruby/resources/entities/subscriptions.rbi

@@ -0,0 +1,118 @@
+# typed: strong
+
+module MethodRuby
+  module Resources
+    class Entities
+      # Subscriptions for entities
+      class Subscriptions
+        # Creates a new subscription for the specified entity.
+        sig do
+          params(
+            entity_id: String,
+            enroll:
+              MethodRuby::Entities::SubscriptionCreateParams::Enroll::OrSymbol,
+            method_version:
+              MethodRuby::Entities::SubscriptionCreateParams::MethodVersion::OrSymbol,
+            payload:
+              T.nilable(
+                MethodRuby::Entities::SubscriptionCreateParams::Payload::OrHash
+              ),
+            idempotency_key: String,
+            request_options: MethodRuby::RequestOptions::OrHash
+          ).returns(MethodRuby::Models::Entities::SubscriptionCreateResponse)
+        end
+        def create(
+          # Path param: Unique identifier for the entity.
+          entity_id,
+          # Body param: Subscription name to enroll.
+          enroll:,
+          # Header param: API version to use for this request. This spec targets
+          # `2025-12-01`. The SDK sets this header automatically.
+          method_version:,
+          # Body param: Optional payload for the subscription. Required when enroll is
+          # attribute.
+          payload: nil,
+          # Header param: Idempotency key for safely retrying a write request. Reuse the
+          # same value when retrying the same logical operation to avoid creating duplicate
+          # side effects.
+          idempotency_key: nil,
+          request_options: {}
+        )
+        end
+
+        # Returns a single entity subscription by its identifier.
+        sig do
+          params(
+            sub_id: String,
+            entity_id: String,
+            method_version:
+              MethodRuby::Entities::SubscriptionRetrieveParams::MethodVersion::OrSymbol,
+            request_options: MethodRuby::RequestOptions::OrHash
+          ).returns(MethodRuby::Models::Entities::SubscriptionRetrieveResponse)
+        end
+        def retrieve(
+          # Path param: Unique identifier for the entity subscription.
+          sub_id,
+          # Path param: Unique identifier for the entity.
+          entity_id:,
+          # Header param: API version to use for this request. This spec targets
+          # `2025-12-01`. The SDK sets this header automatically.
+          method_version:,
+          request_options: {}
+        )
+        end
+
+        # Returns a list of subscriptions for the specified entity.
+        sig do
+          params(
+            entity_id: String,
+            method_version:
+              MethodRuby::Entities::SubscriptionListParams::MethodVersion::OrSymbol,
+            request_options: MethodRuby::RequestOptions::OrHash
+          ).returns(MethodRuby::Models::Entities::SubscriptionListResponse)
+        end
+        def list(
+          # Unique identifier for the entity.
+          entity_id,
+          # API version to use for this request. This spec targets `2025-12-01`. The SDK
+          # sets this header automatically.
+          method_version:,
+          request_options: {}
+        )
+        end
+
+        # Deletes an entity subscription by its identifier.
+        sig do
+          params(
+            sub_id: String,
+            entity_id: String,
+            method_version:
+              MethodRuby::Entities::SubscriptionDeleteParams::MethodVersion::OrSymbol,
+            idempotency_key: String,
+            request_options: MethodRuby::RequestOptions::OrHash
+          ).returns(MethodRuby::Models::Entities::SubscriptionDeleteResponse)
+        end
+        def delete(
+          # Path param: Unique identifier for the entity subscription.
+          sub_id,
+          # Path param: Unique identifier for the entity.
+          entity_id:,
+          # Header param: API version to use for this request. This spec targets
+          # `2025-12-01`. The SDK sets this header automatically.
+          method_version:,
+          # Header param: Idempotency key for safely retrying a write request. Reuse the
+          # same value when retrying the same logical operation to avoid creating duplicate
+          # side effects.
+          idempotency_key: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: MethodRuby::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/method_ruby/resources/entities/vehicles.rbi

@@ -0,0 +1,84 @@
+# typed: strong
+
+module MethodRuby
+  module Resources
+    class Entities
+      # Vehicle data for entities
+      class Vehicles
+        # Searches for vehicles associated with the specified entity.
+        sig do
+          params(
+            entity_id: String,
+            body: T.anything,
+            method_version:
+              MethodRuby::Entities::VehicleCreateParams::MethodVersion::OrSymbol,
+            idempotency_key: String,
+            request_options: MethodRuby::RequestOptions::OrHash
+          ).returns(MethodRuby::Models::Entities::VehicleCreateResponse)
+        end
+        def create(
+          # Path param: Unique identifier for the entity.
+          entity_id,
+          # Body param: Request body for searching entity vehicles. Treated as a product
+          # execution.
+          body:,
+          # Header param: API version to use for this request. This spec targets
+          # `2025-12-01`. The SDK sets this header automatically.
+          method_version:,
+          # Header param: Idempotency key for safely retrying a write request. Reuse the
+          # same value when retrying the same logical operation to avoid creating duplicate
+          # side effects.
+          idempotency_key: nil,
+          request_options: {}
+        )
+        end
+
+        # Returns a single entity vehicle by its identifier.
+        sig do
+          params(
+            vhl_id: String,
+            entity_id: String,
+            method_version:
+              MethodRuby::Entities::VehicleRetrieveParams::MethodVersion::OrSymbol,
+            request_options: MethodRuby::RequestOptions::OrHash
+          ).returns(MethodRuby::Models::Entities::VehicleRetrieveResponse)
+        end
+        def retrieve(
+          # Path param: Unique identifier for the entity vehicle.
+          vhl_id,
+          # Path param: Unique identifier for the entity.
+          entity_id:,
+          # Header param: API version to use for this request. This spec targets
+          # `2025-12-01`. The SDK sets this header automatically.
+          method_version:,
+          request_options: {}
+        )
+        end
+
+        # Returns a list of vehicles for the specified entity.
+        sig do
+          params(
+            entity_id: String,
+            method_version:
+              MethodRuby::Entities::VehicleListParams::MethodVersion::OrSymbol,
+            request_options: MethodRuby::RequestOptions::OrHash
+          ).returns(MethodRuby::Models::Entities::VehicleListResponse)
+        end
+        def list(
+          # Unique identifier for the entity.
+          entity_id,
+          # API version to use for this request. This spec targets `2025-12-01`. The SDK
+          # sets this header automatically.
+          method_version:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: MethodRuby::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/method_ruby/resources/entities/verification_sessions.rbi

@@ -0,0 +1,175 @@
+# typed: strong
+
+module MethodRuby
+  module Resources
+    class Entities
+      # Verification sessions for entities
+      class VerificationSessions
+        # Creates a new verification session for the specified entity.
+        sig do
+          params(
+            entity_id: String,
+            method_:
+              MethodRuby::Entities::VerificationSessionCreateParams::Method::OrSymbol,
+            type:
+              MethodRuby::Entities::VerificationSessionCreateParams::Type::OrSymbol,
+            method_version:
+              MethodRuby::Entities::VerificationSessionCreateParams::MethodVersion::OrSymbol,
+            byo_kyc: T.anything,
+            byo_sms:
+              MethodRuby::Entities::VerificationSessionCreateParams::ByoSMS::OrHash,
+            kba: T.anything,
+            sms: T.anything,
+            sna: T.anything,
+            idempotency_key: String,
+            request_options: MethodRuby::RequestOptions::OrHash
+          ).returns(
+            MethodRuby::Models::Entities::VerificationSessionCreateResponse
+          )
+        end
+        def create(
+          # Path param: Unique identifier for the entity.
+          entity_id,
+          # Body param: The verification method to use.
+          method_:,
+          # Body param: The type of verification to perform.
+          type:,
+          # Header param: API version to use for this request. This spec targets
+          # `2025-12-01`. The SDK sets this header automatically.
+          method_version:,
+          # Body param: BYO KYC-specific options. Required when method is byo_kyc.
+          byo_kyc: nil,
+          # Body param: BYO SMS-specific options. Required when method is byo_sms.
+          byo_sms: nil,
+          # Body param: KBA-specific options. Required when method is kba.
+          kba: nil,
+          # Body param: SMS-specific options. Required when method is sms.
+          sms: nil,
+          # Body param: SNA-specific options. Required when method is sna.
+          sna: nil,
+          # Header param: Idempotency key for safely retrying a write request. Reuse the
+          # same value when retrying the same logical operation to avoid creating duplicate
+          # side effects.
+          idempotency_key: nil,
+          request_options: {}
+        )
+        end
+
+        # Returns a single entity verification session by its identifier.
+        sig do
+          params(
+            evf_id: String,
+            entity_id: String,
+            method_version:
+              MethodRuby::Entities::VerificationSessionRetrieveParams::MethodVersion::OrSymbol,
+            request_options: MethodRuby::RequestOptions::OrHash
+          ).returns(
+            MethodRuby::Models::Entities::VerificationSessionRetrieveResponse
+          )
+        end
+        def retrieve(
+          # Path param: Unique identifier for the entity verification session.
+          evf_id,
+          # Path param: Unique identifier for the entity.
+          entity_id:,
+          # Header param: API version to use for this request. This spec targets
+          # `2025-12-01`. The SDK sets this header automatically.
+          method_version:,
+          request_options: {}
+        )
+        end
+
+        # Updates a verification session, for example by submitting an SMS verification
+        # code or KBA answers. The request body shape depends on the verification type and
+        # method.
+        sig do
+          params(
+            evf_id: String,
+            entity_id: String,
+            method_:
+              MethodRuby::Entities::VerificationSessionUpdateParams::Method::OrSymbol,
+            type: String,
+            method_version:
+              MethodRuby::Entities::VerificationSessionUpdateParams::MethodVersion::OrSymbol,
+            kba:
+              MethodRuby::Entities::VerificationSessionUpdateParams::Kba::OrHash,
+            sms:
+              MethodRuby::Entities::VerificationSessionUpdateParams::SMS::OrHash,
+            sna: T.anything,
+            idempotency_key: String,
+            request_options: MethodRuby::RequestOptions::OrHash
+          ).returns(
+            MethodRuby::Models::Entities::VerificationSessionUpdateResponse
+          )
+        end
+        def update(
+          # Path param: Unique identifier for the entity verification session.
+          evf_id,
+          # Path param: Unique identifier for the entity.
+          entity_id:,
+          # Body param: The verification method.
+          method_:,
+          # Body param: The verification session type.
+          type:,
+          # Header param: API version to use for this request. This spec targets
+          # `2025-12-01`. The SDK sets this header automatically.
+          method_version:,
+          # Body param: KBA verification data.
+          kba: nil,
+          # Body param: SMS verification data.
+          sms: nil,
+          # Body param: SNA verification data.
+          sna: nil,
+          # Header param: Idempotency key for safely retrying a write request. Reuse the
+          # same value when retrying the same logical operation to avoid creating duplicate
+          # side effects.
+          idempotency_key: nil,
+          request_options: {}
+        )
+        end
+
+        # Returns a list of verification sessions for the specified entity.
+        sig do
+          params(
+            entity_id: String,
+            method_version:
+              MethodRuby::Entities::VerificationSessionListParams::MethodVersion::OrSymbol,
+            from_date: Date,
+            page: Integer,
+            page_cursor: String,
+            page_limit: Integer,
+            to_date: Date,
+            request_options: MethodRuby::RequestOptions::OrHash
+          ).returns(
+            MethodRuby::Models::Entities::VerificationSessionListResponse
+          )
+        end
+        def list(
+          # Path param: Unique identifier for the entity.
+          entity_id,
+          # Header param: API version to use for this request. This spec targets
+          # `2025-12-01`. The SDK sets this header automatically.
+          method_version:,
+          # Query param: Filter results from this date (inclusive, YYYY-MM-DD format).
+          from_date: nil,
+          # Query param: Page number for pagination (1-indexed).
+          page: nil,
+          # Query param: Cursor for cursor-based pagination. Use the value from
+          # `Pagination-Page-Cursor-Next` or `Pagination-Page-Cursor-Prev` response headers.
+          page_cursor: nil,
+          # Query param: Number of items per page.
+          page_limit: nil,
+          # Query param: Filter results to this date (inclusive, YYYY-MM-DD format).
+          to_date: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: MethodRuby::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/method_ruby/resources/entities.rbi

@@ -2,10 +2,49 @@
 
 module MethodRuby
   module Resources
-    # Entities represent your application's end-users. An Entity is the legal holder
-    # of an Account and can be either an individual or a corporation.
+    # Individuals, corporations, and receive-only entities
     class Entities
-      # Creates a new Entity.
+      # Attribute data for entities
+      sig { returns(MethodRuby::Resources::Entities::Attributes) }
+      attr_reader :attributes
+
+      # Credit score data for entities
+      sig { returns(MethodRuby::Resources::Entities::CreditScores) }
+      attr_reader :credit_scores
+
+      # Consent management for entities
+      sig { returns(MethodRuby::Resources::Entities::Consent) }
+      attr_reader :consent
+
+      # Vehicle data for entities
+      sig { returns(MethodRuby::Resources::Entities::Vehicles) }
+      attr_reader :vehicles
+
+      # Products associated with entities
+      sig { returns(MethodRuby::Resources::Entities::Products) }
+      attr_reader :products
+
+      # Subscriptions for entities
+      sig { returns(MethodRuby::Resources::Entities::Subscriptions) }
+      attr_reader :subscriptions
+
+      # Account connection sessions for entities
+      sig { returns(MethodRuby::Resources::Entities::Connect) }
+      attr_reader :connect
+
+      # Account connection sessions for entities
+      sig { returns(MethodRuby::Resources::Entities::ManualConnect) }
+      attr_reader :manual_connect
+
+      # Identity verification data for entities
+      sig { returns(MethodRuby::Resources::Entities::Identities) }
+      attr_reader :identities
+
+      # Verification sessions for entities
+      sig { returns(MethodRuby::Resources::Entities::VerificationSessions) }
+      attr_reader :verification_sessions
+
+      # Creates a new entity.
       sig do
         params(
           body:
@@ -13,99 +52,127 @@ 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(MethodRuby::Models::EntityCreateResponse)
       end
       def create(
-        # Body param
+        # Body param: Request body for creating an entity.
         body:,
-        # Header param: Unique key to ensure idempotent requests.
+        # Header param: API version to use for this request. This spec targets
+        # `2025-12-01`. The SDK sets this header automatically.
+        method_version:,
+        # Header param: Idempotency key for safely retrying a write request. Reuse the
+        # same value when retrying the same logical operation to avoid creating duplicate
+        # side effects.
         idempotency_key: nil,
-        # Header param: API version to use for this request.
-        method_version: nil,
         request_options: {}
       )
       end
 
-      # Returns the Entity associated with the ID.
+      # Returns a single entity by its identifier.
       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(MethodRuby::Models::EntityRetrieveResponse)
       end
       def retrieve(
-        # Entity identifier
-        ent_id,
-        # API version to use for this request.
-        method_version: nil,
+        # Path param: Unique identifier for the entity.
+        entity_id,
+        # Header param: API version to use for this request. This spec targets
+        # `2025-12-01`. The SDK sets this header automatically.
+        method_version:,
+        # Query param: 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
 
-      # Updates an Entity with the provided data.
+      # Updates an existing entity.
       sig do
         params(
-          ent_id: String,
+          entity_id: String,
+          method_version:
+            MethodRuby::EntityUpdateParams::MethodVersion::OrSymbol,
           address: MethodRuby::Address::OrHash,
-          corporation: MethodRuby::EntityCorporation::OrHash,
-          individual: MethodRuby::EntityIndividual::OrHash,
+          corporation: MethodRuby::EntityUpdateParams::Corporation::OrHash,
+          individual: MethodRuby::EntityUpdateParams::Individual::OrHash,
           metadata: T.nilable(T::Hash[Symbol, T.anything]),
           idempotency_key: String,
-          method_version:
-            MethodRuby::EntityUpdateParams::MethodVersion::OrSymbol,
           request_options: MethodRuby::RequestOptions::OrHash
         ).returns(MethodRuby::Models::EntityUpdateResponse)
       end
       def update(
-        # Path param: Entity identifier
-        ent_id,
-        # Body param
+        # Path param: Unique identifier for the entity.
+        entity_id,
+        # Header param: API version to use for this request. This spec targets
+        # `2025-12-01`. The SDK sets this header automatically.
+        method_version:,
+        # Body param: Postal mailing address.
         address: nil,
         # Body param
         corporation: nil,
         # Body param
         individual: nil,
-        # Body param: Custom metadata associated with the resource
+        # Body param: Arbitrary key-value metadata attached to the resource.
         metadata: nil,
-        # Header param: Unique key to ensure idempotent requests.
+        # Header param: Idempotency key for safely retrying a write request. Reuse the
+        # same value when retrying the same logical operation to avoid creating duplicate
+        # side effects.
         idempotency_key: nil,
-        # Header param: API version to use for this request.
-        method_version: nil,
         request_options: {}
       )
       end
 
-      # Returns all entities associated with your team.
+      # Returns a paginated list of entities.
       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(MethodRuby::Models::EntityListResponse)
       end
       def list(
-        # Query param
+        # Header param: API version to use for this request. This spec targets
+        # `2025-12-01`. The SDK sets this header automatically.
+        method_version:,
+        # Query param: Expand related entity resources inline. Supports the entity
+        # expandable fields documented by the API validator for entity list and retrieve
+        # operations.
+        expand: nil,
+        # Query param: Filter results from this date (inclusive, YYYY-MM-DD format).
         from_date: nil,
-        # Query param
+        # Query param: Filter entities by their name.
+        name: nil,
+        # Query param: Page number for pagination (1-indexed).
         page: nil,
-        # Query param
+        # Query param: Cursor for cursor-based pagination. Use the value from
+        # `Pagination-Page-Cursor-Next` or `Pagination-Page-Cursor-Prev` response headers.
         page_cursor: nil,
-        # Query param
+        # Query param: Number of items per page.
         page_limit: nil,
-        # Query param
+        # Query param: Filter entities by status.
+        status: nil,
+        # Query param: Filter results to this date (inclusive, YYYY-MM-DD format).
         to_date: nil,
-        # Header param: API version to use for this request.
-        method_version: nil,
+        # Query param: Filter entities by type.
+        type: nil,
         request_options: {}
       )
       end

data/rbi/method_ruby/resources/events.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module MethodRuby
+  module Resources
+    # Webhook event log
+    class Events
+      # Returns a single event by its identifier.
+      sig do
+        params(
+          evt_id: String,
+          method_version:
+            MethodRuby::EventRetrieveParams::MethodVersion::OrSymbol,
+          request_options: MethodRuby::RequestOptions::OrHash
+        ).returns(MethodRuby::Models::EventRetrieveResponse)
+      end
+      def retrieve(
+        # Unique identifier for the event.
+        evt_id,
+        # API version to use for this request. This spec targets `2025-12-01`. The SDK
+        # sets this header automatically.
+        method_version:,
+        request_options: {}
+      )
+      end
+
+      # Returns a paginated list of webhook event records.
+      sig do
+        params(
+          method_version: MethodRuby::EventListParams::MethodVersion::OrSymbol,
+          from_date: Date,
+          page: Integer,
+          page_cursor: String,
+          page_limit: Integer,
+          to_date: Date,
+          type: String,
+          request_options: MethodRuby::RequestOptions::OrHash
+        ).returns(MethodRuby::Models::EventListResponse)
+      end
+      def list(
+        # Header param: API version to use for this request. This spec targets
+        # `2025-12-01`. The SDK sets this header automatically.
+        method_version:,
+        # Query param: Filter results from this date (inclusive, YYYY-MM-DD format).
+        from_date: nil,
+        # Query param: Page number for pagination (1-indexed).
+        page: nil,
+        # Query param: Cursor for cursor-based pagination. Use the value from
+        # `Pagination-Page-Cursor-Next` or `Pagination-Page-Cursor-Prev` response headers.
+        page_cursor: nil,
+        # Query param: Number of items per page.
+        page_limit: nil,
+        # Query param: Filter results to this date (inclusive, YYYY-MM-DD format).
+        to_date: nil,
+        # Query param: Filter events by event type.
+        type: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: MethodRuby::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end