Class: Courier::Models::NotificationTemplateCreateRequest

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Courier::Models::NotificationTemplateCreateRequest

Defined in:

lib/courier/models/notification_template_create_request.rb

Direct Known Subclasses

NotificationCreateParams

Defined Under Namespace

Modules: State

Instance Attribute Summary

• #notification ⇒ Courier::Models::NotificationTemplatePayload

  Full document shape used in POST and PUT request bodies, and returned inside the GET response envelope.

• #state ⇒ Symbol, ...

  Template state after creation.

Instance Method Summary

• #initialize(notification:, state: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see NotificationTemplateCreateRequest for more details.

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(notification:, state: nil) ⇒ Object

Some parameter documentations has been truncated, see Courier::Models::NotificationTemplateCreateRequest for more details.

Request body for creating a notification template.

Parameters:

• notification (Courier::Models::NotificationTemplatePayload) —

  Full document shape used in POST and PUT request bodies, and returned inside the

• state (Symbol, Courier::Models::NotificationTemplateCreateRequest::State) (defaults to: nil) —

  Template state after creation. Case-insensitive input, normalized to uppercase i

# File 'lib/courier/models/notification_template_create_request.rb', line 20

Instance Attribute Details

#notification ⇒ Courier::Models::NotificationTemplatePayload

Full document shape used in POST and PUT request bodies, and returned inside the GET response envelope.

Returns:

• (Courier::Models::NotificationTemplatePayload)

# File 'lib/courier/models/notification_template_create_request.rb', line 11

required :notification, -> { Courier::NotificationTemplatePayload }

#state ⇒ Symbol, ...

Template state after creation. Case-insensitive input, normalized to uppercase in the response. Defaults to "DRAFT".

Returns:

• (Symbol, Courier::Models::NotificationTemplateCreateRequest::State, nil)

# File 'lib/courier/models/notification_template_create_request.rb', line 18

optional :state, enum: -> { Courier::NotificationTemplateCreateRequest::State }