Class: FinchAPI::Models::Connect::SessionNewParams

Inherits:

BaseModel

• Object
• BaseModel
• FinchAPI::Models::Connect::SessionNewParams

Includes:

RequestParameters

Defined in:

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

Defined Under Namespace

Modules: Product, Sandbox Classes: Integration

Instance Attribute Summary

• #customer_email ⇒ String^?
• #customer_id ⇒ String
• #customer_name ⇒ String
• #integration ⇒ FinchAPI::Models::Connect::SessionNewParams::Integration^?
• #manual ⇒ Boolean^?
• #minutes_to_expire ⇒ Float^?

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

• #products ⇒ Array<Symbol, FinchAPI::Models::Connect::SessionNewParams::Product>
• #redirect_uri ⇒ String^?
• #sandbox ⇒ Symbol, ...

Attributes included from RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(customer_id:, customer_name:, products:, customer_email: nil, integration: nil, manual: nil, minutes_to_expire: nil, redirect_uri: nil, sandbox: nil, request_options: {}) ⇒ SessionNewParams constructor

  A new instance of SessionNewParams.

Methods included from RequestParameters

included

Methods inherited from BaseModel

==, #==, #[], coerce, #deconstruct_keys, dump, fields, #inspect, known_fields, optional, required, #to_h

Methods included from Converter

#coerce, coerce, #dump, dump, type_info

Constructor Details

#initialize(customer_id:, customer_name:, products:, customer_email: nil, integration: nil, manual: nil, minutes_to_expire: nil, redirect_uri: nil, sandbox: nil, request_options: {}) ⇒ SessionNewParams

Returns a new instance of SessionNewParams.

Parameters:

• customer_id (String)
• customer_name (String)
• products (Array<Symbol, FinchAPI::Models::Connect::SessionNewParams::Product>)
• customer_email (String, nil) (defaults to: nil)
• integration (FinchAPI::Models::Connect::SessionNewParams::Integration, nil) (defaults to: nil)
• manual (Boolean, nil) (defaults to: nil)
• minutes_to_expire (Float, nil) (defaults to: nil)
• redirect_uri (String, nil) (defaults to: nil)
• sandbox (Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil) (defaults to: nil)
• request_options (FinchAPI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/finch-api/models/connect/session_new_params.rb', line 12

def initialize(
  customer_id:,
  customer_name:,
  products:,
  customer_email: nil,
  integration: nil,
  manual: nil,
  minutes_to_expire: nil,
  redirect_uri: nil,
  sandbox: nil,
  request_options: {},
  **
)
  super
end

Instance Attribute Details

#customer_email ⇒ String^?

Returns:

• (String, nil)

# File 'lib/finch-api/models/connect/session_new_params.rb', line 29

optional :customer_email, String, nil?: true

#customer_id ⇒ String

Returns:

• (String)

# File 'lib/finch-api/models/connect/session_new_params.rb', line 14

required :customer_id, String

#customer_name ⇒ String

Returns:

• (String)

# File 'lib/finch-api/models/connect/session_new_params.rb', line 19

required :customer_name, String

#integration ⇒ FinchAPI::Models::Connect::SessionNewParams::Integration^?

Returns:

• (FinchAPI::Models::Connect::SessionNewParams::Integration, nil)

# File 'lib/finch-api/models/connect/session_new_params.rb', line 34

optional :integration, -> { FinchAPI::Models::Connect::SessionNewParams::Integration }, nil?: true

#manual ⇒ Boolean^?

Returns:

• (Boolean, nil)

# File 'lib/finch-api/models/connect/session_new_params.rb', line 39

optional :manual, FinchAPI::BooleanModel, nil?: true

#minutes_to_expire ⇒ Float^?

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

days)

Returns:

• (Float, nil)

# File 'lib/finch-api/models/connect/session_new_params.rb', line 46

optional :minutes_to_expire, Float, nil?: true

#products ⇒ Array<Symbol, FinchAPI::Models::Connect::SessionNewParams::Product>

Returns:

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

# File 'lib/finch-api/models/connect/session_new_params.rb', line 24

required :products, -> { FinchAPI::ArrayOf[enum: FinchAPI::Models::Connect::SessionNewParams::Product] }

#redirect_uri ⇒ String^?

Returns:

• (String, nil)

# File 'lib/finch-api/models/connect/session_new_params.rb', line 51

optional :redirect_uri, String, nil?: true

#sandbox ⇒ Symbol, ...

Returns:

• (Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil)

# File 'lib/finch-api/models/connect/session_new_params.rb', line 56

optional :sandbox, enum: -> { FinchAPI::Models::Connect::SessionNewParams::Sandbox }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/finch-api/models/connect/session_new_params.rb', line 2

def self.values; end