Class: FinchAPI::Models::Sandbox::ConnectionCreateResponse

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/finch-api/models/sandbox/connection_create_response.rb

Defined Under Namespace

Modules: AuthenticationType

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(access_token:, account_id:, authentication_type:, company_id:, connection_id:, products:, provider_id:, token_type: nil) ⇒ ConnectionCreateResponse

Returns a new instance of ConnectionCreateResponse.

Parameters:



10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/finch-api/models/sandbox/connection_create_response.rb', line 10

def initialize(
  access_token:,
  account_id:,
  authentication_type:,
  company_id:,
  connection_id:,
  products:,
  provider_id:,
  token_type: nil,
  **
)
  super
end

Instance Attribute Details

#access_token ⇒ String

Returns:

  • (String) 


10
 
# File 'lib/finch-api/models/sandbox/connection_create_response.rb', line 10

required :access_token, String

#account_id ⇒ String

DEPRECATED

Use ‘connection_id` to associate a connection with an access token

Returns:

  • (String) 


16
 
# File 'lib/finch-api/models/sandbox/connection_create_response.rb', line 16

required :account_id, String

#authentication_type ⇒ Symbol, FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType

Returns:



21
22
 
# File 'lib/finch-api/models/sandbox/connection_create_response.rb', line 21

required :authentication_type,
enum: -> { FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType }

#company_id ⇒ String

DEPRECATED

Use ‘connection_id` to associate a connection with an access token

Returns:

  • (String) 


28
 
# File 'lib/finch-api/models/sandbox/connection_create_response.rb', line 28

required :company_id, String

#connection_id ⇒ String

The ID of the new connection

Returns:

  • (String) 


34
 
# File 'lib/finch-api/models/sandbox/connection_create_response.rb', line 34

required :connection_id, String

#products ⇒ Array<String>

Returns:

  • (Array<String>) 


39
 
# File 'lib/finch-api/models/sandbox/connection_create_response.rb', line 39

required :products, FinchAPI::ArrayOf[String]

#provider_id ⇒ String

The ID of the provider associated with the ‘access_token`.

Returns:

  • (String) 


45
 
# File 'lib/finch-api/models/sandbox/connection_create_response.rb', line 45

required :provider_id, String

#token_type ⇒ String?

Returns:

  • (String, nil) 


50
 
# File 'lib/finch-api/models/sandbox/connection_create_response.rb', line 50

optional :token_type, String