Class: ModerationAPI::Models::WordlistUpdateParams

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

Overview

See Also:

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:, description: nil, key: nil, name: nil, strict: nil, words: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see ModerationAPI::Models::WordlistUpdateParams for more details.

Parameters:

  • id (String) —

    ID of the wordlist to update

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

    New description for the wordlist

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

    New key for the wordlist

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

    New name for the wordlist

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

    Deprecated. Now using threshold in project settings.

  • words (Array<String>) (defaults to: nil) —

    New words for the wordlist. Replace the existing words with these new ones. Dupl

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



# File 'lib/moderation_api/models/wordlist_update_params.rb', line 47

Instance Attribute Details

#description ⇒ String?

New description for the wordlist

Returns:

  • (String, nil) 


20
 
# File 'lib/moderation_api/models/wordlist_update_params.rb', line 20

optional :description, String

#id ⇒ String

ID of the wordlist to update

Returns:

  • (String) 


14
 
# File 'lib/moderation_api/models/wordlist_update_params.rb', line 14

required :id, String

#key ⇒ String?

New key for the wordlist

Returns:

  • (String, nil) 


26
 
# File 'lib/moderation_api/models/wordlist_update_params.rb', line 26

optional :key, String

#name ⇒ String?

New name for the wordlist

Returns:

  • (String, nil) 


32
 
# File 'lib/moderation_api/models/wordlist_update_params.rb', line 32

optional :name, String

#strict ⇒ Boolean?

Deprecated. Now using threshold in project settings.

Returns:

  • (Boolean, nil) 


38
 
# File 'lib/moderation_api/models/wordlist_update_params.rb', line 38

optional :strict, ModerationAPI::Internal::Type::Boolean

#words ⇒ Array<String>?

New words for the wordlist. Replace the existing words with these new ones. Duplicate words will be ignored.

Returns:

  • (Array<String>, nil) 


45
 
# File 'lib/moderation_api/models/wordlist_update_params.rb', line 45

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