Class: Courier::Models::JourneyInvokeParams

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

Overview

See Also:

  • Courier::Resources::Journeys#invoke

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Attributes inherited from JourneysInvokeRequest

#data, #profile, #user_id

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:, idempotency_key: nil, x_idempotency_expiration: nil, request_options: {}) ⇒ Object

Parameters:

  • template_id (String)
  • idempotency_key (String) (defaults to: nil)
  • x_idempotency_expiration (String) (defaults to: nil)
  • request_options (Courier::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/courier/models/journey_invoke_params.rb', line 25

Instance Attribute Details

#idempotency_key ⇒ String?

Parameters:

  • _ (String)

Returns:

  • (String, nil) 


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

optional :idempotency_key, String

#template_id ⇒ String

Parameters:

  • _ (String)

Returns:

  • (String) 


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

required :template_id, String

#x_idempotency_expiration ⇒ String?

Parameters:

  • _ (String)

Returns:

  • (String, nil) 


23
 
# File 'lib/courier/models/journey_invoke_params.rb', line 23

optional :x_idempotency_expiration, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


34
 
# File 'sig/courier/models/journey_invoke_params.rbs', line 34

def to_hash: -> {