Class: Trycourier::Models::Profiles::ListRetrieveResponse::Result

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/trycourier/models/profiles/list_retrieve_response.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(id:, created:, name:, updated:, preferences: nil) ⇒ Object

Some parameter documentations has been truncated, see Trycourier::Models::Profiles::ListRetrieveResponse::Result for more details.

Parameters:

  • id (String)
  • created (String) —

    The date/time of when the list was created. Represented as a string in ISO forma

  • name (String) —

    List name

  • updated (String) —

    The date/time of when the list was updated. Represented as a string in ISO forma

  • preferences (Trycourier::Models::RecipientPreferences, nil) (defaults to: nil) 


25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/trycourier/models/profiles/list_retrieve_response.rb', line 25

class Result < Trycourier::Internal::Type::BaseModel
  # @!attribute id
  #
  #   @return [String]
  required :id, String

  # @!attribute created
  #   The date/time of when the list was created. Represented as a string in ISO
  #   format.
  #
  #   @return [String]
  required :created, String

  # @!attribute name
  #   List name
  #
  #   @return [String]
  required :name, String

  # @!attribute updated
  #   The date/time of when the list was updated. Represented as a string in ISO
  #   format.
  #
  #   @return [String]
  required :updated, String

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

  # @!method initialize(id:, created:, name:, updated:, preferences: nil)
  #   Some parameter documentations has been truncated, see
  #   {Trycourier::Models::Profiles::ListRetrieveResponse::Result} for more details.
  #
  #   @param id [String]
  #
  #   @param created [String] The date/time of when the list was created. Represented as a string in ISO forma
  #
  #   @param name [String] List name
  #
  #   @param updated [String] The date/time of when the list was updated. Represented as a string in ISO forma
  #
  #   @param preferences [Trycourier::Models::RecipientPreferences, nil]
end

Instance Attribute Details

#created ⇒ String

The date/time of when the list was created. Represented as a string in ISO format.

Returns:

  • (String) 


36
 
# File 'lib/trycourier/models/profiles/list_retrieve_response.rb', line 36

required :created, String

#id ⇒ String

Returns:

  • (String) 


29
 
# File 'lib/trycourier/models/profiles/list_retrieve_response.rb', line 29

required :id, String

#name ⇒ String

List name

Returns:

  • (String) 


42
 
# File 'lib/trycourier/models/profiles/list_retrieve_response.rb', line 42

required :name, String

#preferences ⇒ Trycourier::Models::RecipientPreferences?

Returns:



54
 
# File 'lib/trycourier/models/profiles/list_retrieve_response.rb', line 54

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

#updated ⇒ String

The date/time of when the list was updated. Represented as a string in ISO format.

Returns:

  • (String) 


49
 
# File 'lib/trycourier/models/profiles/list_retrieve_response.rb', line 49

required :updated, String