Class: OpenAI::Models::VideoDeleteResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::VideoDeleteResponse

Defined in:

lib/openai/models/video_delete_response.rb,
sig/openai/models/video_delete_response.rbs

Overview

See Also:

• OpenAI::Resources::Videos#delete

Instance Attribute Summary

• #deleted ⇒ Boolean

  Indicates that the video resource was deleted.

• #id ⇒ String

  Identifier of the deleted video.

• #object ⇒ Symbol, :"video.deleted"

  The object type that signals the deletion response.

Instance Method Summary

• #initialize(id:, deleted:, object: :"video.deleted") ⇒ Object constructor

  Confirmation payload returned after deleting a video.

• #to_hash ⇒ { id: String, deleted: bool, object: :"video.deleted" }

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

#deleted ⇒ Boolean

Indicates that the video resource was deleted.

Parameters:

• value (Boolean)

Returns:

• (Boolean)

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

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

#id ⇒ String

Identifier of the deleted video.

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#object ⇒ Symbol, :"video.deleted"

The object type that signals the deletion response.

Parameters:

• value (:"video.deleted")

Returns:

• (Symbol, :"video.deleted")

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

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

Instance Method Details

#to_hash ⇒ { id: String, deleted: bool, object: :"video.deleted" }

Returns:

• ({ id: String, deleted: bool, object: :"video.deleted" })

# File 'sig/openai/models/video_delete_response.rbs', line 19

def to_hash: -> { id: String, deleted: bool, object: :"video.deleted" }