Class: FinchAPI::Models::Sandbox::ConnectionCreateParams

Inherits:

BaseModel

• Object
• FinchAPI::Models::Sandbox::ConnectionCreateParams

Includes:

Type::RequestParameters

Defined in:

lib/finch-api/models/sandbox/connection_create_params.rb

Defined Under Namespace

Modules: AuthenticationType

Instance Attribute Summary

• #authentication_type ⇒ Symbol, ...
• #employee_size ⇒ Integer^?

  Optional: the size of the employer to be created with this connection.

• #products ⇒ Array<String>^?
• #provider_id ⇒ String

  The provider associated with the connection.

Attributes included from Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(provider_id:, authentication_type: nil, employee_size: nil, products: nil, request_options: {}) ⇒ ConnectionCreateParams constructor

  A new instance of ConnectionCreateParams.

Methods included from Type::RequestParameters

included

Constructor Details

#initialize(provider_id:, authentication_type: nil, employee_size: nil, products: nil, request_options: {}) ⇒ ConnectionCreateParams

Returns a new instance of ConnectionCreateParams.

Parameters:

• provider_id (String)
• authentication_type (Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType) (defaults to: nil)
• employee_size (Integer) (defaults to: nil)
• products (Array<String>) (defaults to: nil)
• request_options (FinchAPI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/finch-api/models/sandbox/connection_create_params.rb', line 7

def initialize(provider_id:, authentication_type: nil, employee_size: nil, products: nil, request_options: {}, **) = super

Instance Attribute Details

#authentication_type ⇒ Symbol, ...

Returns:

• (Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType, nil)

# File 'lib/finch-api/models/sandbox/connection_create_params.rb', line 20

optional :authentication_type,
enum: -> { FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType }

#employee_size ⇒ Integer^?

Optional: the size of the employer to be created with this connection. Defaults

to 20. Note that if this is higher than 100, historical payroll data will not be
generated, and instead only one pay period will be created.

Returns:

• (Integer, nil)

# File 'lib/finch-api/models/sandbox/connection_create_params.rb', line 33

optional :employee_size, Integer

#products ⇒ Array<String>^?

Returns:

• (Array<String>, nil)

# File 'lib/finch-api/models/sandbox/connection_create_params.rb', line 42

optional :products, FinchAPI::ArrayOf[String]

#provider_id ⇒ String

The provider associated with the connection

Returns:

• (String)

# File 'lib/finch-api/models/sandbox/connection_create_params.rb', line 15

required :provider_id, String