Class: Increase::Resources::Simulations::EntityOnboardingSessions

Inherits:
Object
  • Object
show all
Defined in:
lib/increase/resources/simulations/entity_onboarding_sessions.rb,
sig/increase/resources/simulations/entity_onboarding_sessions.rbs

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ EntityOnboardingSessions

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

Parameters:



33
34
35
 
# File 'lib/increase/resources/simulations/entity_onboarding_sessions.rb', line 33

def initialize(client:)
  @client = client
end

Instance Method Details

#submit(entity_onboarding_session_id, request_options: {}) ⇒ Increase::Models::EntityOnboardingSession

Simulates the submission of an Entity Onboarding Session. This session must have a status of active. After submission, the session will transition to expired and a new Entity will be created.

Parameters:

  • entity_onboarding_session_id (String) —

    The identifier of the Entity Onboarding Session you wish to submit.

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

Returns:

See Also:



21
22
23
24
25
26
27
28
 
# File 'lib/increase/resources/simulations/entity_onboarding_sessions.rb', line 21

def submit(entity_onboarding_session_id, params = {})
  @client.request(
    method: :post,
    path: ["simulations/entity_onboarding_sessions/%1$s/submit", entity_onboarding_session_id],
    model: Increase::EntityOnboardingSession,
    options: params[:request_options]
  )
end