Class: Courier::Models::Users::PreferenceBulkUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/courier/models/users/preference_bulk_update_params.rb,
sig/courier/models/users/preference_bulk_update_params.rbs

Overview

See Also:

  • Courier::Resources::Users::Preferences#bulk_update

Defined Under Namespace

Classes: Topic

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 ⇒ Object 



22
 
# File 'sig/courier/models/users/preference_bulk_update_params.rbs', line 22

def initialize: (

Instance Attribute Details

#tenant_id ⇒ String?

Update the preferences of a user for this specific tenant context.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


28
 
# File 'lib/courier/models/users/preference_bulk_update_params.rb', line 28

optional :tenant_id, String, nil?: true

#topics ⇒ Array<Courier::Models::Users::PreferenceBulkUpdateParams::Topic>

The topics to create or update. Between 1 and 50 topics may be provided in a single request.

Parameters:

  • value (::Array[Courier::Users::PreferenceBulkUpdateParams::Topic])

Returns:



21
22
 
# File 'lib/courier/models/users/preference_bulk_update_params.rb', line 21

required :topics,
-> { Courier::Internal::Type::ArrayOf[Courier::Users::PreferenceBulkUpdateParams::Topic] }

#user_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/courier/models/users/preference_bulk_update_params.rb', line 14

required :user_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


29
 
# File 'sig/courier/models/users/preference_bulk_update_params.rbs', line 29

def to_hash: -> {