Class: Inttegro::Schedule::ChimeRequest

Inherits:

T::Struct

• Object
• T::Struct
• Inttegro::Schedule::ChimeRequest

Defined in:

lib/inttegro/schedule/chime_request.rb

Overview

Typed representation of the chime 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

• #email ⇒ Inttegro::Chime::EmailMessageInput^? readonly

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

• #full_message ⇒ String^? readonly

  Complete SMS message content.

• #message_template ⇒ Inttegro::MessageTemplate::Reference^? readonly

  Value of the message_template field in the Inttegro API payload.

• #purpose ⇒ String^? readonly

  Optional purpose or category for this scheduled chime.

• #recipients ⇒ Array<Inttegro::Chime::Recipient> readonly

  Recipient objects for this scheduled chime.

• #request_meta ⇒ Inttegro::Schedule::ChimeRequestRequestMeta^? readonly

  Value of the request_meta field in the Inttegro API payload.

• #send_after ⇒ Time readonly

  ISO 8601 timestamp for when to send the chime (must be in the future).

• #sender_id ⇒ String^? readonly

  Sender identifier displayed to recipients.

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:

• (Inttegro::Chime::EmailMessageInput, nil)

# File 'lib/inttegro/schedule/chime_request.rb', line 70

class ChimeRequest < T::Struct
  const :request_meta, T.nilable(Inttegro::Schedule::ChimeRequestRequestMeta), default: nil
  const :recipients, T::Array[Inttegro::Chime::Recipient]
  const :send_after, Time
  const :full_message, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :message_template, T.nilable(Inttegro::MessageTemplate::Reference), default: nil
  const :sender_id, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
end

#full_message ⇒ String^? (readonly)

Complete SMS message content. Use only with SMS recipients.

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

Returns:

• (String, nil)

# File 'lib/inttegro/schedule/chime_request.rb', line 70

class ChimeRequest < T::Struct
  const :request_meta, T.nilable(Inttegro::Schedule::ChimeRequestRequestMeta), default: nil
  const :recipients, T::Array[Inttegro::Chime::Recipient]
  const :send_after, Time
  const :full_message, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :message_template, T.nilable(Inttegro::MessageTemplate::Reference), default: nil
  const :sender_id, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
end

#message_template ⇒ Inttegro::MessageTemplate::Reference^? (readonly)

Value of the message_template field in the Inttegro API payload.

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

Returns:

• (Inttegro::MessageTemplate::Reference, nil)

# File 'lib/inttegro/schedule/chime_request.rb', line 70

class ChimeRequest < T::Struct
  const :request_meta, T.nilable(Inttegro::Schedule::ChimeRequestRequestMeta), default: nil
  const :recipients, T::Array[Inttegro::Chime::Recipient]
  const :send_after, Time
  const :full_message, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :message_template, T.nilable(Inttegro::MessageTemplate::Reference), default: nil
  const :sender_id, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
end

#purpose ⇒ String^? (readonly)

Optional purpose or category for this scheduled chime

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

Returns:

• (String, nil)

# File 'lib/inttegro/schedule/chime_request.rb', line 70

class ChimeRequest < T::Struct
  const :request_meta, T.nilable(Inttegro::Schedule::ChimeRequestRequestMeta), default: nil
  const :recipients, T::Array[Inttegro::Chime::Recipient]
  const :send_after, Time
  const :full_message, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :message_template, T.nilable(Inttegro::MessageTemplate::Reference), default: nil
  const :sender_id, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
end

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

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

Required in the API payload. Wire name: recipients.

Returns:

• (Array<Inttegro::Chime::Recipient>)

# File 'lib/inttegro/schedule/chime_request.rb', line 70

class ChimeRequest < T::Struct
  const :request_meta, T.nilable(Inttegro::Schedule::ChimeRequestRequestMeta), default: nil
  const :recipients, T::Array[Inttegro::Chime::Recipient]
  const :send_after, Time
  const :full_message, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :message_template, T.nilable(Inttegro::MessageTemplate::Reference), default: nil
  const :sender_id, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
end

#request_meta ⇒ Inttegro::Schedule::ChimeRequestRequestMeta^? (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:

• (Inttegro::Schedule::ChimeRequestRequestMeta, nil)

# File 'lib/inttegro/schedule/chime_request.rb', line 70

class ChimeRequest < T::Struct
  const :request_meta, T.nilable(Inttegro::Schedule::ChimeRequestRequestMeta), default: nil
  const :recipients, T::Array[Inttegro::Chime::Recipient]
  const :send_after, Time
  const :full_message, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :message_template, T.nilable(Inttegro::MessageTemplate::Reference), default: nil
  const :sender_id, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
end

#send_after ⇒ Time (readonly)

ISO 8601 timestamp for when to send the chime (must be in the future)

Required in the API payload. Wire name: send_after.

Returns:

• (Time)

# File 'lib/inttegro/schedule/chime_request.rb', line 70

class ChimeRequest < T::Struct
  const :request_meta, T.nilable(Inttegro::Schedule::ChimeRequestRequestMeta), default: nil
  const :recipients, T::Array[Inttegro::Chime::Recipient]
  const :send_after, Time
  const :full_message, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :message_template, T.nilable(Inttegro::MessageTemplate::Reference), default: nil
  const :sender_id, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
end

#sender_id ⇒ String^? (readonly)

Sender identifier displayed to recipients

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

Returns:

• (String, nil)

# File 'lib/inttegro/schedule/chime_request.rb', line 70

class ChimeRequest < T::Struct
  const :request_meta, T.nilable(Inttegro::Schedule::ChimeRequestRequestMeta), default: nil
  const :recipients, T::Array[Inttegro::Chime::Recipient]
  const :send_after, Time
  const :full_message, T.nilable(String), default: nil
  const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
  const :message_template, T.nilable(Inttegro::MessageTemplate::Reference), default: nil
  const :sender_id, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
end