Class: Hanko::Api::Public::Flow

Inherits:

Object

• Object
• Hanko::Api::Public::Flow

Defined in:

lib/hanko/api/public/flow.rb

Overview

Public resource for initiating authentication and profile flows.

Instance Method Summary

• #initialize(connection) ⇒ Flow constructor

  Initialize the flow resource.

• #login(**params) ⇒ FlowResponse

  Initiate a login flow.

• #profile(**params) ⇒ FlowResponse

  Initiate a profile management flow.

• #registration(**params) ⇒ FlowResponse

  Initiate a registration flow.

Constructor Details

#initialize(connection) ⇒ Flow

Initialize the flow resource.

Parameters:

• connection (Hanko::Connection) —

  the HTTP connection to use

# File 'lib/hanko/api/public/flow.rb', line 12

def initialize(connection)
  @connection = connection
end

Instance Method Details

#login(**params) ⇒ FlowResponse

Initiate a login flow.

Parameters:

• params (Hash) —

  optional parameters for the login flow

Returns:

• (FlowResponse) —

  the login flow response

# File 'lib/hanko/api/public/flow.rb', line 20

def login(**params)
  post_flow('/login', params)
end

#profile(**params) ⇒ FlowResponse

Initiate a profile management flow.

Parameters:

• params (Hash) —

  optional parameters for the profile flow

Returns:

• (FlowResponse) —

  the profile flow response

# File 'lib/hanko/api/public/flow.rb', line 36

def profile(**params)
  post_flow('/profile', params)
end

#registration(**params) ⇒ FlowResponse

Initiate a registration flow.

Parameters:

• params (Hash) —

  optional parameters for the registration flow

Returns:

• (FlowResponse) —

  the registration flow response

# File 'lib/hanko/api/public/flow.rb', line 28

def registration(**params)
  post_flow('/registration', params)
end