Class: Cadenya::Models::WidgetListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/cadenya/models/widget_list_params.rb,
sig/cadenya/models/widget_list_params.rbs

Overview

See Also:

  • Cadenya::Resources::Widgets#list

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(workspace_id: nil, agent_id: nil, cursor: nil, include_info: nil, labels: nil, limit: nil, sort_order: nil, request_options: {}) ⇒ Object

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

Parameters:

  • workspace_id (String) (defaults to: nil)
  • agent_id (String) (defaults to: nil) —

    Filter to widgets bound to a specific agent. Accepts the canonical

  • cursor (String) (defaults to: nil) —

    Pagination cursor from previous response.

  • include_info (Boolean) (defaults to: nil) —

    When true, the info field on each returned widget is populated.

  • labels (String) (defaults to: nil) —

    Filters by metadata labels. Comma-separated key=value pairs,

  • limit (Integer) (defaults to: nil) —

    Maximum number of results to return.

  • sort_order (String) (defaults to: nil) —

    Sort order for results (asc or desc by creation time).

  • request_options (Cadenya::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/cadenya/models/widget_list_params.rb', line 55

Instance Attribute Details

#agent_id ⇒ String?

Filter to widgets bound to a specific agent. Accepts the canonical agent_… form or the external_id:<value> form.

Parameters:

  • (String)

Returns:

  • (String, nil) 


20
 
# File 'lib/cadenya/models/widget_list_params.rb', line 20

optional :agent_id, String

#cursor ⇒ String?

Pagination cursor from previous response.

Parameters:

  • (String)

Returns:

  • (String, nil) 


26
 
# File 'lib/cadenya/models/widget_list_params.rb', line 26

optional :cursor, String

#include_info ⇒ Boolean?

When true, the info field on each returned widget is populated. Requests with this flag count more against your rate limit.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


33
 
# File 'lib/cadenya/models/widget_list_params.rb', line 33

optional :include_info, Cadenya::Internal::Type::Boolean

#labels ⇒ String?

Filters by metadata labels. Comma-separated key=value pairs, e.g. "env=prod,team=ai". A resource matches only if every pair matches exactly (AND semantics).

Parameters:

  • (String)

Returns:

  • (String, nil) 


41
 
# File 'lib/cadenya/models/widget_list_params.rb', line 41

optional :labels, String

#limit ⇒ Integer?

Maximum number of results to return.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


47
 
# File 'lib/cadenya/models/widget_list_params.rb', line 47

optional :limit, Integer

#sort_order ⇒ String?

Sort order for results (asc or desc by creation time).

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :sort_order, String

#workspace_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


13
 
# File 'lib/cadenya/models/widget_list_params.rb', line 13

optional :workspace_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


58
 
# File 'sig/cadenya/models/widget_list_params.rbs', line 58

def to_hash: -> {