Class: Increase::Models::EntityOnboardingSessionCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/increase/models/entity_onboarding_session_create_params.rb,
sig/increase/models/entity_onboarding_session_create_params.rbs

Overview

See Also:

  • Increase::Resources::EntityOnboardingSessions#create

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(program_id:, redirect_url:, entity_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::EntityOnboardingSessionCreateParams for more details.

Parameters:

  • program_id (String) —

    The identifier of the Program the Entity will be onboarded to.

  • redirect_url (String) —

    The URL to redirect the customer to after they complete the onboarding form. The

  • entity_id (String) (defaults to: nil) —

    The identifier of an existing Entity to associate with the onboarding session. I

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



# File 'lib/increase/models/entity_onboarding_session_create_params.rb', line 32

Instance Attribute Details

#entity_id ⇒ String?

The identifier of an existing Entity to associate with the onboarding session. If provided, the onboarding form will display any outstanding tasks required to complete the Entity's onboarding.

Parameters:

  • (String)

Returns:

  • (String, nil) 


30
 
# File 'lib/increase/models/entity_onboarding_session_create_params.rb', line 30

optional :entity_id, String

#program_id ⇒ String

The identifier of the Program the Entity will be onboarded to.

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/increase/models/entity_onboarding_session_create_params.rb', line 14

required :program_id, String

#redirect_url ⇒ String

The URL to redirect the customer to after they complete the onboarding form. The redirect will include entity_onboarding_session_id and entity_id query parameters.

Parameters:

  • value (String)

Returns:

  • (String) 


22
 
# File 'lib/increase/models/entity_onboarding_session_create_params.rb', line 22

required :redirect_url, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


26
 
# File 'sig/increase/models/entity_onboarding_session_create_params.rbs', line 26

def to_hash: -> {