Class: PreludeSDK::Models::NotifySendBatchParams

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

Overview

See Also:

  • PreludeSDK::Resources::Notify#send_batch

Defined Under Namespace

Modules: PreferredChannel Classes: Document

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::PreludeSDK

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(url:, filename: nil) ⇒ Object

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

A media attachment to include in the message header. Supported on WhatsApp templates registered with a DOCUMENT, IMAGE, or VIDEO header. The media type is determined by the template's registered header format; send the matching file type for each.

  • DOCUMENT headers accept PDF and other document formats; filename is required and displayed to the recipient.
  • IMAGE headers accept .png, .jpg, .jpeg, and .webp URLs; filename is ignored.
  • VIDEO headers accept .mp4 and .3gp URLs; filename is ignored.

Parameters:

  • url (String) —

    HTTPS URL of the media file. The file extension must match the template's regist

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

    Filename displayed to the recipient. Required for templates with a DOCUMENT he




# File 'lib/prelude_sdk/models/notify_send_batch_params.rb', line 143

Instance Attribute Details

#callback_url ⇒ String?

The URL where webhooks will be sent for delivery events.

Parameters:

  • (String)

Returns:

  • (String, nil) 


26
 
# File 'lib/prelude_sdk/models/notify_send_batch_params.rb', line 26

optional :callback_url, String

#correlation_id ⇒ String?

A user-defined identifier to correlate this request with your internal systems.

Parameters:

  • (String)

Returns:

  • (String, nil) 


32
 
# File 'lib/prelude_sdk/models/notify_send_batch_params.rb', line 32

optional :correlation_id, String

#document ⇒ PreludeSDK::Models::NotifySendBatchParams::Document?

A media attachment to include in the message header. Supported on WhatsApp templates registered with a DOCUMENT, IMAGE, or VIDEO header. The media type is determined by the template's registered header format; send the matching file type for each.

  • DOCUMENT headers accept PDF and other document formats; filename is required and displayed to the recipient.
  • IMAGE headers accept .png, .jpg, .jpeg, and .webp URLs; filename is ignored.
  • VIDEO headers accept .mp4 and .3gp URLs; filename is ignored.

Returns:



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

optional :document, -> { PreludeSDK::NotifySendBatchParams::Document }

#expires_at ⇒ Time?

The message expiration date in RFC3339 format. Messages will not be sent after this time.

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


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

optional :expires_at, Time

#from ⇒ String?

The Sender ID. Must be approved for your account.

Parameters:

  • (String)

Returns:

  • (String, nil) 


60
 
# File 'lib/prelude_sdk/models/notify_send_batch_params.rb', line 60

optional :from, String

#locale ⇒ String?

A BCP-47 formatted locale string.

Parameters:

  • (String)

Returns:

  • (String, nil) 


66
 
# File 'lib/prelude_sdk/models/notify_send_batch_params.rb', line 66

optional :locale, String

#max_auto_retries ⇒ Integer?

Maximum number of automatic retry attempts across channels for each send in the batch, in addition to the first attempt. For example, 2 allows up to 3 total delivery attempts per recipient. Lower values reduce delivery cost on hard-to-reach numbers at the expense of deliverability. When omitted, your account's configured default applies.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


76
 
# File 'lib/prelude_sdk/models/notify_send_batch_params.rb', line 76

optional :max_auto_retries, Integer

#preferred_channel ⇒ Symbol, ...

Preferred channel for delivery. If unavailable, automatic fallback applies.

Returns:



82
 
# File 'lib/prelude_sdk/models/notify_send_batch_params.rb', line 82

optional :preferred_channel, enum: -> { PreludeSDK::NotifySendBatchParams::PreferredChannel }

#schedule_at ⇒ Time?

Schedule delivery in RFC3339 format. Marketing sends may be adjusted to comply with local time windows.

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


89
 
# File 'lib/prelude_sdk/models/notify_send_batch_params.rb', line 89

optional :schedule_at, Time

#template_id ⇒ String

The template identifier configured by your Customer Success team.

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/prelude_sdk/models/notify_send_batch_params.rb', line 14

required :template_id, String

#to ⇒ Array<String>

The list of recipients' phone numbers in E.164 format.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


20
 
# File 'lib/prelude_sdk/models/notify_send_batch_params.rb', line 20

required :to, PreludeSDK::Internal::Type::ArrayOf[String]

#variables ⇒ Hash{Symbol=>String}?

The variables to be replaced in the template.

Parameters:

  • (::Hash[Symbol, String])

Returns:

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


95
 
# File 'lib/prelude_sdk/models/notify_send_batch_params.rb', line 95

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


88
 
# File 'sig/prelude_sdk/models/notify_send_batch_params.rbs', line 88

def to_hash: -> {