Class: Cadenya::Models::WidgetSessionCreateParams::Secret

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/cadenya/models/widget_session_create_params.rb,
sig/cadenya/models/widget_session_create_params.rbs

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(name: nil, value: nil) ⇒ Secret

Secret is a named credential attached to the session — typically a token the customer's backend minted for the visitor, so the agent acts against their API as that subject. Values are captured at the boundary, encrypted at rest, appended to every conversation the session creates (re-synced on each turn), and never returned by any API. Session secrets take precedence over workspace and tool-set secrets of the same name.

Parameters:

  • name (String) (defaults to: nil)
  • value (String) (defaults to: nil)
  • name: (String) (defaults to: nil)
  • value: (String) (defaults to: nil) 


49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/cadenya/models/widget_session_create_params.rb', line 49

class Secret < Cadenya::Internal::Type::BaseModel
  # @!attribute name
  #
  #   @return [String, nil]
  optional :name, String

  # @!attribute value
  #
  #   @return [String, nil]
  optional :value, String

  # @!method initialize(name: nil, value: nil)
  #   Secret is a named credential attached to the session — typically a token the
  #   customer's backend minted for the visitor, so the agent acts against their API
  #   as that subject. Values are captured at the boundary, encrypted at rest,
  #   appended to every conversation the session creates (re-synced on each turn), and
  #   never returned by any API. Session secrets take precedence over workspace and
  #   tool-set secrets of the same name.
  #
  #   @param name [String]
  #   @param value [String]
end

Instance Attribute Details

#name ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


53
 
# File 'lib/cadenya/models/widget_session_create_params.rb', line 53

optional :name, String

#value ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


58
 
# File 'lib/cadenya/models/widget_session_create_params.rb', line 58

optional :value, String

Instance Method Details

#to_hash ⇒ { name: String, value: String }

Returns:

  • ({ name: String, value: String }) 


63
 
# File 'sig/cadenya/models/widget_session_create_params.rbs', line 63

def to_hash: -> { name: String, value: String }