Class: Inttegro::Broadcast::Request

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/broadcast/request.rb

Overview

Typed representation of the request object in the Inttegro API.

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Instance Attribute Summary collapse

Instance Attribute Details

#email ⇒ Inttegro::Chime::EmailMessageInput? (readonly)

Email content accepted for email chimes, broadcasts, and schedules.

Optional in the API payload; omitted values default to nil. Wire name: email.

Returns:



59
60
61
62
63
64
65
66
 
# File 'lib/inttegro/broadcast/request.rb', line 59

class Request < T::Struct
  const :request_meta, T.nilable(Inttegro::Broadcast::RequestRequestMeta), default: nil
  const :message_template, T.nilable(T.any(String, Inttegro::MessageTemplate::Reference)), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipients, T::Array[Inttegro::Chime::Recipient]
  const :sender, T.nilable(String), default: nil
end

#message_template ⇒ String, ... (readonly)

Raw SMS content for SMS broadcasts, or a stored message template reference for SMS or email broadcasts.

Optional in the API payload; omitted values default to nil. Wire name: message_template.

Returns:



59
60
61
62
63
64
65
66
 
# File 'lib/inttegro/broadcast/request.rb', line 59

class Request < T::Struct
  const :request_meta, T.nilable(Inttegro::Broadcast::RequestRequestMeta), default: nil
  const :message_template, T.nilable(T.any(String, Inttegro::MessageTemplate::Reference)), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipients, T::Array[Inttegro::Chime::Recipient]
  const :sender, T.nilable(String), default: nil
end

#purpose ⇒ String? (readonly)

Category or intent for this broadcast.

Optional in the API payload; omitted values default to nil. Wire name: purpose.

Returns:

  • (String, nil) 


59
60
61
62
63
64
65
66
 
# File 'lib/inttegro/broadcast/request.rb', line 59

class Request < T::Struct
  const :request_meta, T.nilable(Inttegro::Broadcast::RequestRequestMeta), default: nil
  const :message_template, T.nilable(T.any(String, Inttegro::MessageTemplate::Reference)), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipients, T::Array[Inttegro::Chime::Recipient]
  const :sender, T.nilable(String), default: nil
end

#recipients ⇒ Array<Inttegro::Chime::Recipient> (readonly)

Recipient objects for this broadcast. Each item must include transport and either inline contact details or customer_id.

Required in the API payload. Wire name: recipients.

Returns:



59
60
61
62
63
64
65
66
 
# File 'lib/inttegro/broadcast/request.rb', line 59

class Request < T::Struct
  const :request_meta, T.nilable(Inttegro::Broadcast::RequestRequestMeta), default: nil
  const :message_template, T.nilable(T.any(String, Inttegro::MessageTemplate::Reference)), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipients, T::Array[Inttegro::Chime::Recipient]
  const :sender, T.nilable(String), default: nil
end

#request_meta ⇒ Inttegro::Broadcast::RequestRequestMeta? (readonly)

Value of the request_meta field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: request_meta.

Returns:



59
60
61
62
63
64
65
66
 
# File 'lib/inttegro/broadcast/request.rb', line 59

class Request < T::Struct
  const :request_meta, T.nilable(Inttegro::Broadcast::RequestRequestMeta), default: nil
  const :message_template, T.nilable(T.any(String, Inttegro::MessageTemplate::Reference)), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipients, T::Array[Inttegro::Chime::Recipient]
  const :sender, T.nilable(String), default: nil
end

#sender ⇒ String? (readonly)

Sender identifier displayed to recipients.

Optional in the API payload; omitted values default to nil. Wire name: sender.

Returns:

  • (String, nil) 


59
60
61
62
63
64
65
66
 
# File 'lib/inttegro/broadcast/request.rb', line 59

class Request < T::Struct
  const :request_meta, T.nilable(Inttegro::Broadcast::RequestRequestMeta), default: nil
  const :message_template, T.nilable(T.any(String, Inttegro::MessageTemplate::Reference)), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :purpose, T.nilable(String), default: nil
  const :recipients, T::Array[Inttegro::Chime::Recipient]
  const :sender, T.nilable(String), default: nil
end