Class: SurgeAPI::Models::Blast

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/surge_api/models/blast.rb,
sig/surge_api/models/blast.rbs

Overview

See Also:

  • SurgeAPI::Resources::Blasts#create

Defined Under Namespace

Classes: Attachment

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 ⇒ Object 



33
 
# File 'sig/surge_api/models/blast.rbs', line 33

def initialize: (

Instance Attribute Details

#attachments ⇒ Array<SurgeAPI::Models::Blast::Attachment>?

Returns:



16
 
# File 'lib/surge_api/models/blast.rb', line 16

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

#body ⇒ String?

The message body.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


22
 
# File 'lib/surge_api/models/blast.rb', line 22

optional :body, String, nil?: true

#id ⇒ String?

Unique identifier for the object.

Parameters:

  • (String)

Returns:

  • (String, nil) 


11
 
# File 'lib/surge_api/models/blast.rb', line 11

optional :id, String

#name ⇒ String?

Optional name for the blast.

Parameters:

  • (String)

Returns:

  • (String, nil) 


28
 
# File 'lib/surge_api/models/blast.rb', line 28

optional :name, String

#send_at ⇒ Time?

When the blast will be or was sent.

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


34
 
# File 'lib/surge_api/models/blast.rb', line 34

optional :send_at, Time

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


41
 
# File 'sig/surge_api/models/blast.rbs', line 41

def to_hash: -> {