method-ruby 0.1.0 → 0.2.0

data/lib/method_ruby/resources/entities/attributes.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Resources
+    class Entities
+      # Attribute data for entities
+      class Attributes
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::AttributeCreateParams} for more details.
+        #
+        # Creates a new attribute retrieval for the specified entity.
+        #
+        # @overload create(entity_id, method_version:, attributes: nil, idempotency_key: nil, request_options: {})
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::AttributeCreateParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param attributes [Array<String>] Body param: Specific attributes to request.
+        #
+        # @param idempotency_key [String] Header param: Idempotency key for safely retrying a write request. Reuse the sam
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::AttributeCreateResponse]
+        #
+        # @see MethodRuby::Models::Entities::AttributeCreateParams
+        def create(entity_id, params)
+          parsed, options = MethodRuby::Entities::AttributeCreateParams.dump_request(params)
+          header_params = {method_version: "method-version", idempotency_key: "idempotency-key"}
+          @client.request(
+            method: :post,
+            path: ["entities/%1$s/attributes", entity_id],
+            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+            body: parsed.except(*header_params.keys),
+            model: MethodRuby::Models::Entities::AttributeCreateResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::AttributeRetrieveParams} for more details.
+        #
+        # Returns a single entity attribute by its identifier.
+        #
+        # @overload retrieve(attr_id, entity_id:, method_version:, request_options: {})
+        #
+        # @param attr_id [String] Path param: Unique identifier for the entity attribute.
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::AttributeRetrieveParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::AttributeRetrieveResponse]
+        #
+        # @see MethodRuby::Models::Entities::AttributeRetrieveParams
+        def retrieve(attr_id, params)
+          parsed, options = MethodRuby::Entities::AttributeRetrieveParams.dump_request(params)
+          entity_id =
+            parsed.delete(:entity_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["entities/%1$s/attributes/%2$s", entity_id, attr_id],
+            headers: parsed.transform_keys(method_version: "method-version"),
+            model: MethodRuby::Models::Entities::AttributeRetrieveResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::AttributeListParams} for more details.
+        #
+        # Returns a list of attributes for the specified entity.
+        #
+        # @overload list(entity_id, method_version:, from_date: nil, page: nil, page_cursor: nil, page_limit: nil, to_date: nil, request_options: {})
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::AttributeListParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param from_date [Date] Query param: Filter results from this date (inclusive, YYYY-MM-DD format).
+        #
+        # @param page [Integer] Query param: Page number for pagination (1-indexed).
+        #
+        # @param page_cursor [String] Query param: Cursor for cursor-based pagination. Use the value from `Pagination-
+        #
+        # @param page_limit [Integer] Query param: Number of items per page.
+        #
+        # @param to_date [Date] Query param: Filter results to this date (inclusive, YYYY-MM-DD format).
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::AttributeListResponse]
+        #
+        # @see MethodRuby::Models::Entities::AttributeListParams
+        def list(entity_id, params)
+          query_params = [:from_date, :page, :page_cursor, :page_limit, :to_date]
+          parsed, options = MethodRuby::Entities::AttributeListParams.dump_request(params)
+          query = MethodRuby::Internal::Util.encode_query_params(parsed.slice(*query_params))
+          @client.request(
+            method: :get,
+            path: ["entities/%1$s/attributes", entity_id],
+            query: query,
+            headers: parsed.except(*query_params).transform_keys(method_version: "method-version"),
+            model: MethodRuby::Models::Entities::AttributeListResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [MethodRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/method_ruby/resources/entities/connect.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Resources
+    class Entities
+      # Account connection sessions for entities
+      class Connect
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::ConnectCreateParams} for more details.
+        #
+        # Creates a new connect session for the specified entity.
+        #
+        # @overload create(entity_id, method_version:, expand: nil, products: nil, subscriptions: nil, idempotency_key: nil, request_options: {})
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::ConnectCreateParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param expand [Array<Symbol, MethodRuby::Models::Entities::ConnectCreateParams::Expand>] Query param: Expand connected accounts inline on entity connect resources.
+        #
+        # @param products [Array<String>] Body param: Products to request during the connect session.
+        #
+        # @param subscriptions [Array<String>] Body param: Subscriptions to request during the connect session.
+        #
+        # @param idempotency_key [String] Header param: Idempotency key for safely retrying a write request. Reuse the sam
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::ConnectCreateResponse]
+        #
+        # @see MethodRuby::Models::Entities::ConnectCreateParams
+        def create(entity_id, params)
+          query_params = [:expand]
+          header_params = {method_version: "method-version", idempotency_key: "idempotency-key"}
+          parsed, options = MethodRuby::Entities::ConnectCreateParams.dump_request(params)
+          query = MethodRuby::Internal::Util.encode_query_params(parsed.slice(*query_params))
+          @client.request(
+            method: :post,
+            path: ["entities/%1$s/connect", entity_id],
+            query: query,
+            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+            body: parsed.except(*query_params, *header_params.keys),
+            model: MethodRuby::Models::Entities::ConnectCreateResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::ConnectRetrieveParams} for more details.
+        #
+        # Returns a single entity connect session by its identifier.
+        #
+        # @overload retrieve(cxn_id, entity_id:, method_version:, expand: nil, request_options: {})
+        #
+        # @param cxn_id [String] Path param: Unique identifier for the entity connect session.
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::ConnectRetrieveParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param expand [Array<Symbol, MethodRuby::Models::Entities::ConnectRetrieveParams::Expand>] Query param: Expand connected accounts inline on entity connect resources.
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::ConnectRetrieveResponse]
+        #
+        # @see MethodRuby::Models::Entities::ConnectRetrieveParams
+        def retrieve(cxn_id, params)
+          query_params = [:expand]
+          parsed, options = MethodRuby::Entities::ConnectRetrieveParams.dump_request(params)
+          query = MethodRuby::Internal::Util.encode_query_params(parsed.slice(*query_params))
+          entity_id =
+            parsed.delete(:entity_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["entities/%1$s/connect/%2$s", entity_id, cxn_id],
+            query: query,
+            headers: parsed.except(*query_params).transform_keys(method_version: "method-version"),
+            model: MethodRuby::Models::Entities::ConnectRetrieveResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::ConnectListParams} for more details.
+        #
+        # Returns a list of connect sessions for the specified entity.
+        #
+        # @overload list(entity_id, method_version:, expand: nil, from_date: nil, page: nil, page_cursor: nil, page_limit: nil, to_date: nil, request_options: {})
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::ConnectListParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param expand [Array<Symbol, MethodRuby::Models::Entities::ConnectListParams::Expand>] Query param: Expand connected accounts inline on entity connect resources.
+        #
+        # @param from_date [Date] Query param: Filter results from this date (inclusive, YYYY-MM-DD format).
+        #
+        # @param page [Integer] Query param: Page number for pagination (1-indexed).
+        #
+        # @param page_cursor [String] Query param: Cursor for cursor-based pagination. Use the value from `Pagination-
+        #
+        # @param page_limit [Integer] Query param: Number of items per page.
+        #
+        # @param to_date [Date] Query param: Filter results to this date (inclusive, YYYY-MM-DD format).
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::ConnectListResponse]
+        #
+        # @see MethodRuby::Models::Entities::ConnectListParams
+        def list(entity_id, params)
+          query_params = [:expand, :from_date, :page, :page_cursor, :page_limit, :to_date]
+          parsed, options = MethodRuby::Entities::ConnectListParams.dump_request(params)
+          query = MethodRuby::Internal::Util.encode_query_params(parsed.slice(*query_params))
+          @client.request(
+            method: :get,
+            path: ["entities/%1$s/connect", entity_id],
+            query: query,
+            headers: parsed.except(*query_params).transform_keys(method_version: "method-version"),
+            model: MethodRuby::Models::Entities::ConnectListResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [MethodRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/method_ruby/resources/entities/consent.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Resources
+    class Entities
+      # Consent management for entities
+      class Consent
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::ConsentWithdrawParams} for more details.
+        #
+        # Grants or withdraws consent for the specified entity.
+        #
+        # @overload withdraw(entity_id, type:, method_version:, reason: nil, idempotency_key: nil, request_options: {})
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param type [Symbol, MethodRuby::Models::Entities::ConsentWithdrawParams::Type] Body param: The consent action type.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::ConsentWithdrawParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param reason [String] Body param: Optional reason for the consent action.
+        #
+        # @param idempotency_key [String] Header param: Idempotency key for safely retrying a write request. Reuse the sam
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::ConsentWithdrawResponse]
+        #
+        # @see MethodRuby::Models::Entities::ConsentWithdrawParams
+        def withdraw(entity_id, params)
+          parsed, options = MethodRuby::Entities::ConsentWithdrawParams.dump_request(params)
+          header_params = {method_version: "method-version", idempotency_key: "idempotency-key"}
+          @client.request(
+            method: :post,
+            path: ["entities/%1$s/consent", entity_id],
+            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+            body: parsed.except(*header_params.keys),
+            model: MethodRuby::Models::Entities::ConsentWithdrawResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [MethodRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/method_ruby/resources/entities/credit_scores.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Resources
+    class Entities
+      # Credit score data for entities
+      class CreditScores
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::CreditScoreCreateParams} for more details.
+        #
+        # Creates a new credit score retrieval for the specified entity.
+        #
+        # @overload create(entity_id, method_version:, idempotency_key: nil, request_options: {})
+        #
+        # @param entity_id [String] Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::CreditScoreCreateParams::MethodVersion] API version to use for this request. This spec targets `2025-12-01`.
+        #
+        # @param idempotency_key [String] Idempotency key for safely retrying a write request. Reuse the same value when
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::CreditScoreCreateResponse]
+        #
+        # @see MethodRuby::Models::Entities::CreditScoreCreateParams
+        def create(entity_id, params)
+          parsed, options = MethodRuby::Entities::CreditScoreCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["entities/%1$s/credit_scores", entity_id],
+            headers: parsed.transform_keys(
+              method_version: "method-version",
+              idempotency_key: "idempotency-key"
+            ),
+            model: MethodRuby::Models::Entities::CreditScoreCreateResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::CreditScoreRetrieveParams} for more details.
+        #
+        # Returns a single entity credit score by its identifier.
+        #
+        # @overload retrieve(crs_id, entity_id:, method_version:, request_options: {})
+        #
+        # @param crs_id [String] Path param: Unique identifier for the entity credit score.
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::CreditScoreRetrieveParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::CreditScoreRetrieveResponse]
+        #
+        # @see MethodRuby::Models::Entities::CreditScoreRetrieveParams
+        def retrieve(crs_id, params)
+          parsed, options = MethodRuby::Entities::CreditScoreRetrieveParams.dump_request(params)
+          entity_id =
+            parsed.delete(:entity_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["entities/%1$s/credit_scores/%2$s", entity_id, crs_id],
+            headers: parsed.transform_keys(method_version: "method-version"),
+            model: MethodRuby::Models::Entities::CreditScoreRetrieveResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::CreditScoreListParams} for more details.
+        #
+        # Returns a list of credit scores for the specified entity.
+        #
+        # @overload list(entity_id, method_version:, from_date: nil, page: nil, page_cursor: nil, page_limit: nil, to_date: nil, request_options: {})
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::CreditScoreListParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param from_date [Date] Query param: Filter results from this date (inclusive, YYYY-MM-DD format).
+        #
+        # @param page [Integer] Query param: Page number for pagination (1-indexed).
+        #
+        # @param page_cursor [String] Query param: Cursor for cursor-based pagination. Use the value from `Pagination-
+        #
+        # @param page_limit [Integer] Query param: Number of items per page.
+        #
+        # @param to_date [Date] Query param: Filter results to this date (inclusive, YYYY-MM-DD format).
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::CreditScoreListResponse]
+        #
+        # @see MethodRuby::Models::Entities::CreditScoreListParams
+        def list(entity_id, params)
+          query_params = [:from_date, :page, :page_cursor, :page_limit, :to_date]
+          parsed, options = MethodRuby::Entities::CreditScoreListParams.dump_request(params)
+          query = MethodRuby::Internal::Util.encode_query_params(parsed.slice(*query_params))
+          @client.request(
+            method: :get,
+            path: ["entities/%1$s/credit_scores", entity_id],
+            query: query,
+            headers: parsed.except(*query_params).transform_keys(method_version: "method-version"),
+            model: MethodRuby::Models::Entities::CreditScoreListResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [MethodRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/method_ruby/resources/entities/identities.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Resources
+    class Entities
+      # Identity verification data for entities
+      class Identities
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::IdentityCreateParams} for more details.
+        #
+        # Creates a new identity retrieval for the specified entity.
+        #
+        # @overload create(entity_id, method_version:, idempotency_key: nil, request_options: {})
+        #
+        # @param entity_id [String] Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::IdentityCreateParams::MethodVersion] API version to use for this request. This spec targets `2025-12-01`.
+        #
+        # @param idempotency_key [String] Idempotency key for safely retrying a write request. Reuse the same value when
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::IdentityCreateResponse]
+        #
+        # @see MethodRuby::Models::Entities::IdentityCreateParams
+        def create(entity_id, params)
+          parsed, options = MethodRuby::Entities::IdentityCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["entities/%1$s/identities", entity_id],
+            headers: parsed.transform_keys(
+              method_version: "method-version",
+              idempotency_key: "idempotency-key"
+            ),
+            model: MethodRuby::Models::Entities::IdentityCreateResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::IdentityRetrieveParams} for more details.
+        #
+        # Returns a single entity identity record by its identifier.
+        #
+        # @overload retrieve(idn_id, entity_id:, method_version:, request_options: {})
+        #
+        # @param idn_id [String] Path param: Unique identifier for the entity identity.
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::IdentityRetrieveParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::IdentityRetrieveResponse]
+        #
+        # @see MethodRuby::Models::Entities::IdentityRetrieveParams
+        def retrieve(idn_id, params)
+          parsed, options = MethodRuby::Entities::IdentityRetrieveParams.dump_request(params)
+          entity_id =
+            parsed.delete(:entity_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["entities/%1$s/identities/%2$s", entity_id, idn_id],
+            headers: parsed.transform_keys(method_version: "method-version"),
+            model: MethodRuby::Models::Entities::IdentityRetrieveResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::IdentityListParams} for more details.
+        #
+        # Returns a list of identity records for the specified entity.
+        #
+        # @overload list(entity_id, method_version:, from_date: nil, page: nil, page_cursor: nil, page_limit: nil, to_date: nil, request_options: {})
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::IdentityListParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param from_date [Date] Query param: Filter results from this date (inclusive, YYYY-MM-DD format).
+        #
+        # @param page [Integer] Query param: Page number for pagination (1-indexed).
+        #
+        # @param page_cursor [String] Query param: Cursor for cursor-based pagination. Use the value from `Pagination-
+        #
+        # @param page_limit [Integer] Query param: Number of items per page.
+        #
+        # @param to_date [Date] Query param: Filter results to this date (inclusive, YYYY-MM-DD format).
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::IdentityListResponse]
+        #
+        # @see MethodRuby::Models::Entities::IdentityListParams
+        def list(entity_id, params)
+          query_params = [:from_date, :page, :page_cursor, :page_limit, :to_date]
+          parsed, options = MethodRuby::Entities::IdentityListParams.dump_request(params)
+          query = MethodRuby::Internal::Util.encode_query_params(parsed.slice(*query_params))
+          @client.request(
+            method: :get,
+            path: ["entities/%1$s/identities", entity_id],
+            query: query,
+            headers: parsed.except(*query_params).transform_keys(method_version: "method-version"),
+            model: MethodRuby::Models::Entities::IdentityListResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [MethodRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/method_ruby/resources/entities/manual_connect.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Resources
+    class Entities
+      # Account connection sessions for entities
+      class ManualConnect
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::ManualConnectCreateParams} for more details.
+        #
+        # Creates a new manual connect session for the specified entity.
+        #
+        # @overload create(entity_id, bureau:, tradelines:, method_version:, idempotency_key: nil, request_options: {})
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param bureau [Symbol, MethodRuby::Models::Entities::ManualConnectCreateParams::Bureau] Body param: The credit bureau source for the manual connect session.
+        #
+        # @param tradelines [Array<MethodRuby::Models::Entities::ManualConnectCreateParams::Tradeline>] Body param: List of tradeline objects to manually connect.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::ManualConnectCreateParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param idempotency_key [String] Header param: Idempotency key for safely retrying a write request. Reuse the sam
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::ManualConnectCreateResponse]
+        #
+        # @see MethodRuby::Models::Entities::ManualConnectCreateParams
+        def create(entity_id, params)
+          parsed, options = MethodRuby::Entities::ManualConnectCreateParams.dump_request(params)
+          header_params = {method_version: "method-version", idempotency_key: "idempotency-key"}
+          @client.request(
+            method: :post,
+            path: ["entities/%1$s/manual_connect", entity_id],
+            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+            body: parsed.except(*header_params.keys),
+            model: MethodRuby::Models::Entities::ManualConnectCreateResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::ManualConnectRetrieveParams} for more details.
+        #
+        # Returns a single entity manual connect session by its identifier.
+        #
+        # @overload retrieve(mcxn_id, entity_id:, method_version:, request_options: {})
+        #
+        # @param mcxn_id [String] Path param: Unique identifier for the entity manual connect session.
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::ManualConnectRetrieveParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::ManualConnectRetrieveResponse]
+        #
+        # @see MethodRuby::Models::Entities::ManualConnectRetrieveParams
+        def retrieve(mcxn_id, params)
+          parsed, options = MethodRuby::Entities::ManualConnectRetrieveParams.dump_request(params)
+          entity_id =
+            parsed.delete(:entity_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["entities/%1$s/manual_connect/%2$s", entity_id, mcxn_id],
+            headers: parsed.transform_keys(method_version: "method-version"),
+            model: MethodRuby::Models::Entities::ManualConnectRetrieveResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [MethodRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end