Class: Anthropic::Models::Beta::SessionListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/anthropic/models/beta/session_list_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Order

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(agent_id: nil, agent_version: nil, created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, include_archived: nil, limit: nil, order: nil, page: nil, betas: nil, request_options: {}) ⇒ void

Some parameter documentations has been truncated, see Anthropic::Models::Beta::SessionListParams for more details.

Parameters:

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

    Filter sessions created with this agent ID.

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

    Filter by agent version. Only applies when agent_id is also set.

  • created_at_gt (Time) (defaults to: nil) —

    Return sessions created after this time (exclusive).

  • created_at_gte (Time) (defaults to: nil) —

    Return sessions created at or after this time (inclusive).

  • created_at_lt (Time) (defaults to: nil) —

    Return sessions created before this time (exclusive).

  • created_at_lte (Time) (defaults to: nil) —

    Return sessions created at or before this time (inclusive).

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

    When true, includes archived sessions. Default: false (exclude archived).

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

    Maximum number of results to return.

  • order (Symbol, Anthropic::Models::Beta::SessionListParams::Order) (defaults to: nil) —

    Sort direction for results, ordered by created_at. Defaults to desc (newest firs

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

    Opaque pagination cursor from a previous response's next_page.

  • betas (Array<String, Symbol, Anthropic::Models::AnthropicBeta>) (defaults to: nil) —

    Optional header to specify the beta version(s) you want to use.

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



# File 'lib/anthropic/models/beta/session_list_params.rb', line 78

Instance Attribute Details

#agent_id ⇒ String?

Filter sessions created with this agent ID.

Returns:

  • (String, nil) 


15
 
# File 'lib/anthropic/models/beta/session_list_params.rb', line 15

optional :agent_id, String

#agent_version ⇒ Integer?

Filter by agent version. Only applies when agent_id is also set.

Returns:

  • (Integer, nil) 


21
 
# File 'lib/anthropic/models/beta/session_list_params.rb', line 21

optional :agent_version, Integer

#betas ⇒ Array<String, Symbol, Anthropic::Models::AnthropicBeta>?

Optional header to specify the beta version(s) you want to use.

Returns:



76
 
# File 'lib/anthropic/models/beta/session_list_params.rb', line 76

optional :betas, -> { Anthropic::Internal::Type::ArrayOf[union: Anthropic::AnthropicBeta] }

#created_at_gt ⇒ Time?

Return sessions created after this time (exclusive).

Returns:

  • (Time, nil) 


27
 
# File 'lib/anthropic/models/beta/session_list_params.rb', line 27

optional :created_at_gt, Time

#created_at_gte ⇒ Time?

Return sessions created at or after this time (inclusive).

Returns:

  • (Time, nil) 


33
 
# File 'lib/anthropic/models/beta/session_list_params.rb', line 33

optional :created_at_gte, Time

#created_at_lt ⇒ Time?

Return sessions created before this time (exclusive).

Returns:

  • (Time, nil) 


39
 
# File 'lib/anthropic/models/beta/session_list_params.rb', line 39

optional :created_at_lt, Time

#created_at_lte ⇒ Time?

Return sessions created at or before this time (inclusive).

Returns:

  • (Time, nil) 


45
 
# File 'lib/anthropic/models/beta/session_list_params.rb', line 45

optional :created_at_lte, Time

#include_archived ⇒ Boolean?

When true, includes archived sessions. Default: false (exclude archived).

Returns:



51
 
# File 'lib/anthropic/models/beta/session_list_params.rb', line 51

optional :include_archived, Anthropic::Internal::Type::Boolean

#limit ⇒ Integer?

Maximum number of results to return.

Returns:

  • (Integer, nil) 


57
 
# File 'lib/anthropic/models/beta/session_list_params.rb', line 57

optional :limit, Integer

#order ⇒ Symbol, ...

Sort direction for results, ordered by created_at. Defaults to desc (newest first).

Returns:



64
 
# File 'lib/anthropic/models/beta/session_list_params.rb', line 64

optional :order, enum: -> { Anthropic::Beta::SessionListParams::Order }

#page ⇒ String?

Opaque pagination cursor from a previous response's next_page.

Returns:

  • (String, nil) 


70
 
# File 'lib/anthropic/models/beta/session_list_params.rb', line 70

optional :page, String