Class: Anthropic::Models::Beta::Organization::BetaPlugin

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/anthropic/models/beta/organization/beta_plugin.rb,
sig/anthropic/models/beta/organization/beta_plugin.rbs

Overview

See Also:

  • Anthropic::Resources::Beta::Organization::Plugins#create

Defined Under Namespace

Modules: CreatedBy, OrganizationInstallationPreference, Owner, Reach

Instance Attribute Summary collapse

Class Method 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(id:, components:, content_scan:, created_at:, created_by:, description:, display_name:, latest_version_id:, manifest_version:, marketplace_id:, name:, organization_installation_preference:, organization_installation_preference_inherited:, owner:, reach:, served_version_id:, served_version_pinned:, updated_at:, type: :plugin) ⇒ void

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

Parameters:




# File 'lib/anthropic/models/beta/organization/beta_plugin.rb', line 144

Instance Attribute Details

#components ⇒ Array<Anthropic::Models::Beta::Organization::BetaPluginComponent>?

What the served version contains; null when not enumerated.

Parameters:

  • value (::Array[Anthropic::Beta::Organization::BetaPluginComponent], nil)

Returns:



19
20
21
22
23
 
# File 'lib/anthropic/models/beta/organization/beta_plugin.rb', line 19

required :components,
-> {
  Anthropic::Internal::Type::ArrayOf[Anthropic::Beta::Organization::BetaPluginComponent]
},
nil?: true

#content_scan ⇒ Anthropic::Models::Beta::Organization::BetaPluginContentScan?

The served version's content scan; null when it has not been scanned.

Parameters:

  • value (Anthropic::Beta::Organization::BetaPluginContentScan, nil)

Returns:



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

required :content_scan, -> { Anthropic::Beta::Organization::BetaPluginContentScan }, nil?: true

#created_at ⇒ Time

RFC 3339.

Parameters:

  • value (Time)

Returns:

  • (Time) 


35
 
# File 'lib/anthropic/models/beta/organization/beta_plugin.rb', line 35

required :created_at, Time

#created_by ⇒ Anthropic::Models::Beta::Organization::BetaPluginUserActor, ...

Who created the Plugin; null when no creator is recorded.

Parameters:

  • value (Anthropic::Models::Beta::Organization::BetaPlugin::created_by, nil)

Returns:



41
 
# File 'lib/anthropic/models/beta/organization/beta_plugin.rb', line 41

required :created_by, union: -> { Anthropic::Beta::Organization::BetaPlugin::CreatedBy }, nil?: true

#description ⇒ String?

The served version's description.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


47
 
# File 'lib/anthropic/models/beta/organization/beta_plugin.rb', line 47

required :description, String, nil?: true

#display_name ⇒ String?

The served version's display name.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


53
 
# File 'lib/anthropic/models/beta/organization/beta_plugin.rb', line 53

required :display_name, String, nil?: true

#id ⇒ String

The Plugin's ID.

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/anthropic/models/beta/organization/beta_plugin.rb', line 13

required :id, String

#latest_version_id ⇒ String

The newest version.

Parameters:

  • value (String)

Returns:

  • (String) 


59
 
# File 'lib/anthropic/models/beta/organization/beta_plugin.rb', line 59

required :latest_version_id, String

#manifest_version ⇒ String?

The version string the served version's manifest declares.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


65
 
# File 'lib/anthropic/models/beta/organization/beta_plugin.rb', line 65

required :manifest_version, String, nil?: true

#marketplace_id ⇒ String

The ID of the plugin marketplace the Plugin lives in.

Parameters:

  • value (String)

Returns:

  • (String) 


71
 
# File 'lib/anthropic/models/beta/organization/beta_plugin.rb', line 71

required :marketplace_id, String

#name ⇒ String

Lowercase identifier, unique within its plugin marketplace. Fixed for an organization-owned Plugin's lifetime; a member-owned Plugin's changes when its owner renames it in claude.ai, while its id stays the same.

