Class: OpenAI::Models::Beta::Agents::Vaults::CredentialListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Beta::Agents::Vaults::CredentialListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openai/models/beta/agents/vaults/credential_list_params.rb,
sig/openai/models/beta/agents/vaults/credential_list_params.rbs

Overview

See Also:

• OpenAI::Resources::Beta::Agents::Vaults::Credentials#list

Defined Under Namespace

Modules: Order

Instance Attribute Summary

• #after ⇒ String^?

  Return resources after this resource ID in the selected order.

• #limit ⇒ Integer^?

  The maximum number of resources to return.

• #order ⇒ Symbol, ...

  Sort order by the created_at timestamp.

• #status ⇒ Symbol, ...

  Filter by one status or a list, such as status=active or status[]=active&status[]=archived.

• #vault_id ⇒ String

Attributes included from Internal::Type::RequestParameters

#request_options

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary

• #initialize(vault_id:, after: nil, limit: nil, order: nil, status: nil, request_options: {}) ⇒ Object constructor
• #to_hash ⇒ {

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

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, 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(vault_id:, after: nil, limit: nil, order: nil, status: nil, request_options: {}) ⇒ Object

Parameters:

• vault_id (String)
• after (String) (defaults to: nil) —

  Return resources after this resource ID in the selected order.

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

  The maximum number of resources to return. Defaults to 20. Values are clamped between 1 and 100.

• order (Symbol, OpenAI::Models::Beta::Agents::Vaults::CredentialListParams::Order) (defaults to: nil) —

  Sort order by the created_at timestamp. Use asc for ascending order or desc for descending order. Defaults to desc.

• status (Symbol, OpenAI::Models::Beta::Agents::VaultStatus, Array<Symbol, OpenAI::Models::Beta::Agents::VaultStatus>) (defaults to: nil) —

  Filter by one status or a list, such as status=active or status[]=active&status[]=archived. Both statuses are included by default.

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

# File 'lib/openai/models/beta/agents/vaults/credential_list_params.rb', line 45

Instance Attribute Details

#after ⇒ String^?

Return resources after this resource ID in the selected order.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/openai/models/beta/agents/vaults/credential_list_params.rb', line 22

optional :after, String

#limit ⇒ Integer^?

The maximum number of resources to return. Defaults to 20. Values are clamped between 1 and 100.

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/openai/models/beta/agents/vaults/credential_list_params.rb', line 29

optional :limit, Integer, nil?: true

#order ⇒ Symbol, ...

Sort order by the created_at timestamp. Use asc for ascending order or desc for descending order. Defaults to desc.

Returns:

• (Symbol, OpenAI::Models::Beta::Agents::Vaults::CredentialListParams::Order, nil)

# File 'lib/openai/models/beta/agents/vaults/credential_list_params.rb', line 36

optional :order, enum: -> { OpenAI::Beta::Agents::Vaults::CredentialListParams::Order }

#status ⇒ Symbol, ...

Filter by one status or a list, such as status=active or status[]=active&status[]=archived. Both statuses are included by default.

Returns:

• (Symbol, OpenAI::Models::Beta::Agents::VaultStatus, Array<Symbol, OpenAI::Models::Beta::Agents::VaultStatus>, nil)

# File 'lib/openai/models/beta/agents/vaults/credential_list_params.rb', line 43

optional :status, union: -> { OpenAI::Beta::Agents::VaultStatusFilter }

#vault_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/openai/models/beta/agents/vaults/credential_list_params.rb', line 16

required :vault_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/openai/models/beta/agents/vaults/credential_list_params.rbs', line 49

def to_hash: -> {