Class: Cadenya::Models::Widget

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

Overview

See Also:

  • Cadenya::Resources::Widgets#create

Defined Under Namespace

Modules: State

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(metadata:, spec:, state:, info: nil) ⇒ Object

Some parameter documentations has been truncated, see Cadenya::Models::Widget for more details.

Widget is an embeddable chat surface bound to a single agent. Each widget owns a globally unique, immutable DNS label under the widgets domain (e.g. "k7m2xq9fp4wn.widgets.cadenya.com"): one widget = one hostname = one origin allowlist = one agent binding. Browsers talk to the widget host with session bearer tokens minted server-side via WidgetSessionService.

Parameters:




# File 'lib/cadenya/models/widget.rb', line 35

Instance Attribute Details

#info ⇒ Cadenya::Models::WidgetInfo?

WidgetInfo provides read-only server-derived data about a widget.

Parameters:

Returns:



23
 
# File 'lib/cadenya/models/widget.rb', line 23

optional :info, -> { Cadenya::WidgetInfo }

#metadata ⇒ Cadenya::Models::ResourceMetadata

Standard metadata for persistent, named resources (e.g., agents, tools, prompts)

Parameters:

Returns:



11
 
# File 'lib/cadenya/models/widget.rb', line 11

required :metadata, -> { Cadenya::ResourceMetadata }

#spec ⇒ Cadenya::Models::WidgetSpec

WidgetSpec is the user-provided configuration for a widget.

Parameters:

Returns:



17
 
# File 'lib/cadenya/models/widget.rb', line 17

required :spec, -> { Cadenya::WidgetSpec }

#state ⇒ Cadenya::Models::Widget::state

Returns the value of attribute state.

Returns:

  • (Cadenya::Models::Widget::state) 


20
21
22
 
# File 'sig/cadenya/models/widget.rbs', line 20

def state
  @state
end

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


29
 
# File 'sig/cadenya/models/widget.rbs', line 29

def to_hash: -> {