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

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/finch_api/models/connect/session_new_params.rb

Defined Under Namespace

Modules: AuthMethod

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(auth_method: , provider: ) ⇒ Object

Integration configuration for the connect session

Parameters:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/finch_api/models/connect/session_new_params.rb', line 91

class Integration < FinchAPI::Internal::Type::BaseModel
  # @!attribute auth_method
  #   The authentication method to use
  #
  #   @return [Symbol, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod, nil]
  required :auth_method,
           enum: -> { FinchAPI::Connect::SessionNewParams::Integration::AuthMethod },
           nil?: true

  # @!attribute provider
  #   The provider to integrate with
  #
  #   @return [String, nil]
  required :provider, String, nil?: true

  # @!method initialize(auth_method:, provider:)
  #   Integration configuration for the connect session
  #
  #   @param auth_method [Symbol, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod, nil] The authentication method to use
  #
  #   @param provider [String, nil] The provider to integrate with

  # The authentication method to use
  #
  # @see FinchAPI::Models::Connect::SessionNewParams::Integration#auth_method
  module AuthMethod
    extend FinchAPI::Internal::Type::Enum

    ASSISTED = :assisted
    CREDENTIAL = :credential
    OAUTH = :oauth
    API_TOKEN = :api_token

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#auth_method ⇒ Symbol, ...

The authentication method to use

Returns:



96
97
98
 
# File 'lib/finch_api/models/connect/session_new_params.rb', line 96

required :auth_method,
enum: -> { FinchAPI::Connect::SessionNewParams::Integration::AuthMethod },
nil?: true

#provider ⇒ String?

The provider to integrate with

Returns:

  • (String, nil) 


104
 
# File 'lib/finch_api/models/connect/session_new_params.rb', line 104

required :provider, String, nil?: true