Class: MethodRuby::Resources::Simulate::Entities::CreditScores

Inherits:
Object
  • Object
show all
Defined in:
lib/method_ruby/resources/simulate/entities/credit_scores.rb

Overview

Sandbox entity simulation

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ CreditScores

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of CreditScores.

Parameters:



57
58
59
 
# File 'lib/method_ruby/resources/simulate/entities/credit_scores.rb', line 57

def initialize(client:)
  @client = client
end

Instance Method Details

#create(crs_id, entity_id:, score:, method_version:, status: nil, request_options: {}) ⇒ MethodRuby::Models::Simulate::Entities::CreditScoreCreateResponse

Some parameter documentations has been truncated, see Models::Simulate::Entities::CreditScoreCreateParams for more details.

Simulates a credit score result for an entity in the sandbox environment. Use this to test credit score retrieval flows during development.

**Development only** - This endpoint is only available in the sandbox environment.

Parameters:

  • crs_id (String) —

    Path param: Unique identifier for the credit score resource.

  • entity_id (String) —

    Path param: Unique identifier for the entity.

  • score (Integer) —

    Body param: The credit score value to simulate.

  • method_version (Symbol, MethodRuby::Models::Simulate::Entities::CreditScoreCreateParams::MethodVersion) —

    Header param: API version to use for this request. This spec targets ‘2025-12-01

  • status (String) —

    Body param: The status to set on the credit score resource.

  • request_options (MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/method_ruby/resources/simulate/entities/credit_scores.rb', line 36

def create(crs_id, params)
  parsed, options = MethodRuby::Simulate::Entities::CreditScoreCreateParams.dump_request(params)
  entity_id =
    parsed.delete(:entity_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  header_params = {method_version: "method-version"}
  @client.request(
    method: :post,
    path: ["simulate/entities/%1$s/credit_scores/%2$s", entity_id, crs_id],
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: MethodRuby::Models::Simulate::Entities::CreditScoreCreateResponse,
    security: {secret_key: true},
    options: options
  )
end