Class: OpenAI::Models::VideoDeleteResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/video_delete_response.rb

Overview

Instance Attribute 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:, deleted:, object: :"video.deleted") ⇒ Object

Confirmation payload returned after deleting a video.

Parameters:

  • id (String)

    Identifier of the deleted video.

  • deleted (Boolean)

    Indicates that the video resource was deleted.

  • object (Symbol, :"video.deleted") (defaults to: :"video.deleted")

    The object type that signals the deletion response.



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

Instance Attribute Details

#deletedBoolean

Indicates that the video resource was deleted.

Returns:



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

required :deleted, OpenAI::Internal::Type::Boolean

#idString

Identifier of the deleted video.

Returns:

  • (String)


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

required :id, String

#objectSymbol, :"video.deleted"

The object type that signals the deletion response.

Returns:



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

required :object, const: :"video.deleted"