Class: Anthropic::Models::Beta::UserProfileListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Anthropic::Models::Beta::UserProfileListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/anthropic/models/beta/user_profile_list_params.rb,
sig/anthropic/models/beta/user_profile_list_params.rbs

Overview

See Also:

• Anthropic::Resources::Beta::UserProfiles#list

Defined Under Namespace

Modules: Order, OrderBy

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Anthropic

Instance Attribute Summary

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

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

• #limit ⇒ Integer^?

  The maximum number of user profiles to return, from 1 to 100.

• #order ⇒ Symbol, ...

  The sort direction, applied to the field that order_by selects.

• #order_by ⇒ Symbol, ...

  The field to sort user profiles by, in the direction that order sets.

• #page ⇒ String^?

  The cursor for the page to return, taken from next_page in a previous response.

• #workspace_id ⇒ String^?

  Optional header to select the Workspace for this request.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(limit: nil, order: nil, order_by: nil, page: nil, betas: nil, workspace_id: nil, request_options: {}) ⇒ void constructor

  Some parameter documentations has been truncated, see UserProfileListParams for more details.

• #to_hash ⇒ {

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(limit: nil, order: nil, order_by: nil, page: nil, betas: nil, workspace_id: nil, request_options: {}) ⇒ void

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

Parameters:

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

  The maximum number of user profiles to return, from 1 to 100. Defaults to 20.

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

  The sort direction, applied to the field that order_by selects. Defaults to `d

• order_by (Symbol, Anthropic::Models::Beta::UserProfileListParams::OrderBy) (defaults to: nil) —

  The field to sort user profiles by, in the direction that order sets. Defaults

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

  The cursor for the page to return, taken from next_page in a previous response

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

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

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

  Optional header to select the Workspace for this request. The value is a Workspa

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

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

Instance Attribute Details

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

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

Returns:

• (Array<Symbol, String, Anthropic::Models::AnthropicBeta>, nil)

# File 'lib/anthropic/models/beta/user_profile_list_params.rb', line 44

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

#limit ⇒ Integer^?

The maximum number of user profiles to return, from 1 to 100. Defaults to 20.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :limit, Integer

#order ⇒ Symbol, ...

The sort direction, applied to the field that order_by selects. Defaults to desc.

Returns:

• (Symbol, Anthropic::Models::Beta::UserProfileListParams::Order, nil)

# File 'lib/anthropic/models/beta/user_profile_list_params.rb', line 22

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

#order_by ⇒ Symbol, ...

The field to sort user profiles by, in the direction that order sets. Defaults to created_at.

Returns:

• (Symbol, Anthropic::Models::Beta::UserProfileListParams::OrderBy, nil)

# File 'lib/anthropic/models/beta/user_profile_list_params.rb', line 29

optional :order_by, enum: -> { Anthropic::Beta::UserProfileListParams::OrderBy }

#page ⇒ String^?

The cursor for the page to return, taken from next_page in a previous response.

Leave it out to get the first page.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/anthropic/models/beta/user_profile_list_params.rb', line 38

optional :page, String

#workspace_id ⇒ String^?

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/anthropic/models/beta/user_profile_list_params.rb', line 55

optional :workspace_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/anthropic/models/beta/user_profile_list_params.rb', line 86

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/anthropic/models/beta/user_profile_list_params.rbs', line 59

def to_hash: -> {