Class: PreludeSDK::Models::TransactionalSendResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/prelude_sdk/models/transactional_send_response.rb

Overview

See Also:

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_at:, expires_at:, template_id:, to:, variables:, callback_url: nil, correlation_id: nil, from: nil) ⇒ Object

Some parameter documentations has been truncated, see PreludeSDK::Models::TransactionalSendResponse for more details.

Parameters:

  • id (String) —

    The message identifier.

  • created_at (Time) —

    The message creation date.

  • expires_at (Time) —

    The message expiration date.

  • template_id (String) —

    The template identifier.

  • to (String) —

    The recipient’s phone number.

  • variables (Hash{Symbol=>String}) —

    The variables to be replaced in the template.

  • callback_url (String) (defaults to: nil) —

    The callback URL.

  • correlation_id (String) (defaults to: nil) —

    A user-defined identifier to correlate this transactional message with. It is re

  • from (String) (defaults to: nil) —

    The Sender ID.




# File 'lib/prelude_sdk/models/transactional_send_response.rb', line 63

Instance Attribute Details

#callback_url ⇒ String?

The callback URL.

Returns:

  • (String, nil) 


47
 
# File 'lib/prelude_sdk/models/transactional_send_response.rb', line 47

optional :callback_url, String

#correlation_id ⇒ String?

A user-defined identifier to correlate this transactional message with. It is returned in the response and any webhook events that refer to this transactional message.

Returns:

  • (String, nil) 


55
 
# File 'lib/prelude_sdk/models/transactional_send_response.rb', line 55

optional :correlation_id, String

#created_at ⇒ Time

The message creation date.

Returns:

  • (Time) 


17
 
# File 'lib/prelude_sdk/models/transactional_send_response.rb', line 17

required :created_at, Time

#expires_at ⇒ Time

The message expiration date.

Returns:

  • (Time) 


23
 
# File 'lib/prelude_sdk/models/transactional_send_response.rb', line 23

required :expires_at, Time

#from ⇒ String?

The Sender ID.

Returns:

  • (String, nil) 


61
 
# File 'lib/prelude_sdk/models/transactional_send_response.rb', line 61

optional :from, String

#id ⇒ String

The message identifier.

Returns:

  • (String) 


11
 
# File 'lib/prelude_sdk/models/transactional_send_response.rb', line 11

required :id, String

#template_id ⇒ String

The template identifier.

Returns:

  • (String) 


29
 
# File 'lib/prelude_sdk/models/transactional_send_response.rb', line 29

required :template_id, String

#to ⇒ String

The recipient’s phone number.

Returns:

  • (String) 


35
 
# File 'lib/prelude_sdk/models/transactional_send_response.rb', line 35

required :to, String

#variables ⇒ Hash{Symbol=>String}

The variables to be replaced in the template.

Returns:

  • (Hash{Symbol=>String}) 


41
 
# File 'lib/prelude_sdk/models/transactional_send_response.rb', line 41

required :variables, PreludeSDK::Internal::Type::HashOf[String]