Class: OpenAI::Models::Admin::Organization::AdminAPIKeyCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Admin::Organization::AdminAPIKeyCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openai/models/admin/organization/admin_api_key_create_params.rb

Overview

See Also:

• Resources::Admin::Organization::AdminAPIKeys#create

Instance Attribute Summary

• #expires_in_seconds ⇒ Integer^?

  The number of seconds until the API key expires.

• #name ⇒ String

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(name:, expires_in_seconds: nil, request_options: {}) ⇒ Object constructor

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

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(name:, expires_in_seconds: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Admin::Organization::AdminAPIKeyCreateParams for more details.

Parameters:

• name (String)
• expires_in_seconds (Integer) (defaults to: nil) —

  The number of seconds until the API key expires. Omit this field for a key that

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

# File 'lib/openai/models/admin/organization/admin_api_key_create_params.rb', line 24

Instance Attribute Details

#expires_in_seconds ⇒ Integer^?

The number of seconds until the API key expires. Omit this field for a key that does not expire.

Returns:

• (Integer, nil)

# File 'lib/openai/models/admin/organization/admin_api_key_create_params.rb', line 22

optional :expires_in_seconds, Integer

#name ⇒ String

Returns:

• (String)

# File 'lib/openai/models/admin/organization/admin_api_key_create_params.rb', line 15

required :name, String