Class: ContextDev::Models::BatchDeleteResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/context_dev/models/batch_delete_response.rb,
sig/context_dev/models/batch_delete_response.rbs

Overview

See Also:

  • ContextDev::Resources::Batch#delete

Defined Under Namespace

Classes: KeyMetadata

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: nil, deleted: nil, key_metadata: nil) ⇒ Object

Some parameter documentations has been truncated, see ContextDev::Models::BatchDeleteResponse for more details.

Parameters:

  • id (String) (defaults to: nil) —

    ID of the deleted batch.

  • deleted (Boolean) (defaults to: nil) —

    Always true on success.

  • key_metadata (ContextDev::Models::BatchDeleteResponse::KeyMetadata) (defaults to: nil) —

    Metadata about the API key used for the request. Included in every response when




# File 'lib/context_dev/models/batch_delete_response.rb', line 26

Instance Attribute Details

#deleted ⇒ Boolean?

Always true on success.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


17
 
# File 'lib/context_dev/models/batch_delete_response.rb', line 17

optional :deleted, ContextDev::Internal::Type::Boolean

#id ⇒ String?

ID of the deleted batch.

Parameters:

  • (String)

Returns:

  • (String, nil) 


11
 
# File 'lib/context_dev/models/batch_delete_response.rb', line 11

optional :id, String

#key_metadata ⇒ ContextDev::Models::BatchDeleteResponse::KeyMetadata?

Metadata about the API key used for the request. Included in every response whenever a valid API key is provided, even when the response status is not 200.

Returns:



24
 
# File 'lib/context_dev/models/batch_delete_response.rb', line 24

optional :key_metadata, -> { ContextDev::Models::BatchDeleteResponse::KeyMetadata }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


31
 
# File 'sig/context_dev/models/batch_delete_response.rbs', line 31

def to_hash: -> {