Class: FinchAPI::Models::Connect::SessionReauthenticateParams

Inherits:

BaseModel

• Object
• FinchAPI::Models::Connect::SessionReauthenticateParams

Includes:

Type::RequestParameters

Defined in:

lib/finch-api/models/connect/session_reauthenticate_params.rb

Defined Under Namespace

Modules: Product

Instance Attribute Summary

• #connection_id ⇒ String

  The ID of the existing connection to reauthenticate.

• #minutes_to_expire ⇒ Integer^?

  The number of minutes until the session expires (defaults to 43,200, which is 30 days).

• #products ⇒ Array<Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product>^?

  The products to request access to (optional for reauthentication).

• #redirect_uri ⇒ String^?

  The URI to redirect to after the Connect flow is completed.

Attributes included from Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(connection_id:, minutes_to_expire: nil, products: nil, redirect_uri: nil, request_options: {}) ⇒ SessionReauthenticateParams constructor

  A new instance of SessionReauthenticateParams.

Methods included from Type::RequestParameters

included

Constructor Details

#initialize(connection_id:, minutes_to_expire: nil, products: nil, redirect_uri: nil, request_options: {}) ⇒ SessionReauthenticateParams

Returns a new instance of SessionReauthenticateParams.

Parameters:

• connection_id (String)
• minutes_to_expire (Integer, nil) (defaults to: nil)
• products (Array<Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product>, nil) (defaults to: nil)
• redirect_uri (String, nil) (defaults to: nil)
• request_options (FinchAPI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/finch-api/models/connect/session_reauthenticate_params.rb', line 7

def initialize(connection_id:, minutes_to_expire: nil, products: nil, redirect_uri: nil, request_options: {}, **) = super

Instance Attribute Details

#connection_id ⇒ String

The ID of the existing connection to reauthenticate

Returns:

• (String)

# File 'lib/finch-api/models/connect/session_reauthenticate_params.rb', line 15

required :connection_id, String

#minutes_to_expire ⇒ Integer^?

The number of minutes until the session expires (defaults to 43,200, which is 30

days)

Returns:

• (Integer, nil)

# File 'lib/finch-api/models/connect/session_reauthenticate_params.rb', line 22

optional :minutes_to_expire, Integer, nil?: true

#products ⇒ Array<Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product>^?

The products to request access to (optional for reauthentication)

Returns:

• (Array<Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product>, nil)

# File 'lib/finch-api/models/connect/session_reauthenticate_params.rb', line 28

optional :products,
-> { FinchAPI::ArrayOf[enum: FinchAPI::Models::Connect::SessionReauthenticateParams::Product] },
nil?: true

#redirect_uri ⇒ String^?

The URI to redirect to after the Connect flow is completed

Returns:

• (String, nil)

# File 'lib/finch-api/models/connect/session_reauthenticate_params.rb', line 36

optional :redirect_uri, String, nil?: true