Class: OpenAI::Models::Beta::HostedPluginParam

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/hosted_plugin_param.rb,
sig/openai/models/beta/hosted_plugin_param.rbs

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

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(description:, name:, source:, type: :inline) ⇒ Object

Parameters:

  • The plugin description declared in .codex-plugin/plugin.json.

  • The plugin name declared in .codex-plugin/plugin.json.

  • Provides ZIP bytes encoded with standard base64.

  • (defaults to: :inline)

    The type of the object. Always inline.




# File 'lib/openai/models/beta/hosted_plugin_param.rb', line 31

Instance Attribute Details

#description ⇒ String

The plugin description declared in .codex-plugin/plugin.json.

Returns:



11
 
# File 'lib/openai/models/beta/hosted_plugin_param.rb', line 11

required :description, String

#name ⇒ String

The plugin name declared in .codex-plugin/plugin.json.

Returns:



17
 
# File 'lib/openai/models/beta/hosted_plugin_param.rb', line 17

required :name, String

#source ⇒ OpenAI::Beta::InlineCapabilitySourceParam

Provides ZIP bytes encoded with standard base64.

Returns:



23
 
# File 'lib/openai/models/beta/hosted_plugin_param.rb', line 23

required :source, -> { OpenAI::Beta::InlineCapabilitySourceParam }

#type ⇒ :inline

The type of the object. Always inline.

Returns:



29
 
# File 'lib/openai/models/beta/hosted_plugin_param.rb', line 29

required :type, const: :inline

Instance Method Details

#to_hash ⇒ {

Returns:



40
 
# File 'sig/openai/models/beta/hosted_plugin_param.rbs', line 40

def to_hash: -> {