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

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/finch_api/models/sandbox/connection_create_response.rb

Overview

See Also:

Defined Under Namespace

Modules: AuthenticationType

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

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

Parameters:

  • access_token (String) (defaults to: )
  • account_id (String) (defaults to: ) —
    DEPRECATED

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

  • authentication_type (Symbol, FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType) (defaults to: )
  • company_id (String) (defaults to: ) —
    DEPRECATED

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

  • connection_id (String) (defaults to: ) —

    The ID of the new connection

  • products (Array<String>) (defaults to: )
  • provider_id (String) (defaults to: ) —

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

  • token_type (String) (defaults to: nil) 



# File 'lib/finch_api/models/sandbox/connection_create_response.rb', line 57

Instance Attribute Details

#access_token ⇒ String

Returns:

  • (String) 


11
 
# File 'lib/finch_api/models/sandbox/connection_create_response.rb', line 11

required :access_token, String

#account_id ⇒ String

Deprecated.
DEPRECATED

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

Returns:

  • (String) 


19
 
# File 'lib/finch_api/models/sandbox/connection_create_response.rb', line 19

required :account_id, String

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

Returns:



24
25
 
# File 'lib/finch_api/models/sandbox/connection_create_response.rb', line 24

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

#company_id ⇒ String

Deprecated.
DEPRECATED

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

Returns:

  • (String) 


33
 
# File 'lib/finch_api/models/sandbox/connection_create_response.rb', line 33

required :company_id, String

#connection_id ⇒ String

The ID of the new connection

Returns:

  • (String) 


39
 
# File 'lib/finch_api/models/sandbox/connection_create_response.rb', line 39

required :connection_id, String

#products ⇒ Array<String>

Returns:

  • (Array<String>) 


44
 
# File 'lib/finch_api/models/sandbox/connection_create_response.rb', line 44

required :products, FinchAPI::Internal::Type::ArrayOf[String]

#provider_id ⇒ String

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

Returns:

  • (String) 


50
 
# File 'lib/finch_api/models/sandbox/connection_create_response.rb', line 50

required :provider_id, String

#token_type ⇒ String?

Returns:

  • (String, nil) 


55
 
# File 'lib/finch_api/models/sandbox/connection_create_response.rb', line 55

optional :token_type, String