Parameters:

  • value (String)

Returns:

  • (String) 


79
 
# File 'lib/anthropic/models/beta/organization/beta_plugin.rb', line 79

required :name, String

#organization_installation_preference ⇒ Symbol, ...

Organization-owned Plugin: the organization-wide installation setting every member gets unless an RBAC Group they belong to holds its own — the Plugin's own setting, or its plugin marketplace's default. Null for a member-owned Plugin, which has shares instead. One of required, auto_install, available, not_available; a value this API does not yet name is returned as stored.

Parameters:

  • value (Anthropic::Models::Beta::Organization::BetaPlugin::organization_installation_preference, nil)

Returns:



89
90
91
 
# File 'lib/anthropic/models/beta/organization/beta_plugin.rb', line 89

required :organization_installation_preference,
enum: -> { Anthropic::Beta::Organization::BetaPlugin::OrganizationInstallationPreference },
nil?: true

#organization_installation_preference_inherited ⇒ Boolean?

Organization-owned Plugin: true while it has no organization-wide setting of its own and organization_installation_preference is its plugin marketplace's default. Null for a member-owned Plugin.

Parameters:

Returns:



99
100
101
 
# File 'lib/anthropic/models/beta/organization/beta_plugin.rb', line 99

required :organization_installation_preference_inherited,
Anthropic::Internal::Type::Boolean,
nil?: true

#owner ⇒ Anthropic::Models::Beta::Organization::BetaPluginOwnerOrganization, Anthropic::Models::Beta::Organization::BetaPluginOwnerUser

Who owns the Plugin: the organization, or the member whose personal plugin marketplace it lives in.

Parameters:

  • value (Anthropic::Models::Beta::Organization::BetaPlugin::owner)

Returns:



108
 
# File 'lib/anthropic/models/beta/organization/beta_plugin.rb', line 108

required :owner, union: -> { Anthropic::Beta::Organization::BetaPlugin::Owner }

#reach ⇒ Symbol, ...

How far the served version reaches: remote when it declares an MCP server or a CLI, privileged when it declares a hook, monitor, language server or settings but nothing remote, contained otherwise; null when not classifiable.

Parameters:

  • value (Anthropic::Models::Beta::Organization::BetaPlugin::reach, nil)

Returns:



116
 
# File 'lib/anthropic/models/beta/organization/beta_plugin.rb', line 116

required :reach, enum: -> { Anthropic::Beta::Organization::BetaPlugin::Reach }, nil?: true

#served_version_id ⇒ String

The version claude.ai serves to members.

Parameters:

  • value (String)

Returns:

  • (String) 


122
 
# File 'lib/anthropic/models/beta/organization/beta_plugin.rb', line 122

required :served_version_id, String

#served_version_pinned ⇒ Boolean

False while the served version follows each new version; true once it has been pinned to one.

Parameters:

Returns:



129
 
# File 'lib/anthropic/models/beta/organization/beta_plugin.rb', line 129

required :served_version_pinned, Anthropic::Internal::Type::Boolean

#type ⇒ Symbol, :plugin

Always plugin.

Parameters:

  • value (:plugin)

Returns:

  • (Symbol, :plugin) 


135
 
# File 'lib/anthropic/models/beta/organization/beta_plugin.rb', line 135

required :type, const: :plugin

#updated_at ⇒ Time

RFC 3339. Moves on a new version and on a served-version change; a change to the Plugin's installation settings or shares does not move it.

Parameters:

  • value (Time)

Returns:

  • (Time) 


142
 
# File 'lib/anthropic/models/beta/organization/beta_plugin.rb', line 142

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/anthropic/models/beta/organization/beta_plugin.rb', line 256

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


89
 
# File 'sig/anthropic/models/beta/organization/beta_plugin.rbs', line 89

def to_hash: -> {