Class: Courier::Models::NotificationTemplateSummary

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/courier/models/notification_template_summary.rb

Defined Under Namespace

Modules: State

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:, creator:, name:, state:, tags:, updated: nil, updater: nil) ⇒ Object

V2 (CDS) template summary returned in list responses.

Parameters:

  • id (String)
  • created (Integer)

    Epoch milliseconds when the template was created.

  • creator (String)

    User ID of the creator.

  • name (String)
  • state (Symbol, Courier::Models::NotificationTemplateSummary::State)
  • tags (Array<String>)
  • updated (Integer) (defaults to: nil)

    Epoch milliseconds of last update.

  • updater (String) (defaults to: nil)

    User ID of the last updater.



# File 'lib/courier/models/notification_template_summary.rb', line 50

Instance Attribute Details

#createdInteger

Epoch milliseconds when the template was created.

Returns:

  • (Integer)


15
# File 'lib/courier/models/notification_template_summary.rb', line 15

required :created, Integer

#creatorString

User ID of the creator.

Returns:

  • (String)


21
# File 'lib/courier/models/notification_template_summary.rb', line 21

required :creator, String

#idString

Returns:

  • (String)


9
# File 'lib/courier/models/notification_template_summary.rb', line 9

required :id, String

#nameString

Returns:

  • (String)


26
# File 'lib/courier/models/notification_template_summary.rb', line 26

required :name, String

#stateSymbol, Courier::Models::NotificationTemplateSummary::State



31
# File 'lib/courier/models/notification_template_summary.rb', line 31

required :state, enum: -> { Courier::NotificationTemplateSummary::State }

#tagsArray<String>

Returns:

  • (Array<String>)


36
# File 'lib/courier/models/notification_template_summary.rb', line 36

required :tags, Courier::Internal::Type::ArrayOf[String]

#updatedInteger?

Epoch milliseconds of last update.

Returns:

  • (Integer, nil)


42
# File 'lib/courier/models/notification_template_summary.rb', line 42

optional :updated, Integer

#updaterString?

User ID of the last updater.

Returns:

  • (String, nil)


48
# File 'lib/courier/models/notification_template_summary.rb', line 48

optional :updater, String