Class: Courier::Models::Journeys::TemplateRetrieveContentParams

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

Overview

See Also:

  • Courier::Resources::Journeys::Templates#retrieve_content

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(template_id:, notification_id:, version: nil, request_options: {}) ⇒ Object

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

Parameters:

  • template_id (String)
  • notification_id (String)
  • version (String) (defaults to: nil) —

    Accepts draft, published, or a version string (e.g., v001). Defaults to `p

  • request_options (Courier::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/courier/models/journeys/template_retrieve_content_params.rb', line 28

Instance Attribute Details

#notification_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


19
 
# File 'lib/courier/models/journeys/template_retrieve_content_params.rb', line 19

required :notification_id, String

#template_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/courier/models/journeys/template_retrieve_content_params.rb', line 14

required :template_id, String

#version ⇒ String?

Accepts draft, published, or a version string (e.g., v001). Defaults to published.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :version, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


27
 
# File 'sig/courier/models/journeys/template_retrieve_content_params.rbs', line 27

def to_hash: -> {