Class: OpenAI::Models::Realtime::ClientSecretCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Realtime::ClientSecretCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openai/models/realtime/client_secret_create_params.rb

Overview

See Also:

• Resources::Realtime::ClientSecrets#create

Defined Under Namespace

Modules: Session Classes: ExpiresAfter

Instance Attribute Summary

• #expires_after ⇒ OpenAI::Models::Realtime::ClientSecretCreateParams::ExpiresAfter^?

  Configuration for the client secret expiration.

• #session ⇒ OpenAI::Models::Realtime::RealtimeSessionCreateRequest, ...

  Session configuration to use for the client secret.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

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, #initialize, 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

This class inherits a constructor from OpenAI::Internal::Type::BaseModel

Instance Attribute Details

#expires_after ⇒ OpenAI::Models::Realtime::ClientSecretCreateParams::ExpiresAfter^?

Configuration for the client secret expiration. Expiration refers to the time after which a client secret will no longer be valid for creating sessions. The session itself may continue after that time once started. A secret can be used to create multiple sessions until it expires.

Returns:

• (OpenAI::Models::Realtime::ClientSecretCreateParams::ExpiresAfter, nil)

# File 'lib/openai/models/realtime/client_secret_create_params.rb', line 18

optional :expires_after, -> { OpenAI::Realtime::ClientSecretCreateParams::ExpiresAfter }

#session ⇒ OpenAI::Models::Realtime::RealtimeSessionCreateRequest, ...

Session configuration to use for the client secret. Choose either a realtime session or a transcription session.

Returns:

• (OpenAI::Models::Realtime::RealtimeSessionCreateRequest, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest, nil)

# File 'lib/openai/models/realtime/client_secret_create_params.rb', line 25

optional :session, union: -> { OpenAI::Realtime::ClientSecretCreateParams::Session }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/openai/models/realtime/client_secret_create_params.rb', line 78