Class: Courier::Models::NotificationRetrieveContentParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/courier/models/notification_retrieve_content_params.rb

Overview

See Also:

• Resources::Notifications#retrieve_content

Instance Attribute Summary

• #id ⇒ String
• #version ⇒ String^?

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

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(id:, version: nil, request_options: {}) ⇒ Object constructor

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

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

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

Parameters:

• 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/notification_retrieve_content_params.rb', line 22

Instance Attribute Details

#id ⇒ String

Returns:

• (String)

# File 'lib/courier/models/notification_retrieve_content_params.rb', line 13

required :id, String

#version ⇒ String^?

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

Returns:

• (String, nil)

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

optional :version, String