Class: ModerationAPI::Models::Wordlist::WordRemoveParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/moderation_api/models/wordlist/word_remove_params.rb

Overview

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

Parameters:

  • id (String)

    ID of the wordlist to remove words from

  • words (Array<String>)

    Array of words to remove from the wordlist

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


# File 'lib/moderation_api/models/wordlist/word_remove_params.rb', line 23

Instance Attribute Details

#idString

ID of the wordlist to remove words from

Returns:

  • (String)


15
# File 'lib/moderation_api/models/wordlist/word_remove_params.rb', line 15

required :id, String

#wordsArray<String>

Array of words to remove from the wordlist

Returns:

  • (Array<String>)


21
# File 'lib/moderation_api/models/wordlist/word_remove_params.rb', line 21

required :words, ModerationAPI::Internal::Type::ArrayOf[String]