Class: GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/growsurf_ruby/models/campaign/participant_bulk_delete_params.rb,
sig/growsurf_ruby/models/campaign/participant_bulk_delete_params.rbs

Overview

See Also:

  • GrowsurfRuby::Resources::Campaign::Participant#bulk_delete

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::GrowsurfRuby

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

Some parameter documentations has been truncated, see GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteParams for more details.

Parameters:

  • id (String)
  • participants (Array<String>) —

    GrowSurf participant IDs and/or email addresses to delete. Mixed entries are al

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



# File 'lib/growsurf_ruby/models/campaign/participant_bulk_delete_params.rb', line 23

Instance Attribute Details

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/growsurf_ruby/models/campaign/participant_bulk_delete_params.rb', line 14

required :id, String

#participants ⇒ Array<String>

GrowSurf participant IDs and/or email addresses to delete. Mixed entries are allowed.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


21
 
# File 'lib/growsurf_ruby/models/campaign/participant_bulk_delete_params.rb', line 21

required :participants, GrowsurfRuby::Internal::Type::ArrayOf[String]

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


22
 
# File 'sig/growsurf_ruby/models/campaign/participant_bulk_delete_params.rbs', line 22

def to_hash: -> {