Class: Knockapi::Models::Objects::BulkDeleteParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/knockapi/models/objects/bulk_delete_params.rb,
sig/knockapi/models/objects/bulk_delete_params.rbs

Overview

See Also:

  • Knockapi::Resources::Objects::Bulk#delete

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(collection:, object_ids:, request_options: {}) ⇒ Object

Parameters:

  • collection (String)
  • object_ids (Array<String>) —

    List of object IDs to delete.

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



# File 'lib/knockapi/models/objects/bulk_delete_params.rb', line 22

Instance Attribute Details

#collection ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/knockapi/models/objects/bulk_delete_params.rb', line 14

required :collection, String

#object_ids ⇒ Array<String>

List of object IDs to delete.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


20
 
# File 'lib/knockapi/models/objects/bulk_delete_params.rb', line 20

required :object_ids, Knockapi::Internal::Type::ArrayOf[String]

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


22
 
# File 'sig/knockapi/models/objects/bulk_delete_params.rbs', line 22

def to_hash: -> {