Class: PreludeSDK::Models::NotifySendBatchResponse

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

Overview

See Also:

Defined Under Namespace

Classes: Result

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from PreludeSDK::Internal::Type::BaseModel

Instance Attribute Details

#callback_url ⇒ String?

The callback URL used for this bulk request, if any.

Returns:

  • (String, nil) 


36
 
# File 'lib/prelude_sdk/models/notify_send_batch_response.rb', line 36

optional :callback_url, String

#error_count ⇒ Integer

Number of failed sends.

Returns:

  • (Integer) 


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

required :error_count, Integer

#request_id ⇒ String?

A string that identifies this specific request.

Returns:

  • (String, nil) 


42
 
# File 'lib/prelude_sdk/models/notify_send_batch_response.rb', line 42

optional :request_id, String

#results ⇒ Array<PreludeSDK::Models::NotifySendBatchResponse::Result>

The per-recipient result of the bulk send.

Returns:



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

required :results,
-> { PreludeSDK::Internal::Type::ArrayOf[PreludeSDK::Models::NotifySendBatchResponse::Result] }

#success_count ⇒ Integer

Number of successful sends.

Returns:

  • (Integer) 


24
 
# File 'lib/prelude_sdk/models/notify_send_batch_response.rb', line 24

required :success_count, Integer

#template_id ⇒ String?

The template identifier used for this bulk request.

Returns:

  • (String, nil) 


48
 
# File 'lib/prelude_sdk/models/notify_send_batch_response.rb', line 48

optional :template_id, String

#total_count ⇒ Integer

Total number of recipients.

Returns:

  • (Integer) 


30
 
# File 'lib/prelude_sdk/models/notify_send_batch_response.rb', line 30

required :total_count, Integer

#variables ⇒ Hash{Symbol=>String}?

The variables used for this bulk request.

Returns:

  • (Hash{Symbol=>String}, nil) 


54
 
# File 'lib/prelude_sdk/models/notify_send_batch_response.rb', line 54

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