Class: Increase::Resources::EntityOnboardingSessions

Inherits:
Object
  • Object
show all
Defined in:
lib/increase/resources/entity_onboarding_sessions.rb,
sig/increase/resources/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:



117
118
119
 
# File 'lib/increase/resources/entity_onboarding_sessions.rb', line 117

def initialize(client:)
  @client = client
end

Instance Method Details

#create(program_id:, redirect_url:, entity_id: nil, request_options: {}) ⇒ Increase::Models::EntityOnboardingSession

Create an Entity Onboarding Session

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 redirect will include entity_onboarding_session_id and entity_id query parameters.

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

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

Returns:

See Also:



27
28
29
30
31
32
33
34
35
36
 
# File 'lib/increase/resources/entity_onboarding_sessions.rb', line 27

def create(params)
  parsed, options = Increase::EntityOnboardingSessionCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "entity_onboarding_sessions",
    body: parsed,
    model: Increase::EntityOnboardingSession,
    options: options
  )
end

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

Expire an Entity Onboarding Session

Parameters:

  • entity_onboarding_session_id (String) —

    The identifier of the Entity Onboarding Session to expire.

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

Returns:

See Also:



105
106
107
108
109
110
111
112
 
# File 'lib/increase/resources/entity_onboarding_sessions.rb', line 105

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

#list(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::EntityOnboardingSession>

List Entity Onboarding Session

Parameters:

  • cursor (String) —

    Return the page of entries after this one.

  • idempotency_key (String) —

    Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

  • limit (Integer) —

    Limit the size of the list that is returned. The default (and maximum) is 100 objects.

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

Returns:

See Also:



81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/increase/resources/entity_onboarding_sessions.rb', line 81

def list(params = {})
  parsed, options = Increase::EntityOnboardingSessionListParams.dump_request(params)
  query = Increase::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "entity_onboarding_sessions",
    query: query,
    page: Increase::Internal::Page,
    model: Increase::EntityOnboardingSession,
    options: options
  )
end

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

Retrieve an Entity Onboarding Session

Parameters:

  • entity_onboarding_session_id (String) —

    The identifier of the Entity Onboarding Session.

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

Returns:

See Also:



49
50
51
52
53
54
55
56
 
# File 'lib/increase/resources/entity_onboarding_sessions.rb', line 49

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