Class: SurgeAPI::Models::BlastCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• SurgeAPI::Models::BlastCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/surge_api/models/blast_create_params.rb

Overview

See Also:

• Resources::Blasts#create

Defined Under Namespace

Classes: Attachment

Instance Attribute Summary

• #attachments ⇒ Array<SurgeAPI::Models::BlastCreateParams::Attachment>^?
• #body ⇒ String^?

  The message body.

• #contacts ⇒ Array<String>^? deprecated Deprecated.

  Use ‘to` to specify recipients instead.

• #from ⇒ String^?

  The phone number from which to send the blast.

• #name ⇒ String^?

  Optional name for the blast.

• #segments ⇒ Array<String>^? deprecated Deprecated.

  Use ‘to` to specify recipients instead.

• #send_at ⇒ Time^?

  When to send the blast.

• #to ⇒ Array<String>^?

  List of recipients to whom the blast should be sent.

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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, #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 SurgeAPI::Internal::Type::BaseModel

Instance Attribute Details

#attachments ⇒ Array<SurgeAPI::Models::BlastCreateParams::Attachment>^?

Returns:

• (Array<SurgeAPI::Models::BlastCreateParams::Attachment>, nil)

# File 'lib/surge_api/models/blast_create_params.rb', line 13

optional :attachments, -> { SurgeAPI::Internal::Type::ArrayOf[SurgeAPI::BlastCreateParams::Attachment] }

#body ⇒ String^?

The message body.

Returns:

• (String, nil)

# File 'lib/surge_api/models/blast_create_params.rb', line 19

optional :body, String, nil?: true

#contacts ⇒ Array<String>^?

Deprecated.

Use ‘to` to specify recipients instead.

Deprecated. Use ‘to` instead.

Returns:

• (Array<String>, nil)

# File 'lib/surge_api/models/blast_create_params.rb', line 27

optional :contacts, SurgeAPI::Internal::Type::ArrayOf[String]

#from ⇒ String^?

The phone number from which to send the blast. This can be either the phone number in E.164 format or a Surge phone number id. If not provided, the account’s default phone number is used.

Returns:

• (String, nil)

# File 'lib/surge_api/models/blast_create_params.rb', line 35

optional :from, String

#name ⇒ String^?

Optional name for the blast.

Returns:

• (String, nil)

# File 'lib/surge_api/models/blast_create_params.rb', line 41

optional :name, String

#segments ⇒ Array<String>^?

Deprecated.

Use ‘to` to specify recipients instead.

Deprecated. Use ‘to` instead.

Returns:

• (Array<String>, nil)

# File 'lib/surge_api/models/blast_create_params.rb', line 49

optional :segments, SurgeAPI::Internal::Type::ArrayOf[String]

#send_at ⇒ Time^?

When to send the blast. If not provided, sends immediately.

Returns:

• (Time, nil)

# File 'lib/surge_api/models/blast_create_params.rb', line 55

optional :send_at, Time

#to ⇒ Array<String>^?

List of recipients to whom the blast should be sent. This can be a combination of contact IDs, segment IDs, and phone numbers.

Returns:

• (Array<String>, nil)

# File 'lib/surge_api/models/blast_create_params.rb', line 62

optional :to, SurgeAPI::Internal::Type::ArrayOf[String]