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.

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

  Set the status for an [Entity’s validation](/documentation/api/entities#entity-object.validation).

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 40

def initialize(client:)
  @client = client
end

Instance Method Details

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

Set the status for an [Entity’s validation](/documentation/api/entities#entity-object.validation). In production, Know Your Customer validations [run automatically](/documentation/entity-validation#entity-validation). While developing, it can be helpful to override the behavior in Sandbox.

Parameters:

• entity_id (String) —

  The identifier of the Entity whose validation status to update.

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

  The validation issues to attach. Only allowed when ‘status` is `invalid`.

• status (Symbol, Increase::Models::Simulations::EntityValidationParams::Status) —

  The validation status to set on the Entity.

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

Returns:

• (Increase::Models::Entity)

See Also:

• Models::Simulations::EntityValidationParams

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

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