Class: Increase::Resources::Simulations::Entities

Inherits:

Object

• Object
• Increase::Resources::Simulations::Entities

Defined in:

lib/increase/resources/simulations/entities.rb

Instance Method Summary

• #initialize(client:) ⇒ Entities constructor private

  A new instance of Entities.

• #update_validation(entity_id, issues:, request_options: {}) ⇒ Increase::Models::Entity

  Some parameter documentations has been truncated, see Models::Simulations::EntityUpdateValidationParams for more details.

Constructor Details

#initialize(client:) ⇒ Entities

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 Entities.

Parameters:

• client (Increase::Client)

# File 'lib/increase/resources/simulations/entities.rb', line 42

def initialize(client:)
  @client = client
end

Instance Method Details

#update_validation(entity_id, issues:, request_options: {}) ⇒ Increase::Models::Entity

Some parameter documentations has been truncated, see Models::Simulations::EntityUpdateValidationParams for more details.

Simulate updates to an [Entity’s validation](/documentation/api/entities#entity-object.validation). In production, Know Your Customer validations [run automatically](/documentation/entity-validation#entity-validation) for eligible programs. While developing, use this API to simulate issues with information submissions.

Parameters:

• entity_id (String) —

  The identifier of the Entity whose validation status to update.

• issues (Array<Increase::Models::Simulations::EntityUpdateValidationParams::Issue>) —

  The validation issues to attach. If no issues are provided, the validation statu

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

Returns:

• (Increase::Models::Entity)

See Also:

• Models::Simulations::EntityUpdateValidationParams

# File 'lib/increase/resources/simulations/entities.rb', line 28

def update_validation(entity_id, params)
  parsed, options = Increase::Simulations::EntityUpdateValidationParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["simulations/entities/%1$s/update_validation", entity_id],
    body: parsed,
    model: Increase::Entity,
    options: options
  )
end