Class: FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse

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

Defined Under Namespace

Modules: AuthenticationType

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(account_id:, authentication_type:, company_id:, products:, provider_id:, connection_id: nil) ⇒ AccountUpdateResponse

Returns a new instance of AccountUpdateResponse.

Parameters:



8
 
# File 'lib/finch-api/models/sandbox/connections/account_update_response.rb', line 8

def initialize(account_id:, authentication_type:, company_id:, products:, provider_id:, connection_id: nil, **) = super

Instance Attribute Details

#account_id ⇒ String

DEPRECATED

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

Returns:

  • (String) 


12
 
# File 'lib/finch-api/models/sandbox/connections/account_update_response.rb', line 12

required :account_id, String

#authentication_type ⇒ Symbol, FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType

Returns:



17
18
 
# File 'lib/finch-api/models/sandbox/connections/account_update_response.rb', line 17

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

#company_id ⇒ String

DEPRECATED

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

Returns:

  • (String) 


24
 
# File 'lib/finch-api/models/sandbox/connections/account_update_response.rb', line 24

required :company_id, String

#connection_id ⇒ String?

The ID of the new connection

Returns:

  • (String, nil) 


41
 
# File 'lib/finch-api/models/sandbox/connections/account_update_response.rb', line 41

optional :connection_id, String

#products ⇒ Array<String>

Returns:

  • (Array<String>) 


29
 
# File 'lib/finch-api/models/sandbox/connections/account_update_response.rb', line 29

required :products, FinchAPI::ArrayOf[String]

#provider_id ⇒ String

The ID of the provider associated with the ‘access_token`

Returns:

  • (String) 


35
 
# File 'lib/finch-api/models/sandbox/connections/account_update_response.rb', line 35

required :provider_id, String