Class: Trycourier::Models::Profiles::ListSubscribeParams::List

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/trycourier/models/profiles/list_subscribe_params.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

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(list_id: , preferences: nil) ⇒ Object

Parameters:



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/trycourier/models/profiles/list_subscribe_params.rb', line 21

class List < Trycourier::Internal::Type::BaseModel
  # @!attribute list_id
  #
  #   @return [String]
  required :list_id, String, api_name: :listId

  # @!attribute preferences
  #
  #   @return [Trycourier::Models::RecipientPreferences, nil]
  optional :preferences, -> { Trycourier::RecipientPreferences }, nil?: true

  # @!method initialize(list_id:, preferences: nil)
  #   @param list_id [String]
  #   @param preferences [Trycourier::Models::RecipientPreferences, nil]
end

Instance Attribute Details

#list_id ⇒ String

Returns:

  • (String) 


25
 
# File 'lib/trycourier/models/profiles/list_subscribe_params.rb', line 25

required :list_id, String, api_name: :listId

#preferences ⇒ Trycourier::Models::RecipientPreferences?

Returns:



30
 
# File 'lib/trycourier/models/profiles/list_subscribe_params.rb', line 30

optional :preferences, -> { Trycourier::RecipientPreferences }, nil?: true